Package org.redisson.api
Interface RLockAsync
-
- All Known Subinterfaces:
RLock
- All Known Implementing Classes:
RedissonBaseLock
,RedissonFairLock
,RedissonLock
,RedissonMultiLock
,RedissonReadLock
,RedissonRedLock
,RedissonSpinLock
,RedissonTransactionalLock
,RedissonWriteLock
public interface RLockAsync
Async interface for Lock object- Author:
- Nikita Koksharov
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description >
forceUnlockAsync()
Unlocks the lock independently of its state>
getHoldCountAsync()
Number of holds on this lock by the current thread>
isLockedAsync()
Checks if the lock locked by any thread>
lockAsync()
Acquires the lock.>
lockAsync(long threadId)
Acquires the lock by thread with definedthreadId
.>
lockAsync(long leaseTime, unit)
Acquires the lock with definedleaseTime
.>
lockAsync(long leaseTime, unit, long threadId)
Acquires the lock with definedleaseTime
andthreadId
.>
remainTimeToLiveAsync()
Remaining time to live of the lock>
tryLockAsync()
Tries to acquire the lock.>
tryLockAsync(long threadId)
Tries to acquire the lock by thread with specifiedthreadId
.>
tryLockAsync(long waitTime, long leaseTime, unit)
Tries to acquire the lock with definedleaseTime
.>
tryLockAsync(long waitTime, long leaseTime, unit, long threadId)
Tries to acquire the lock by thread with specifiedthreadId
andleaseTime
.>
tryLockAsync(long waitTime, unit)
Tries to acquire the lock.>
unlockAsync()
Unlocks the lock>
unlockAsync(long threadId)
Unlocks the lock.
-
-
-
Method Detail
-
forceUnlockAsync
> forceUnlockAsync()
Unlocks the lock independently of its state- Returns:
true
if lock existed and now unlocked otherwisefalse
-
unlockAsync
> unlockAsync()
Unlocks the lock- Returns:
- void
-
unlockAsync
> unlockAsync(long threadId)
Unlocks the lock. Throws if lock isn't locked by thread with specifiedthreadId
.- Parameters:
threadId
- id of thread- Returns:
- void
-
tryLockAsync
> tryLockAsync()
Tries to acquire the lock.- Returns:
true
if lock acquired otherwisefalse
-
lockAsync
> lockAsync()
Acquires the lock. Waits if necessary until lock became available.- Returns:
- void
-
lockAsync
> lockAsync(long threadId)
Acquires the lock by thread with definedthreadId
. Waits if necessary until lock became available.- Parameters:
threadId
- id of thread- Returns:
- void
-
lockAsync
> lockAsync(long leaseTime, unit)
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
> lockAsync(long leaseTime, unit, long threadId)
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 unitthreadId
- id of thread- Returns:
- void
-
tryLockAsync
> tryLockAsync(long threadId)
Tries to acquire the lock by thread with specifiedthreadId
.- Parameters:
threadId
- id of thread- Returns:
true
if lock acquired otherwisefalse
-
tryLockAsync
> tryLockAsync(long waitTime, unit)
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
> tryLockAsync(long waitTime, long leaseTime, unit)
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
> tryLockAsync(long waitTime, long leaseTime, unit, long threadId)
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:
threadId
- id of threadwaitTime
- time interval to acquire lockleaseTime
- time interval after which lock will be released automaticallyunit
- the time unit of thewaitTime
andleaseTime
arguments- Returns:
true
if lock acquired otherwisefalse
-
getHoldCountAsync
> getHoldCountAsync()
Number of holds on this lock by the current thread- Returns:
- holds or
0
if this lock is not held by current thread
-
isLockedAsync
> isLockedAsync()
Checks if the lock locked by any thread- Returns:
true
if locked otherwisefalse
-
remainTimeToLiveAsync
> remainTimeToLiveAsync()
Remaining time to live of the lock- Returns:
- time in milliseconds -2 if the lock does not exist. -1 if the lock exists but has no associated expire.
-
-