Package org.redisson

Class RedissonTransferQueue<V>

    • Method Detail

      • addAsync

        public RFuture<Boolean> addAsync​(V v)
        Description copied from interface: RCollectionAsync
        Adds element into this collection.
        Specified by:
        addAsync in interface RCollectionAsync<V>
        Parameters:
        v - - element to add
        Returns:
        true if an element was added and false if it is already present
      • remove

        public V remove()
        Specified by:
        remove in interface Queue<V>
      • poll

        public V poll()
        Specified by:
        poll in interface Queue<V>
      • pollAsync

        public RFuture<V> pollAsync()
        Description copied from interface: RQueueAsync
        Retrieves and removes the head of this queue in async mode.
        Specified by:
        pollAsync in interface RQueueAsync<V>
        Returns:
        the head of this queue, or null
      • element

        public V element()
        Specified by:
        element in interface Queue<V>
      • peek

        public V peek()
        Specified by:
        peek in interface Queue<V>
      • peekAsync

        public RFuture<V> peekAsync()
        Description copied from interface: RQueueAsync
        Retrieves the head of this queue in async mode.
        Specified by:
        peekAsync in interface RQueueAsync<V>
        Returns:
        the head of this queue, or null
      • 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
      • 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
      • getValueAsync

        public RFuture<V> getValueAsync​(int index)
      • toArray

        public <T> T[] toArray​(T[] a)
        Specified by:
        toArray in interface Collection<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
      • 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
      • 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
      • 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
      • 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
      • 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
      • pollLastAndOfferFirstTo

        public V pollLastAndOfferFirstTo​(String queueName)
        Description copied from interface: RQueue
        Retrieves and removes last available tail element of this queue queue and adds it at the head of queueName.
        Specified by:
        pollLastAndOfferFirstTo in interface RQueue<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
      • 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>
        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
      • 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
      • 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
      • putAsync

        public RFuture<Void> putAsync​(V value)
        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:
        value - the element to add
        Returns:
        void
      • 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>
        Parameters:
        e - the element to add
        Returns:
        true if successful, or false
      • pollLastAndOfferFirstToAsync

        public RFuture<V> pollLastAndOfferFirstToAsync​(String queueName)
        Description copied from interface: RQueueAsync
        Retrieves and removes last available tail element of this queue queue and adds it at the head of queueName.
        Specified by:
        pollLastAndOfferFirstToAsync in interface RQueueAsync<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
      • 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>
        Returns:
        list of head elements
      • retainAllAsync

        public RFuture<Boolean> retainAllAsync​(Collection<?> c)
        Description copied from interface: RCollectionAsync
        Retains only the elements in this collection that are contained in the specified collection.
        Specified by:
        retainAllAsync in interface RCollectionAsync<V>
        Parameters:
        c - collection containing elements to be retained in this collection
        Returns:
        true if this collection changed as a result of the call
      • removeAllAsync

        public RFuture<Boolean> removeAllAsync​(Collection<?> c)
        Description copied from interface: RCollectionAsync
        Removes all of this collection's elements that are also contained in the specified collection.
        Specified by:
        removeAllAsync in interface RCollectionAsync<V>
        Parameters:
        c - collection containing elements to be removed from this collection
        Returns:
        true if this collection changed as a result of the call
      • containsAsync

        public RFuture<Boolean> containsAsync​(Object o)
        Description copied from interface: RCollectionAsync
        Returns true if this collection contains encoded state of the specified element.
        Specified by:
        containsAsync in interface RCollectionAsync<V>
        Parameters:
        o - element whose presence in this collection is to be tested
        Returns:
        true if this collection contains the specified element and false otherwise
      • containsAllAsync

        public RFuture<Boolean> containsAllAsync​(Collection<?> c)
        Description copied from interface: RCollectionAsync
        Returns true if this collection contains all of the elements in the specified collection.
        Specified by:
        containsAllAsync in interface RCollectionAsync<V>
        Parameters:
        c - collection to be checked for containment in this collection
        Returns:
        true if this collection contains all of the elements in the specified collection
      • removeAsync

        public RFuture<Boolean> removeAsync​(Object o)
        Description copied from interface: RCollectionAsync
        Removes a single instance of the specified element from this collection, if it is present.
        Specified by:
        removeAsync in interface RCollectionAsync<V>
        Parameters:
        o - element to be removed from this collection, if present
        Returns:
        true if an element was removed as a result of this call
      • addAllAsync

        public RFuture<Boolean> addAllAsync​(Collection<? extends V> c)
        Description copied from interface: RCollectionAsync
        Adds all elements contained in the specified collection
        Specified by:
        addAllAsync in interface RCollectionAsync<V>
        Parameters:
        c - - collection of elements to add
        Returns:
        true if at least one element was added and false if all elements are already present
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • clearExpireAsync

        public RFuture<Boolean> clearExpireAsync()
        Description copied from interface: RExpirableAsync
        Clear an expire timeout or expire date for object in async mode. Object will not be deleted.
        Specified by:
        clearExpireAsync in interface RExpirableAsync
        Returns:
        true if the timeout was cleared and false if not
      • remainTimeToLive

        public long remainTimeToLive()
        Description copied from interface: RExpirable
        Remaining time to live of Redisson object that has a timeout
        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
        Remaining time to live of Redisson object that has a timeout
        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
        Expiration time of Redisson object that has a timeout

        Requires Redis 7.0.0 and higher.

        Specified by:
        getExpireTime in interface RExpirable
        Returns:
        expiration time