AsyncSemaphoreLock (Tascalate Concurrent 0.9.6 API)

All Superinterfaces:

AbstractAsyncLock<AsyncSemaphoreLock.Token>

All Known Implementing Classes:

DefaultAsyncSemaphoreLock
```
public interface AsyncSemaphoreLock
extends AbstractAsyncLock<AsyncSemaphoreLock.Token>
```

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface AsyncSemaphoreLock.Token
A semaphore token indicating that necessary permit has been exclusively acquired.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`AsyncSemaphoreLock.Token` A semaphore token indicating that necessary permit has been exclusively acquired.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default Promise<AsyncSemaphoreLock.Token>`	`acquire()` Exclusively acquires this lock.
`Promise<AsyncSemaphoreLock.Token>`	`acquire(long permits)`
`long`	`availablePermits()`
`static AsyncSemaphoreLock`	`create(long permits, boolean fair)`
`Optional<AsyncSemaphoreLock.Token>`	`drainPermits()`
`int`	`getQueueLength()`
`default Optional<AsyncSemaphoreLock.Token>`	`tryAcquire()` Attempts to immediately acquire the lock, returning a populated `Optional` if the lock is not currently held.
`Optional<AsyncSemaphoreLock.Token>`	`tryAcquire(long permits)`

- Method Detail
  - availablePermits
```
long availablePermits()
```
  - getQueueLength
```
int getQueueLength()
```
  - drainPermits
```
Optional<AsyncSemaphoreLock.Token> drainPermits()
```
  - tryAcquire
```
default Optional<AsyncSemaphoreLock.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<AsyncSemaphoreLock.Token>
    
    Returns:
    
    An Optional holding a AbstractAsyncLock.Token if the lock is not held; otherwise an empty Optional
  - tryAcquire
```
Optional<AsyncSemaphoreLock.Token> tryAcquire(long permits)
```
  - acquire
```
default Promise<AsyncSemaphoreLock.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<AsyncSemaphoreLock.Token>
    
    Returns:
    
    A Promise which will complete with a AbstractAsyncLock.Token when the lock has been exclusively acquired
  - acquire
```
Promise<AsyncSemaphoreLock.Token> acquire(long permits)
```
  - create
```
static AsyncSemaphoreLock create(long permits,
                                 boolean fair)
```

Interface AsyncSemaphoreLock

Nested Class Summary

Method Summary

Method Detail

availablePermits

getQueueLength

drainPermits

tryAcquire

tryAcquire

acquire

acquire

create