org.redisson

Class RedissonQueue<V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonList<V>

org.redisson.RedissonQueue<V>

Type Parameters:

V - the type of elements held in this collection

All Implemented Interfaces:

Iterable<V>, Collection<V>, List<V>, Queue<V>, RandomAccess, RCollectionAsync<V>, RExpirable, RExpirableAsync, RList<V>, RListAsync<V>, RObject, RObjectAsync, RQueue<V>, RQueueAsync<V>, RSortable<List<V>>, RSortableAsync<List<V>>

Direct Known Subclasses:

RedissonBlockingQueue, RedissonBoundedBlockingQueue, RedissonDeque

public class RedissonQueue<V>
extends RedissonList<V>
implements RQueue<V>

Distributed and concurrent implementation of Queue

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RedissonQueue(Codec codec, CommandAsyncExecutor commandExecutor, String name, RedissonClient redisson)
protected	RedissonQueue(CommandAsyncExecutor commandExecutor, String name, RedissonClient redisson)

Method Summary

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.
V	element()
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	getFirst()
boolean	offer(V e)
RFuture<Boolean>	offerAsync(V e)
V	peek()
RFuture<V>	peekAsync()
V	poll()
RFuture<V>	pollAsync()
V	pollLastAndOfferFirstTo(String queueName)
RFuture<V>	pollLastAndOfferFirstToAsync(String queueName)
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
V	remove()
V	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, get, getAsync, 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, removeAllAsync, removeAsync, 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, copy, copyAsync, delete, deleteAsync, dump, dumpAsync, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getName, getName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, suffixName, toSeconds, touch, touchAsync, unlink, unlinkAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.redisson.api.RQueue

readAll

Methods inherited from interface java.util.Queue

add

Methods inherited from interface java.util.Collection

addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObject

copy, delete, dump, getCodec, getName, isExists, migrate, move, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, touch, unlink

Methods inherited from interface org.redisson.api.RQueueAsync

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

copyAsync, deleteAsync, dumpAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, touchAsync, unlinkAsync

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Constructor Detail

RedissonQueue

protected RedissonQueue(CommandAsyncExecutor commandExecutor,
                        String name,
                        RedissonClient redisson)

RedissonQueue

protected RedissonQueue(Codec codec,
                        CommandAsyncExecutor commandExecutor,
                        String name,
                        RedissonClient redisson)

Method Detail

offer

public boolean offer(V e)

Specified by:

offer in interface Queue<V>

offerAsync

public RFuture<Boolean> offerAsync(V e)

Specified by:

offerAsync in interface RQueueAsync<V>

getFirst

public V getFirst()

removeFirst

public V removeFirst()

remove

public V remove()

Specified by:

remove in interface Queue<V>

pollAsync

public RFuture<V> pollAsync()

Specified by:

pollAsync in interface RQueueAsync<V>

poll

public V poll()

Specified by:

poll in interface Queue<V>

element

public V element()

Specified by:

element in interface Queue<V>

peekAsync

public RFuture<V> peekAsync()

Specified by:

peekAsync in interface RQueueAsync<V>

peek

public V peek()

Specified by:

peek in interface Queue<V>

pollLastAndOfferFirstTo

public V pollLastAndOfferFirstTo(String queueName)

Specified by:

pollLastAndOfferFirstTo in interface RQueue<V>

pollLastAndOfferFirstToAsync

public RFuture<V> pollLastAndOfferFirstToAsync(String queueName)

Specified by:

pollLastAndOfferFirstToAsync in interface RQueueAsync<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

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.