Class default

constructor

• new default(webSocket, defaultOpenTimeout?): default

• Construct a new connection - at the moment based on WebSockets

  Parameters

  • webSocket: WebSocket
  • defaultOpenTimeout: number = Number.POSITIVE_INFINITY

  Returns default

Readonlyid

onMessage

state

bufferedAmount

• get bufferedAmount(): number

• Chum streams use the websocket bufferedAmount number to control how fast the streams provide data to the websocket stream.

  Returns number

statistics

• get statistics(): ConnectionStatistics

• Retrieve statistics.

  The StatisticsPlugin has to be registered in order for this to work.

  Returns ConnectionStatistics

addPlugin

• addPlugin(plugin, options?): void

• Add a plugin to the connection.

  Parameters

  • plugin: default
  • Optionaloptions: {
        after?: string;
        before?: string;
    }

    • Optionalafter?: string

    • Optionalbefore?: string

  Returns void

close

• close(reason?): void

• Closes the connection.

  This function waits for the other side to acknowledge.

  Parameters

  • Optionalreason: string

    Reason for timeout

  Returns void

debug

• debug(bus, message): void

• Parameters

  • bus: MessageBusObj
  • message: string

  Returns void

encryptionPlugin

• encryptionPlugin(): default

• Returns default

hasPlugin

• hasPlugin(name): boolean

• Parameters

  • name: string

  Returns boolean

log

• log(bus, message): void

• Parameters

  • bus: MessageBusObj
  • message: string

  Returns void

pingPlugin

• pingPlugin(): PingPlugin

• Returns PingPlugin

plugin

• plugin(name): default

• Parameters

  • name: string

  Returns default

pongPlugin

• pongPlugin(): PongPlugin

• Returns PongPlugin

promisePlugin

• promisePlugin(): default

• Returns default

removePlugin

• removePlugin(name): void

• Parameters

  • name: string

  Returns void

send

• send(message): void

• Send data to the websocket.

  Parameters

  • message: string | Uint8Array

  Returns void

statisticsPlugin

• statisticsPlugin(): default

• Returns default

terminate

• terminate(reason?): void

• Terminates the connection immediately without waiting for the other side.

  Parameters

  • Optionalreason: string

    Reason for timeout

  Returns void

waitForOpen

• waitForOpen(timeout?): Promise<void>

• Wait for the socket to be open.

  Parameters

  • Optionaltimeout: number

  Returns Promise<void>

websocketPlugin

• websocketPlugin(): default

• Returns default