Package org.redisson

Class RedissonLock

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonBaseLock

org.redisson.RedissonLock

All Implemented Interfaces:

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

Direct Known Subclasses:

RedissonFairLock, RedissonReadLock, RedissonTransactionalLock, RedissonWriteLock

public class RedissonLock
extends RedissonBaseLock

Distributed implementation of Lock Implements reentrant lock.
Lock will be removed automatically if client disconnects.

Implements a non-fair locking so doesn't guarantees an acquire order.

Author:

Nikita Koksharov

Nested Class Summary

Nested classes/interfaces inherited from class org.redisson.RedissonBaseLock

RedissonBaseLock.ExpirationEntry

Field Summary

Fields

Modifier and Type	Field	Description
protected long	internalLockLeaseTime
protected LockPubSub	pubSub

Fields inherited from class org.redisson.RedissonObject

codec, name

Constructor Summary

Constructors

Constructor	Description
RedissonLock(CommandAsyncExecutor commandExecutor, String name)

Method Summary

Modifier and Type	Method	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.
protected RFuture<Boolean>	clearExpireAsync(String... keys)
boolean	expire(long timeToLive, TimeUnit timeUnit)	Set a timeout for object.
boolean	expire(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)
RFuture<Boolean>	expireAsync(Instant instant)	Set an expire date for object.
boolean	expireAt(long timestamp)	Use RExpirable.expire(Instant) instead
boolean	expireAt(Date timestamp)	Use RExpirable.expire(Instant) instead
RFuture<Boolean>	expireAtAsync(long timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
protected RFuture<Boolean>	expireAtAsync(long timestamp, String... keys)
RFuture<Boolean>	expireAtAsync(Date timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
boolean	forceUnlock()	Unlocks the lock independently of its state
RFuture<Boolean>	forceUnlockAsync()	Unlocks the lock independently of its state
void	lock()
void	lock(long leaseTime, TimeUnit unit)	Acquires the lock with defined leaseTime.
RFuture<Void>	lockAsync()	Acquires the lock.
RFuture<Void>	lockAsync(long currentThreadId)	Acquires the lock by thread with defined threadId.
RFuture<Void>	lockAsync(long leaseTime, TimeUnit unit)	Acquires the lock with defined leaseTime.
RFuture<Void>	lockAsync(long leaseTime, TimeUnit unit, long currentThreadId)	Acquires the lock with defined leaseTime and threadId.
void	lockInterruptibly()
void	lockInterruptibly(long leaseTime, TimeUnit unit)	Acquires the lock with defined leaseTime.
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<RedissonLockEntry>	subscribe(long threadId)
boolean	tryLock()
boolean	tryLock(long waitTime, long leaseTime, TimeUnit unit)	Tries to acquire the lock with defined leaseTime.
boolean	tryLock(long waitTime, TimeUnit unit)
RFuture<Boolean>	tryLockAsync()	Tries to acquire the lock.
RFuture<Boolean>	tryLockAsync(long threadId)	Tries to acquire the lock by thread with specified threadId.
RFuture<Boolean>	tryLockAsync(long waitTime, long leaseTime, TimeUnit unit)	Tries to acquire the lock with defined leaseTime.
RFuture<Boolean>	tryLockAsync(long waitTime, long leaseTime, TimeUnit unit, long currentThreadId)	Tries to acquire the lock by thread with specified threadId and leaseTime.
RFuture<Boolean>	tryLockAsync(long waitTime, TimeUnit unit)	Tries to acquire the lock.
void	unlock()
protected RFuture<Boolean>	unlockInnerAsync(long threadId)
protected void	unsubscribe(RFuture<RedissonLockEntry> future, long threadId)

Methods inherited from class org.redisson.RedissonBaseLock

acquireFailed, acquireFailedAsync, cancelExpirationRenewal, deleteAsync, evalWriteAsync, getEntryName, getHoldCount, getHoldCountAsync, getLockName, isHeldByCurrentThread, isHeldByThread, isLocked, isLockedAsync, newCondition, 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, 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

getName, remainTimeToLive

Methods inherited from interface org.redisson.api.RLockAsync

remainTimeToLiveAsync

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

pubSub

protected final LockPubSub pubSub

Constructor Detail

RedissonLock

public RedissonLock(CommandAsyncExecutor commandExecutor,
                    String name)

Method Detail

lock

public void lock()

lock

public void lock(long leaseTime,
                 TimeUnit unit)

Description copied from interface: RLock

Acquires the lock with defined leaseTime. Waits if necessary until lock became available. Lock will be released automatically after defined leaseTime interval.

Parameters:

leaseTime - the maximum time to hold the lock after it's acquisition, if it hasn't already been released by invoking unlock. If leaseTime is -1, hold the lock until explicitly unlocked.

unit - the time unit

lockInterruptibly

public void lockInterruptibly()
                       throws InterruptedException

Throws:

InterruptedException

lockInterruptibly

public void lockInterruptibly(long leaseTime,
                              TimeUnit unit)
                       throws InterruptedException

Description copied from interface: RLock

Acquires the lock with defined leaseTime. Waits if necessary until lock became available. Lock will be released automatically after defined leaseTime interval.

Parameters:

leaseTime - the maximum time to hold the lock after it's acquisition, if it hasn't already been released by invoking unlock. If leaseTime is -1, hold the lock until explicitly unlocked.

unit - the time unit

Throws:

InterruptedException - - if the thread is interrupted

tryLock

public boolean tryLock()

tryLock

public boolean tryLock(long waitTime,
                       long leaseTime,
                       TimeUnit unit)
                throws InterruptedException

Description copied from interface: RLock

Tries to acquire the lock with defined leaseTime. Waits up to defined waitTime if necessary until the lock became available. Lock will be released automatically after defined leaseTime interval.

Parameters:

waitTime - the maximum time to acquire the lock

leaseTime - lease time

unit - time unit

Returns:

true if lock is successfully acquired, otherwise false if lock is already set.

Throws:

InterruptedException - - if the thread is interrupted

subscribe

protected RFuture<RedissonLockEntry> subscribe(long threadId)

unsubscribe

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

tryLock

public boolean tryLock(long waitTime,
                       TimeUnit unit)
                throws InterruptedException

Throws:

InterruptedException

unlock

public void unlock()

forceUnlock

public boolean forceUnlock()

Description copied from interface: RLock

Unlocks the lock independently of its state

Returns:

true if lock existed and now unlocked otherwise false

forceUnlockAsync

public RFuture<Boolean> forceUnlockAsync()

Description copied from interface: RLockAsync

Unlocks the lock independently of its state

Returns:

true if lock existed and now unlocked otherwise false

unlockInnerAsync

protected RFuture<Boolean> unlockInnerAsync(long threadId)

Specified by:

unlockInnerAsync in class RedissonBaseLock

lockAsync

public RFuture<Void> lockAsync()

Description copied from interface: RLockAsync

Acquires the lock. Waits if necessary until lock became available.

Returns:

void

lockAsync

public RFuture<Void> lockAsync(long leaseTime,
                               TimeUnit unit)

Description copied from interface: RLockAsync

Acquires the lock with defined leaseTime. Waits if necessary until lock became available. Lock will be released automatically after defined leaseTime interval.

Parameters:

leaseTime - the maximum time to hold the lock after it's acquisition, if it hasn't already been released by invoking unlock. If leaseTime is -1, hold the lock until explicitly unlocked.

unit - the time unit

Returns:

void

lockAsync

public RFuture<Void> lockAsync(long currentThreadId)

Description copied from interface: RLockAsync

Acquires the lock by thread with defined threadId. Waits if necessary until lock became available.

Parameters:

currentThreadId - id of thread

Returns:

void

lockAsync

public RFuture<Void> lockAsync(long leaseTime,
                               TimeUnit unit,
                               long currentThreadId)

Description copied from interface: RLockAsync

Acquires the lock with defined leaseTime and threadId. Waits if necessary until lock became available. Lock will be released automatically after defined leaseTime interval.

Parameters:

leaseTime - the maximum time to hold the lock after it's acquisition, if it hasn't already been released by invoking unlock. If leaseTime is -1, hold the lock until explicitly unlocked.

unit - the time unit

currentThreadId - id of thread

Returns:

void

tryLockAsync

public RFuture<Boolean> tryLockAsync()

Description copied from interface: RLockAsync

Tries to acquire the lock.

Returns:

true if lock acquired otherwise false

tryLockAsync

public RFuture<Boolean> tryLockAsync(long threadId)

Description copied from interface: RLockAsync

Tries to acquire the lock by thread with specified threadId.

Parameters:

threadId - id of thread

Returns:

true if lock acquired otherwise false

tryLockAsync

public RFuture<Boolean> tryLockAsync(long waitTime,
                                     TimeUnit unit)

Description copied from interface: RLockAsync

Tries to acquire the lock. Waits up to defined waitTime if necessary until the lock became available.

Parameters:

waitTime - the maximum time to acquire the lock

unit - time unit

Returns:

true if lock is successfully acquired, otherwise false if lock is already set.

tryLockAsync

public RFuture<Boolean> tryLockAsync(long waitTime,
                                     long leaseTime,
                                     TimeUnit unit)

Description copied from interface: RLockAsync

Tries to acquire the lock with defined leaseTime. Waits up to defined waitTime if necessary until the lock became available. Lock will be released automatically after defined leaseTime interval.

Parameters:

waitTime - the maximum time to acquire the lock

leaseTime - lease time

unit - time unit

Returns:

true if lock is successfully acquired, otherwise false if lock is already set.

tryLockAsync

public RFuture<Boolean> tryLockAsync(long waitTime,
                                     long leaseTime,
                                     TimeUnit unit,
                                     long currentThreadId)

Description copied from interface: RLockAsync

Tries to acquire the lock by thread with specified threadId and leaseTime. Waits up to defined waitTime if necessary until the lock became available. Lock will be released automatically after defined leaseTime interval.

Parameters:

waitTime - time interval to acquire lock

leaseTime - time interval after which lock will be released automatically

unit - the time unit of the waitTime and leaseTime arguments

currentThreadId - id of thread

Returns:

true if lock acquired 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

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)