Class SharedCountingSemaphore

A counting semaphore that uses a shared array buffer for synchronization.

Implements

Index

Constructors

Properties

buffer index permits waitInterval

Accessors

availablePermits

Methods

acquire release tryAcquire

Constructors

constructor

new SharedCountingSemaphore(__namedParameters?): SharedCountingSemaphore
Parameters
- __namedParameters: SharedCountingSemaphoreOptions = {}
Returns SharedCountingSemaphore
- Defined in packages/commons/src/async/semaphore.ts:63

Properties

`Readonly` buffer

buffer: Int32Array

Shared array buffer for permit synchronization.

`Readonly` index

index: number

The buffer index to use for permit synchronization. Defaults to 0.

`Readonly` permits

permits: number

Max number of permits. Defaults to 1.

`Readonly` waitInterval

waitInterval: number

The interval in milliseconds to wait for a permit. Defaults to 200.

Accessors

availablePermits

get availablePermits(): number
Returns the number of permits available for use.

Returns number
- Defined in packages/commons/src/async/semaphore.ts:76

Methods

acquire

acquire(options?): Promise<void>
Waits for a lock to be acquired.
Parameters
- Optional options: AbortOptions
Returns Promise<void>
Implementation of Lock.acquire
- Defined in packages/commons/src/async/semaphore.ts:80

release

release(): void
Releases a lock.

Returns void
Implementation of Lock.release
- Defined in packages/commons/src/async/semaphore.ts:99

tryAcquire

tryAcquire(): boolean
Tried to acquire a lock. Returns true if success, false otherwise.

Returns boolean
Implementation of Lock.tryAcquire
- Defined in packages/commons/src/async/semaphore.ts:87

Generated using TypeDoc