Skip to main content

Interface: StreamWebSocketConfig

Gala Launchpad SDK 9.0.0-rc.5

Gala Launchpad SDK 9.0.0-rc.5 / index / StreamWebSocketConfig

Interface: StreamWebSocketConfig

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:42

Stream WebSocket configuration

Properties​

autoConnect?​

optional autoConnect?: boolean

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:59

Open the socket when a subscription is registered and none is open (default: true).

reconnectAttempts?​

optional reconnectAttempts?: number

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:46

Maximum reconnection attempts (default: 5; Infinity never gives up)

reconnectDelay?​

optional reconnectDelay?: number

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:48

Delay before the first reconnection attempt in ms (default: 2000)

reconnectDelayMax?​

optional reconnectDelayMax?: number

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:50

Longest delay between reconnection attempts in ms (socket.io's default: 5000)

subscriptionTimeout?​

optional subscriptionTimeout?: number

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:52

How long a room join or an authentication may wait for the server's answer in ms (default: 10000)

tokenProvider?​

optional tokenProvider?: () => Promise<string | null>

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:57

The JWT to authenticate with, asked for whenever the service authenticates without being handed a token (and on every reconnect). It must answer with the token current at that moment. null: none.

Returns​

Promise<string | null>

url​

url: string

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:44

Stream WebSocket server URL (SEPARATE from bundleBaseUrl)