Package org.redisson

Class RedissonBlockingDeque<V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonList<V>

org.redisson.RedissonQueue<V>

org.redisson.RedissonDeque<V>

org.redisson.RedissonBlockingDeque<V>

All Implemented Interfaces:

Iterable<V>, Collection<V>, BlockingDeque<V>, BlockingQueue<V>, Deque<V>, List<V>, Queue<V>, RandomAccess, RBlockingDeque<V>, RBlockingDequeAsync<V>, RBlockingQueue<V>, RBlockingQueueAsync<V>, RCollectionAsync<V>, RDeque<V>, RDequeAsync<V>, RExpirable, RExpirableAsync, RList<V>, RListAsync<V>, RObject, RObjectAsync, RQueue<V>, RQueueAsync<V>, RSortable<List<V>>, RSortableAsync<List<V>>

public class RedissonBlockingDeque<V>
extends RedissonDeque<V>
implements RBlockingDeque<V>

Distributed and concurrent implementation of BlockingDeque.

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

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor, name

Constructor Summary

Constructors

Constructor	Description
RedissonBlockingDeque(Codec codec, CommandAsyncExecutor commandExecutor, String name, RedissonClient redisson)
RedissonBlockingDeque(CommandAsyncExecutor commandExecutor, String name, RedissonClient redisson)

Method Summary

Modifier and Type	Method	Description
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)
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)	Set a timeout for object.
boolean	expire(Instant instant)	Set an expire date for object.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit)	Set a timeout for object in async mode.
protected RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit, String... keys)
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... keys)
RFuture<Boolean>	expireAtAsync(Date timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
V	move(Duration timeout, DequeMoveArgs args)
RFuture<V>	moveAsync(Duration timeout, DequeMoveArgs args)
boolean	offer(V e, long timeout, TimeUnit unit)
boolean	offerFirst(V e, long timeout, TimeUnit unit)
boolean	offerLast(V e, long timeout, TimeUnit unit)
V	poll(long timeout, TimeUnit unit)
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.
V	pollFirst(long timeout, TimeUnit unit)
RFuture<V>	pollFirstAsync(long timeout, TimeUnit unit)	Retrieves and removes value at the head of queue.
V	pollFirstFromAny(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 own.
RFuture<V>	pollFirstFromAnyAsync(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 own.
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.
V	pollLast(long timeout, TimeUnit unit)
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.
RFuture<V>	pollLastAsync(long timeout, TimeUnit unit)	Retrieves and removes value at the tail of queue.
V	pollLastFromAny(long timeout, TimeUnit unit, String... queueNames)	Retrieves and removes first available tail element of any queue, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue own.
RFuture<V>	pollLastFromAnyAsync(long timeout, TimeUnit unit, String... queueNames)	Retrieves and removes first available tail element of any queue in async mode, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue own.
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.
void	putFirst(V e)
RFuture<Void>	putFirstAsync(V e)	Adds value to the head of queue.
void	putLast(V e)
RFuture<Void>	putLastAsync(V e)	Adds value to the tail of queue.
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
int	subscribeOnElements(Consumer<V> consumer)	Subscribes on elements appeared in this queue.
int	subscribeOnFirstElements(Consumer<V> consumer)	Subscribes on first elements appeared in this queue.
int	subscribeOnLastElements(Consumer<V> consumer)	Subscribes on last 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	takeFirst()
RFuture<V>	takeFirstAsync()	Retrieves and removes value at the head of queue.
V	takeLast()
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.
RFuture<V>	takeLastAsync()	Retrieves and removes value at the tail of queue.
void	unsubscribe(int id)	Un-subscribes defined listener.

Methods inherited from class org.redisson.RedissonDeque

addFirst, addFirstAsync, addFirstIfExists, addFirstIfExistsAsync, addLast, addLastAsync, addLastIfExists, addLastIfExistsAsync, descendingIterator, getLast, getLastAsync, move, moveAsync, offerFirst, offerFirstAsync, offerLast, offerLastAsync, peekFirst, peekFirstAsync, peekLast, peekLastAsync, pollFirst, pollFirst, pollFirstAsync, pollFirstAsync, pollLast, pollLast, pollLastAsync, pollLastAsync, pop, popAsync, push, pushAsync, removeFirstAsync, removeFirstOccurrence, removeFirstOccurrenceAsync, removeLast, removeLastAsync, removeLastOccurrence, removeLastOccurrenceAsync

Methods inherited from class org.redisson.RedissonQueue

element, getFirst, offer, offerAsync, peek, peekAsync, poll, poll, pollAsync, pollAsync, pollLastAndOfferFirstTo, pollLastAndOfferFirstToAsync, remove, removeFirst

Methods inherited from class org.redisson.RedissonList

add, add, addAfter, addAfterAsync, addAll, addAll, addAllAsync, addAllAsync, addAsync, addAsync, addAsync, addBefore, addBeforeAsync, addListener, addListenerAsync, clear, contains, containsAll, containsAllAsync, containsAsync, 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, removeAllAsync, removeAsync, 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, deleteAsync, dump, dumpAsync, encode, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getIdleTime, getIdleTimeAsync, getLockByMapKey, getLockByValue, getName, getRawName, getRawName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, removeListenersAsync, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, setName, sizeInMemory, sizeInMemoryAsync, 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.BlockingDeque

add, addFirst, addLast, contains, element, iterator, offer, offerFirst, offerLast, peek, poll, push, remove, remove, removeFirstOccurrence, removeLastOccurrence, size

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.util.Deque

add, addAll, contains, descendingIterator, getFirst, getLast, offer, peekFirst, peekLast, pollFirst, pollLast, pop, remove, removeFirst, removeLast

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Methods inherited from interface org.redisson.api.RCollectionAsync

addAllAsync, addAsync, containsAllAsync, containsAsync, removeAllAsync, removeAsync, retainAllAsync, sizeAsync

Methods inherited from interface org.redisson.api.RDeque

addFirstIfExists, addLastIfExists, move, pollFirst, pollLast

Methods inherited from interface org.redisson.api.RDequeAsync

addFirstAsync, addFirstIfExistsAsync, addLastAsync, addLastIfExistsAsync, getLastAsync, moveAsync, offerFirstAsync, offerLastAsync, peekFirstAsync, peekLastAsync, pollFirstAsync, pollFirstAsync, pollLastAsync, pollLastAsync, popAsync, pushAsync, removeFirstAsync, removeFirstOccurrenceAsync, removeLastAsync, removeLastOccurrenceAsync

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, 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, deleteAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync

Methods inherited from interface org.redisson.api.RQueue

addListener, poll, pollLastAndOfferFirstTo, readAll

Methods inherited from interface org.redisson.api.RQueueAsync

addListenerAsync, offerAsync, peekAsync, pollAsync, pollAsync, pollLastAndOfferFirstToAsync, readAllAsync

Constructor Detail

RedissonBlockingDeque

public RedissonBlockingDeque(CommandAsyncExecutor commandExecutor,
                             String name,
                             RedissonClient redisson)

RedissonBlockingDeque

public RedissonBlockingDeque(Codec codec,
                             CommandAsyncExecutor commandExecutor,
                             String name,
                             RedissonClient redisson)

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

put

public void put(V e)
         throws InterruptedException

Specified by:

put in interface BlockingDeque<V>

Specified by:

put in interface BlockingQueue<V>

Throws:

InterruptedException

offer

public boolean offer(V e,
                     long timeout,
                     TimeUnit unit)
              throws InterruptedException

Specified by:

offer in interface BlockingDeque<V>

Specified by:

offer in interface BlockingQueue<V>

Throws:

InterruptedException

takeAsync

public RFuture<V> takeAsync()

Description copied from interface: RBlockingQueueAsync

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

Specified by:

takeAsync in interface RBlockingQueueAsync<V>

Returns:

the head of this queue

take

public V take()
       throws InterruptedException

Specified by:

take in interface BlockingDeque<V>

Specified by:

take in interface BlockingQueue<V>

Throws:

InterruptedException

pollAsync

public RFuture<V> pollAsync(long timeout,
                            TimeUnit unit)

Description copied from interface: RBlockingQueueAsync

Retrieves and removes the head of this queue in async mode, waiting up to the specified wait time if necessary for an element to become available.

Specified by:

pollAsync in interface RBlockingQueueAsync<V>

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

the head of this queue, or null if the specified waiting time elapses before an element is available

poll

public V poll(long timeout,
              TimeUnit unit)
       throws InterruptedException

Specified by:

poll in interface BlockingDeque<V>

Specified by:

poll in interface BlockingQueue<V>

Throws:

InterruptedException

pollFromAny

public V pollFromAny(long timeout,
                     TimeUnit unit,
                     String... queueNames)
              throws InterruptedException

Description copied from interface: RBlockingQueue

Retrieves and removes first available head element of any queue, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue itself.

Specified by:

pollFromAny in interface RBlockingQueue<V>

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

queueNames - - queue names. Queue name itself is always included

Returns:

the head of this queue, or null if the specified waiting time elapses before an element is available

Throws:

InterruptedException - if interrupted while waiting

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

pollLastAndOfferFirstTo

public V pollLastAndOfferFirstTo(String queueName,
                                 long timeout,
                                 TimeUnit unit)
                          throws InterruptedException

Description copied from interface: RBlockingQueue

Retrieves and removes last available tail element of this queue and adds it at the head of queueName, waiting up to the specified wait time if necessary for an element to become available.

Specified by:

pollLastAndOfferFirstTo in interface RBlockingQueue<V>

Parameters:

queueName - - names of destination queue

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

the tail of this queue, or null if the specified waiting time elapses before an element is available

Throws:

InterruptedException - if interrupted while waiting

takeLastAndOfferFirstTo

public V takeLastAndOfferFirstTo(String queueName)
                          throws InterruptedException

Description copied from interface: RBlockingQueue

Retrieves and removes last available tail element of any queue and adds it at the head of queueName, waiting if necessary for an element to become available in any of defined queues including queue itself.

Specified by:

takeLastAndOfferFirstTo in interface RBlockingQueue<V>

Parameters:

queueName - - names of destination queue

Returns:

the tail of this queue, or null if the specified waiting time elapses before an element is available

Throws:

InterruptedException - if interrupted while waiting

subscribeOnElements

public int subscribeOnElements(Consumer<V> consumer)

Description copied from interface: RBlockingQueue

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 id)

Description copied from interface: RBlockingQueue

Un-subscribes defined listener.

Specified by:

unsubscribe in interface RBlockingQueue<V>

Parameters:

id - - id of listener

takeLastAndOfferFirstToAsync

public RFuture<V> takeLastAndOfferFirstToAsync(String queueName)

Description copied from interface: RBlockingQueueAsync

Retrieves and removes last available tail element of any queue and adds it at the head of queueName, waiting if necessary for an element to become available in any of defined queues including queue itself.

Specified by:

takeLastAndOfferFirstToAsync in interface RBlockingQueueAsync<V>

Parameters:

queueName - - names of destination queue

Returns:

the tail of this queue, or null if the specified waiting time elapses before an element is available

remainingCapacity

public int remainingCapacity()

Specified by:

remainingCapacity in interface BlockingQueue<V>

drainTo

public int drainTo(Collection<? super V> c)

Specified by:

drainTo in interface BlockingQueue<V>

drainToAsync

public RFuture<Integer> drainToAsync(Collection<? super V> c)

Description copied from interface: RBlockingQueueAsync

Removes all available elements from this queue and adds them to the given collection in async mode. This operation may be more efficient than repeatedly polling this queue. A failure encountered while attempting to add elements to collection c may result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in IllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

Specified by:

drainToAsync in interface RBlockingQueueAsync<V>

Parameters:

c - the collection to transfer elements into

Returns:

the number of elements transferred

drainTo

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

Specified by:

drainTo in interface BlockingQueue<V>

drainToAsync

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

Description copied from interface: RBlockingQueueAsync

Removes at most the given number of available elements from this queue and adds them to the given collection in async mode. A failure encountered while attempting to add elements to collection c may result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in IllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

Specified by:

drainToAsync in interface RBlockingQueueAsync<V>

Parameters:

c - the collection to transfer elements into

maxElements - the maximum number of elements to transfer

Returns:

the number of elements transferred

putFirstAsync

public RFuture<Void> putFirstAsync(V e)

Description copied from interface: RBlockingDequeAsync

Adds value to the head of queue.

Specified by:

putFirstAsync in interface RBlockingDequeAsync<V>

Parameters:

e - value

Returns:

void

putLastAsync

public RFuture<Void> putLastAsync(V e)

Description copied from interface: RBlockingDequeAsync

Adds value to the tail of queue.

Specified by:

putLastAsync in interface RBlockingDequeAsync<V>

Parameters:

e - value

Returns:

void

putFirst

public void putFirst(V e)
              throws InterruptedException

Specified by:

putFirst in interface BlockingDeque<V>

Throws:

InterruptedException

putLast

public void putLast(V e)
             throws InterruptedException

Specified by:

putLast in interface BlockingDeque<V>

Throws:

InterruptedException

offerFirst

public boolean offerFirst(V e,
                          long timeout,
                          TimeUnit unit)
                   throws InterruptedException

Specified by:

offerFirst in interface BlockingDeque<V>

Throws:

InterruptedException

offerLast

public boolean offerLast(V e,
                         long timeout,
                         TimeUnit unit)
                  throws InterruptedException

Specified by:

offerLast in interface BlockingDeque<V>

Throws:

InterruptedException

takeFirst

public V takeFirst()
            throws InterruptedException

Specified by:

takeFirst in interface BlockingDeque<V>

Throws:

InterruptedException

takeFirstAsync

public RFuture<V> takeFirstAsync()

Description copied from interface: RBlockingDequeAsync

Retrieves and removes value at the head of queue. Waits for an element become available.

Specified by:

takeFirstAsync in interface RBlockingDequeAsync<V>

Returns:

the head element of this queue

takeLastAsync

public RFuture<V> takeLastAsync()

Description copied from interface: RBlockingDequeAsync

Retrieves and removes value at the tail of queue. Waits for an element become available.

Specified by:

takeLastAsync in interface RBlockingDequeAsync<V>

Returns:

the tail element of this queue

takeLast

public V takeLast()
           throws InterruptedException

Specified by:

takeLast in interface BlockingDeque<V>

Throws:

InterruptedException

pollFirstAsync

public RFuture<V> pollFirstAsync(long timeout,
                                 TimeUnit unit)

Description copied from interface: RBlockingDequeAsync

Retrieves and removes value at the head of queue. If necessary waits up to defined timeout for an element become available.

Specified by:

pollFirstAsync in interface RBlockingDequeAsync<V>

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

the element at the tail of this queue, or null if the specified waiting time elapses before an element is available

pollFirstFromAny

public V pollFirstFromAny(long timeout,
                          TimeUnit unit,
                          String... queueNames)
                   throws InterruptedException

Description copied from interface: RBlockingDeque

Retrieves and removes first available head element of any queue, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue own.

Specified by:

pollFirstFromAny in interface RBlockingDeque<V>

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

queueNames - - names of queue

Returns:

the head of this queue, or null if the specified waiting time elapses before an element is available

Throws:

InterruptedException - if interrupted while waiting

pollFirstFromAnyAsync

public RFuture<V> pollFirstFromAnyAsync(long timeout,
                                        TimeUnit unit,
                                        String... queueNames)

Description copied from interface: RBlockingDequeAsync

Retrieves and removes first available head element of any queue in async mode, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue own.

Specified by:

pollFirstFromAnyAsync in interface RBlockingDequeAsync<V>

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

queueNames - - names of queue

Returns:

the head of this queue, or null if the specified waiting time elapses before an element is available

pollLastFromAny

public V pollLastFromAny(long timeout,
                         TimeUnit unit,
                         String... queueNames)
                  throws InterruptedException

Description copied from interface: RBlockingDeque

Retrieves and removes first available tail element of any queue, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue own.

Specified by:

pollLastFromAny in interface RBlockingDeque<V>

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

queueNames - - names of queue

Returns:

the head of this queue, or null if the specified waiting time elapses before an element is available

Throws:

InterruptedException - if interrupted while waiting

subscribeOnFirstElements

public int subscribeOnFirstElements(Consumer<V> consumer)

Description copied from interface: RBlockingDeque

Subscribes on first elements appeared in this queue. Continuously invokes RBlockingDequeAsync.takeFirstAsync() method to get a new element.

Specified by:

subscribeOnFirstElements in interface RBlockingDeque<V>

Parameters:

consumer - - queue elements listener

Returns:

listenerId - id of listener

subscribeOnLastElements

public int subscribeOnLastElements(Consumer<V> consumer)

Description copied from interface: RBlockingDeque

Subscribes on last elements appeared in this queue. Continuously invokes RBlockingDequeAsync.takeLastAsync() method to get a new element.

Specified by:

subscribeOnLastElements in interface RBlockingDeque<V>

Parameters:

consumer - - queue elements listener

Returns:

listenerId - id of listener

pollLastFromAnyAsync

public RFuture<V> pollLastFromAnyAsync(long timeout,
                                       TimeUnit unit,
                                       String... queueNames)

Description copied from interface: RBlockingDequeAsync

Retrieves and removes first available tail element of any queue in async mode, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue own.

Specified by:

pollLastFromAnyAsync in interface RBlockingDequeAsync<V>

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

queueNames - - names of queue

Returns:

the head of this queue, or null if the specified waiting time elapses before an element is available

pollFirst

public V pollFirst(long timeout,
                   TimeUnit unit)
            throws InterruptedException

Specified by:

pollFirst in interface BlockingDeque<V>

Throws:

InterruptedException

pollLastAsync

public RFuture<V> pollLastAsync(long timeout,
                                TimeUnit unit)

Description copied from interface: RBlockingDequeAsync

Retrieves and removes value at the tail of queue. If necessary waits up to defined timeout for an element become available.

Specified by:

pollLastAsync in interface RBlockingDequeAsync<V>

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

the element at the head of this queue, or null if the specified waiting time elapses before an element is available

pollLast

public V pollLast(long timeout,
                  TimeUnit unit)
           throws InterruptedException

Specified by:

pollLast in interface BlockingDeque<V>

Throws:

InterruptedException

move

public V move(Duration timeout,
              DequeMoveArgs args)

Specified by:

move in interface RBlockingDeque<V>

moveAsync

public RFuture<V> moveAsync(Duration timeout,
                            DequeMoveArgs args)

Specified by:

moveAsync in interface RBlockingDequeAsync<V>

expire

public boolean expire(long timeToLive,
                      TimeUnit timeUnit)

Description copied from interface: RExpirable

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

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

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

Set an expire date for 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

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

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

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.

expireAsync

protected RFuture<Boolean> expireAsync(long timeToLive,
                                       TimeUnit timeUnit,
                                       String... keys)

expireAtAsync

protected RFuture<Boolean> expireAtAsync(long timestamp,
                                         String... keys)

clearExpireAsync

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