Class CountingSemaphore

A simple counting semaphore that limits access to resources with a fixed number of permits.

Implements

Lock

Index

Constructors

Properties

leased onRelease? permits released?

Accessors

availablePermits

Methods

acquire release tryAcquire waitToAcquire

Constructors

constructor

new CountingSemaphore(permits?): CountingSemaphore
Parameters
- permits: number = 1
  Total number of permits.
Returns CountingSemaphore
- Defined in packages/commons/src/async/semaphore.ts:11

Properties

`Private` leased

leased: number = 0

`Private` `Optional` onRelease

onRelease?: (() => void)

Type declaration

- (): void
- Returns void

`Readonly` permits

permits: number = 1

Total number of permits.

`Private` `Optional` released

released?: Promise<void>

Accessors

availablePermits

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

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

Methods

acquire

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

release

release(): void
Releases a lock.

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

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:29

`Private` waitToAcquire

waitToAcquire(options?): Promise<void>
Parameters
- Optional options: AbortOptions
Returns Promise<void>
- Defined in packages/commons/src/async/semaphore.ts:43

Generated using TypeDoc