Class WebSocketTransport

Default WebSocket-based Transport.

Remarks

Handles the full connection lifecycle: it resolves a WebSocket implementation (the global one in browsers/Node ≥ 22, falling back to the ws package), validates every inbound frame against ServerMessageSchema and silently drops invalid ones, and answers server ping frames with pong automatically. Messages sent while the socket is not open are buffered in a MessageQueue and flushed on reconnect. When TransportOptions.reconnect is enabled it retries using a BackoffStrategy, optionally refreshing the auth token via TransportOptions.tokenRefresh before each attempt, and gives up once the strategy is exhausted.

Example

const transport = new WebSocketTransport('wss://example.com/rtc?roomId=demo', {
  reconnect: true,
  maxReconnectDelay: 32_000,
})
transport.on('message', (msg) => console.log(msg))
await transport.connect()

Hierarchy (View Summary)

EventEmitter<TransportEvents>
- WebSocketTransport

Implements

Transport

Index

Constructors

constructor

Methods

close connect emit flush listenerCount off on once removeAllListeners send

Constructors

constructor

new WebSocketTransport(
url: string,
options?: TransportOptions,
): WebSocketTransport
Parameters
- url: string
  Full signaling socket URL including any auth/room query parameters.
- options: TransportOptions = {}
  Reconnect, timeout, logging, token-refresh, and queue configuration.
Returns WebSocketTransport
Overrides EventEmitter.constructor
- Defined in packages/sdk/src/WebSocketTransport.ts:59

Methods

close

close(): void
Closes the connection permanently, clears the queue, and cancels any pending reconnect.

Returns void
Implementation of Transport.close
- Defined in packages/sdk/src/WebSocketTransport.ts:113

connect

connect(): Promise<void>
Opens the connection, resolving when the socket is open and rejecting on failure/timeout.

Returns Promise<void>
Implementation of Transport.connect
- Defined in packages/sdk/src/WebSocketTransport.ts:91

emit

emit<K extends keyof TransportEvents>(
event: K,
...args: TransportEvents[K],
): boolean
Synchronously invokes every listener registered for event, in registration order.
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
  The event name to emit.
- ...args: TransportEvents[K]
  The argument tuple to pass to each listener, matching Events[event].
Returns boolean
true if at least one listener was invoked, false if there were none.

Remarks
The listener list is snapshotted before dispatch, so mutations made by handlers take effect only on subsequent emissions. Listeners are isolated: if one throws, the remaining listeners still run and the error is surfaced via console.error rather than swallowed silently (consistent with LocalMessageBus).
Inherited from EventEmitter.emit
- Defined in packages/core/src/EventEmitter.ts:95

flush

flush(): void
Flushes any queued messages to the open socket. Called after (re)join to drain the offline buffer.

Returns void
Implementation of Transport.flush
- Defined in packages/sdk/src/WebSocketTransport.ts:107

listenerCount

listenerCount<K extends keyof TransportEvents>(event: K): number
Returns the number of listeners currently registered for event.
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
  The event name to count listeners for.
Returns number
The count of registered listeners (0 if none).
Inherited from EventEmitter.listenerCount
- Defined in packages/core/src/EventEmitter.ts:128

off

off<K extends keyof TransportEvents>(
event: K,
listener: (...args: TransportEvents[K]) => void,
): this
Removes a previously registered listener for event.
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
  The event name the listener was registered for.
- listener: (...args: TransportEvents[K]) => void
  The exact function reference passed to on or once.
Returns this
This emitter, for chaining.

Remarks
If the listener is not currently registered, this is a no-op. Only the first matching registration is removed.
Implementation of Transport.off
Inherited from EventEmitter.off
- Defined in packages/core/src/EventEmitter.ts:74

on

on<K extends keyof TransportEvents>(
event: K,
listener: (...args: TransportEvents[K]) => void,
): this
Registers a listener that is invoked every time event is emitted.
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
  The event name to listen for.
- listener: (...args: TransportEvents[K]) => void
  Callback invoked with the event's argument tuple.
Returns this
This emitter, for chaining.
Implementation of Transport.on
Inherited from EventEmitter.on
- Defined in packages/core/src/EventEmitter.ts:43

once

once<K extends keyof TransportEvents>(
event: K,
listener: (...args: TransportEvents[K]) => void,
): this
Registers a listener that is invoked at most once: it is removed automatically before being called the first time event is emitted.
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
  The event name to listen for.
- listener: (...args: TransportEvents[K]) => void
  Callback invoked with the event's argument tuple on the next emission.
Returns this
This emitter, for chaining.

Remarks
Remove a pending one-time listener by passing the same function reference to off.
Implementation of Transport.once
Inherited from EventEmitter.once
- Defined in packages/core/src/EventEmitter.ts:57

removeAllListeners

removeAllListeners(event?: keyof TransportEvents): this
Removes listeners for a single event, or for all events.
Parameters
- Optionalevent: keyof TransportEvents
  The event name to clear; if omitted, listeners for every event are removed.
Returns this
This emitter, for chaining.
Inherited from EventEmitter.removeAllListeners
- Defined in packages/core/src/EventEmitter.ts:116

send

send(
    msg:
        | { data: unknown; to: string; type: "signal" }
        | { type: "pong" }
        | { channel: string; data?: unknown; type: "broadcast" },
): void
Sends a message immediately if connected, otherwise buffers it in the send queue.
Parameters
- msg:
      | { data: unknown; to: string; type: "signal" }
      | { type: "pong" }
      | { channel: string; data?: unknown; type: "broadcast" }
Returns void
Implementation of Transport.send
- Defined in packages/sdk/src/WebSocketTransport.ts:97

Class WebSocketTransport

Remarks

Example

Hierarchy (View Summary)

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns WebSocketTransport

Methods

close

Returns void

connect

Returns Promise<void>

emit

Type Parameters

Parameters

Returns boolean

Remarks

flush

Returns void

listenerCount

Type Parameters

Parameters

Returns number

off

Type Parameters

Parameters

Returns this

Remarks

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

Remarks

removeAllListeners

Parameters

Returns this

send

Parameters

Returns void

Settings

On This Page