Package org.redisson
Class RedissonFairLock
-
- org.redisson.RedissonObject
-
- org.redisson.RedissonBaseLock
-
- org.redisson.RedissonLock
-
- org.redisson.RedissonFairLock
-
- All Implemented Interfaces:
,
RExpirable
,RExpirableAsync
,RLock
,RLockAsync
,RObject
,RObjectAsync
public class RedissonFairLock extends RedissonLock implements RLock
Distributed implementation of Implements reentrant lock.
Lock will be removed automatically if client disconnects.Implements a fair locking so it guarantees an acquire order by threads.
- 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 RedissonFairLock(CommandAsyncExecutor commandExecutor, name)
RedissonFairLock(CommandAsyncExecutor commandExecutor, name, long threadWaitTime)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected >
acquireFailedAsync(long waitTime, unit, long 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 modeboolean
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)
instead>
forceUnlockAsync()
Unlocks the lock independently of its statenewCondition()
long
remainTimeToLive()
Remaining time to live of Redisson object that has a timeout>
remainTimeToLiveAsync()
Remaining time to live of Redisson object that has a timeout>
sizeInMemoryAsync()
Returns bytes amount used by object in Redis memory.protected RFuture<RedissonLockEntry>
subscribe(long threadId)
protected >
unlockInnerAsync(long threadId)
protected void
unsubscribe(RFuture<RedissonLockEntry> future, long threadId)
-
Methods inherited from class org.redisson.RedissonLock
forceUnlock, lock, lock, lockAsync, lockAsync, lockAsync, lockAsync, lockInterruptibly, lockInterruptibly, tryLock, tryLock, tryLock, tryLockAsync, tryLockAsync, tryLockAsync, tryLockAsync, tryLockAsync, unlock
-
Methods inherited from class org.redisson.RedissonBaseLock
acquireFailed, cancelExpirationRenewal, evalWriteAsync, getEntryName, getHoldCount, getHoldCountAsync, getLockName, isHeldByCurrentThread, isHeldByThread, isLocked, isLockedAsync, renewExpirationAsync, scheduleExpirationRenewal, unlockAsync, unlockAsync
-
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, suffixName, toSeconds, toStream, touch, touchAsync, unlink, unlinkAsync
-
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
getHoldCountAsync, isLockedAsync, lockAsync, lockAsync, lockAsync, lockAsync, remainTimeToLiveAsync, tryLockAsync, tryLockAsync, tryLockAsync, tryLockAsync, tryLockAsync, unlockAsync, unlockAsync
-
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, touchAsync, unlinkAsync
-
-
-
-
Constructor Detail
-
RedissonFairLock
public RedissonFairLock(CommandAsyncExecutor commandExecutor, name)
-
RedissonFairLock
public RedissonFairLock(CommandAsyncExecutor commandExecutor, name, long threadWaitTime)
-
-
Method Detail
-
subscribe
protected RFuture<RedissonLockEntry> subscribe(long threadId)
- Overrides:
subscribe
in classRedissonLock
-
unsubscribe
protected void unsubscribe(RFuture<RedissonLockEntry> future, long threadId)
- Overrides:
unsubscribe
in classRedissonLock
-
acquireFailedAsync
protected > acquireFailedAsync(long waitTime, unit, long threadId)
- Overrides:
acquireFailedAsync
in classRedissonBaseLock
-
unlockInnerAsync
protected > unlockInnerAsync(long threadId)
- Overrides:
unlockInnerAsync
in classRedissonLock
-
newCondition
public newCondition()
- Specified by:
in interface
- Overrides:
newCondition
in classRedissonBaseLock
-
deleteAsync
public > deleteAsync()
Description copied from interface:RObjectAsync
Delete object in async mode- Specified by:
deleteAsync
in interfaceRObjectAsync
- Overrides:
deleteAsync
in classRedissonBaseLock
- Returns:
true
if object was deletedfalse
if not
-
sizeInMemoryAsync
public > sizeInMemoryAsync()
Description copied from interface:RObjectAsync
Returns bytes amount used by object in Redis memory.- Specified by:
sizeInMemoryAsync
in interfaceRObjectAsync
- Overrides:
sizeInMemoryAsync
in classRedissonObject
- Returns:
- size in bytes
-
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
-
expireAtAsync
protected > expireAtAsync(long timestamp, ... keys)
-
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
-
forceUnlockAsync
public > forceUnlockAsync()
Description copied from interface:RLockAsync
Unlocks the lock independently of its state- Specified by:
forceUnlockAsync
in interfaceRLockAsync
- Overrides:
forceUnlockAsync
in classRedissonLock
- Returns:
true
if lock existed and now unlocked otherwisefalse
-
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
-
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
-
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)
-
clearExpireAsync
protected > clearExpireAsync(... keys)
-
-