org.redisson.api

Interface RExpirableAsync

All Superinterfaces:

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>, RDelayedQueue<V>, RDeque<V>, RDequeAsync<V>, RDoubleAdder, RExpirable, RGeo<V>, RGeoAsync<V>, RHyperLogLog<V>, RHyperLogLogAsync<V>, RLexSortedSet, RLexSortedSetAsync, RList<V>, RListAsync<V>, RListMultimap<K,V>, RListMultimapCache<K,V>, RLocalCachedMap<K,V>, RLock, RLockAsync, 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>, RPermitExpirableSemaphore, RPermitExpirableSemaphoreAsync, RPriorityBlockingDeque<V>, RPriorityBlockingQueue<V>, RQueue<V>, RQueueAsync<V>, RReadWriteLock, RScoredSortedSet<V>, RScoredSortedSetAsync<V>, RSemaphore, RSemaphoreAsync, RSet<V>, RSetAsync<V>, RSetCache<V>, RSetCacheAsync<V>, RSetMultimap<K,V>, RSetMultimapCache<K,V>, RStream<K,V>, RStreamAsync<K,V>

All Known Implementing Classes:

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

public interface RExpirableAsync
extends RObjectAsync

Base async interface for all Redisson objects which supports expiration (TTL)

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method and Description
RFuture<Boolean>	clearExpireAsync() Clear an expire timeout or expire date for object in async mode.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit) Set a timeout for object in async mode.
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.
RFuture<Long>	remainTimeToLiveAsync() Remaining time to live of Redisson object that has a timeout

Methods inherited from interface org.redisson.api.RObjectAsync

copyAsync, deleteAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync, touchAsync, unlinkAsync

Method Detail

expireAsync

RFuture<Boolean> expireAsync(long timeToLive,
                             TimeUnit timeUnit)

Set a timeout for object in async mode. After the timeout has expired, the key will automatically be deleted.

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAtAsync

RFuture<Boolean> expireAtAsync(Date timestamp)

Set an expire date for object in async mode. When expire date comes the key will automatically be deleted.

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

expireAtAsync

RFuture<Boolean> expireAtAsync(long timestamp)

Set an expire date for object in async mode. When expire date comes the key will automatically be deleted.

Parameters:

timestamp - - expire date in seconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

clearExpireAsync

RFuture<Boolean> clearExpireAsync()

Clear an expire timeout or expire date for object in async mode. Object will not be deleted.

Returns:

true if the timeout was cleared and false if not

remainTimeToLiveAsync

RFuture<Long> remainTimeToLiveAsync()

Remaining time to live of Redisson object that has a timeout

Returns:

time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.