Class Semaphore

Package version

internal: A simple Semaphore

Hierarchy

Semaphore

Index

Constructors

constructor

Properties

limit

Methods

Constructors

constructor

new Semaphore(limit: number): Semaphore

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/semaphore.ts:15
Parameters
- limit: number
Returns Semaphore

Properties

limit

limit: number

The number of concurrent calls that can be made.

Methods

acquire

acquire(): Promise<void>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/semaphore.ts:31
Acquires a lock from the semaphore, returns a Promise that resolves when the caller holds a lock.

Returns Promise<void>

awaitedTaskCount

awaitedTaskCount(): number

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/semaphore.ts:85
Provides the number of tasks waiting to acquire a lock.

Returns number

currentLockCount

currentLockCount(): number

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/semaphore.ts:78
Provides the number of locks currently held.

Returns number

release

release(): void

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/semaphore.ts:45
Releases a lock back to the semaphore.

Returns void

use

use<T>(fn: () => T | PromiseLike<T>): Promise<T>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/semaphore.ts:62
Aquires a lock from the semaphore and then execute the fn. If the fn returns a Promise, wait for that promise to settle and then release the lock back to the semaphore.

Type parameters
- T
Parameters
- fn: () => T | PromiseLike<T>
  
  The function that needs to be executed in the ciritical region.
  - - (): T | PromiseLike<T>
    - Returns T | PromiseLike<T>
Returns Promise<T>

A Promise that will settle with the return value of fn.

Generated using TypeDoc