ConnectionPool | etcd3

Connection wraps GRPC hosts. Note that this wraps the hosts themselves; each host can contain multiple discreet services.

Hierarchy

ConnectionPool

Implements

ICallable<Host>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ConnectionPool(options: IOptions): ConnectionPool

- Defined in src/connection-pool.ts:250
Parameters
- options: IOptions
Returns ConnectionPool

Properties

Readonly callOptionsFactory

callOptionsFactory: undefined | CallOptions | ((context: CallContext) => CallOptions) = this.options.defaultCallOptions

Static deterministicOrder

deterministicOrder: boolean = false

Toggles whether hosts are looped through in a deterministic order. For use in tests, should not be toggled in production/

Methods

close

close(): void

- Defined in src/connection-pool.ts:286
Tears down all ongoing connections and resoruces.

Returns void

exec

exec<T>(serviceName: keyof typeof Services, method: string, payload: unknown, options?: grpc.CallOptions): Promise<T>

- Defined in src/connection-pool.ts:293
override

Type parameters
- T
Parameters
- serviceName: keyof typeof Services
- method: string
- payload: unknown
- Optional options: grpc.CallOptions
Returns Promise<T>

markFailed

markFailed(resource: Host, error: Error): void

- Defined in src/connection-pool.ts:391
override

Parameters
- resource: Host
- error: Error
Returns void

mock

mock(callable: ICallable<Host>): void

- Defined in src/connection-pool.ts:272
Sets a mock interface to use instead of hitting real services.

Parameters
- callable: ICallable<Host>
Returns void

unmock

unmock(): void

- Defined in src/connection-pool.ts:279
Removes any existing mock.

Returns void

withConnection

withConnection<T>(service: keyof typeof Services, fn: (args: { client: Client; metadata: Metadata; resource: Host }) => Promise<T> | T, shuffleGenerator?: Generator<Host, void, unknown>): Promise<T>

- Defined in src/connection-pool.ts:348
override

Type parameters
- T
Parameters
- service: keyof typeof Services
- fn: (args: { client: Client; metadata: Metadata; resource: Host }) => Promise<T> | T
  - - (args: { client: Client; metadata: Metadata; resource: Host }): Promise<T> | T
    - Parameters
      - args: { client: Client; metadata: Metadata; resource: Host }
        
        client: Client
        
        metadata: Metadata
        
        resource: Host
      Returns Promise<T> | T
- Default value shuffleGenerator: Generator<Host, void, unknown> = this.shuffledHosts()
Returns Promise<T>

Generated using TypeDoc