Interface WebSocketLifecycle

Hierarchy

WebSocketLifecycle

Implemented by

QueuingWebSocketLifecycle

Index

Methods

Methods

connected

connected(): boolean

- Defined in lib/internal/transport/websocket/WebSocketLifecycle.ts:16
Is the WebSocket is connected and healthy

Returns boolean

get

get(): WebSocket

- Defined in lib/internal/transport/websocket/WebSocketLifecycle.ts:21
Get the raw WebSocket that is managed here

Returns WebSocket

reset

reset(): void

- Defined in lib/internal/transport/websocket/WebSocketLifecycle.ts:26
Reset the WebSocket

Returns void

send

send(msg: any): void

- Defined in lib/internal/transport/websocket/WebSocketLifecycle.ts:34
Send a message over the managed WebSocket If the WebSocket isn't connected, messages are queued for later when a WebSocket is connected again.

Parameters
- msg: any
Returns void

set

set(ws: WebSocket): void

- Defined in lib/internal/transport/websocket/WebSocketLifecycle.ts:11
Set the WebSocket to manage

Parameters
- ws: WebSocket
Returns void

Generated using TypeDoc