org.redisson

Class RedissonBaseLock

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonBaseLock

All Implemented Interfaces:

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

Direct Known Subclasses:

RedissonLock, RedissonSpinLock

public abstract class RedissonBaseLock
extends RedissonObject
implements RLock

Base class for implementing distributed locks

Author:

Danila Varatyntsev, Nikita Koksharov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RedissonBaseLock.ExpirationEntry

Field Summary

Fields

Modifier and Type	Field and Description
protected long	internalLockLeaseTime

Fields inherited from class org.redisson.RedissonObject

codec, name

Constructor Summary

Constructors

Constructor and Description
RedissonBaseLock(CommandAsyncExecutor commandExecutor, String name)

Method Summary

Modifier and Type	Method and Description
protected void	acquireFailed(long waitTime, TimeUnit unit, long threadId)
protected RFuture<Void>	acquireFailedAsync(long waitTime, TimeUnit unit, long threadId)
protected void	cancelExpirationRenewal(Long threadId)
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
protected <T> RFuture<T>	evalWriteAsync(String key, Codec codec, RedisCommand<T> evalCommandType, String script, List<Object> keys, Object... params)
boolean	expire(Instant instant) Set an expire date for object.
boolean	expire(long timeToLive, TimeUnit timeUnit) Set a timeout for object.
RFuture<Boolean>	expireAsync(Instant instant) Set an expire date for object.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit) Set a timeout for object in async mode.
protected RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit, String... keys)
boolean	expireAt(Date timestamp) Use RExpirable.expire(Instant) instead
boolean	expireAt(long timestamp) Use RExpirable.expire(Instant) instead
RFuture<Boolean>	expireAtAsync(Date timestamp) Use RExpirableAsync.expireAsync(Instant) instead
RFuture<Boolean>	expireAtAsync(long timestamp) Use RExpirableAsync.expireAsync(Instant) instead
protected RFuture<Boolean>	expireAtAsync(long timestamp, String... keys)
protected String	getEntryName()
int	getHoldCount() Number of holds on this lock by the current thread
RFuture<Integer>	getHoldCountAsync() Number of holds on this lock by the current thread
protected String	getLockName(long threadId)
boolean	isHeldByCurrentThread() Checks if this lock is held by the current thread
boolean	isHeldByThread(long threadId) Checks if the lock is held by thread with defined threadId
boolean	isLocked() Checks if the lock locked by any thread
RFuture<Boolean>	isLockedAsync() Checks if the lock locked by any thread
Condition	newCondition()
long	remainTimeToLive() Remaining time to live of Redisson object that has a timeout
RFuture<Long>	remainTimeToLiveAsync() Remaining time to live of Redisson object that has a timeout
protected RFuture<Boolean>	renewExpirationAsync(long threadId)
protected void	scheduleExpirationRenewal(long threadId)
RFuture<Void>	unlockAsync() Unlocks the lock
RFuture<Void>	unlockAsync(long threadId) Unlocks the lock.
protected abstract RFuture<Boolean>	unlockInnerAsync(long threadId)

Methods inherited from class org.redisson.RedissonObject

addListener, addListener, addListenerAsync, addListenerAsync, copy, copyAsync, delete, 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.Object

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

Methods inherited from interface org.redisson.api.RLock

forceUnlock, getName, lock, lockInterruptibly, remainTimeToLive, tryLock

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

lock, lockInterruptibly, tryLock, tryLock, unlock

Methods inherited from interface org.redisson.api.RLockAsync

forceUnlockAsync, lockAsync, lockAsync, lockAsync, lockAsync, remainTimeToLiveAsync, tryLockAsync, tryLockAsync, tryLockAsync, tryLockAsync, tryLockAsync

Methods inherited from interface org.redisson.api.RObject

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

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

Field Detail

internalLockLeaseTime

protected long internalLockLeaseTime

Constructor Detail

RedissonBaseLock

public RedissonBaseLock(CommandAsyncExecutor commandExecutor,
                        String name)

Method Detail

getEntryName

protected String getEntryName()

getLockName

protected String getLockName(long threadId)

scheduleExpirationRenewal

protected void scheduleExpirationRenewal(long threadId)

renewExpirationAsync

protected RFuture<Boolean> renewExpirationAsync(long threadId)

cancelExpirationRenewal

protected void cancelExpirationRenewal(Long threadId)

evalWriteAsync

protected <T> RFuture<T> evalWriteAsync(String key,
                                        Codec codec,
                                        RedisCommand<T> evalCommandType,
                                        String script,
                                        List<Object> keys,
                                        Object... params)

acquireFailed

protected void acquireFailed(long waitTime,
                             TimeUnit unit,
                             long threadId)

acquireFailedAsync

protected RFuture<Void> acquireFailedAsync(long waitTime,
                                           TimeUnit unit,
                                           long threadId)

newCondition

public Condition newCondition()

Specified by:

newCondition in interface Lock

isLocked

public boolean isLocked()

Description copied from interface: RLock

Checks if the lock locked by any thread

Specified by:

isLocked in interface RLock

Returns:

true if locked otherwise false

isLockedAsync

public RFuture<Boolean> isLockedAsync()

Description copied from interface: RLockAsync

Checks if the lock locked by any thread

Specified by:

isLockedAsync in interface RLockAsync

Returns:

true if locked otherwise false

isHeldByCurrentThread

public boolean isHeldByCurrentThread()

Description copied from interface: RLock

Checks if this lock is held by the current thread

Specified by:

isHeldByCurrentThread in interface RLock

Returns:

true if held by current thread otherwise false

isHeldByThread

public boolean isHeldByThread(long threadId)

Description copied from interface: RLock

Checks if the lock is held by thread with defined threadId

Specified by:

isHeldByThread in interface RLock

Parameters:

threadId - Thread ID of locking thread

Returns:

true if held by thread with given id otherwise false

getHoldCountAsync

public RFuture<Integer> getHoldCountAsync()

Description copied from interface: RLockAsync

Number of holds on this lock by the current thread

Specified by:

getHoldCountAsync in interface RLockAsync

Returns:

holds or 0 if this lock is not held by current thread

getHoldCount

public int getHoldCount()

Description copied from interface: RLock

Number of holds on this lock by the current thread

Specified by:

getHoldCount in interface RLock

Returns:

holds or 0 if this lock is not held by current thread

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 RedissonObject

Returns:

true if object was deleted false if not

unlockAsync

public RFuture<Void> unlockAsync()

Description copied from interface: RLockAsync

Unlocks the lock

Specified by:

unlockAsync in interface RLockAsync

Returns:

void

unlockAsync

public RFuture<Void> unlockAsync(long threadId)

Description copied from interface: RLockAsync

Unlocks the lock. Throws IllegalMonitorStateException if lock isn't locked by thread with specified threadId.

Specified by:

unlockAsync in interface RLockAsync

Parameters:

threadId - id of thread

Returns:

void

unlockInnerAsync

protected abstract RFuture<Boolean> unlockInnerAsync(long threadId)

expire

public boolean expire(long timeToLive,
                      TimeUnit 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 RFuture<Boolean> expireAsync(long timeToLive,
                                    TimeUnit 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 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

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 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

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

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 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

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 RFuture<Long> 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 RFuture<Boolean> expireAsync(long timeToLive,
                                       TimeUnit timeUnit,
                                       String... keys)

expireAtAsync

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

clearExpireAsync

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