org.redisson

Class RedissonFairLock

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonLock

org.redisson.RedissonFairLock

All Implemented Interfaces:

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

public class RedissonFairLock
extends RedissonLock
implements RLock

Distributed implementation of Lock 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.RedissonLock

RedissonLock.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 and Description
RedissonFairLock(CommandAsyncExecutor commandExecutor, String name)
RedissonFairLock(CommandAsyncExecutor commandExecutor, String name, long threadWaitTime)

Method Summary

Modifier and Type	Method and Description
protected RFuture<Void>	acquireFailedAsync(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.
RFuture<Boolean>	deleteAsync() Delete object in async mode
boolean	expire(long timeToLive, TimeUnit timeUnit) Set a timeout for object.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit) Set a timeout for object in async mode.
boolean	expireAt(Date timestamp) Set an expire date for object.
boolean	expireAt(long timestamp) Set an expire date for object.
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<Boolean>	forceUnlockAsync() Unlocks the lock independently of state
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
RFuture<Long>	sizeInMemoryAsync() Returns bytes amount used by object in Redis memory.
protected RFuture<RedissonLockEntry>	subscribe(long threadId)
protected RFuture<Boolean>	unlockInnerAsync(long threadId)
protected void	unsubscribe(RFuture<RedissonLockEntry> future, long threadId)

Methods inherited from class org.redisson.RedissonLock

forceUnlock, getEntryName, getHoldCount, getHoldCountAsync, getLockName, isExistsAsync, isHeldByCurrentThread, isHeldByThread, isLocked, isLockedAsync, lock, lock, lockAsync, lockAsync, lockAsync, lockAsync, lockInterruptibly, lockInterruptibly, renewExpirationAsync, tryLock, tryLock, tryLock, tryLockAsync, tryLockAsync, tryLockAsync, tryLockAsync, tryLockAsync, unlock, unlockAsync, unlockAsync

Methods inherited from class org.redisson.RedissonObject

addListener, addListenerAsync, copy, copyAsync, delete, dump, dumpAsync, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getLockByMapKey, getLockByValue, getName, getName, isExists, migrate, migrateAsync, move, moveAsync, prefixName, removeListener, removeListenerAsync, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemory, 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, getHoldCount, getName, isHeldByCurrentThread, isHeldByThread, isLocked, 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

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, 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, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, touchAsync, unlinkAsync

Constructor Detail

RedissonFairLock

public RedissonFairLock(CommandAsyncExecutor commandExecutor,
                        String name)

RedissonFairLock

public RedissonFairLock(CommandAsyncExecutor commandExecutor,
                        String name,
                        long threadWaitTime)

Method Detail

subscribe

protected RFuture<RedissonLockEntry> subscribe(long threadId)

Overrides:

subscribe in class RedissonLock

unsubscribe

protected void unsubscribe(RFuture<RedissonLockEntry> future,
                           long threadId)

Overrides:

unsubscribe in class RedissonLock

acquireFailedAsync

protected RFuture<Void> acquireFailedAsync(long threadId)

Overrides:

acquireFailedAsync in class RedissonLock

unlockInnerAsync

protected RFuture<Boolean> unlockInnerAsync(long threadId)

Overrides:

unlockInnerAsync in class RedissonLock

newCondition

public Condition newCondition()

Specified by:

newCondition in interface Lock

Overrides:

newCondition in class RedissonLock

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 RedissonLock

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)

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

expireAtAsync

public RFuture<Boolean> expireAtAsync(long timestamp)

Description copied from interface: RExpirableAsync

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

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

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

forceUnlockAsync

public RFuture<Boolean> forceUnlockAsync()

Description copied from interface: RLockAsync

Unlocks the lock independently of state

Specified by:

forceUnlockAsync in interface RLockAsync

Overrides:

forceUnlockAsync in class RedissonLock

Returns:

true if lock existed and now unlocked otherwise false

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

expireAt

public boolean expireAt(long timestamp)

Description copied from interface: RExpirable

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

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

expireAt

public boolean expireAt(Date timestamp)

Description copied from interface: RExpirable

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

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

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

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

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.