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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description RFuture<Integer>
addListenerAsync(ObjectListener listener)
Adds object event listenerRFuture<Void>
copyAsync(String host, int port, int database, long timeout)
Copy object from source Redis instance to destination Redis instance in async modeRFuture<Boolean>
deleteAsync()
Delete object in async modeRFuture<byte[]>
dumpAsync()
Returns dump of objectRFuture<Long>
getIdleTimeAsync()
Returns number of seconds spent since last write or read operation over this object.RFuture<Boolean>
isExistsAsync()
Check object existence in async mode.RFuture<Void>
migrateAsync(String host, int port, int database, long timeout)
Transfer object from source Redis instance to destination Redis instance in async modeRFuture<Boolean>
moveAsync(int database)
Move object to another database in async modeRFuture<Void>
removeListenerAsync(int listenerId)
Removes object event listenerRFuture<Void>
renameAsync(String newName)
Rename current object key tonewName
in async modeRFuture<Boolean>
renamenxAsync(String newName)
Rename current object key tonewName
in async mode only if new key is not existsRFuture<Void>
restoreAndReplaceAsync(byte[] state)
Restores and replaces object if it already exists.RFuture<Void>
restoreAndReplaceAsync(byte[] state, long timeToLive, TimeUnit timeUnit)
Restores and replaces object if it already exists and set time to live for it.RFuture<Void>
restoreAsync(byte[] state)
Restores object using its state returned bydumpAsync()
method.RFuture<Void>
restoreAsync(byte[] state, long timeToLive, TimeUnit timeUnit)
Restores object using its state returned bydumpAsync()
method and set time to live for it.RFuture<Long>
sizeInMemoryAsync()
Returns bytes amount used by object in Redis memory.RFuture<Boolean>
touchAsync()
Update the last access time of an object in async mode.RFuture<Boolean>
unlinkAsync()
Delete the objects.
-
-
-
Method Detail
-
getIdleTimeAsync
RFuture<Long> getIdleTimeAsync()
Returns number of seconds spent since last write or read operation over this object.- Returns:
- number of seconds
-
sizeInMemoryAsync
RFuture<Long> sizeInMemoryAsync()
Returns bytes amount used by object in Redis memory.- Returns:
- size in bytes
-
restoreAsync
RFuture<Void> restoreAsync(byte[] state)
Restores object using its state returned bydumpAsync()
method.- Parameters:
state
- - state of object- Returns:
- void
-
restoreAsync
RFuture<Void> restoreAsync(byte[] state, long timeToLive, TimeUnit timeUnit)
Restores object using its state returned bydumpAsync()
method and set time to live for it.- Parameters:
state
- - state of objecttimeToLive
- - time to live of the objecttimeUnit
- - time unit- Returns:
- void
-
restoreAndReplaceAsync
RFuture<Void> restoreAndReplaceAsync(byte[] state)
Restores and replaces object if it already exists.- Parameters:
state
- - state of the object- Returns:
- void
-
restoreAndReplaceAsync
RFuture<Void> restoreAndReplaceAsync(byte[] state, long timeToLive, TimeUnit timeUnit)
Restores and replaces object if it already exists and set time to live for it.- Parameters:
state
- - state of the objecttimeToLive
- - time to live of the objecttimeUnit
- - time unit- Returns:
- void
-
dumpAsync
RFuture<byte[]> dumpAsync()
Returns dump of object- Returns:
- dump
-
touchAsync
RFuture<Boolean> touchAsync()
Update the last access time of an object in async mode.- Returns:
true
if object was touched elsefalse
-
migrateAsync
RFuture<Void> migrateAsync(String host, int port, int database, long timeout)
Transfer object from source Redis instance to destination Redis instance in async mode- Parameters:
host
- - destination hostport
- - destination portdatabase
- - destination databasetimeout
- - maximum idle time in any moment of the communication with the destination instance in milliseconds- Returns:
- void
-
copyAsync
RFuture<Void> copyAsync(String host, int port, int database, long timeout)
Copy object from source Redis instance to destination Redis instance in async mode- Parameters:
host
- - destination hostport
- - destination portdatabase
- - destination databasetimeout
- - maximum idle time in any moment of the communication with the destination instance in milliseconds- Returns:
- void
-
moveAsync
RFuture<Boolean> moveAsync(int database)
Move object to another database in async mode- Parameters:
database
- - number of Redis database- Returns:
true
if key was movedfalse
if not
-
deleteAsync
RFuture<Boolean> deleteAsync()
Delete object in async mode- Returns:
true
if object was deletedfalse
if not
-
unlinkAsync
RFuture<Boolean> unlinkAsync()
Delete the objects. Actual removal will happen later asynchronously.Requires Redis 4.0+
- Returns:
true
if it was exist and deleted elsefalse
-
renameAsync
RFuture<Void> renameAsync(String newName)
Rename current object key tonewName
in async mode- Parameters:
newName
- - new name of object- Returns:
- void
-
renamenxAsync
RFuture<Boolean> renamenxAsync(String newName)
Rename current object key tonewName
in async mode only if new key is not exists- Parameters:
newName
- - new name of object- Returns:
true
if object has been renamed successfully andfalse
otherwise
-
isExistsAsync
RFuture<Boolean> isExistsAsync()
Check object existence in async mode.- Returns:
true
if object exists andfalse
otherwise
-
addListenerAsync
RFuture<Integer> addListenerAsync(ObjectListener listener)
Adds object event listener- Parameters:
listener
- - object event listener- Returns:
- listener id
- See Also:
ExpiredObjectListener
,DeletedObjectListener
-
-