Class ConcurrentResourcePool<TResource>

Type Parameters

TResource

Hierarchy

ConcurrentResourcePool

Index

Constructors

Methods

acquire drain getDiagnostics initialize release retire

Constructors

constructor

new ConcurrentResourcePool<TResource>(options): ConcurrentResourcePool<TResource>
Type Parameters
- TResource
Parameters
- options: PoolOptions<TResource>
Returns ConcurrentResourcePool<TResource>
- Defined in src/common/concurrent-pool.ts:105

Methods

acquire

acquire(options?): Promise<ResourceLease<TResource>>
Waits for a resource to have capacity and obtains a lease on that resource, creating a resource if necessary.

If this operation times out or rejects, the lease is automatically released.
Parameters
- Optional options: ActionOptions
  
  The options for this individual .acquire invocation.
Returns Promise<ResourceLease<TResource>>
A lease on a pool resouce.
- Defined in src/common/concurrent-pool.ts:428

drain

drain(): Promise<void>
Shutdown the pool. Start (and await) the destruction of all resources. All leases are expired in the process.

Returns Promise<void>
void
- Defined in src/common/concurrent-pool.ts:552

getDiagnostics

getDiagnostics(): GenericPoolDiagnostics
Returns information on the state of the pool.

Returns GenericPoolDiagnostics
The set of current resources and leases.
- Defined in src/common/concurrent-pool.ts:565

initialize

initialize(): Promise<void>
Creates the set of minimum resources and awaits their readiness.

Returns Promise<void>
void
- Defined in src/common/concurrent-pool.ts:410

release

release(externalLease, options?): Promise<void>
Waits for the resource to be cleaned up (if necessary) and returns the lease to the pool.

If this operation times out or rejects, the lease is still released.
Parameters
- externalLease: ResourceLease<TResource>
  
  The lease obtained by .acquire
- Optional options: ActionOptions
  
  The options for this individual .release invocation.
Returns Promise<void>
void
- Defined in src/common/concurrent-pool.ts:499

retire

retire(externalLease, options?): Promise<void>
Immediately retire the resource associated with a lease and release the lease.
Parameters
- externalLease: ResourceLease<TResource>
  
  The lease obtained by .acquire
- Optional options: ActionOptions
  
  The options for this individual .retire invocation.
Returns Promise<void>
void
- Defined in src/common/concurrent-pool.ts:535

Generated using TypeDoc