public interface ClusteredLock
lock() will be :
ClusteredLock lock = clm.get("lock");
lock.lock()
.thenRun(() ->
try {
// manipulate protected state
} finally {
return lock.unlock();
}
)
A typical usage idiom for tryLock() will be :
lock.tryLock()
.thenCompose(result -> {
if (result) {
try {
// manipulate protected state
} finally {
return lock.unlock();
}
} else {
// Do something else
}
});
| Modifier and Type | Method and Description |
|---|---|
java.util.concurrent.CompletableFuture<java.lang.Boolean> |
isLocked()
Returns a
CompletableFuture holding true when the lock is locked and false when the lock is released. |
java.util.concurrent.CompletableFuture<java.lang.Boolean> |
isLockedByMe()
Returns a
CompletableFuture holding true when the lock is owned by the caller and
false when the lock is owned by someone else or it's released. |
java.util.concurrent.CompletableFuture<java.lang.Void> |
lock()
Acquires the lock.
|
java.util.concurrent.CompletableFuture<java.lang.Boolean> |
tryLock()
Acquires the lock only if it is free at the time of invocation.
|
java.util.concurrent.CompletableFuture<java.lang.Boolean> |
tryLock(long time,
java.util.concurrent.TimeUnit unit)
If the lock is available this method returns immediately with the
CompletableFuture holding the value true. |
java.util.concurrent.CompletableFuture<java.lang.Void> |
unlock()
Releases the lock.
|
java.util.concurrent.CompletableFuture<java.lang.Void> lock()
CompletableFuture waits until the lock has been acquired.
Currently, there is no maximum time specified for a lock request to fail, so this could cause thread starvation.CompletableFuture when the lock is acquiredClusteredLockException - when the lock does not existjava.util.concurrent.CompletableFuture<java.lang.Boolean> tryLock()
CompletableFuture holding the value true.
If the lock is not available then this method will return immediately with the CompletableFuture holding the value false.CompletableFuture(true) if the lock was acquired and CompletableFuture(false) otherwiseClusteredLockException - when the lock does not existjava.util.concurrent.CompletableFuture<java.lang.Boolean> tryLock(long time,
java.util.concurrent.TimeUnit unit)
CompletableFuture holding the value true.
If the lock is not available then the CompletableFuture waits until :
CompletableFuture will complete with the value true.
If the specified waiting time elapses then the CompletableFuture will complete with the value false.
If the time is less than or equal to zero, the method will not wait at all.time, - the maximum time to wait for the lockunit, - the time unit of the time argumentCompletableFuture(true) if the lock was acquired and CompletableFuture(false) if the waiting time elapsed before the lock was acquiredClusteredLockException - when the lock does not existjava.util.concurrent.CompletableFuture<java.lang.Void> unlock()
CompletableFuture when the lock is releasedClusteredLockException - when the lock does not existjava.util.concurrent.CompletableFuture<java.lang.Boolean> isLocked()
CompletableFuture holding true when the lock is locked and false when the lock is released.CompletableFuture holding a BooleanClusteredLockException - when the lock does not existjava.util.concurrent.CompletableFuture<java.lang.Boolean> isLockedByMe()
CompletableFuture holding true when the lock is owned by the caller and
false when the lock is owned by someone else or it's released.CompletableFuture holding a BooleanClusteredLockException - when the lock does not exist