org.redisson

Class RedissonFairLock

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonLock

org.redisson.RedissonFairLock

All Implemented Interfaces:

Lock, RExpirable, RExpirableAsync, RLock, 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

Field Summary

Fields inherited from class org.redisson.RedissonLock

internalLockLeaseTime, LOCK_EXPIRATION_INTERVAL_SECONDS, PUBSUB

Fields inherited from class org.redisson.RedissonObject

codec

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RedissonFairLock(CommandExecutor commandExecutor, String name, UUID id)

Method Summary

Methods

Modifier and Type	Method and 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.
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()
protected RedissonLockEntry	getEntry(long threadId)
Condition	newCondition()
long	remainTimeToLive() Remaining time to live of Redisson object that has a timeout
RFuture<Long>	remainTimeToLiveAsync() Get remaining time to live of object in seconds.
protected RFuture<RedissonLockEntry>	subscribe(long threadId)
void	unlock()
protected RFuture<Boolean>	unlockInnerAsync(long threadId)
protected void	unsubscribe(RFuture<RedissonLockEntry> future, long threadId)

Methods inherited from class org.redisson.RedissonLock

forceUnlock, getEntryName, getHoldCount, isExistsAsync, isHeldByCurrentThread, isLocked, lock, lock, lockAsync, lockAsync, lockAsync, lockInterruptibly, lockInterruptibly, tryLock, tryLock, tryLock, tryLockAsync, tryLockAsync, tryLockAsync, tryLockAsync, tryLockAsync, unlockAsync, unlockAsync

Methods inherited from class org.redisson.RedissonObject

await, delete, encode, encodeMapKey, encodeMapValue, get, getCodec, getName, isExists, migrate, migrateAsync, move, moveAsync, newPromise, newSucceededFuture, prefixName, rename, renameAsync, renamenx, renamenxAsync

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, isHeldByCurrentThread, isLocked, lock, lockAsync, lockAsync, lockInterruptibly, tryLock, tryLockAsync, tryLockAsync, tryLockAsync, unlockAsync

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

lock, lockInterruptibly, tryLock, tryLock

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObject

delete, getCodec, getName, isExists, migrate, move, rename, renamenx

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync

Constructor Detail

RedissonFairLock

protected RedissonFairLock(CommandExecutor commandExecutor,
                String name,
                UUID id)

Method Detail

getEntry

protected RedissonLockEntry getEntry(long threadId)

Overrides:

getEntry in class RedissonLock

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

unlock

public void unlock()

Specified by:

unlock in interface Lock

Overrides:

unlock 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

forceUnlockAsync

public RFuture<Boolean> forceUnlockAsync()

Specified by:

forceUnlockAsync in interface RLock

Overrides:

forceUnlockAsync in class RedissonLock

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

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

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

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

Get remaining time to live of object in seconds.

Specified by:

remainTimeToLiveAsync in interface RExpirableAsync

Returns:

-1 if object does not exist or time in seconds