org.redisson

Class RedissonBoundedBlockingQueue<V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonList<V>

org.redisson.RedissonQueue<V>

org.redisson.RedissonBoundedBlockingQueue<V>

All Implemented Interfaces:

Iterable<V>, Collection<V>, BlockingQueue<V>, List<V>, Queue<V>, RandomAccess, 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.RedissonList

EVAL_BOOLEAN_ARGS2

Fields inherited from class org.redisson.RedissonObject

codec

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RedissonBoundedBlockingQueue(SemaphorePubSub semaphorePubSub, Codec codec, CommandExecutor commandExecutor, String name, RedissonClient redisson)
protected	RedissonBoundedBlockingQueue(SemaphorePubSub semaphorePubSub, CommandExecutor commandExecutor, String name, RedissonClient redisson)

Method Summary

Methods

Modifier and Type	Method and Description
RFuture<Boolean>	addAllAsync(Collection<? extends V> c)
RFuture<Boolean>	addAsync(V e)
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.
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) Set a timeout for object.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit) Set a timeout for object in async mode.
boolean	expireAt(Date timestamp) Set an expire date for object.
boolean	expireAt(long timestamp) Set an expire date for object.
RFuture<Boolean>	expireAtAsync(Date timestamp) Set an expire date for object in async mode.
RFuture<Boolean>	expireAtAsync(long timestamp) Set an expire date for object in async mode.
boolean	offer(V e, long timeout, TimeUnit unit)
RFuture<Boolean>	offerAsync(V e)
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()
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	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 own.
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 own.
V	pollLastAndOfferFirstTo(String queueName, long timeout, TimeUnit unit)
RFuture<V>	pollLastAndOfferFirstToAsync(String queueName, long timeout, TimeUnit unit)
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() Get remaining time to live of object in seconds.
RFuture<Boolean>	removeAllAsync(Collection<?> c) Removes all of this collection's elements that are also contained in the specified collection (optional operation).
RFuture<Boolean>	removeAsync(Object o) Removes a single instance of the specified element from this collection, if it is present (optional operation).
V	take()
RFuture<V>	takeAsync() Retrieves and removes the head of this queue in async mode, waiting if necessary until an element becomes available.
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.

Methods inherited from class org.redisson.RedissonQueue

element, getFirst, offer, peek, peekAsync, poll, pollLastAndOfferFirstTo, pollLastAndOfferFirstToAsync, remove, removeFirst, toSeconds

Methods inherited from class org.redisson.RedissonList

add, add, addAfter, addAfterAsync, addAll, addAll, addAllAsync, addAsync, addBefore, addBeforeAsync, contains, containsAll, containsAllAsync, containsAsync, equals, fastRemove, fastRemoveAsync, fastSet, fastSetAsync, get, getAsync, hashCode, indexOf, indexOfAsync, indexOfAsync, isEmpty, iterator, lastIndexOf, lastIndexOfAsync, lastIndexOfAsync, listIterator, listIterator, mapReduce, readAll, readAllAsync, readSort, readSort, readSort, readSort, readSort, readSort, readSortAsync, readSortAsync, readSortAsync, readSortAsync, readSortAsync, readSortAsync, remove, remove, remove, remove, removeAll, removeAsync, removeAsync, 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

await, delete, encode, encodeMapKey, encodeMapValue, get, getCodec, getName, getName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, newPromise, newSucceededFuture, prefixName, rename, renameAsync, renamenx, renamenxAsync, suffixName, touch, touchAsync

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 org.redisson.api.RQueue

pollLastAndOfferFirstTo, readAll

Methods inherited from interface java.util.Queue

element, peek, poll, remove

Methods inherited from interface java.util.Collection

addAll, containsAll, equals, hashCode, isEmpty, iterator, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObject

delete, getCodec, getName, isExists, migrate, move, rename, renamenx, touch

Methods inherited from interface org.redisson.api.RQueueAsync

peekAsync, pollLastAndOfferFirstToAsync, readAllAsync

Methods inherited from interface org.redisson.api.RCollectionAsync

containsAllAsync, containsAsync, retainAllAsync, sizeAsync

Methods inherited from interface org.redisson.api.RExpirableAsync

expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync, touchAsync

Constructor Detail

RedissonBoundedBlockingQueue

protected RedissonBoundedBlockingQueue(SemaphorePubSub semaphorePubSub,
                            CommandExecutor commandExecutor,
                            String name,
                            RedissonClient redisson)

RedissonBoundedBlockingQueue

protected RedissonBoundedBlockingQueue(SemaphorePubSub semaphorePubSub,
                            Codec codec,
                            CommandExecutor commandExecutor,
                            String name,
                            RedissonClient redisson)

Method Detail

addAsync

public RFuture<Boolean> addAsync(V e)

Specified by:

addAsync in interface RCollectionAsync<V>

Overrides:

addAsync in class RedissonList<V>

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)

Specified by:

offerAsync in interface RQueueAsync<V>

Overrides:

offerAsync in class RedissonQueue<V>

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 (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).

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 (optional operation). After this call returns, this collection will contain no elements in common with 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()

Specified by:

pollAsync in interface RQueueAsync<V>

Overrides:

pollAsync in class RedissonQueue<V>

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 own.

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

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 own.

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 - - names of queue

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)

Specified by:

pollLastAndOfferFirstToAsync in interface RBlockingQueueAsync<V>

pollLastAndOfferFirstTo

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

Specified by:

pollLastAndOfferFirstTo in interface RBlockingQueue<V>

Throws:

InterruptedException

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

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 seconds (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

addAllAsync

public RFuture<Boolean> addAllAsync(Collection<? extends V> c)

Specified by:

addAllAsync in interface RCollectionAsync<V>

Overrides:

addAllAsync in class RedissonList<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

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

Get remaining time to live of object in seconds.

Specified by:

remainTimeToLiveAsync in interface RExpirableAsync

Returns:

-1 if object does not exist or time in seconds