Package org.redisson.api

Interface RObjectAsync

All Known Subinterfaces:

RAtomicDouble, RAtomicDoubleAsync, RAtomicLong, RAtomicLongAsync, RBinaryStream, RBitSet, RBitSetAsync, RBlockingDeque<V>, RBlockingDequeAsync<V>, RBlockingQueue<V>, RBlockingQueueAsync<V>, RBloomFilter<T>, RBoundedBlockingQueue<V>, RBoundedBlockingQueueAsync<V>, RBucket<V>, RBucketAsync<V>, RCollectionAsync<V>, RCountDownLatch, RCountDownLatchAsync, RDelayedQueue<V>, RDeque<V>, RDequeAsync<V>, RDoubleAdder, RExpirable, RExpirableAsync, RGeo<V>, RGeoAsync<V>, RHyperLogLog<V>, RHyperLogLogAsync<V>, RIdGenerator, RIdGeneratorAsync, RLexSortedSet, RLexSortedSetAsync, RList<V>, RListAsync<V>, RListMultimap<K,V>, RListMultimapCache<K,V>, RLiveObject, RLocalCachedMap<K,V>, RLongAdder, RMap<K,V>, RMapAsync<K,V>, RMapCache<K,V>, RMapCacheAsync<K,V>, RMultimap<K,V>, RMultimapAsync<K,V>, RMultimapCache<K,V>, RMultimapCacheAsync<K,V>, RObject, RPermitExpirableSemaphore, RPermitExpirableSemaphoreAsync, RPriorityBlockingDeque<V>, RPriorityBlockingQueue<V>, RPriorityDeque<V>, RPriorityQueue<V>, RQueue<V>, RQueueAsync<V>, RRateLimiter, RRateLimiterAsync, RReliableTopic, RReliableTopicAsync, RRingBuffer<V>, RRingBufferAsync<V>, RScoredSortedSet<V>, RScoredSortedSetAsync<V>, RSemaphore, RSemaphoreAsync, RSet<V>, RSetAsync<V>, RSetCache<V>, RSetCacheAsync<V>, RSetMultimap<K,V>, RSetMultimapCache<K,V>, RSortedSet<V>, RStream<K,V>, RStreamAsync<K,V>, RTimeSeries<V>, RTimeSeriesAsync<V>, RTransferQueue<V>, RTransferQueueAsync<V>

All Known Implementing Classes:

JCache, RedissonAtomicDouble, RedissonAtomicLong, RedissonBaseAdder, RedissonBaseLock, RedissonBinaryStream, RedissonBitSet, RedissonBlockingDeque, RedissonBlockingQueue, RedissonBloomFilter, RedissonBoundedBlockingQueue, RedissonBucket, RedissonCountDownLatch, RedissonDelayedQueue, RedissonDeque, RedissonDoubleAdder, RedissonFairLock, RedissonGeo, RedissonHyperLogLog, RedissonIdGenerator, RedissonLexSortedSet, RedissonList, RedissonListMultimap, RedissonListMultimapCache, RedissonListMultimapValues, RedissonLocalCachedMap, RedissonLock, RedissonLongAdder, RedissonMap, RedissonMapCache, RedissonMultimap, RedissonObject, RedissonPermitExpirableSemaphore, RedissonPriorityBlockingDeque, RedissonPriorityBlockingQueue, RedissonPriorityDeque, RedissonPriorityQueue, RedissonQueue, RedissonQueueSemaphore, RedissonRateLimiter, RedissonReadLock, RedissonReadWriteLock, RedissonReliableTopic, RedissonRingBuffer, RedissonScoredSortedSet, RedissonSemaphore, RedissonSet, RedissonSetCache, RedissonSetMultimap, RedissonSetMultimapCache, RedissonSetMultimapValues, RedissonSortedSet, RedissonSpinLock, RedissonStream, RedissonSubList, RedissonTimeSeries, RedissonTransactionalBucket, RedissonTransactionalLocalCachedMap, RedissonTransactionalLock, RedissonTransactionalMap, RedissonTransactionalMapCache, RedissonTransactionalSet, RedissonTransactionalSetCache, RedissonTransferQueue, RedissonWriteLock

public interface RObjectAsync

Base asynchronous interface for all Redisson objects

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
>	addListenerAsync(ObjectListener listener)	Adds object event listener
>	host, int port, int database, long timeout)	Copy object from source Redis instance to destination Redis instance in async mode
>	deleteAsync()	Delete object in async mode
RFuture<byte[]>	dumpAsync()	Returns dump of object
>	getIdleTimeAsync()	Returns number of seconds spent since last write or read operation over this object.
>	isExistsAsync()	Check object existence in async mode.
>	host, int port, int database, long timeout)	Transfer object from source Redis instance to destination Redis instance in async mode
>	moveAsync(int database)	Move object to another database in async mode
>	removeListenerAsync(int listenerId)	Removes object event listener
>	newName)	Rename current object key to newName in async mode
>	newName)	Rename current object key to newName in async mode only if new key is not exists
>	restoreAndReplaceAsync(byte[] state)	Restores and replaces object if it already exists.
>	restoreAndReplaceAsync(byte[] state, long timeToLive, timeUnit)	Restores and replaces object if it already exists and set time to live for it.
>	restoreAsync(byte[] state)	Restores object using its state returned by dumpAsync() method.
>	restoreAsync(byte[] state, long timeToLive, timeUnit)	Restores object using its state returned by dumpAsync() method and set time to live for it.
>	sizeInMemoryAsync()	Returns bytes amount used by object in Redis memory.
>	touchAsync()	Update the last access time of an object in async mode.
>	unlinkAsync()	Delete the objects.

Method Detail

getIdleTimeAsync

> getIdleTimeAsync()

Returns number of seconds spent since last write or read operation over this object.

Returns:

number of seconds

sizeInMemoryAsync

> sizeInMemoryAsync()

Returns bytes amount used by object in Redis memory.

Returns:

size in bytes

restoreAsync

> restoreAsync(byte[] state)

Restores object using its state returned by dumpAsync() method.

Parameters:

state - - state of object

Returns:

void

restoreAsync

> restoreAsync(byte[] state,
                           long timeToLive,
                            timeUnit)

Restores object using its state returned by dumpAsync() method and set time to live for it.

Parameters:

state - - state of object

timeToLive - - time to live of the object

timeUnit - - time unit

Returns:

void

restoreAndReplaceAsync

> restoreAndReplaceAsync(byte[] state)

Restores and replaces object if it already exists.

Parameters:

state - - state of the object

Returns:

void

restoreAndReplaceAsync

> restoreAndReplaceAsync(byte[] state,
                                     long timeToLive,
                                      timeUnit)

Restores and replaces object if it already exists and set time to live for it.

Parameters:

state - - state of the object

timeToLive - - time to live of the object

timeUnit - - time unit

Returns:

void

dumpAsync

RFuture<byte[]> dumpAsync()

Returns dump of object

Returns:

dump

touchAsync

> touchAsync()

Update the last access time of an object in async mode.

Returns:

true if object was touched else false

migrateAsync

> migrateAsync( host,
                           int port,
                           int database,
                           long timeout)

Transfer object from source Redis instance to destination Redis instance in async mode

Parameters:

host - - destination host

port - - destination port

database - - destination database

timeout - - maximum idle time in any moment of the communication with the destination instance in milliseconds

Returns:

void

copyAsync

> copyAsync( host,
                        int port,
                        int database,
                        long timeout)

Copy object from source Redis instance to destination Redis instance in async mode

Parameters:

host - - destination host

port - - destination port

database - - destination database

timeout - - maximum idle time in any moment of the communication with the destination instance in milliseconds

Returns:

void

moveAsync

> moveAsync(int database)

Move object to another database in async mode

Parameters:

database - - number of Redis database

Returns:

true if key was moved false if not

deleteAsync

> deleteAsync()

Delete object in async mode

Returns:

true if object was deleted false if not

unlinkAsync

> unlinkAsync()

Delete the objects. Actual removal will happen later asynchronously.

Requires Redis 4.0+

Returns:

true if it was exist and deleted else false

renameAsync

> renameAsync( newName)

Rename current object key to newName in async mode

Parameters:

newName - - new name of object

Returns:

void

renamenxAsync

> renamenxAsync( newName)

Rename current object key to newName in async mode only if new key is not exists

Parameters:

newName - - new name of object

Returns:

true if object has been renamed successfully and false otherwise

isExistsAsync

> isExistsAsync()

Check object existence in async mode.

Returns:

true if object exists and false otherwise

addListenerAsync

> addListenerAsync(ObjectListener listener)

Adds object event listener

Parameters:

listener - - object event listener

Returns:

listener id

See Also:

ExpiredObjectListener, DeletedObjectListener

removeListenerAsync

> removeListenerAsync(int listenerId)

Removes object event listener

Parameters:

listenerId - - listener id