RLockAsync (Redisson 3.11.6 API)

All Known Subinterfaces:

RLock

All Known Implementing Classes:

RedissonFairLock, RedissonLock, RedissonMultiLock, RedissonReadLock, RedissonRedLock, 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 and Description
`RFuture<Boolean>`	`forceUnlockAsync()` Unlocks the lock independently of state
`RFuture<Integer>`	`getHoldCountAsync()` Number of holds on this lock by the current thread
`RFuture<Boolean>`	`isLockedAsync()` Checks if this lock locked by any thread
`RFuture<Void>`	`lockAsync()` Acquires the lock.
`RFuture<Void>`	`lockAsync(long threadId)` Acquires the lock by thread with specified `threadId`.
`RFuture<Void>`	`lockAsync(long leaseTime, TimeUnit unit)` Acquires the lock.
`RFuture<Void>`	`lockAsync(long leaseTime, TimeUnit unit, long threadId)` Acquires the lock by thread with specified `threadId`.
`RFuture<Long>`	`remainTimeToLiveAsync()` Remaining time to live of this lock
`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.
`RFuture<Boolean>`	`tryLockAsync(long waitTime, long leaseTime, TimeUnit unit, long threadId)` Tries to acquire the lock by thread with specified `threadId`.
`RFuture<Boolean>`	`tryLockAsync(long waitTime, TimeUnit unit)` Tries to acquire the lock.
`RFuture<Void>`	`unlockAsync()` Unlocks the lock
`RFuture<Void>`	`unlockAsync(long threadId)` Unlocks the lock.

- Method Detail
  - forceUnlockAsync
```
RFuture<Boolean> forceUnlockAsync()
```
    Unlocks the lock independently of state
    
    Returns:
    
    true if lock existed and now unlocked otherwise false
  - unlockAsync
```
RFuture<Void> unlockAsync()
```
    Unlocks the lock
    
    Returns:
    
    void
  - unlockAsync
```
RFuture<Void> unlockAsync(long threadId)
```
    Unlocks the lock. Throws IllegalMonitorStateException if lock isn't locked by thread with specified threadId.
    
    Parameters:
    
    threadId - id of thread
    
    Returns:
    
    void
  - tryLockAsync
```
RFuture<Boolean> tryLockAsync()
```
    Tries to acquire the lock.
    
    Returns:
    
    true if lock acquired otherwise false
  - lockAsync
```
RFuture<Void> lockAsync()
```
    Acquires the lock.
    
    Returns:
    
    void
  - lockAsync
```
RFuture<Void> lockAsync(long threadId)
```
    Acquires the lock by thread with specified threadId.
    
    Parameters:
    
    threadId - id of thread
    
    Returns:
    
    void
  - lockAsync
```
RFuture<Void> lockAsync(long leaseTime,
                        TimeUnit unit)
```
    Acquires the lock.
    If the lock is not available then the current thread becomes disabled for thread scheduling purposes and lies dormant until the lock has been acquired. If the lock is acquired, it is held until unlock is invoked, or until leaseTime milliseconds have passed since the lock was granted - whichever comes first.
    
    Parameters:
    
    leaseTime - the maximum time to hold the lock after granting it, before automatically releasing it if it hasn't already been released by invoking unlock. If leaseTime is -1, hold the lock until explicitly unlocked.
    
    unit - the time unit of the leaseTime argument
    
    Returns:
    
    void
  - lockAsync
```
RFuture<Void> lockAsync(long leaseTime,
                        TimeUnit unit,
                        long threadId)
```
    Acquires the lock by thread with specified threadId.
    If the lock is not available then the current thread becomes disabled for thread scheduling purposes and lies dormant until the lock has been acquired. If the lock is acquired, it is held until unlock is invoked, or until leaseTime milliseconds have passed since the lock was granted - whichever comes first.
    
    Parameters:
    
    leaseTime - the maximum time to hold the lock after granting it, before automatically releasing it if it hasn't already been released by invoking unlock. If leaseTime is -1, hold the lock until explicitly unlocked.
    
    unit - the time unit of the leaseTime argument
    
    threadId - id of thread
    
    Returns:
    
    void
  - tryLockAsync
```
RFuture<Boolean> tryLockAsync(long threadId)
```
    Tries to acquire the lock by thread with specified threadId.
    
    Parameters:
    
    threadId - id of thread
    
    Returns:
    
    true if lock acquired otherwise false
  - tryLockAsync
```
RFuture<Boolean> tryLockAsync(long waitTime,
                              TimeUnit unit)
```
    Tries to acquire the lock. If the lock is not available waits up to specified waitTime time interval to acquire it.
    
    Parameters:
    
    waitTime - interval to acquire lock
    
    unit - the time unit of the waitTime argument
    
    Returns:
    
    true if lock acquired otherwise false
  - tryLockAsync
```
RFuture<Boolean> tryLockAsync(long waitTime,
                              long leaseTime,
                              TimeUnit unit)
```
    Tries to acquire the lock. If the lock is not available waits up to specified waitTime time interval to acquire it. Lock will be release 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
    
    Returns:
    
    true if lock acquired otherwise false
  - tryLockAsync
```
RFuture<Boolean> tryLockAsync(long waitTime,
                              long leaseTime,
                              TimeUnit unit,
                              long threadId)
```
    Tries to acquire the lock by thread with specified threadId. If the lock is not available waits up to specified waitTime time interval to acquire it. Lock will be release automatically after defined leaseTime interval.
    
    Parameters:
    
    threadId - id of thread
    
    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
    
    Returns:
    
    true if lock acquired otherwise false
  - getHoldCountAsync
```
RFuture<Integer> 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
```
RFuture<Boolean> isLockedAsync()
```
    Checks if this lock locked by any thread
    
    Returns:
    
    true if locked otherwise false
  - remainTimeToLiveAsync
```
RFuture<Long> remainTimeToLiveAsync()
```
    Remaining time to live of this lock
    
    Returns:
    
    time in milliseconds -2 if the lock does not exist. -1 if the lock exists but has no associated expire.

Interface RLockAsync

Method Summary

Method Detail

forceUnlockAsync

unlockAsync

unlockAsync

tryLockAsync

lockAsync

lockAsync

lockAsync

lockAsync

tryLockAsync

tryLockAsync

tryLockAsync

tryLockAsync

getHoldCountAsync

isLockedAsync

remainTimeToLiveAsync