Package org.redisson
Class RedissonSpinLock
- java.lang.Object
-
- org.redisson.RedissonObject
-
- org.redisson.RedissonBaseLock
-
- org.redisson.RedissonSpinLock
-
- All Implemented Interfaces:
Lock
,RExpirable
,RExpirableAsync
,RLock
,RLockAsync
,RObject
,RObjectAsync
public class RedissonSpinLock extends RedissonBaseLock
Distributed implementation ofLock
Implements reentrant lock.
Lock will be removed automatically if client disconnects. This lock implementation doesn't use pub/sub mechanism. It can be used in large Redis clusters despite current naive pub/sub implementation.Implements a non-fair locking so doesn't guarantees an acquire order.
- Author:
- Danila Varatyntsev
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.redisson.RedissonBaseLock
RedissonBaseLock.ExpirationEntry
-
-
Field Summary
Fields Modifier and Type Field Description protected LockOptions.BackOff
backOff
protected long
internalLockLeaseTime
-
Fields inherited from class org.redisson.RedissonObject
codec, name
-
-
Constructor Summary
Constructors Constructor Description RedissonSpinLock(CommandAsyncExecutor commandExecutor, String name, LockOptions.BackOff backOff)
-
Method Summary
All Methods Instance Methods Concrete Methods 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)
UseRExpirable.expire(Instant)
insteadboolean
expireAt(Date timestamp)
UseRExpirable.expire(Instant)
insteadRFuture<Boolean>
expireAtAsync(long timestamp)
UseRExpirableAsync.expireAsync(Instant)
insteadprotected RFuture<Boolean>
expireAtAsync(long timestamp, String... keys)
RFuture<Boolean>
expireAtAsync(Date timestamp)
UseRExpirableAsync.expireAsync(Instant)
insteadboolean
forceUnlock()
Unlocks the lock independently of its stateRFuture<Boolean>
forceUnlockAsync()
Unlocks the lock independently of its statevoid
lock()
void
lock(long leaseTime, TimeUnit unit)
Acquires the lock with definedleaseTime
.RFuture<Void>
lockAsync()
Acquires the lock.RFuture<Void>
lockAsync(long currentThreadId)
Acquires the lock by thread with definedthreadId
.RFuture<Void>
lockAsync(long leaseTime, TimeUnit unit)
Acquires the lock with definedleaseTime
.RFuture<Void>
lockAsync(long leaseTime, TimeUnit unit, long currentThreadId)
Acquires the lock with definedleaseTime
andthreadId
.void
lockInterruptibly()
void
lockInterruptibly(long leaseTime, TimeUnit unit)
Acquires the lock with definedleaseTime
.long
remainTimeToLive()
Remaining time to live of Redisson object that has a timeoutRFuture<Long>
remainTimeToLiveAsync()
Remaining time to live of Redisson object that has a timeoutboolean
tryLock()
boolean
tryLock(long waitTime, long leaseTime, TimeUnit unit)
Tries to acquire the lock with definedleaseTime
.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 specifiedthreadId
.RFuture<Boolean>
tryLockAsync(long waitTime, long leaseTime, TimeUnit unit)
Tries to acquire the lock with definedleaseTime
.RFuture<Boolean>
tryLockAsync(long waitTime, long leaseTime, TimeUnit unit, long currentThreadId)
Tries to acquire the lock by thread with specifiedthreadId
andleaseTime
.RFuture<Boolean>
tryLockAsync(long waitTime, TimeUnit unit)
Tries to acquire the lock.void
unlock()
protected RFuture<Boolean>
unlockInnerAsync(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
-
backOff
protected final LockOptions.BackOff backOff
-
-
Constructor Detail
-
RedissonSpinLock
public RedissonSpinLock(CommandAsyncExecutor commandExecutor, String name, LockOptions.BackOff backOff)
-
-
Method Detail
-
lock
public void lock()
-
lock
public void lock(long leaseTime, TimeUnit unit)
Description copied from interface:RLock
Acquires the lock with definedleaseTime
. Waits if necessary until lock became available. Lock will be released automatically after definedleaseTime
interval.- Parameters:
leaseTime
- the maximum time to hold the lock after it's acquisition, if it hasn't already been released by invokingunlock
. 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 definedleaseTime
. Waits if necessary until lock became available. Lock will be released automatically after definedleaseTime
interval.- Parameters:
leaseTime
- the maximum time to hold the lock after it's acquisition, if it hasn't already been released by invokingunlock
. 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 definedleaseTime
. Waits up to definedwaitTime
if necessary until the lock became available. Lock will be released automatically after definedleaseTime
interval.- Parameters:
waitTime
- the maximum time to acquire the lockleaseTime
- lease timeunit
- time unit- Returns:
true
if lock is successfully acquired, otherwisefalse
if lock is already set.- Throws:
InterruptedException
- - if the thread is interrupted
-
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 otherwisefalse
-
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 otherwisefalse
-
unlockInnerAsync
protected RFuture<Boolean> unlockInnerAsync(long threadId)
- Specified by:
unlockInnerAsync
in classRedissonBaseLock
-
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 definedleaseTime
. Waits if necessary until lock became available. Lock will be released automatically after definedleaseTime
interval.- Parameters:
leaseTime
- the maximum time to hold the lock after it's acquisition, if it hasn't already been released by invokingunlock
. 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 definedthreadId
. 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 definedleaseTime
andthreadId
. Waits if necessary until lock became available. Lock will be released automatically after definedleaseTime
interval.- Parameters:
leaseTime
- the maximum time to hold the lock after it's acquisition, if it hasn't already been released by invokingunlock
. If leaseTime is -1, hold the lock until explicitly unlocked.unit
- the time unitcurrentThreadId
- 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 otherwisefalse
-
tryLockAsync
public RFuture<Boolean> tryLockAsync(long threadId)
Description copied from interface:RLockAsync
Tries to acquire the lock by thread with specifiedthreadId
.- Parameters:
threadId
- id of thread- Returns:
true
if lock acquired otherwisefalse
-
tryLockAsync
public RFuture<Boolean> tryLockAsync(long waitTime, TimeUnit unit)
Description copied from interface:RLockAsync
Tries to acquire the lock. Waits up to definedwaitTime
if necessary until the lock became available.- Parameters:
waitTime
- the maximum time to acquire the lockunit
- time unit- Returns:
true
if lock is successfully acquired, otherwisefalse
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 definedleaseTime
. Waits up to definedwaitTime
if necessary until the lock became available. Lock will be released automatically after definedleaseTime
interval.- Parameters:
waitTime
- the maximum time to acquire the lockleaseTime
- lease timeunit
- time unit- Returns:
true
if lock is successfully acquired, otherwisefalse
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 specifiedthreadId
andleaseTime
. Waits up to definedwaitTime
if necessary until the lock became available. Lock will be released automatically after definedleaseTime
interval.- Parameters:
waitTime
- time interval to acquire lockleaseTime
- time interval after which lock will be released automaticallyunit
- the time unit of thewaitTime
andleaseTime
argumentscurrentThreadId
- id of thread- Returns:
true
if lock acquired otherwisefalse
-
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 interfaceRExpirable
- Parameters:
timeToLive
- - timeout before object will be deletedtimeUnit
- - timeout time unit- Returns:
true
if the timeout was set andfalse
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 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 RFuture<Boolean> 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 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 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 interfaceRExpirableAsync
- Parameters:
instant
- - expire date- Returns:
true
if the timeout was set andfalse
if not
-
expireAt
public boolean expireAt(Date 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 RFuture<Boolean> expireAtAsync(Date 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 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 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 RFuture<Long> 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 RFuture<Boolean> expireAsync(long timeToLive, TimeUnit timeUnit, String... keys)
-
-