net.tascalate.concurrent.locks

Class DefaultAsyncLock

java.lang.Object

net.tascalate.concurrent.locks.DefaultAsyncLock

All Implemented Interfaces:

AbstractAsyncLock<AsyncLock.Token>, AsyncLock

public class DefaultAsyncLock
extends Object
implements AsyncLock

Nested Class Summary

Nested classes/interfaces inherited from interface net.tascalate.concurrent.locks.AsyncLock

AsyncLock.Token

Constructor Summary

Constructors

Constructor and Description
DefaultAsyncLock()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.tascalate.concurrent.locks.AsyncLock

create

Constructor Detail

DefaultAsyncLock

public DefaultAsyncLock()

Method Detail

tryAcquire

public Optional<AsyncLock.Token> tryAcquire()

Description copied from interface: AbstractAsyncLock

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

Specified by:

tryAcquire in interface AbstractAsyncLock<AsyncLock.Token>

Returns:

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

acquire

public Promise<AsyncLock.Token> acquire()

Description copied from interface: AbstractAsyncLock

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.

Specified by:

acquire in interface AbstractAsyncLock<AsyncLock.Token>

Returns:

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

toString

public String toString()

Overrides:

toString in class Object