net.tascalate.concurrent.locks

Interface AbstractAsyncLock<T extends AbstractAsyncLock.Token>

All Known Subinterfaces:

AsyncLock, AsyncSemaphoreLock

All Known Implementing Classes:

DefaultAsyncLock, DefaultAsyncSemaphoreLock

public interface AbstractAsyncLock<T extends AbstractAsyncLock.Token>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AbstractAsyncLock.Token A lock token indicating that the associated lock has been exclusively acquired.

Method Summary

Modifier and Type	Method and Description
Promise<T>	acquire() Exclusively acquires this lock.
Optional<T>	tryAcquire() Attempts to immediately acquire the lock, returning a populated Optional if the lock is not currently held.

Method Detail

tryAcquire

Optional<T> tryAcquire()

Attempts to immediately acquire the lock, returning a populated Optional if the lock is not currently held.

Returns:

An Optional holding a AbstractAsyncLock.Token if the lock is not held; otherwise an empty Optional

acquire

Promise<T> acquire()

Exclusively acquires this lock. The returned stage will complete when the lock is exclusively acquired by this caller. The stage may already be complete if the lock was not held.

The AbstractAsyncLock.Token held by the returned stage is used to release the lock after it has been acquired and the lock-protected action has completed.

Returns:

A Promise which will complete with a AbstractAsyncLock.Token when the lock has been exclusively acquired