Interface Transport

A transport for sending and receiving messages. Most implementations use an underlying WebSocket connection.

Hierarchy

Transport

Index

Methods

close onReceive ready send

Methods

close

close(): Promise<void>
Closes the underlying resources.

Returns Promise<void>
- Defined in out/common/transport.d.ts:13

onReceive

onReceive(handler): void
Registers the given handler for incoming messages.
Parameters
- handler: ((message) => void)
  - - (message): void
    - Parameters
      
      message: Uint8Array
      
      Returns void
Returns void
- Defined in out/common/transport.d.ts:9

ready

ready(): Promise<void>
A promise that resolves once ready.

Returns Promise<void>
- Defined in out/common/transport.d.ts:11

send

send(message): Promise<void>
Sends the given message.
Parameters
- message: Uint8Array
Returns Promise<void>
- Defined in out/common/transport.d.ts:7

Generated using TypeDoc