Interface WebSocketSignallingClientOptions

Connection and handshake options for WebSocket signalling.

interface WebSocketSignallingClientOptions {
    deadline?: number | Date | null;
    headers?: Readonly<Record<string, string>>;
    maxMessageSize?: number;
    protocols?: string | readonly string[];
    webSocketFactory?: WebSocketFactory;
}

Properties

deadline?: number | Date | null

Absolute time by which the socket must open.

headers?: Readonly<Record<string, string>>

Extra handshake headers; browser WebSockets may reject these.

maxMessageSize?: number

Maximum UTF-8 bytes in one signalling JSON message.

protocols?: string | readonly string[]

WebSocket subprotocol or preference list.

webSocketFactory?: WebSocketFactory

Custom socket constructor for tests or non-browser runtimes.