Package org.redisson

Class RedissonFencedLock

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonBaseLock

org.redisson.RedissonLock

org.redisson.RedissonFencedLock

All Implemented Interfaces:

Lock, RExpirable, RExpirableAsync, RFencedLock, RFencedLockAsync, RLock, RLockAsync, RObject, RObjectAsync

public class RedissonFencedLock
extends RedissonLock
implements RFencedLock

Redis based implementation of Fenced Lock with reentrancy support.

Each lock acquisition increases fencing token. It should be checked if it's greater or equal with the previous one by the service guarded by this lock and reject operation if condition is false.

Author:

Nikita Koksharov

Nested Class Summary

Nested classes/interfaces inherited from class org.redisson.RedissonBaseLock

RedissonBaseLock.ExpirationEntry

Field Summary

Fields inherited from class org.redisson.RedissonLock

internalLockLeaseTime, pubSub

Fields inherited from class org.redisson.RedissonObject

codec, name

Constructor Summary

Constructors

Constructor	Description
RedissonFencedLock(CommandAsyncExecutor commandExecutor, String name)

Method Summary

Modifier and Type	Method	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.
protected RFuture<Boolean>	clearExpireAsync(String... keys)
RFuture<Boolean>	deleteAsync()	Delete object in async mode
boolean	expire(long timeToLive, TimeUnit timeUnit)	Use RExpirable.expire(Duration) instead
boolean	expire(Duration duration)	Sets a timeout for this object.
boolean	expire(Instant instant)	Sets an expiration date for this object.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit)	Use RExpirableAsync.expireAsync(Duration) instead
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit, String param, String... keys)
RFuture<Boolean>	expireAsync(Duration duration)	Set a timeout for object.
RFuture<Boolean>	expireAsync(Instant instant)	Set an expire date for object.
boolean	expireAt(long timestamp)	Use RExpirable.expire(Instant) instead
boolean	expireAt(Date timestamp)	Use RExpirable.expire(Instant) instead
RFuture<Boolean>	expireAtAsync(long timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
protected RFuture<Boolean>	expireAtAsync(long timestamp, String param, String... keys)
RFuture<Boolean>	expireAtAsync(Date timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
boolean	expireIfGreater(Duration duration)	Sets a timeout for this object only if it's greater than timeout set before.
boolean	expireIfGreater(Instant time)	Sets an expiration date for this object only if it's greater than expiration date set before.
RFuture<Boolean>	expireIfGreaterAsync(Duration duration)	Sets a timeout for this object only if it's greater than timeout set before.
RFuture<Boolean>	expireIfGreaterAsync(Instant time)	Sets an expiration date for this object only if it's greater than expiration date set before.
boolean	expireIfLess(Duration duration)	Sets a timeout for this object only if it's less than timeout set before.
boolean	expireIfLess(Instant time)	Sets an expiration date for this object only if it's less than expiration date set before.
RFuture<Boolean>	expireIfLessAsync(Duration duration)	Sets a timeout for this object only if it's less than timeout set before.
RFuture<Boolean>	expireIfLessAsync(Instant time)	Sets an expiration date for this object only if it's less than expiration date set before.
boolean	expireIfNotSet(Duration duration)	Sets a timeout for this object only if it hasn't been set before.
boolean	expireIfNotSet(Instant time)	Sets an expiration date for this object only if it hasn't been set before.
RFuture<Boolean>	expireIfNotSetAsync(Duration duration)	Sets a timeout for this object only if it hasn't been set before.
RFuture<Boolean>	expireIfNotSetAsync(Instant time)	Sets an expiration date for this object only if it hasn't been set before.
boolean	expireIfSet(Duration duration)	Sets a timeout for this object only if it has been already set.
boolean	expireIfSet(Instant time)	Sets an expiration date for this object only if it has been already set.
RFuture<Boolean>	expireIfSetAsync(Duration duration)	Sets a timeout for this object only if it has been already set.
RFuture<Boolean>	expireIfSetAsync(Instant time)	Sets an expiration date for this object only if it has been already set.
long	getExpireTime()	Returns expiration time of the object as the absolute Unix expiration timestamp in milliseconds.
RFuture<Long>	getExpireTimeAsync()	Returns expiration time of the object as the absolute Unix expiration timestamp in milliseconds.
Long	getToken()	Returns current fencing token
RFuture<Long>	getTokenAsync()	Returns current fencing token
Long	lockAndGetToken()	Acquires the lock and returns increased fencing token.
Long	lockAndGetToken(long leaseTime, TimeUnit unit)	Acquires the lock with defined leaseTime and returns increased fencing token.
RFuture<Long>	lockAndGetTokenAsync()	Acquires the lock and returns increased fencing token.
RFuture<Long>	lockAndGetTokenAsync(long leaseTime, TimeUnit unit)	Acquires the lock with defined leaseTime and returns increased fencing token.
long	remainTimeToLive()	Returns remaining time of the object in milliseconds.
RFuture<Long>	remainTimeToLiveAsync()	Returns remaining time of the object in milliseconds.
RFuture<Long>	sizeInMemoryAsync()	Returns bytes amount used by object in Redis memory.
Long	tryLockAndGetToken()	Tries to acquire the lock and returns increased fencing token if operation successful.
Long	tryLockAndGetToken(long waitTime, long leaseTime, TimeUnit unit)	Tries to acquire the lock with defined leaseTime and returns increased fencing token.
Long	tryLockAndGetToken(long waitTime, TimeUnit unit)	Tries to acquire the lock and returns increased fencing token.
RFuture<Long>	tryLockAndGetTokenAsync()	Tries to acquire the lock and returns increased fencing token if operation successful.
RFuture<Long>	tryLockAndGetTokenAsync(long waitTime, long leaseTime, TimeUnit unit)	Tries to acquire the lock with defined leaseTime and returns increased fencing token.
RFuture<Long>	tryLockAndGetTokenAsync(long waitTime, long leaseTime, TimeUnit unit, long currentThreadId)
RFuture<Long>	tryLockAndGetTokenAsync(long waitTime, TimeUnit unit)	Tries to acquire the lock and returns increased fencing token.

Methods inherited from class org.redisson.RedissonLock

cancelExpirationRenewal, forceUnlockAsync, lock, lock, lockAsync, lockInterruptibly, lockInterruptibly, subscribe, tryLock, tryLock, tryLock, tryLockAsync, tryLockAsync, unlockInnerAsync, unsubscribe

Methods inherited from class org.redisson.RedissonBaseLock

acquireFailed, acquireFailedAsync, copyAsync, evalWriteSyncedNoRetryAsync, forceUnlock, getEntryName, getHoldCount, getHoldCountAsync, getLockName, handleNoSync, isHeldByCurrentThread, isHeldByThread, isHeldByThreadAsync, isLocked, isLockedAsync, lockAsync, lockAsync, lockAsync, newCondition, renewExpirationAsync, scheduleExpirationRenewal, tryLockAsync, tryLockAsync, tryLockAsync, trySuccessFalse, unlock, unlockAsync, unlockAsync, unlockInnerAsync

Methods inherited from class org.redisson.RedissonObject

addListener, addListener, addListener, addListenerAsync, addListenerAsync, addListenerAsync, addListenerId, addTrackingListener, addTrackingListenerAsync, checkNotBatch, copy, copy, copy, copyAndReplace, copyAndReplace, copyAndReplaceAsync, copyAndReplaceAsync, copyAsync, copyAsync, copyAsync, copyAsync, delete, deleteAsync, dump, dumpAsync, encode, encode, encode, encode, encodeMapKey, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getIdleTime, getIdleTimeAsync, getListenerIdsByName, getLockByMapKey, getLockByValue, getName, getNameByListenerId, getRawName, getRawName, getServiceManager, getSubscribeService, isExists, isExistsAsync, map, mapName, migrate, migrateAsync, move, moveAsync, prefixName, removeListener, removeListener, removeListenerAsync, removeListenerAsync, removeListenerAsync, removeListenerId, removeListeners, removeTrackingListener, removeTrackingListenerAsync, rename, renameAsync, renameAsync, renameAsync, renamenx, renamenxAsync, renamenxAsync, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, setName, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, toStream, touch, touchAsync, unlink, unlinkAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.concurrent.locks.Lock

lock, lockInterruptibly, newCondition, tryLock, tryLock, unlock

Methods inherited from interface org.redisson.api.RLock

forceUnlock, getHoldCount, getName, isHeldByCurrentThread, isHeldByThread, isLocked, lock, lockInterruptibly, remainTimeToLive, tryLock

Methods inherited from interface org.redisson.api.RLockAsync

forceUnlockAsync, getHoldCountAsync, isHeldByThreadAsync, isLockedAsync, lockAsync, lockAsync, lockAsync, lockAsync, remainTimeToLiveAsync, tryLockAsync, tryLockAsync, tryLockAsync, tryLockAsync, tryLockAsync, unlockAsync, unlockAsync

Methods inherited from interface org.redisson.api.RObject

addListener, copy, copy, copy, copyAndReplace, copyAndReplace, 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

addListenerAsync, copyAndReplaceAsync, copyAndReplaceAsync, copyAsync, copyAsync, copyAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, touchAsync, unlinkAsync

Constructor Details

RedissonFencedLock

public RedissonFencedLock(CommandAsyncExecutor commandExecutor,
 String name)

Method Details

getToken

public Long getToken()

Description copied from interface: RFencedLock

Returns current fencing token

Specified by:

getToken in interface RFencedLock

Returns:

fencing token

getTokenAsync

public RFuture<Long> getTokenAsync()

Description copied from interface: RFencedLockAsync

Returns current fencing token

Specified by:

getTokenAsync in interface RFencedLockAsync

Returns:

fencing token

lockAndGetToken

public Long lockAndGetToken()

Description copied from interface: RFencedLock

Acquires the lock and returns increased fencing token. Waits if necessary until lock became available.

Specified by:

lockAndGetToken in interface RFencedLock

Returns:

fencing token

lockAndGetTokenAsync

public RFuture<Long> lockAndGetTokenAsync()

Description copied from interface: RFencedLockAsync

Acquires the lock and returns increased fencing token. Waits if necessary until lock became available.

Specified by:

lockAndGetTokenAsync in interface RFencedLockAsync

Returns:

fencing token

lockAndGetToken

public Long lockAndGetToken(long leaseTime,
 TimeUnit unit)

Description copied from interface: RFencedLock

Acquires the lock with defined leaseTime and returns increased fencing token. Waits if necessary until lock became available.

Lock will be released automatically after defined leaseTime interval.

Specified by:

lockAndGetToken in interface RFencedLock

Parameters:

leaseTime - the maximum time to hold the lock after it's acquisition, if it hasn't already been released by invoking unlock. If leaseTime is -1, hold the lock until explicitly unlocked.

unit - the time unit

Returns:

fencing token

lockAndGetTokenAsync

public RFuture<Long> lockAndGetTokenAsync(long leaseTime,
 TimeUnit unit)

Description copied from interface: RFencedLockAsync

Acquires the lock with defined leaseTime and returns increased fencing token. Waits if necessary until lock became available.

Lock will be released automatically after defined leaseTime interval.

Specified by:

lockAndGetTokenAsync in interface RFencedLockAsync

Parameters:

leaseTime - the maximum time to hold the lock after it's acquisition, if it hasn't already been released by invoking unlock. If leaseTime is -1, hold the lock until explicitly unlocked.

unit - the time unit

Returns:

fencing token

tryLockAndGetToken

public Long tryLockAndGetToken()

Description copied from interface: RFencedLock

Tries to acquire the lock and returns increased fencing token if operation successful.

Specified by:

tryLockAndGetToken in interface RFencedLock

Returns:

fencing token if lock acquired otherwise null

tryLockAndGetTokenAsync

public RFuture<Long> tryLockAndGetTokenAsync()

Description copied from interface: RFencedLockAsync

Tries to acquire the lock and returns increased fencing token if operation successful.

Specified by:

tryLockAndGetTokenAsync in interface RFencedLockAsync

Returns:

fencing token if lock acquired otherwise null

tryLockAndGetToken

public Long tryLockAndGetToken(long waitTime,
 long leaseTime,
 TimeUnit unit)

Description copied from interface: RFencedLock

Tries to acquire the lock with defined leaseTime and returns increased fencing token. Waits up to defined waitTime if necessary until the lock became available.

Lock will be released automatically after defined leaseTime interval.

Specified by:

tryLockAndGetToken in interface RFencedLock

Parameters:

waitTime - the maximum time to acquire the lock

leaseTime - lease time

unit - time unit

Returns:

fencing token if lock is successfully acquired, otherwise null if lock is already set.

tryLockAndGetTokenAsync

public RFuture<Long> tryLockAndGetTokenAsync(long waitTime,
 long leaseTime,
 TimeUnit unit)

Description copied from interface: RFencedLockAsync

Tries to acquire the lock with defined leaseTime and returns increased fencing token. Waits up to defined waitTime if necessary until the lock became available.

Lock will be released automatically after defined leaseTime interval.

Specified by:

tryLockAndGetTokenAsync in interface RFencedLockAsync

Parameters:

waitTime - the maximum time to acquire the lock

leaseTime - lease time

unit - time unit

Returns:

fencing token if lock is successfully acquired, otherwise null if lock is already set.

tryLockAndGetToken

public Long tryLockAndGetToken(long waitTime,
 TimeUnit unit)

Description copied from interface: RFencedLock

Tries to acquire the lock and returns increased fencing token. Waits up to defined waitTime if necessary until the lock became available.

Specified by:

tryLockAndGetToken in interface RFencedLock

Parameters:

waitTime - the maximum time to acquire the lock

unit - time unit

Returns:

fencing token if lock is successfully acquired, otherwise null if lock is already set.

tryLockAndGetTokenAsync

public RFuture<Long> tryLockAndGetTokenAsync(long waitTime,
 TimeUnit unit)

Description copied from interface: RFencedLockAsync

Tries to acquire the lock and returns increased fencing token. Waits up to defined waitTime if necessary until the lock became available.

Specified by:

tryLockAndGetTokenAsync in interface RFencedLockAsync

Parameters:

waitTime - the maximum time to acquire the lock

unit - time unit

Returns:

fencing token if lock is successfully acquired, otherwise null if lock is already set.

tryLockAndGetTokenAsync

public RFuture<Long> tryLockAndGetTokenAsync(long waitTime,
 long leaseTime,
 TimeUnit unit,
 long currentThreadId)

deleteAsync

public RFuture<Boolean> deleteAsync()

Description copied from interface: RObjectAsync

Delete object in async mode

Specified by:

deleteAsync in interface RObjectAsync

Overrides:

deleteAsync in class RedissonBaseLock

Returns:

true if object was deleted false if not

sizeInMemoryAsync

public RFuture<Long> sizeInMemoryAsync()

Description copied from interface: RObjectAsync

Returns bytes amount used by object in Redis memory.

Specified by:

sizeInMemoryAsync in interface RObjectAsync

Overrides:

sizeInMemoryAsync in class RedissonObject

Returns:

size in bytes

expireAsync

public RFuture<Boolean> expireAsync(long timeToLive,
 TimeUnit timeUnit,
 String param,
 String... keys)

expireAtAsync

protected RFuture<Boolean> expireAtAsync(long timestamp,
 String param,
 String... keys)

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

expire

public boolean expire(long timeToLive,
 TimeUnit timeUnit)

Description copied from interface: RExpirable

Use RExpirable.expire(Duration) instead

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

Use RExpirableAsync.expireAsync(Duration) instead

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 RFuture<Boolean> 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 instant)

Description copied from interface: RExpirable

Sets an expiration date for this 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

expireIfSet

public boolean expireIfSet(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it has been already set. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfSet in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfSetAsync

public RFuture<Boolean> expireIfSetAsync(Instant time)

Description copied from interface: RExpirableAsync

Sets an expiration date for this object only if it has been already set. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfSetAsync in interface RExpirableAsync

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfNotSet

public boolean expireIfNotSet(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it hasn't been set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfNotSet in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfNotSetAsync

public RFuture<Boolean> expireIfNotSetAsync(Instant time)

Description copied from interface: RExpirableAsync

Sets an expiration date for this object only if it hasn't been set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfNotSetAsync in interface RExpirableAsync

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfGreater

public boolean expireIfGreater(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it's greater than expiration date set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfGreater in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfGreaterAsync

public RFuture<Boolean> expireIfGreaterAsync(Instant time)

Description copied from interface: RExpirableAsync

Sets an expiration date for this object only if it's greater than expiration date set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfGreaterAsync in interface RExpirableAsync

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfLess

public boolean expireIfLess(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it's less than expiration date set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfLess in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfLessAsync

public RFuture<Boolean> expireIfLessAsync(Instant time)

Description copied from interface: RExpirableAsync

Sets an expiration date for this object only if it's less than expiration date set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfLessAsync in interface RExpirableAsync

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireAsync

public RFuture<Boolean> expireAsync(Instant 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

expire

public boolean expire(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object. After the timeout has expired, the key will automatically be deleted.

Specified by:

expire in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireAsync

public RFuture<Boolean> expireAsync(Duration duration)

Description copied from interface: RExpirableAsync

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

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(Date 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 RFuture<Boolean> expireAtAsync(Date 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

expireIfSet

public boolean expireIfSet(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it has been already set. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfSet in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfSetAsync

public RFuture<Boolean> expireIfSetAsync(Duration duration)

Description copied from interface: RExpirableAsync

Sets a timeout for this object only if it has been already set. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfSetAsync in interface RExpirableAsync

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfNotSet

public boolean expireIfNotSet(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it hasn't been set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfNotSet in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfNotSetAsync

public RFuture<Boolean> expireIfNotSetAsync(Duration duration)

Description copied from interface: RExpirableAsync

Sets a timeout for this object only if it hasn't been set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfNotSetAsync in interface RExpirableAsync

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfGreater

public boolean expireIfGreater(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it's greater than timeout set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfGreater in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfGreaterAsync

public RFuture<Boolean> expireIfGreaterAsync(Duration duration)

Description copied from interface: RExpirableAsync

Sets a timeout for this object only if it's greater than timeout set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfGreaterAsync in interface RExpirableAsync

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfLess

public boolean expireIfLess(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it's less than timeout set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfLess in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfLessAsync

public RFuture<Boolean> expireIfLessAsync(Duration duration)

Description copied from interface: RExpirableAsync

Sets a timeout for this object only if it's less than timeout set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfLessAsync in interface RExpirableAsync

Parameters:

duration - timeout before object will be deleted

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

remainTimeToLive

public long remainTimeToLive()

Description copied from interface: RExpirable

Returns remaining time of the object in milliseconds.

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

Returns remaining time of the object in milliseconds.

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.

getExpireTime

public long getExpireTime()

Description copied from interface: RExpirable

Returns expiration time of the object as the absolute Unix expiration timestamp in milliseconds.

Requires Redis 7.0.0 and higher.

Specified by:

getExpireTime in interface RExpirable

Returns:

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

getExpireTimeAsync

public RFuture<Long> getExpireTimeAsync()

Description copied from interface: RExpirableAsync

Returns expiration time of the object as the absolute Unix expiration timestamp in milliseconds.

Requires Redis 7.0.0 and higher.

Specified by:

getExpireTimeAsync in interface RExpirableAsync

Returns:

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

clearExpireAsync

protected RFuture<Boolean> clearExpireAsync(String... keys)