org.redisson

Class RedissonBlockingFairQueue<V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonList<V>

org.redisson.RedissonQueue<V>

org.redisson.RedissonBlockingQueue<V>

org.redisson.RedissonBlockingFairQueue<V>

All Implemented Interfaces:

Iterable<V>, Collection<V>, BlockingQueue<V>, List<V>, Queue<V>, RandomAccess, RBlockingFairQueue<V>, RBlockingQueue<V>, RBlockingQueueAsync<V>, RCollectionAsync<V>, RExpirable, RExpirableAsync, RList<V>, RListAsync<V>, RObject, RObjectAsync, RQueue<V>, RQueueAsync<V>

public class RedissonBlockingFairQueue<V>
extends RedissonBlockingQueue<V>
implements RBlockingFairQueue<V>

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonList

EVAL_BOOLEAN_ARGS2

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RedissonBlockingFairQueue(Codec codec, CommandExecutor commandExecutor, String name, UUID id)
protected	RedissonBlockingFairQueue(CommandExecutor commandExecutor, String name, UUID id)

Method Summary

Methods

Modifier and Type	Method and 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.
RFuture<Boolean>	deleteAsync() Delete object 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.
V	poll()
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	pollLastAndOfferFirstTo(String queueName, long timeout, TimeUnit unit)
RFuture<V>	pollLastAndOfferFirstToAsync(String queueName, long timeout, TimeUnit unit)
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.
V	take()
RFuture<V>	takeAsync() Retrieves and removes the head of this queue in async mode, waiting if necessary until an element becomes available.

Methods inherited from class org.redisson.RedissonBlockingQueue

drainTo, drainTo, drainToAsync, drainToAsync, offer, pollFromAny, pollFromAnyAsync, put, putAsync, remainingCapacity

Methods inherited from class org.redisson.RedissonQueue

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

Methods inherited from class org.redisson.RedissonList

add, add, addAfter, addAfterAsync, addAll, addAll, addAllAsync, addAllAsync, addAsync, addAsync, addBefore, addBeforeAsync, clear, contains, containsAll, containsAllAsync, containsAsync, equals, fastRemove, fastRemoveAsync, fastSet, fastSetAsync, get, getAsync, hashCode, indexOf, indexOfAsync, indexOfAsync, isEmpty, iterator, lastIndexOf, lastIndexOfAsync, lastIndexOfAsync, listIterator, listIterator, readAll, readAllAsync, remove, remove, remove, remove, removeAll, removeAllAsync, removeAsync, removeAsync, removeAsync, retainAll, retainAllAsync, set, setAsync, size, sizeAsync, subList, toArray, toArray, toString, trim, trimAsync

Methods inherited from class org.redisson.RedissonObject

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.redisson.api.RBlockingQueue

pollFromAny

Methods inherited from interface java.util.concurrent.BlockingQueue

add, contains, drainTo, drainTo, offer, offer, put, remainingCapacity, remove

Methods inherited from interface org.redisson.api.RQueue

pollLastAndOfferFirstTo, pollLastAndOfferFirstTo, readAll

Methods inherited from interface java.util.Queue

element, peek, remove

Methods inherited from interface java.util.Collection

addAll, clear, 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

Methods inherited from interface org.redisson.api.RBlockingQueueAsync

drainToAsync, drainToAsync, pollFromAnyAsync, putAsync

Methods inherited from interface org.redisson.api.RQueueAsync

offerAsync, peekAsync, pollLastAndOfferFirstToAsync, readAllAsync

Methods inherited from interface org.redisson.api.RCollectionAsync

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

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync

Constructor Detail

RedissonBlockingFairQueue

protected RedissonBlockingFairQueue(CommandExecutor commandExecutor,
                         String name,
                         UUID id)

RedissonBlockingFairQueue

protected RedissonBlockingFairQueue(Codec codec,
                         CommandExecutor commandExecutor,
                         String name,
                         UUID id)

Method Detail

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

take

public V take()
       throws InterruptedException

Specified by:

take in interface BlockingQueue<V>

Overrides:

take in class RedissonBlockingQueue<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>

Overrides:

takeAsync in class RedissonBlockingQueue<V>

Returns:

the head of this queue

poll

public V poll()

Specified by:

poll in interface Queue<V>

Overrides:

poll in class RedissonQueue<V>

pollAsync

public RFuture<V> pollAsync()

Specified by:

pollAsync in interface RQueueAsync<V>

Overrides:

pollAsync in class RedissonQueue<V>

poll

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

Specified by:

poll in interface BlockingQueue<V>

Overrides:

poll in class RedissonBlockingQueue<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>

Overrides:

pollAsync in class RedissonBlockingQueue<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

pollLastAndOfferFirstTo

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

Specified by:

pollLastAndOfferFirstTo in interface RBlockingQueue<V>

Overrides:

pollLastAndOfferFirstTo in class RedissonBlockingQueue<V>

Throws:

InterruptedException

pollLastAndOfferFirstToAsync

public RFuture<V> pollLastAndOfferFirstToAsync(String queueName,
                                      long timeout,
                                      TimeUnit unit)

Specified by:

pollLastAndOfferFirstToAsync in interface RBlockingQueueAsync<V>

Overrides:

pollLastAndOfferFirstToAsync in class RedissonBlockingQueue<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

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

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

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

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

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