org.redisson.RedissonBoundedBlockingQueue<V>

All Implemented Interfaces:: Iterable<V>, Collection<V>, BlockingQueue<V>, List<V>, Queue<V>, RandomAccess, SequencedCollection<V>, RBlockingQueue<V>, RBlockingQueueAsync<V>, RBoundedBlockingQueue<V>, RBoundedBlockingQueueAsync<V>, RCollectionAsync<V>, RExpirable, RExpirableAsync, RList<V>, RListAsync<V>, RObject, RObjectAsync, RQueue<V>, RQueueAsync<V>, RSortable<List<V>>, RSortableAsync<List<V>>

public class RedissonBoundedBlockingQueue<V> extends RedissonQueue<V> implements RBoundedBlockingQueue<V>

Distributed and concurrent implementation of bounded BlockingQueue.

Author:: Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject
codec, commandExecutor, name
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

RedissonBoundedBlockingQueue(Codec codec, CommandAsyncExecutor commandExecutor, String name, RedissonClient redisson)

protected

RedissonBoundedBlockingQueue(CommandAsyncExecutor commandExecutor, String name, RedissonClient redisson)
Method Summary

Modifier and Type

Method

Description

RFuture<Boolean>

addAllAsync(Collection<? extends V> c)

Adds all elements contained in the specified collection

RFuture<Boolean>

addAsync(V e)

Adds element into this collection.

void

clear()

boolean

clearExpire()

Clear an expire timeout or expire date for object.

RFuture<Boolean>

clearExpireAsync()

Clear an expire timeout or expire date for object in async mode.

protected RFuture<Boolean>

clearExpireAsync(String... keys)

RFuture<Boolean>

deleteAsync()

Delete object in async mode

int

drainTo(Collection<? super V> c)

int

drainTo(Collection<? super V> c, int maxElements)

RFuture<Integer>

drainToAsync(Collection<? super V> c)

Removes all available elements from this queue and adds them to the given collection in async mode.

RFuture<Integer>

drainToAsync(Collection<? super V> c, int maxElements)

Removes at most the given number of available elements from this queue and adds them to the given collection in async mode.

boolean

expire(long timeToLive, TimeUnit timeUnit)

Use RExpirable.expire(Duration) instead

boolean

expire(Duration duration)

Sets a timeout for this object.

boolean

expire(Instant instant)

Sets an expiration date for this object.

RFuture<Boolean>

expireAsync(long timeToLive, TimeUnit timeUnit)

Use RExpirableAsync.expireAsync(Duration) instead

RFuture<Boolean>

expireAsync(long timeToLive, TimeUnit timeUnit, String param, String... keys)

RFuture<Boolean>

expireAsync(Duration duration)

Set a timeout for object.

RFuture<Boolean>

expireAsync(Instant instant)

Set an expire date for object.

boolean

expireAt(long timestamp)

Use RExpirable.expire(Instant) instead

boolean

expireAt(Date timestamp)

Use RExpirable.expire(Instant) instead

RFuture<Boolean>

expireAtAsync(long timestamp)

Use RExpirableAsync.expireAsync(Instant) instead

protected RFuture<Boolean>

expireAtAsync(long timestamp, String param, String... keys)

RFuture<Boolean>

expireAtAsync(Date timestamp)

Use RExpirableAsync.expireAsync(Instant) instead

boolean

expireIfGreater(Duration duration)

Sets a timeout for this object only if it's greater than timeout set before.

boolean

expireIfGreater(Instant time)

Sets an expiration date for this object only if it's greater than expiration date set before.

RFuture<Boolean>

expireIfGreaterAsync(Duration duration)

Sets a timeout for this object only if it's greater than timeout set before.

RFuture<Boolean>

expireIfGreaterAsync(Instant time)

Sets an expiration date for this object only if it's greater than expiration date set before.

boolean

expireIfLess(Duration duration)

Sets a timeout for this object only if it's less than timeout set before.

boolean

expireIfLess(Instant time)

Sets an expiration date for this object only if it's less than expiration date set before.

RFuture<Boolean>

expireIfLessAsync(Duration duration)

Sets a timeout for this object only if it's less than timeout set before.

RFuture<Boolean>

expireIfLessAsync(Instant time)

Sets an expiration date for this object only if it's less than expiration date set before.

boolean

expireIfNotSet(Duration duration)

Sets a timeout for this object only if it hasn't been set before.

boolean

expireIfNotSet(Instant time)

Sets an expiration date for this object only if it hasn't been set before.

RFuture<Boolean>

expireIfNotSetAsync(Duration duration)

Sets a timeout for this object only if it hasn't been set before.

RFuture<Boolean>

expireIfNotSetAsync(Instant time)

Sets an expiration date for this object only if it hasn't been set before.

boolean

expireIfSet(Duration duration)

Sets a timeout for this object only if it has been already set.

boolean

expireIfSet(Instant time)

Sets an expiration date for this object only if it has been already set.

RFuture<Boolean>

expireIfSetAsync(Duration duration)

Sets a timeout for this object only if it has been already set.

RFuture<Boolean>

expireIfSetAsync(Instant time)

Sets an expiration date for this object only if it has been already set.

long

getExpireTime()

Expiration time of Redisson object that has a timeout

RFuture<Long>

getExpireTimeAsync()

Expiration time of Redisson object that has a timeout

boolean

offer(V e, long timeout, TimeUnit unit)

RFuture<Boolean>

offerAsync(V e)

Inserts the specified element into this queue.

RFuture<Boolean>

offerAsync(V e, long timeout, TimeUnit unit)

Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available.

V

poll(long timeout, TimeUnit unit)

RFuture<V>

pollAsync()

Retrieves and removes the head of this queue in async mode.

RFuture<V>

pollAsync(long timeout, TimeUnit unit)

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.

Map<String,List<V>>

pollFirstFromAny(Duration duration, int count, String... queueNames)

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.

RFuture<Map<String,List<V>>>

pollFirstFromAnyAsync(Duration duration, int count, String... queueNames)

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.

V

pollFromAny(long timeout, TimeUnit unit, String... queueNames)

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.

RFuture<V>

pollFromAnyAsync(long timeout, TimeUnit unit, String... queueNames)

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.

Entry<String,V>

pollFromAnyWithName(Duration timeout, String... queueNames)

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.

RFuture<Entry<String,V>>

pollFromAnyWithNameAsync(Duration timeout, String... queueNames)

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.

V

pollLastAndOfferFirstTo(String queueName, long timeout, TimeUnit unit)

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.

RFuture<V>

pollLastAndOfferFirstToAsync(String queueName, long timeout, TimeUnit unit)

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.

Map<String,List<V>>

pollLastFromAny(Duration duration, int count, String... queueNames)

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.

RFuture<Map<String,List<V>>>

pollLastFromAnyAsync(Duration duration, int count, String... queueNames)

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.

void

put(V e)

RFuture<Void>

putAsync(V e)

Inserts the specified element into this queue in async mode, waiting if necessary for space to become available.

int

remainingCapacity()

long

remainTimeToLive()

Remaining time to live of Redisson object that has a timeout

RFuture<Long>

remainTimeToLiveAsync()

Remaining time to live of Redisson object that has a timeout

RFuture<Boolean>

removeAllAsync(Collection<?> c)

Removes all of this collection's elements that are also contained in the specified collection.

RFuture<Boolean>

removeAsync(Object o)

Removes a single instance of the specified element from this collection, if it is present.

RFuture<Long>

sizeInMemoryAsync()

Returns bytes amount used by object in Redis memory.

int

subscribeOnElements(Consumer<V> consumer)

Subscribes on elements appeared in this queue.

V

take()

RFuture<V>

takeAsync()

Retrieves and removes the head of this queue in async mode, waiting if necessary until an element becomes available.

V

takeLastAndOfferFirstTo(String queueName)

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.

RFuture<V>

takeLastAndOfferFirstToAsync(String queueName)

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.

boolean

trySetCapacity(int capacity)

Sets queue capacity only if it is not set before.

RFuture<Boolean>

trySetCapacityAsync(int capacity)

Sets queue capacity only if it is not set before.

void

unsubscribe(int listenerId)

Un-subscribes defined listener.

Methods inherited from class org.redisson.RedissonQueue
element, getFirst, offer, peek, peekAsync, poll, poll, pollAsync, pollLastAndOfferFirstTo, pollLastAndOfferFirstToAsync, remove, removeFirst

Methods inherited from class org.redisson.RedissonList
add, add, addAfter, addAfterAsync, addAll, addAll, addAllAsync, addAsync, addAsync, addBefore, addBeforeAsync, addListener, addListenerAsync, contains, containsAll, containsAllAsync, containsAsync, distributedIterator, distributedIterator, equals, fastRemove, fastRemoveAsync, fastSet, fastSetAsync, get, get, getAsync, getAsync, hashCode, indexOf, indexOfAsync, indexOfAsync, isEmpty, iterator, lastIndexOf, lastIndexOfAsync, lastIndexOfAsync, listIterator, listIterator, mapReduce, range, range, rangeAsync, rangeAsync, readAll, readAllAsync, readSort, readSort, readSort, readSort, readSort, readSort, readSortAlpha, readSortAlpha, readSortAlpha, readSortAlpha, readSortAlpha, readSortAlpha, readSortAlphaAsync, readSortAlphaAsync, readSortAlphaAsync, readSortAlphaAsync, readSortAlphaAsync, readSortAlphaAsync, readSortAsync, readSortAsync, readSortAsync, readSortAsync, readSortAsync, readSortAsync, remove, remove, remove, removeAll, removeAsync, removeAsync, removeIf, removeListener, removeListenerAsync, retainAll, retainAllAsync, set, setAsync, size, sizeAsync, sortTo, sortTo, sortTo, sortTo, sortTo, sortTo, sortToAsync, sortToAsync, sortToAsync, sortToAsync, sortToAsync, sortToAsync, subList, toArray, toArray, toString, trim, trimAsync

Methods inherited from class org.redisson.RedissonObject
addListener, addListenerAsync, copy, copyAsync, delete, deleteAsync, dump, dumpAsync, encode, encode, encode, encode, encodeMapKey, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getIdleTime, getIdleTimeAsync, getLockByMapKey, getLockByValue, getName, getRawName, getRawName, getServiceManager, getSubscribeService, isExists, isExistsAsync, map, migrate, migrateAsync, move, moveAsync, prefixName, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, setName, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, toStream, touch, touchAsync, unlink, unlinkAsync

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.concurrent.BlockingQueue
add, contains, offer, remove

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.util.List
addFirst, addLast, getLast, removeLast, replaceAll, reversed, sort, spliterator

Methods inherited from interface java.util.Queue
element, peek, poll, remove

Methods inherited from interface org.redisson.api.RCollectionAsync
containsAllAsync, containsAsync, retainAllAsync, sizeAsync

Methods inherited from interface org.redisson.api.RExpirable
clearExpire, expire, expire, expire, expireAt, expireAt, expireIfGreater, expireIfGreater, expireIfLess, expireIfLess, expireIfNotSet, expireIfNotSet, expireIfSet, expireIfSet, getExpireTime, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync
expireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, expireIfGreaterAsync, expireIfGreaterAsync, expireIfLessAsync, expireIfLessAsync, expireIfNotSetAsync, expireIfNotSetAsync, expireIfSetAsync, expireIfSetAsync, getExpireTimeAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObject
copy, delete, dump, getCodec, getIdleTime, getName, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink

Methods inherited from interface org.redisson.api.RObjectAsync
copyAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, touchAsync, unlinkAsync

Methods inherited from interface org.redisson.api.RQueue
addListener, poll, pollLastAndOfferFirstTo, readAll

Methods inherited from interface org.redisson.api.RQueueAsync
addListenerAsync, peekAsync, pollAsync, pollLastAndOfferFirstToAsync, readAllAsync

Constructor Details
- RedissonBoundedBlockingQueue
  
  protected RedissonBoundedBlockingQueue(CommandAsyncExecutor commandExecutor, String name, RedissonClient redisson)
- RedissonBoundedBlockingQueue
  
  protected RedissonBoundedBlockingQueue(Codec codec, CommandAsyncExecutor commandExecutor, String name, RedissonClient redisson)
Method Details
- addAsync
  
  public RFuture<Boolean> addAsync(V e)
  
  Description copied from interface: RCollectionAsync
  
  Adds element into this collection.
  
  Specified by:
  
  addAsync in interface RCollectionAsync<V>
  
  Overrides:
  
  addAsync in class RedissonList<V>
  
  Parameters:
  
  e - - element to add
  
  Returns:
  
  true if an element was added and false if it is already present
- 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
- put
  
  public void put(V e) throws InterruptedException
  
  Specified by:
  
  put in interface BlockingQueue<V>
  
  Throws:
  
  InterruptedException
- 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 RedissonQueue<V>
  
  Parameters:
  
  e - the element to add
  
  Returns:
  
  true if successful, or false
- offer
  
  public boolean offer(V e, long timeout, TimeUnit unit) throws InterruptedException
  
  Specified by:
  
  offer in interface BlockingQueue<V>
  
  Throws:
  
  InterruptedException
- 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()
  
  Description copied from interface: RQueueAsync
  
  Retrieves and removes the head of this queue in async mode.
  
  Specified by:
  
  pollAsync in interface RQueueAsync<V>
  
  Overrides:
  
  pollAsync in class RedissonQueue<V>
  
  Returns:
  
  the head of this queue, or null
- take
  
  public V take() throws InterruptedException
  
  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 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
- 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
- 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)
  
  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
- pollLastFromAny
  
  public Map<String,List<V>> pollLastFromAny(Duration duration, int count, String... queueNames)
  
  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
- 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
- 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
  
  Subscribes on elements appeared in this queue. Continuously invokes RBlockingQueueAsync.takeAsync() method to get a new element.
  
  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
- 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
- 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
- trySetCapacityAsync
  
  public RFuture<Boolean> trySetCapacityAsync(int capacity)
  
  Description copied from interface: RBoundedBlockingQueueAsync
  
  Sets queue capacity only if it is not set before.
  
  Specified by:
  
  trySetCapacityAsync in interface RBoundedBlockingQueueAsync<V>
  
  Parameters:
  
  capacity - - queue capacity
  
  Returns:
  
  true if capacity set successfully false if capacity already set
- 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
- clear
  
  public void clear()
  
  Specified by:
  
  clear in interface Collection<V>
  
  Specified by:
  
  clear in interface List<V>
  
  Overrides:
  
  clear in class RedissonList<V>
- deleteAsync
  
  public RFuture<Boolean> deleteAsync()
  
  Description copied from interface: RObjectAsync
  
  Delete object in async mode
  
  Specified by:
  
  deleteAsync in interface RObjectAsync
  
  Overrides:
  
  deleteAsync in class RedissonObject
  
  Returns:
  
  true if object was deleted false if not
- sizeInMemoryAsync
  
  public RFuture<Long> sizeInMemoryAsync()
  
  Description copied from interface: RObjectAsync
  
  Returns bytes amount used by object in Redis memory.
  
  Specified by:
  
  sizeInMemoryAsync in interface RObjectAsync
  
  Overrides:
  
  sizeInMemoryAsync in class RedissonObject
  
  Returns:
  
  size in bytes
- expireAsync
  
  public RFuture<Boolean> expireAsync(long timeToLive, TimeUnit timeUnit, String param, String... keys)
- expireAtAsync
  
  protected RFuture<Boolean> expireAtAsync(long timestamp, String param, String... keys)
- 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
- 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>
  
  Overrides:
  
  addAllAsync in class RedissonList<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
  
  Use RExpirable.expire(Duration) instead
  
  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
  
  Use RExpirableAsync.expireAsync(Duration) instead
  
  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
  
  Use RExpirable.expire(Instant) instead
  
  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
  
  Use RExpirableAsync.expireAsync(Instant) instead
  
  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
  
  Use RExpirable.expire(Instant) instead
  
  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
  
  Use RExpirableAsync.expireAsync(Instant) instead
  
  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
  
  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
- getExpireTimeAsync
  
  public RFuture<Long> getExpireTimeAsync()
  
  Description copied from interface: RExpirableAsync
  
  Expiration time of Redisson object that has a timeout
  Requires Redis 7.0.0 and higher.
  
  Specified by:
  
  getExpireTimeAsync in interface RExpirableAsync
  
  Returns:
  
  expiration time
- clearExpireAsync
  
  protected RFuture<Boolean> clearExpireAsync(String... keys)

Class RedissonBoundedBlockingQueue<V>

Field Summary

Fields inherited from class org.redisson.RedissonObject

Constructor Summary

Method Summary

Methods inherited from class org.redisson.RedissonQueue

Methods inherited from class org.redisson.RedissonList

Methods inherited from class org.redisson.RedissonObject

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.concurrent.BlockingQueue

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Queue

Methods inherited from interface org.redisson.api.RCollectionAsync

Methods inherited from interface org.redisson.api.RExpirable

Methods inherited from interface org.redisson.api.RExpirableAsync

Methods inherited from interface org.redisson.api.RObject

Methods inherited from interface org.redisson.api.RObjectAsync

Methods inherited from interface org.redisson.api.RQueue

Methods inherited from interface org.redisson.api.RQueueAsync

Constructor Details

RedissonBoundedBlockingQueue

RedissonBoundedBlockingQueue

Method Details

addAsync

putAsync

put

offerAsync

offer

offerAsync

takeAsync

removeAsync

removeAllAsync

pollAsync

take

pollAsync

poll

pollFromAny

pollFromAnyAsync

pollFromAnyWithName

pollFromAnyWithNameAsync

pollFirstFromAny

pollLastFromAny

pollFirstFromAnyAsync

pollLastFromAnyAsync

takeLastAndOfferFirstTo

subscribeOnElements

unsubscribe

takeLastAndOfferFirstToAsync

pollLastAndOfferFirstToAsync

pollLastAndOfferFirstTo

remainingCapacity

drainTo

drainToAsync

drainTo

drainToAsync

trySetCapacityAsync

trySetCapacity

clear

deleteAsync

sizeInMemoryAsync

expireAsync

expireAtAsync

clearExpireAsync

addAllAsync

expire

expireAsync

expireAt

expireAtAsync

expire

expireIfSet

expireIfSetAsync

expireIfNotSet

expireIfNotSetAsync

expireIfGreater

expireIfGreaterAsync

expireIfLess

expireIfLessAsync

expireAsync