Class GatewaySource

constructor

• new GatewaySource(gateway: GatewayLike): GatewaySource

  Wraps a gateway.

  Parameters

  • gateway: GatewayLike

    The gateway session.

  Returns GatewaySource

closeReason

Readonlygateway

onError

Readonlywindow

[asyncIterator]

• "[asyncIterator]"(): AsyncGenerator<Delivery, void, undefined>

  Yields the deliveries of the gateway until it stops.

  Returns AsyncGenerator<Delivery, void, undefined>

  The deliveries.

ack

• ack(seq: number): Promise<void>

  Sends the op ack.

  Parameters

  • seq: number

    The highest settled seq.

  Returns Promise<void>

  A promise that resolves once the frame is handed to the socket.

advance

• advance(seq: number): Promise<void>

  Passes on a cursor; it never settles an open delivered event.

  Parameters

  • seq: number

    The cursor.

  Returns Promise<void>

  A promise that resolves after a needed ack.

answerAutocomplete

• answerAutocomplete(requestId: string, choices: readonly {}[]): Promise<void>

  Sends the op command.autocomplete_result.

  Parameters

  • requestId: string

    The request.

  • choices: readonly {}[]

    The choices.

  Returns Promise<void>

  A promise that resolves once the frame is handed to the socket.

  Throws

  TransportError when the gateway is not connected.

close

• close(): Promise<void>

  Closes the gateway with 1000.

  Returns Promise<void>

  A promise that resolves once the close is started.

settle

• settle(seq: number): Promise<void>

  Marks seq settled and sends ack when the acknowledgement point moves.

  Parameters

  • seq: number

    The settled seq.

  Returns Promise<void>

  A promise that resolves after a needed ack.