PooledTransferClient
Defined in: src/core/ConnectionPool.ts:70
Pool-aware TransferClient returned by createPooledTransferClient.
Methods
Section titled “Methods”connect()
Section titled “connect()”connect(profile: ConnectionProfile): Promise<TransferSession<unknown>>;Defined in: src/core/ConnectionPool.ts:72
Opens (or leases) a pooled provider session.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
profile | ConnectionProfile |
Returns
Section titled “Returns”Promise<TransferSession<unknown>>
drainPool()
Section titled “drainPool()”drainPool(): Promise<void>;Defined in: src/core/ConnectionPool.ts:84
Disconnects every idle session and prevents further pooling. After
drainPool() resolves, subsequent connect() calls still work but
always create fresh sessions (and never return them to the pool).
Returns
Section titled “Returns”Promise<void>
getCapabilities()
Section titled “getCapabilities()”Call Signature
Section titled “Call Signature”getCapabilities(): CapabilitySet[];Defined in: src/core/ConnectionPool.ts:76
Returns the registered capability snapshots (delegated).
Returns
Section titled “Returns”Call Signature
Section titled “Call Signature”getCapabilities(providerId: ProviderId): CapabilitySet;Defined in: src/core/ConnectionPool.ts:78
Returns a specific capability snapshot (delegated).
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
providerId | ProviderId |
Returns
Section titled “Returns”hasProvider()
Section titled “hasProvider()”hasProvider(providerId: ProviderId): boolean;Defined in: src/core/ConnectionPool.ts:74
Inspects the registered providers (delegated to the underlying client).
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
providerId | ProviderId |
Returns
Section titled “Returns”boolean
poolSize()
Section titled “poolSize()”poolSize(): number;Defined in: src/core/ConnectionPool.ts:86
Returns the number of idle sessions currently held in the pool.
Returns
Section titled “Returns”number