Package org.redisson
Class RedissonBaseLock
-
- org.redisson.RedissonObject
-
- org.redisson.RedissonBaseLock
-
- All Implemented Interfaces:
,
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 Description static class
RedissonBaseLock.ExpirationEntry
-
Field Summary
Fields Modifier and Type Field Description protected long
internalLockLeaseTime
-
Fields inherited from class org.redisson.RedissonObject
codec, name
-
-
Constructor Summary
Constructors Constructor Description RedissonBaseLock(CommandAsyncExecutor commandExecutor, name)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected void
acquireFailed(long waitTime, unit, long threadId)
protected >
acquireFailedAsync(long waitTime, unit, long threadId)
protected void
threadId)
boolean
clearExpire()
Clear an expire timeout or expire date for object.>
clearExpireAsync()
Clear an expire timeout or expire date for object in async mode.protected >
... keys)
>
deleteAsync()
Delete object in async modeprotected <T> RFuture<T>
key, Codec codec, RedisCommand<T> evalCommandType, script, <> keys, ... params)
boolean
expire(long timeToLive, timeUnit)
Set a timeout for object.boolean
instant)
Set an expire date for object.>
expireAsync(long timeToLive, timeUnit)
Set a timeout for object in async mode.protected >
expireAsync(long timeToLive, timeUnit, ... keys)
>
instant)
Set an expire date for object.boolean
expireAt(long timestamp)
UseRExpirable.expire(Instant)
insteadboolean
timestamp)
UseRExpirable.expire(Instant)
instead>
expireAtAsync(long timestamp)
UseRExpirableAsync.expireAsync(Instant)
insteadprotected >
expireAtAsync(long timestamp, ... keys)
>
timestamp)
UseRExpirableAsync.expireAsync(Instant)
insteadprotected
getEntryName()
int
getHoldCount()
Number of holds on this lock by the current thread>
getHoldCountAsync()
Number of holds on this lock by the current threadprotected
getLockName(long threadId)
boolean
isHeldByCurrentThread()
Checks if this lock is held by the current threadboolean
isHeldByThread(long threadId)
Checks if the lock is held by thread with definedthreadId
boolean
isLocked()
Checks if the lock locked by any thread>
isLockedAsync()
Checks if the lock locked by any threadnewCondition()
long
remainTimeToLive()
Remaining time to live of Redisson object that has a timeout>
remainTimeToLiveAsync()
Remaining time to live of Redisson object that has a timeoutprotected >
renewExpirationAsync(long threadId)
protected void
scheduleExpirationRenewal(long threadId)
>
unlockAsync()
Unlocks the lock>
unlockAsync(long threadId)
Unlocks the lock.protected abstract >
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 interface org.redisson.api.RLock
forceUnlock, getName, lock, lockInterruptibly, remainTimeToLive, tryLock
-
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
-
-
-
-
Constructor Detail
-
RedissonBaseLock
public RedissonBaseLock(CommandAsyncExecutor commandExecutor, name)
-
-
Method Detail
-
getEntryName
protected getEntryName()
-
getLockName
protected getLockName(long threadId)
-
scheduleExpirationRenewal
protected void scheduleExpirationRenewal(long threadId)
-
renewExpirationAsync
protected > renewExpirationAsync(long threadId)
-
cancelExpirationRenewal
protected void cancelExpirationRenewal( threadId)
-
evalWriteAsync
protected <T> key, Codec codec, RedisCommand<T> evalCommandType, script, <> keys, ... params)
-
acquireFailed
protected void acquireFailed(long waitTime, unit, long threadId)
-
acquireFailedAsync
protected > acquireFailedAsync(long waitTime, unit, long threadId)
-
newCondition
public newCondition()
- Specified by:
in interface
-
isLocked
public boolean isLocked()
Description copied from interface:RLock
Checks if the lock locked by any thread
-
isLockedAsync
public > isLockedAsync()
Description copied from interface:RLockAsync
Checks if the lock locked by any thread- Specified by:
isLockedAsync
in interfaceRLockAsync
- Returns:
true
if locked otherwisefalse
-
isHeldByCurrentThread
public boolean isHeldByCurrentThread()
Description copied from interface:RLock
Checks if this lock is held by the current thread- Specified by:
isHeldByCurrentThread
in interfaceRLock
- Returns:
true
if held by current thread otherwisefalse
-
isHeldByThread
public boolean isHeldByThread(long threadId)
Description copied from interface:RLock
Checks if the lock is held by thread with definedthreadId
- Specified by:
isHeldByThread
in interfaceRLock
- Parameters:
threadId
- Thread ID of locking thread- Returns:
true
if held by thread with given id otherwisefalse
-
getHoldCountAsync
public > getHoldCountAsync()
Description copied from interface:RLockAsync
Number of holds on this lock by the current thread- Specified by:
getHoldCountAsync
in interfaceRLockAsync
- 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 interfaceRLock
- Returns:
- holds or
0
if this lock is not held by current thread
-
deleteAsync
public > deleteAsync()
Description copied from interface:RObjectAsync
Delete object in async mode- Specified by:
deleteAsync
in interfaceRObjectAsync
- Overrides:
deleteAsync
in classRedissonObject
- Returns:
true
if object was deletedfalse
if not
-
unlockAsync
public > unlockAsync()
Description copied from interface:RLockAsync
Unlocks the lock- Specified by:
unlockAsync
in interfaceRLockAsync
- Returns:
- void
-
unlockAsync
public > unlockAsync(long threadId)
Description copied from interface:RLockAsync
Unlocks the lock. Throws if lock isn't locked by thread with specifiedthreadId
.- Specified by:
unlockAsync
in interfaceRLockAsync
- Parameters:
threadId
- id of thread- Returns:
- void
-
unlockInnerAsync
protected abstract > unlockInnerAsync(long threadId)
-
expire
public boolean expire(long timeToLive, 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 interfaceRExpirable
- Parameters:
timeToLive
- - timeout before object will be deletedtimeUnit
- - timeout time unit- Returns:
true
if the timeout was set andfalse
if not
-
expireAsync
public > expireAsync(long timeToLive, 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 interfaceRExpirableAsync
- Parameters:
timeToLive
- - timeout before object will be deletedtimeUnit
- - timeout time unit- Returns:
true
if the timeout was set andfalse
if not
-
expireAt
public boolean expireAt(long timestamp)
Description copied from interface:RExpirable
UseRExpirable.expire(Instant)
instead- Specified by:
expireAt
in interfaceRExpirable
- Parameters:
timestamp
- - expire date in milliseconds (Unix timestamp)- Returns:
true
if the timeout was set andfalse
if not
-
expireAtAsync
public > expireAtAsync(long timestamp)
Description copied from interface:RExpirableAsync
UseRExpirableAsync.expireAsync(Instant)
instead- Specified by:
expireAtAsync
in interfaceRExpirableAsync
- Parameters:
timestamp
- - expire date in milliseconds (Unix timestamp)- Returns:
true
if the timeout was set andfalse
if not
-
expire
public boolean expire( 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 interfaceRExpirable
- Parameters:
instant
- - expire date- Returns:
true
if the timeout was set andfalse
if not
-
expireAsync
public > expireAsync( 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 interfaceRExpirableAsync
- Parameters:
instant
- - expire date- Returns:
true
if the timeout was set andfalse
if not
-
expireAt
public boolean expireAt( timestamp)
Description copied from interface:RExpirable
UseRExpirable.expire(Instant)
instead- Specified by:
expireAt
in interfaceRExpirable
- Parameters:
timestamp
- - expire date- Returns:
true
if the timeout was set andfalse
if not
-
expireAtAsync
public > expireAtAsync( timestamp)
Description copied from interface:RExpirableAsync
UseRExpirableAsync.expireAsync(Instant)
instead- Specified by:
expireAtAsync
in interfaceRExpirableAsync
- Parameters:
timestamp
- - expire date- Returns:
true
if the timeout was set andfalse
if not
-
clearExpire
public boolean clearExpire()
Description copied from interface:RExpirable
Clear an expire timeout or expire date for object.- Specified by:
clearExpire
in interfaceRExpirable
- Returns:
true
if timeout was removedfalse
if object does not exist or does not have an associated timeout
-
clearExpireAsync
public > 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 interfaceRExpirableAsync
- Returns:
true
if the timeout was cleared andfalse
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 interfaceRExpirable
- Returns:
- time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.
-
remainTimeToLiveAsync
public > remainTimeToLiveAsync()
Description copied from interface:RExpirableAsync
Remaining time to live of Redisson object that has a timeout- Specified by:
remainTimeToLiveAsync
in interfaceRExpirableAsync
- Returns:
- time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.
-
expireAsync
protected > expireAsync(long timeToLive, timeUnit, ... keys)
-
expireAtAsync
protected > expireAtAsync(long timestamp, ... keys)
-
clearExpireAsync
protected > clearExpireAsync(... keys)
-
-