Package org.redisson

Class RedissonPriorityBlockingDeque<V>

All Implemented Interfaces:
Iterable<V>, Collection<V>, BlockingDeque<V>, BlockingQueue<V>, Deque<V>, Queue<V>, RBlockingDeque<V>, RBlockingDequeAsync<V>, RBlockingQueue<V>, RBlockingQueueAsync<V>, RCollectionAsync<V>, RDeque<V>, RDequeAsync<V>, RExpirable, RExpirableAsync, RObject, RObjectAsync, RPriorityBlockingDeque<V>, RPriorityDeque<V>, RPriorityQueue<V>, RQueue<V>, RQueueAsync<V>

public class RedissonPriorityBlockingDeque<V> extends RedissonPriorityDeque<V> implements RPriorityBlockingDeque<V>

Distributed and concurrent implementation of priority blocking deque.

Queue size limited by Redis server memory amount. This is why remainingCapacity() always returns Integer.MAX_VALUE

Author:
Nikita Koksharov
  • Constructor Details

  • Method Details

    • put

      public void put(V e) throws InterruptedException
      Specified by:
      put in interface BlockingDeque<V>
      Specified by:
      put in interface BlockingQueue<V>
      Throws:
      InterruptedException
    • offer

      public boolean offer(V e, long timeout, TimeUnit unit) throws InterruptedException
      Specified by:
      offer in interface BlockingDeque<V>
      Specified by:
      offer in interface BlockingQueue<V>
      Throws:
      InterruptedException
    • takeAsync

      public RFuture<V> takeAsync()
      Description copied from interface: RBlockingQueueAsync
      Retrieves and removes the head of this queue in async mode, waiting if necessary until an element becomes available.
      Specified by:
      takeAsync in interface RBlockingQueueAsync<V>
      Returns:
      the head of this queue
    • take

      public V take() throws InterruptedException
      Specified by:
      take in interface BlockingDeque<V>
      Specified by:
      take in interface BlockingQueue<V>
      Throws:
      InterruptedException
    • pollAsync

      public RFuture<V> pollAsync(long timeout, TimeUnit unit)
      Description copied from interface: RBlockingQueueAsync
      Retrieves and removes the head of this queue in async mode, waiting up to the specified wait time if necessary for an element to become available.
      Specified by:
      pollAsync in interface RBlockingQueueAsync<V>
      Parameters:
      timeout - how long to wait before giving up, in units of unit
      unit - a TimeUnit determining how to interpret the timeout parameter
      Returns:
      the head of this queue, or null if the specified waiting time elapses before an element is available
    • poll

      public V poll(long timeout, TimeUnit unit) throws InterruptedException
      Specified by:
      poll in interface BlockingDeque<V>
      Specified by:
      poll in interface BlockingQueue<V>
      Throws:
      InterruptedException
    • pollFromAny

      public V pollFromAny(long timeout, TimeUnit unit, String... queueNames) throws InterruptedException
      Description copied from interface: RBlockingQueue
      Retrieves and removes first available head element of any queue, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue itself.
      Specified by:
      pollFromAny in interface RBlockingQueue<V>
      Parameters:
      timeout - how long to wait before giving up, in units of unit
      unit - a TimeUnit determining how to interpret the timeout parameter
      queueNames - - queue names. Queue name itself is always included
      Returns:
      the head of this queue, or null if the specified waiting time elapses before an element is available
      Throws:
      InterruptedException - if interrupted while waiting
    • pollFromAnyWithName

      public Entry<String,V> pollFromAnyWithName(Duration timeout, String... queueNames) throws InterruptedException
      Description copied from interface: RBlockingQueue
      Retrieves and removes first available head element of any queue, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue itself.
      Specified by:
      pollFromAnyWithName in interface RBlockingQueue<V>
      Parameters:
      timeout - how long to wait before giving up, in units of unit
      queueNames - queue names. Queue name itself is always included
      Returns:
      the head of this queue, or null if the specified waiting time elapses before an element is available
      Throws:
      InterruptedException - if interrupted while waiting
    • pollFromAnyWithNameAsync

      public RFuture<Entry<String,V>> pollFromAnyWithNameAsync(Duration timeout, String... queueNames)
      Description copied from interface: RBlockingQueueAsync
      Retrieves and removes first available head element of any queue in async mode, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue itself.
      Specified by:
      pollFromAnyWithNameAsync in interface RBlockingQueueAsync<V>
      Parameters:
      timeout - how long to wait before giving up
      queueNames - - queue names. Queue name itself is always included
      Returns:
      Future object with the head of this queue, or null if the specified waiting time elapses before an element is available
    • pollFirstFromAny

      public Map<String,List<V>> pollFirstFromAny(Duration duration, int count, String... queueNames) throws InterruptedException
      Description copied from interface: RBlockingQueue
      Retrieves and removes first available head elements of any queue, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue itself.

      Requires Redis 7.0.0 and higher.

      Specified by:
      pollFirstFromAny in interface RBlockingQueue<V>
      Parameters:
      duration - how long to wait before giving up
      count - elements amount
      queueNames - name of queues
      Returns:
      the head elements
      Throws:
      InterruptedException
    • pollLastFromAny

      public Map<String,List<V>> pollLastFromAny(Duration duration, int count, String... queueNames) throws InterruptedException
      Description copied from interface: RBlockingQueue
      Retrieves and removes first available tail elements of any queue, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue itself.

      Requires Redis 7.0.0 and higher.

      Specified by:
      pollLastFromAny in interface RBlockingQueue<V>
      Parameters:
      duration - how long to wait before giving up
      count - elements amount
      queueNames - name of queues
      Returns:
      the tail elements
      Throws:
      InterruptedException
    • pollFirstFromAnyAsync

      public RFuture<Map<String,List<V>>> pollFirstFromAnyAsync(Duration duration, int count, String... queueNames)
      Description copied from interface: RBlockingQueueAsync
      Retrieves and removes first available head elements of any queue, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue itself.

      Requires Redis 7.0.0 and higher.

      Specified by:
      pollFirstFromAnyAsync in interface RBlockingQueueAsync<V>
      Parameters:
      duration - how long to wait before giving up
      count - elements amount
      queueNames - name of queues
      Returns:
      the head elements
    • pollLastFromAnyAsync

      public RFuture<Map<String,List<V>>> pollLastFromAnyAsync(Duration duration, int count, String... queueNames)
      Description copied from interface: RBlockingQueueAsync
      Retrieves and removes first available tail elements of any queue, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue itself.

      Requires Redis 7.0.0 and higher.

      Specified by:
      pollLastFromAnyAsync in interface RBlockingQueueAsync<V>
      Parameters:
      duration - how long to wait before giving up
      count - elements amount
      queueNames - name of queues
      Returns:
      the tail elements
    • pollLastAndOfferFirstToAsync

      public RFuture<V> pollLastAndOfferFirstToAsync(String queueName, long timeout, TimeUnit unit)
      Description copied from interface: RBlockingQueueAsync
      Retrieves and removes last available tail element of this queue and adds it at the head of queueName, waiting up to the specified wait time if necessary for an element to become available.
      Specified by:
      pollLastAndOfferFirstToAsync in interface RBlockingQueueAsync<V>
      Parameters:
      queueName - - names of destination queue
      timeout - how long to wait before giving up, in units of unit
      unit - a TimeUnit determining how to interpret the timeout parameter
      Returns:
      the tail of this queue, or null if the specified waiting time elapses before an element is available
    • pollLastAndOfferFirstTo

      public V pollLastAndOfferFirstTo(String queueName, long timeout, TimeUnit unit) throws InterruptedException
      Description copied from interface: RBlockingQueue
      Retrieves and removes last available tail element of this queue and adds it at the head of queueName, waiting up to the specified wait time if necessary for an element to become available.
      Specified by:
      pollLastAndOfferFirstTo in interface RBlockingQueue<V>
      Parameters:
      queueName - - names of destination queue
      timeout - how long to wait before giving up, in units of unit
      unit - a TimeUnit determining how to interpret the timeout parameter
      Returns:
      the tail of this queue, or null if the specified waiting time elapses before an element is available
      Throws:
      InterruptedException - if interrupted while waiting
    • takeLastAndOfferFirstTo

      public V takeLastAndOfferFirstTo(String queueName) throws InterruptedException
      Description copied from interface: RBlockingQueue
      Retrieves and removes last available tail element of any queue and adds it at the head of queueName, waiting if necessary for an element to become available in any of defined queues including queue itself.
      Specified by:
      takeLastAndOfferFirstTo in interface RBlockingQueue<V>
      Parameters:
      queueName - - names of destination queue
      Returns:
      the tail of this queue, or null if the specified waiting time elapses before an element is available
      Throws:
      InterruptedException - if interrupted while waiting
    • subscribeOnElements

      public int subscribeOnElements(Consumer<V> consumer)
      Description copied from interface: RBlockingQueue
      Specified by:
      subscribeOnElements in interface RBlockingQueue<V>
      Parameters:
      consumer - - queue elements listener
      Returns:
      listenerId - id of listener
    • subscribeOnElements

      public int subscribeOnElements(Function<V,CompletionStage<Void>> consumer)
      Description copied from interface: RBlockingQueue
      Subscribes on elements appeared in this queue. Continuously invokes RBlockingQueueAsync.takeAsync() method to get a new element.

      NOTE: don't call blocking methods in the elements listener

      Specified by:
      subscribeOnElements in interface RBlockingQueue<V>
      Parameters:
      consumer - - queue elements listener
      Returns:
      listenerId - id of listener
    • unsubscribe

      public void unsubscribe(int listenerId)
      Description copied from interface: RBlockingQueue
      Un-subscribes defined listener.
      Specified by:
      unsubscribe in interface RBlockingQueue<V>
      Parameters:
      listenerId - - id of listener
    • takeLastAndOfferFirstToAsync

      public RFuture<V> takeLastAndOfferFirstToAsync(String queueName)
      Description copied from interface: RBlockingQueueAsync
      Retrieves and removes last available tail element of any queue and adds it at the head of queueName, waiting if necessary for an element to become available in any of defined queues including queue itself.
      Specified by:
      takeLastAndOfferFirstToAsync in interface RBlockingQueueAsync<V>
      Parameters:
      queueName - - names of destination queue
      Returns:
      the tail of this queue, or null if the specified waiting time elapses before an element is available
    • remainingCapacity

      public int remainingCapacity()
      Specified by:
      remainingCapacity in interface BlockingQueue<V>
    • drainTo

      public int drainTo(Collection<? super V> c)
      Specified by:
      drainTo in interface BlockingQueue<V>
    • drainToAsync

      public RFuture<Integer> drainToAsync(Collection<? super V> c)
      Description copied from interface: RBlockingQueueAsync
      Removes all available elements from this queue and adds them to the given collection in async mode. This operation may be more efficient than repeatedly polling this queue. A failure encountered while attempting to add elements to collection c may result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in IllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.
      Specified by:
      drainToAsync in interface RBlockingQueueAsync<V>
      Parameters:
      c - the collection to transfer elements into
      Returns:
      the number of elements transferred
    • drainTo

      public int drainTo(Collection<? super V> c, int maxElements)
      Specified by:
      drainTo in interface BlockingQueue<V>
    • drainToAsync

      public RFuture<Integer> drainToAsync(Collection<? super V> c, int maxElements)
      Description copied from interface: RBlockingQueueAsync
      Removes at most the given number of available elements from this queue and adds them to the given collection in async mode. A failure encountered while attempting to add elements to collection c may result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in IllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.
      Specified by:
      drainToAsync in interface RBlockingQueueAsync<V>
      Parameters:
      c - the collection to transfer elements into
      maxElements - the maximum number of elements to transfer
      Returns:
      the number of elements transferred
    • offerAsync

      public RFuture<Boolean> offerAsync(V e)
      Description copied from interface: RQueueAsync
      Inserts the specified element into this queue.
      Specified by:
      offerAsync in interface RQueueAsync<V>
      Overrides:
      offerAsync in class RedissonPriorityQueue<V>
      Parameters:
      e - the element to add
      Returns:
      true if successful, or false
    • pollAsync

      public RFuture<List<V>> pollAsync(int limit)
      Description copied from interface: RQueueAsync
      Retrieves and removes the head elements of this queue. Elements amount limited by limit param.
      Specified by:
      pollAsync in interface RQueueAsync<V>
      Overrides:
      pollAsync in class RedissonPriorityQueue<V>
      Returns:
      list of head elements
    • pollFromAnyAsync

      public RFuture<V> pollFromAnyAsync(long timeout, TimeUnit unit, String... queueNames)
      Description copied from interface: RBlockingQueueAsync
      Retrieves and removes first available head element of any queue in async mode, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue itself.
      Specified by:
      pollFromAnyAsync in interface RBlockingQueueAsync<V>
      Parameters:
      timeout - how long to wait before giving up, in units of unit
      unit - a TimeUnit determining how to interpret the timeout parameter
      queueNames - - queue names. Queue name itself is always included
      Returns:
      Future object with the head of this queue, or null if the specified waiting time elapses before an element is available
    • putAsync

      public RFuture<Void> putAsync(V e)
      Description copied from interface: RBlockingQueueAsync
      Inserts the specified element into this queue in async mode, waiting if necessary for space to become available.
      Specified by:
      putAsync in interface RBlockingQueueAsync<V>
      Parameters:
      e - the element to add
      Returns:
      void
    • putFirstAsync

      public RFuture<Void> putFirstAsync(V e)
      Description copied from interface: RBlockingDequeAsync
      Adds value to the head of queue.
      Specified by:
      putFirstAsync in interface RBlockingDequeAsync<V>
      Parameters:
      e - value
      Returns:
      void
    • putLastAsync

      public RFuture<Void> putLastAsync(V e)
      Description copied from interface: RBlockingDequeAsync
      Adds value to the tail of queue.
      Specified by:
      putLastAsync in interface RBlockingDequeAsync<V>
      Parameters:
      e - value
      Returns:
      void
    • putFirst

      public void putFirst(V e) throws InterruptedException
      Specified by:
      putFirst in interface BlockingDeque<V>
      Throws:
      InterruptedException
    • putLast

      public void putLast(V e) throws InterruptedException
      Specified by:
      putLast in interface BlockingDeque<V>
      Throws:
      InterruptedException
    • offerFirst

      public boolean offerFirst(V e, long timeout, TimeUnit unit) throws InterruptedException
      Specified by:
      offerFirst in interface BlockingDeque<V>
      Throws:
      InterruptedException
    • offerLast

      public boolean offerLast(V e, long timeout, TimeUnit unit) throws InterruptedException
      Specified by:
      offerLast in interface BlockingDeque<V>
      Throws:
      InterruptedException
    • takeFirst

      public V takeFirst() throws InterruptedException
      Specified by:
      takeFirst in interface BlockingDeque<V>
      Throws:
      InterruptedException
    • takeFirstAsync

      public RFuture<V> takeFirstAsync()
      Description copied from interface: RBlockingDequeAsync
      Retrieves and removes value at the head of queue. Waits for an element become available.
      Specified by:
      takeFirstAsync in interface RBlockingDequeAsync<V>
      Returns:
      the head element of this queue
    • takeLastAsync

      public RFuture<V> takeLastAsync()
      Description copied from interface: RBlockingDequeAsync
      Retrieves and removes value at the tail of queue. Waits for an element become available.
      Specified by:
      takeLastAsync in interface RBlockingDequeAsync<V>
      Returns:
      the tail element of this queue
    • takeLast

      public V takeLast() throws InterruptedException
      Specified by:
      takeLast in interface BlockingDeque<V>
      Throws:
      InterruptedException
    • pollFirstAsync

      public RFuture<V> pollFirstAsync(long timeout, TimeUnit unit)
      Description copied from interface: RBlockingDequeAsync
      Retrieves and removes value at the head of queue. If necessary waits up to defined timeout for an element become available.
      Specified by:
      pollFirstAsync in interface RBlockingDequeAsync<V>
      Parameters:
      timeout - how long to wait before giving up, in units of unit
      unit - a TimeUnit determining how to interpret the timeout parameter
      Returns:
      the element at the tail of this queue, or null if the specified waiting time elapses before an element is available
    • pollFirstFromAny

      public V pollFirstFromAny(long timeout, TimeUnit unit, String... queueNames) throws InterruptedException
      Description copied from interface: RBlockingDeque
      Retrieves and removes first available head element of any queue, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue own.
      Specified by:
      pollFirstFromAny in interface RBlockingDeque<V>
      Parameters:
      timeout - how long to wait before giving up, in units of unit
      unit - a TimeUnit determining how to interpret the timeout parameter
      queueNames - - names of queue
      Returns:
      the head of this queue, or null if the specified waiting time elapses before an element is available
      Throws:
      InterruptedException - if interrupted while waiting
    • pollFirstFromAnyAsync

      public RFuture<V> pollFirstFromAnyAsync(long timeout, TimeUnit unit, String... queueNames)
      Description copied from interface: RBlockingDequeAsync
      Retrieves and removes first available head element of any queue in async mode, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue own.
      Specified by:
      pollFirstFromAnyAsync in interface RBlockingDequeAsync<V>
      Parameters:
      timeout - how long to wait before giving up, in units of unit
      unit - a TimeUnit determining how to interpret the timeout parameter
      queueNames - - names of queue
      Returns:
      the head of this queue, or null if the specified waiting time elapses before an element is available
    • pollLastFromAny

      public V pollLastFromAny(long timeout, TimeUnit unit, String... queueNames) throws InterruptedException
      Description copied from interface: RBlockingDeque
      Retrieves and removes first available tail element of any queue, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue own.
      Specified by:
      pollLastFromAny in interface RBlockingDeque<V>
      Parameters:
      timeout - how long to wait before giving up, in units of unit
      unit - a TimeUnit determining how to interpret the timeout parameter
      queueNames - - names of queue
      Returns:
      the head of this queue, or null if the specified waiting time elapses before an element is available
      Throws:
      InterruptedException - if interrupted while waiting
    • subscribeOnFirstElements

      public int subscribeOnFirstElements(Consumer<V> consumer)
      Description copied from interface: RBlockingDeque
      Specified by:
      subscribeOnFirstElements in interface RBlockingDeque<V>
      Parameters:
      consumer - - queue elements listener
      Returns:
      listenerId - id of listener
    • subscribeOnLastElements

      public int subscribeOnLastElements(Consumer<V> consumer)
      Description copied from interface: RBlockingDeque
      Specified by:
      subscribeOnLastElements in interface RBlockingDeque<V>
      Parameters:
      consumer - - queue elements listener
      Returns:
      listenerId - id of listener
    • subscribeOnLastElements

      public int subscribeOnLastElements(Function<V,CompletionStage<Void>> consumer)
      Description copied from interface: RBlockingDeque
      Subscribes on last elements appeared in this queue. Continuously invokes RBlockingDequeAsync.takeLastAsync() method to get a new element.

      NOTE: don't call blocking methods in the elements listener

      Specified by:
      subscribeOnLastElements in interface RBlockingDeque<V>
      Parameters:
      consumer - - queue elements listener
      Returns:
      listenerId - id of listener
    • subscribeOnFirstElements

      public int subscribeOnFirstElements(Function<V,CompletionStage<Void>> consumer)
      Description copied from interface: RBlockingDeque
      Use RBlockingDeque.subscribeOnLastElements(Function) instead. Continuously invokes RBlockingDequeAsync.takeFirstAsync() method to get a new element.

      NOTE: don't call blocking methods in the elements listener

      Specified by:
      subscribeOnFirstElements in interface RBlockingDeque<V>
      Parameters:
      consumer - - queue elements listener
      Returns:
      listenerId - id of listener
    • pollLastFromAnyAsync

      public RFuture<V> pollLastFromAnyAsync(long timeout, TimeUnit unit, String... queueNames)
      Description copied from interface: RBlockingDequeAsync
      Retrieves and removes first available tail element of any queue in async mode, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue own.
      Specified by:
      pollLastFromAnyAsync in interface RBlockingDequeAsync<V>
      Parameters:
      timeout - how long to wait before giving up, in units of unit
      unit - a TimeUnit determining how to interpret the timeout parameter
      queueNames - - names of queue
      Returns:
      the head of this queue, or null if the specified waiting time elapses before an element is available
    • pollFirst

      public V pollFirst(long timeout, TimeUnit unit) throws InterruptedException
      Specified by:
      pollFirst in interface BlockingDeque<V>
      Throws:
      InterruptedException
    • pollLastAsync

      public RFuture<V> pollLastAsync(long timeout, TimeUnit unit)
      Description copied from interface: RBlockingDequeAsync
      Retrieves and removes value at the tail of queue. If necessary waits up to defined timeout for an element become available.
      Specified by:
      pollLastAsync in interface RBlockingDequeAsync<V>
      Parameters:
      timeout - how long to wait before giving up, in units of unit
      unit - a TimeUnit determining how to interpret the timeout parameter
      Returns:
      the element at the head of this queue, or null if the specified waiting time elapses before an element is available
    • pollLast

      public V pollLast(long timeout, TimeUnit unit) throws InterruptedException
      Specified by:
      pollLast in interface BlockingDeque<V>
      Throws:
      InterruptedException
    • poll

      public List<V> poll(int limit)
      Description copied from interface: RQueue
      Retrieves and removes the head elements of this queue. Elements amount limited by limit param.
      Specified by:
      poll in interface RQueue<V>
      Overrides:
      poll in class RedissonPriorityQueue<V>
      Returns:
      list of head elements
    • pollLast

      public List<V> pollLast(int limit)
      Description copied from interface: RDeque
      Retrieves and removes the tail elements of this queue. Elements amount limited by limit param.
      Specified by:
      pollLast in interface RDeque<V>
      Overrides:
      pollLast in class RedissonPriorityDeque<V>
      Returns:
      list of tail elements
    • pollFirst

      public List<V> pollFirst(int limit)
      Description copied from interface: RDeque
      Retrieves and removes the head elements of this queue. Elements amount limited by limit param.
      Specified by:
      pollFirst in interface RDeque<V>
      Overrides:
      pollFirst in class RedissonPriorityDeque<V>
      Returns:
      list of head elements
    • pollFirstAsync

      public RFuture<List<V>> pollFirstAsync(int limit)
      Description copied from interface: RDequeAsync
      Retrieves and removes the head elements of this queue. Elements amount limited by limit param.
      Specified by:
      pollFirstAsync in interface RDequeAsync<V>
      Overrides:
      pollFirstAsync in class RedissonPriorityDeque<V>
      Returns:
      list of head elements
    • pollLastAsync

      public RFuture<List<V>> pollLastAsync(int limit)
      Description copied from interface: RDequeAsync
      Retrieves and removes the tail elements of this queue. Elements amount limited by limit param.
      Specified by:
      pollLastAsync in interface RDequeAsync<V>
      Overrides:
      pollLastAsync in class RedissonPriorityDeque<V>
      Returns:
      list of tail elements
    • move

      public V move(Duration timeout, DequeMoveArgs args)
      Specified by:
      move in interface RBlockingDeque<V>
    • moveAsync

      public RFuture<V> moveAsync(Duration timeout, DequeMoveArgs args)
      Specified by:
      moveAsync in interface RBlockingDequeAsync<V>
    • expire

      public boolean expire(long timeToLive, TimeUnit timeUnit)
      Description copied from interface: RExpirable
      Specified by:
      expire in interface RExpirable
      Parameters:
      timeToLive - - timeout before object will be deleted
      timeUnit - - timeout time unit
      Returns:
      true if the timeout was set and false if not
    • expireAsync

      public RFuture<Boolean> expireAsync(long timeToLive, TimeUnit timeUnit)
      Description copied from interface: RExpirableAsync
      Specified by:
      expireAsync in interface RExpirableAsync
      Parameters:
      timeToLive - - timeout before object will be deleted
      timeUnit - - timeout time unit
      Returns:
      true if the timeout was set and false if not
    • expireAt

      public boolean expireAt(long timestamp)
      Description copied from interface: RExpirable
      Specified by:
      expireAt in interface RExpirable
      Parameters:
      timestamp - - expire date in milliseconds (Unix timestamp)
      Returns:
      true if the timeout was set and false if not
    • expireAtAsync

      public RFuture<Boolean> expireAtAsync(long timestamp)
      Description copied from interface: RExpirableAsync
      Specified by:
      expireAtAsync in interface RExpirableAsync
      Parameters:
      timestamp - - expire date in milliseconds (Unix timestamp)
      Returns:
      true if the timeout was set and false if not
    • expire

      public boolean expire(Instant instant)
      Description copied from interface: RExpirable
      Sets an expiration date for this object. When expire date comes the key will automatically be deleted.
      Specified by:
      expire in interface RExpirable
      Parameters:
      instant - expire date
      Returns:
      true if the timeout was set and false if not
    • expireIfSet

      public boolean expireIfSet(Instant time)
      Description copied from interface: RExpirable
      Sets an expiration date for this object only if it has been already set. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfSet in interface RExpirable
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not
    • expireIfSetAsync

      public RFuture<Boolean> expireIfSetAsync(Instant time)
      Description copied from interface: RExpirableAsync
      Sets an expiration date for this object only if it has been already set. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfSetAsync in interface RExpirableAsync
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not
    • expireIfNotSet

      public boolean expireIfNotSet(Instant time)
      Description copied from interface: RExpirable
      Sets an expiration date for this object only if it hasn't been set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfNotSet in interface RExpirable
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not
    • expireIfNotSetAsync

      public RFuture<Boolean> expireIfNotSetAsync(Instant time)
      Description copied from interface: RExpirableAsync
      Sets an expiration date for this object only if it hasn't been set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfNotSetAsync in interface RExpirableAsync
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not
    • expireIfGreater

      public boolean expireIfGreater(Instant time)
      Description copied from interface: RExpirable
      Sets an expiration date for this object only if it's greater than expiration date set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfGreater in interface RExpirable
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not
    • expireIfGreaterAsync

      public RFuture<Boolean> expireIfGreaterAsync(Instant time)
      Description copied from interface: RExpirableAsync
      Sets an expiration date for this object only if it's greater than expiration date set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfGreaterAsync in interface RExpirableAsync
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not
    • expireIfLess

      public boolean expireIfLess(Instant time)
      Description copied from interface: RExpirable
      Sets an expiration date for this object only if it's less than expiration date set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfLess in interface RExpirable
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not
    • expireIfLessAsync

      public RFuture<Boolean> expireIfLessAsync(Instant time)
      Description copied from interface: RExpirableAsync
      Sets an expiration date for this object only if it's less than expiration date set before. When expire date comes the object will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfLessAsync in interface RExpirableAsync
      Parameters:
      time - expire date
      Returns:
      true if the timeout was set and false if not
    • expireAsync

      public RFuture<Boolean> expireAsync(Instant instant)
      Description copied from interface: RExpirableAsync
      Set an expire date for object. When expire date comes the key will automatically be deleted.
      Specified by:
      expireAsync in interface RExpirableAsync
      Parameters:
      instant - - expire date
      Returns:
      true if the timeout was set and false if not
    • expire

      public boolean expire(Duration duration)
      Description copied from interface: RExpirable
      Sets a timeout for this object. After the timeout has expired, the key will automatically be deleted.
      Specified by:
      expire in interface RExpirable
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not
    • expireAsync

      public RFuture<Boolean> expireAsync(Duration duration)
      Description copied from interface: RExpirableAsync
      Set a timeout for object. After the timeout has expired, the key will automatically be deleted.
      Specified by:
      expireAsync in interface RExpirableAsync
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not
    • expireAt

      public boolean expireAt(Date timestamp)
      Description copied from interface: RExpirable
      Specified by:
      expireAt in interface RExpirable
      Parameters:
      timestamp - - expire date
      Returns:
      true if the timeout was set and false if not
    • expireAtAsync

      public RFuture<Boolean> expireAtAsync(Date timestamp)
      Description copied from interface: RExpirableAsync
      Specified by:
      expireAtAsync in interface RExpirableAsync
      Parameters:
      timestamp - - expire date
      Returns:
      true if the timeout was set and false if not
    • expireIfSet

      public boolean expireIfSet(Duration duration)
      Description copied from interface: RExpirable
      Sets a timeout for this object only if it has been already set. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfSet in interface RExpirable
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not
    • expireIfSetAsync

      public RFuture<Boolean> expireIfSetAsync(Duration duration)
      Description copied from interface: RExpirableAsync
      Sets a timeout for this object only if it has been already set. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfSetAsync in interface RExpirableAsync
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not
    • expireIfNotSet

      public boolean expireIfNotSet(Duration duration)
      Description copied from interface: RExpirable
      Sets a timeout for this object only if it hasn't been set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfNotSet in interface RExpirable
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not
    • expireIfNotSetAsync

      public RFuture<Boolean> expireIfNotSetAsync(Duration duration)
      Description copied from interface: RExpirableAsync
      Sets a timeout for this object only if it hasn't been set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfNotSetAsync in interface RExpirableAsync
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not
    • expireIfGreater

      public boolean expireIfGreater(Duration duration)
      Description copied from interface: RExpirable
      Sets a timeout for this object only if it's greater than timeout set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfGreater in interface RExpirable
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not
    • expireIfGreaterAsync

      public RFuture<Boolean> expireIfGreaterAsync(Duration duration)
      Description copied from interface: RExpirableAsync
      Sets a timeout for this object only if it's greater than timeout set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfGreaterAsync in interface RExpirableAsync
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not
    • expireIfLess

      public boolean expireIfLess(Duration duration)
      Description copied from interface: RExpirable
      Sets a timeout for this object only if it's less than timeout set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfLess in interface RExpirable
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not
    • expireIfLessAsync

      public RFuture<Boolean> expireIfLessAsync(Duration duration)
      Description copied from interface: RExpirableAsync
      Sets a timeout for this object only if it's less than timeout set before. After the timeout has expired, the key will automatically be deleted.

      Requires Redis 7.0.0 and higher.

      Specified by:
      expireIfLessAsync in interface RExpirableAsync
      Parameters:
      duration - timeout before object will be deleted
      Returns:
      true if the timeout was set and false if not
    • clearExpire

      public boolean clearExpire()
      Description copied from interface: RExpirable
      Clear an expire timeout or expire date for object.
      Specified by:
      clearExpire in interface RExpirable
      Returns:
      true if timeout was removed false if object does not exist or does not have an associated timeout
    • remainTimeToLive

      public long remainTimeToLive()
      Description copied from interface: RExpirable
      Returns remaining time of the object in milliseconds.
      Specified by:
      remainTimeToLive in interface RExpirable
      Returns:
      time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.
    • remainTimeToLiveAsync

      public RFuture<Long> remainTimeToLiveAsync()
      Description copied from interface: RExpirableAsync
      Returns remaining time of the object in milliseconds.
      Specified by:
      remainTimeToLiveAsync in interface RExpirableAsync
      Returns:
      time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.
    • getExpireTime

      public long getExpireTime()
      Description copied from interface: RExpirable
      Returns expiration time of the object as the absolute Unix expiration timestamp in milliseconds.

      Requires Redis 7.0.0 and higher.

      Specified by:
      getExpireTime in interface RExpirable
      Returns:
      Unix time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expiration time.
    • getExpireTimeAsync

      public RFuture<Long> getExpireTimeAsync()
      Description copied from interface: RExpirableAsync
      Returns expiration time of the object as the absolute Unix expiration timestamp in milliseconds.

      Requires Redis 7.0.0 and higher.

      Specified by:
      getExpireTimeAsync in interface RExpirableAsync
      Returns:
      Unix time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expiration time.
    • clearExpireAsync

      protected RFuture<Boolean> clearExpireAsync(String... keys)