Package com.ibm.asyncutil.locks

Class FairAsyncLock

java.lang.Object

com.ibm.asyncutil.locks.FairAsyncLock

All Implemented Interfaces:

AsyncLock

public class FairAsyncLock
extends Object
implements AsyncLock

An AsyncLock which enforces fairness in its acquisition ordering

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.asyncutil.locks.AsyncLock

AsyncLock.LockToken

Constructor Summary

Constructors

Constructor	Description
FairAsyncLock()

Method Summary

Modifier and Type	Method	Description
CompletionStage<AsyncLock.LockToken>	acquireLock()	Exclusively acquires this lock.
Optional<AsyncLock.LockToken>	tryLock()	Attempts to immediately acquire the lock, returning a populated Optional if the lock is not currently held.

Methods inherited from interface com.ibm.asyncutil.locks.AsyncLock

create, createFair

Methods inherited from class java.lang.Object

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

Constructor Detail

FairAsyncLock

public FairAsyncLock()

Method Detail

acquireLock

public CompletionStage<AsyncLock.LockToken> acquireLock()

Description copied from interface: AsyncLock

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 AsyncLock.LockToken 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:

acquireLock in interface AsyncLock

Returns:

A CompletionStage which will complete with a AsyncLock.LockToken when the lock has been exclusively acquired

tryLock

public Optional<AsyncLock.LockToken> tryLock()

Description copied from interface: AsyncLock

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

Specified by:

tryLock in interface AsyncLock

Returns:

An Optional holding a AsyncLock.LockToken if the lock is not held; otherwise an empty Optional