Class QueuingWebSocketLifecycle

Lifecycle owning a WebSocket connection wrt message sending

Hierarchy

QueuingWebSocketLifecycle

Implements

WebSocketLifecycle

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new QueuingWebSocketLifecycle(): QueuingWebSocketLifecycle

- Defined in lib/internal/transport/websocket/WebSocketLifecycle.ts:44
Returns QueuingWebSocketLifecycle

Properties

Private Readonly messages

messages: TinyQueue<any>

Private timer

timer: Timer

Private ws

ws: WebSocket

Methods

connected

connected(): boolean

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

Returns boolean

get

get(): WebSocket

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

Returns WebSocket

Private init

init(): void

- Defined in lib/internal/transport/websocket/WebSocketLifecycle.ts:103
Init the internal queue processing

Returns void

reset

reset(): void

Implementation of WebSocketLifecycle.reset
- Defined in lib/internal/transport/websocket/WebSocketLifecycle.ts:76
Reset the WebSocket

Returns void

send

send(msg: any): void

Implementation of WebSocketLifecycle.send
- Defined in lib/internal/transport/websocket/WebSocketLifecycle.ts:86
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

Implementation of WebSocketLifecycle.set
- Defined in lib/internal/transport/websocket/WebSocketLifecycle.ts:55
Set the WebSocket to manage

Parameters
- ws: WebSocket
Returns void

Generated using TypeDoc