Package org.redisson

Class RedissonTransferQueue<V>

org.redisson.RedissonObject

org.redisson.RedissonTransferQueue<V>

All Implemented Interfaces:

<V>, <V>, <V>, <V>, <V>, RBlockingQueue<V>, RBlockingQueueAsync<V>, RCollectionAsync<V>, RExpirable, RExpirableAsync, RObject, RObjectAsync, RQueue<V>, RQueueAsync<V>, RTransferQueue<V>, RTransferQueueAsync<V>

public class RedissonTransferQueue<V>
extends RedissonObject
implements RTransferQueue<V>

Author:

Nikita Koksharov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RedissonTransferQueue.TransferQueueService
static interface	RedissonTransferQueue.TransferQueueServiceAsync
static class	RedissonTransferQueue.TransferQueueServiceImpl

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor, name

Constructor Summary

Constructors

Constructor	Description
RedissonTransferQueue(Codec codec, CommandAsyncExecutor commandExecutor, name, RRemoteService remoteService)
RedissonTransferQueue(CommandAsyncExecutor commandExecutor, name, RRemoteService remoteService)

Method Summary

Modifier and Type	Method	Description
boolean	add(V v)
boolean	<? extends V> c)
>	<? extends V> c)	Adds all elements contained in the specified collection
>	addAsync(V v)	Adds element into this collection.
void	clear()
>	clearAsync()
boolean	clearExpire()	Clear an expire timeout or expire date for object.
>	clearExpireAsync()	Clear an expire timeout or expire date for object in async mode.
protected >	... keys)
boolean	o)
boolean	<?> c)
>	<?> c)	Returns true if this collection contains all of the elements in the specified collection.
>	o)	Returns true if this collection contains encoded state of the specified element.
int	<? super V> c)
int	<? super V> c, int maxElements)
>	<? super V> c)	Removes all available elements from this queue and adds them to the given collection in async mode.
>	<? 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.
V	element()
boolean	expire(long timeToLive, timeUnit)	Set a timeout for object.
boolean	instant)	Set an expire date for object.
>	expireAsync(long timeToLive, timeUnit)	Set a timeout for object in async mode.
protected >	expireAsync(long timeToLive, timeUnit, ... keys)
>	instant)	Set an expire date for object.
boolean	expireAt(long timestamp)	Use RExpirable.expire(Instant) instead
boolean	timestamp)	Use RExpirable.expire(Instant) instead
>	expireAtAsync(long timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
protected >	expireAtAsync(long timestamp, ... keys)
>	timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
RFuture<V>	getValueAsync(int index)
int	getWaitingConsumerCount()
boolean	hasWaitingConsumer()
boolean	isEmpty()
<V>	iterator()
boolean	offer(V v)
boolean	offer(V v, long timeout, unit)
>	offerAsync(V e)	Inserts the specified element into this queue.
V	peek()
RFuture<V>	peekAsync()	Retrieves the head of this queue in async mode.
V	poll()
<V>	poll(int limit)	Retrieves and removes the head elements of this queue.
V	poll(long timeout, unit)
RFuture<V>	pollAsync()	Retrieves and removes the head of this queue in async mode.
<V>>	pollAsync(int limit)	Retrieves and removes the head elements of this queue.
RFuture<V>	pollAsync(long timeout, 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, unit, ... 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, unit, ... 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	queueName)	Retrieves and removes last available tail element of this queue queue and adds it at the head of queueName.
V	queueName, long timeout, 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>	queueName)	Retrieves and removes last available tail element of this queue queue and adds it at the head of queueName.
RFuture<V>	queueName, long timeout, 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.
void	put(V v)
>	putAsync(V value)	Inserts the specified element into this queue in async mode, waiting if necessary for space to become available.
<V>	readAll()	Returns all queue elements at once
<V>>	readAllAsync()	Returns all queue elements at once
int	remainingCapacity()
long	remainTimeToLive()	Remaining time to live of Redisson object that has a timeout
>	remainTimeToLiveAsync()	Remaining time to live of Redisson object that has a timeout
V	remove()
boolean	o)
boolean	<?> c)
>	<?> c)	Removes all of this collection's elements that are also contained in the specified collection.
>	o)	Removes a single instance of the specified element from this collection, if it is present.
boolean	<?> c)
>	<?> c)	Retains only the elements in this collection that are contained in the specified collection.
int	size()
>	sizeAsync()	Returns number of elements in this collection.
int	<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	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>	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.
[]	toArray()
<T> T[]	toArray(T[] a)
void	transfer(V v)
>	transferAsync(V v)	Transfers the element to waiting consumer which invoked RBlockingQueueAsync.takeAsync() or RBlockingQueueAsync.pollAsync(long, java.util.concurrent.TimeUnit) method at the moment of transfer.
boolean	tryTransfer(V v)
boolean	tryTransfer(V v, long timeout, unit)
>	tryTransferAsync(V v)	Tries to transfer the element to waiting consumer which invoked RBlockingQueueAsync.takeAsync() or RBlockingQueueAsync.pollAsync(long, java.util.concurrent.TimeUnit) method at the moment of transfer.
>	tryTransferAsync(V v, long timeout, unit)	Transfers the element to waiting consumer which invoked RBlockingQueueAsync.takeAsync() or RBlockingQueueAsync.pollAsync(long, java.util.concurrent.TimeUnit) method at the moment of transfer.
void	unsubscribe(int listenerId)	Un-subscribes defined listener.

Methods inherited from class org.redisson.RedissonObject

addListener, addListener, addListenerAsync, 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, removeListener, removeListenerAsync, 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.

, , , , , , , , , ,

Methods inherited from interface java.util.

, , , , , ,

Methods inherited from interface java.lang.

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

Methods inherited from interface org.redisson.api.RQueueAsync

addListenerAsync

Constructor Detail

RedissonTransferQueue

public RedissonTransferQueue(Codec codec,
                             CommandAsyncExecutor commandExecutor,
                              name,
                             RRemoteService remoteService)

RedissonTransferQueue

public RedissonTransferQueue(CommandAsyncExecutor commandExecutor,
                              name,
                             RRemoteService remoteService)

Method Detail

tryTransfer

public boolean tryTransfer(V v)

Specified by:

in interface <V>

tryTransferAsync

public > tryTransferAsync(V v)

Description copied from interface: RTransferQueueAsync

Tries to transfer the element to waiting consumer which invoked RBlockingQueueAsync.takeAsync() or RBlockingQueueAsync.pollAsync(long, java.util.concurrent.TimeUnit) method at the moment of transfer.

Specified by:

tryTransferAsync in interface RTransferQueueAsync<V>

Parameters:

v - element to transfer

Returns:

true if element was transferred, otherwise false

transfer

public void transfer(V v)
              throws 

Specified by:

in interface <V>

Throws:

transferAsync

public > transferAsync(V v)

Description copied from interface: RTransferQueueAsync

Transfers the element to waiting consumer which invoked RBlockingQueueAsync.takeAsync() or RBlockingQueueAsync.pollAsync(long, java.util.concurrent.TimeUnit) method at the moment of transfer. Waits if necessary for a consumer.

Specified by:

transferAsync in interface RTransferQueueAsync<V>

Parameters:

v - the element to transfer

tryTransfer

public boolean tryTransfer(V v,
                           long timeout,
                            unit)
                    throws 

Specified by:

in interface <V>

Throws:

tryTransferAsync

public > tryTransferAsync(V v,
                                         long timeout,
                                          unit)

Description copied from interface: RTransferQueueAsync

Transfers the element to waiting consumer which invoked RBlockingQueueAsync.takeAsync() or RBlockingQueueAsync.pollAsync(long, java.util.concurrent.TimeUnit) method at the moment of transfer. Waits up to defined timeout if necessary for a consumer.

Specified by:

tryTransferAsync in interface RTransferQueueAsync<V>

Parameters:

v - the element to transfer

timeout - the maximum time to wait

unit - the time unit

Returns:

true if the element was transferred and false otherwise

hasWaitingConsumer

public boolean hasWaitingConsumer()

Specified by:

in interface <V>

getWaitingConsumerCount

public int getWaitingConsumerCount()

Specified by:

in interface <V>

add

public boolean add(V v)

Specified by:

in interface <V>

Specified by:

in interface <V>

Specified by:

in interface <V>

addAsync

public > addAsync(V v)

Description copied from interface: RCollectionAsync

Adds element into this collection.

Specified by:

addAsync in interface RCollectionAsync<V>

Parameters:

v - - element to add

Returns:

true if an element was added and false if it is already present

offer

public boolean offer(V v)

Specified by:

in interface <V>

Specified by:

in interface <V>

remove

public V remove()

Specified by:

in interface <V>

poll

public V poll()

Specified by:

in interface <V>

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>

Returns:

the head of this queue, or null

element

public V element()

Specified by:

in interface <V>

peek

public V peek()

Specified by:

in interface <V>

peekAsync

public RFuture<V> peekAsync()

Description copied from interface: RQueueAsync

Retrieves the head of this queue in async mode.

Specified by:

peekAsync in interface RQueueAsync<V>

Returns:

the head of this queue, or null

put

public void put(V v)
         throws 

Specified by:

in interface <V>

Throws:

offer

public boolean offer(V v,
                     long timeout,
                      unit)
              throws 

Specified by:

in interface <V>

Throws:

take

public V take()
       throws 

Specified by:

in interface <V>

Throws:

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

poll

public V poll(long timeout,
               unit)
       throws 

Specified by:

in interface <V>

Throws:

pollAsync

public RFuture<V> pollAsync(long timeout,
                             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

remainingCapacity

public int remainingCapacity()

Specified by:

in interface <V>

remove

public boolean remove( o)

Specified by:

in interface <V>

Specified by:

in interface <V>

containsAll

public boolean containsAll(<?> c)

Specified by:

in interface <V>

addAll

public boolean addAll(<? extends V> c)

Specified by:

in interface <V>

removeAll

public boolean removeAll(<?> c)

Specified by:

in interface <V>

retainAll

public boolean retainAll(<?> c)

Specified by:

in interface <V>

clear

public void clear()

Specified by:

in interface <V>

clearAsync

public > clearAsync()

size

public int size()

Specified by:

in interface <V>

sizeAsync

public > sizeAsync()

Description copied from interface: RCollectionAsync

Returns number of elements in this collection.

Specified by:

sizeAsync in interface RCollectionAsync<V>

Returns:

size of collection

isEmpty

public boolean isEmpty()

Specified by:

in interface <V>

contains

public boolean contains( o)

Specified by:

in interface <V>

Specified by:

in interface <V>

getValueAsync

public RFuture<V> getValueAsync(int index)

iterator

public <V> iterator()

Specified by:

in interface <V>

Specified by:

in interface <V>

toArray

public [] toArray()

Specified by:

in interface <V>

toArray

public <T> T[] toArray(T[] a)

Specified by:

in interface <V>

drainTo

public int drainTo(<? super V> c)

Specified by:

in interface <V>

drainToAsync

public > drainToAsync(<? 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(<? super V> c,
                   int maxElements)

Specified by:

in interface <V>

drainToAsync

public > drainToAsync(<? 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

readAll

public <V> readAll()

Description copied from interface: RTransferQueue

Returns all queue elements at once

Specified by:

readAll in interface RQueue<V>

Specified by:

readAll in interface RTransferQueue<V>

Specified by:

readAll in interface RTransferQueueAsync<V>

Returns:

elements

readAllAsync

public <V>> readAllAsync()

Description copied from interface: RQueueAsync

Returns all queue elements at once

Specified by:

readAllAsync in interface RQueueAsync<V>

Returns:

elements

pollFromAny

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

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:

- if interrupted while waiting

pollLastAndOfferFirstTo

public  queueName,
                                 long timeout,
                                  unit)
                          throws 

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:

- if interrupted while waiting

takeLastAndOfferFirstTo

public  queueName)
                          throws 

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:

- if interrupted while waiting

subscribeOnElements

public int subscribeOnElements(<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

pollLastAndOfferFirstTo

public  queueName)

Description copied from interface: RQueue

Retrieves and removes last available tail element of this queue queue and adds it at the head of queueName.

Specified by:

pollLastAndOfferFirstTo in interface RQueue<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

poll

public <V> poll(int limit)

Description copied from interface: RQueue

Retrieves and removes the head elements of this queue. Elements amount limited by limit param.

Specified by:

poll in interface RQueue<V>

Returns:

list of head elements

pollFromAnyAsync

public RFuture<V> pollFromAnyAsync(long timeout,
                                    unit,
                                   ... 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  queueName,
                                               long timeout,
                                                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

takeLastAndOfferFirstToAsync

public  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

putAsync

public > putAsync(V value)

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:

value - the element to add

Returns:

void

offerAsync

public > offerAsync(V e)

Description copied from interface: RQueueAsync

Inserts the specified element into this queue.

Specified by:

offerAsync in interface RQueueAsync<V>

Parameters:

e - the element to add

Returns:

true if successful, or false

pollLastAndOfferFirstToAsync

public  queueName)

Description copied from interface: RQueueAsync

Retrieves and removes last available tail element of this queue queue and adds it at the head of queueName.

Specified by:

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

pollAsync

public <V>> pollAsync(int limit)

Description copied from interface: RQueueAsync

Retrieves and removes the head elements of this queue. Elements amount limited by limit param.

Specified by:

pollAsync in interface RQueueAsync<V>

Returns:

list of head elements

retainAllAsync

public > retainAllAsync(<?> c)

Description copied from interface: RCollectionAsync

Retains only the elements in this collection that are contained in the specified collection.

Specified by:

retainAllAsync in interface RCollectionAsync<V>

Parameters:

c - collection containing elements to be retained in this collection

Returns:

true if this collection changed as a result of the call

removeAllAsync

public > removeAllAsync(<?> 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>

Parameters:

c - collection containing elements to be removed from this collection

Returns:

true if this collection changed as a result of the call

containsAsync

public > containsAsync( o)

Description copied from interface: RCollectionAsync

Returns true if this collection contains encoded state of the specified element.

Specified by:

containsAsync in interface RCollectionAsync<V>

Parameters:

o - element whose presence in this collection is to be tested

Returns:

true if this collection contains the specified element and false otherwise

containsAllAsync

public > containsAllAsync(<?> c)

Description copied from interface: RCollectionAsync

Returns true if this collection contains all of the elements in the specified collection.

Specified by:

containsAllAsync in interface RCollectionAsync<V>

Parameters:

c - collection to be checked for containment in this collection

Returns:

true if this collection contains all of the elements in the specified collection

removeAsync

public > removeAsync( 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>

Parameters:

o - element to be removed from this collection, if present

Returns:

true if an element was removed as a result of this call

addAllAsync

public > addAllAsync(<? extends V> c)

Description copied from interface: RCollectionAsync

Adds all elements contained in the specified collection

Specified by:

addAllAsync in interface RCollectionAsync<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)

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 > expireAsync(long timeToLive,
                                     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 > 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)

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 > expireAsync( 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( 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 > expireAtAsync( 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 > 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 > 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 > expireAsync(long timeToLive,
                                        timeUnit,
                                       ... keys)

expireAtAsync

protected > expireAtAsync(long timestamp,
                                         ... keys)

clearExpireAsync

protected > clearExpireAsync(... keys)