Package org.redisson

Class RedissonBoundedBlockingQueue<V>

    • Method Detail

      • 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
      • offerAsync

        public RFuture<Boolean> offerAsync​(V e,
                                           long timeout,
                                           TimeUnit unit)
        Description copied from interface: RBoundedBlockingQueueAsync
        Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available.
        Specified by:
        offerAsync in interface RBoundedBlockingQueueAsync<V>
        Parameters:
        e - the element to add
        timeout - how long to wait before giving up, in units of unit
        unit - a TimeUnit determining how to interpret the timeout parameter
        Returns:
        true if successful, or false if the specified waiting time elapses before space is available
      • 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
      • 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>
        Overrides:
        removeAsync in class RedissonList<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
      • 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>
        Overrides:
        removeAllAsync in class RedissonList<V>
        Parameters:
        c - collection containing elements to be removed from this collection
        Returns:
        true if this collection changed as a result of the call
      • 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
      • 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
      • 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
      • 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
      • 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
      • pollLastAndOfferFirstToAsync

        public RFuture<V> pollLastAndOfferFirstToAsync​(String queueName,
                                                       long timeout,
                                                       TimeUnit unit)
        Description copied from interface: RBlockingQueueAsync
        Retrieves and removes last available tail element of any queue and adds it at the head of queueName, 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:
        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 any queue and adds it at the head of queueName, 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:
        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
      • 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
      • trySetCapacity

        public boolean trySetCapacity​(int capacity)
        Description copied from interface: RBoundedBlockingQueue
        Sets queue capacity only if it is not set before.
        Specified by:
        trySetCapacity in interface RBoundedBlockingQueue<V>
        Parameters:
        capacity - - queue capacity
        Returns:
        true if capacity set successfully false if capacity already set
      • expireAsync

        public RFuture<Boolean> expireAsync​(long timeToLive,
                                            TimeUnit timeUnit)
        Description copied from interface: RExpirableAsync
        Set a timeout for object in async mode. After the timeout has expired, the key will automatically be deleted.
        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
      • expireAtAsync

        public RFuture<Boolean> expireAtAsync​(long timestamp)
        Description copied from interface: RExpirableAsync
        Set an expire date for object in async mode. When expire date comes the key will automatically be deleted.
        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
      • 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
      • expire

        public boolean expire​(long timeToLive,
                              TimeUnit timeUnit)
        Description copied from interface: RExpirable
        Set a timeout for object. After the timeout has expired, the key will automatically be deleted.
        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
        Set an expire date for object. When expire date comes the key will automatically be deleted.
        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
      • expireAt

        public boolean expireAt​(Date timestamp)
        Description copied from interface: RExpirable
        Set an expire date for object. When expire date comes the key will automatically be deleted.
        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
        Set an expire date for object in async mode. When expire date comes the key will automatically be deleted.
        Specified by:
        expireAtAsync in interface RExpirableAsync
        Parameters:
        timestamp - - expire date
        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
        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.