Synclets logoSynclets

createWsBrokerTransport

The createWsBrokerTransport function wraps a WebSocketServer in a WsBrokerTransport implementation.

createWsBrokerTransport(
  webSocketServer: WebSocketServer,
  options?: WsBrokerTransportOptions & TransportOptions,
): WsBrokerTransport
TypeDescription
webSocketServerWebSocketServer

The WebSocketServer instance to wrap.

options?WsBrokerTransportOptions & TransportOptions

Optional TransportOptions for configuring the transport.

returnsWsBrokerTransport

A WsBrokerTransport instance for server-side WebSocket communication.

This transport enables a Synclet running on a server to communicate with multiple client Synclets over WebSocket connections. It handles packet fragmentation, connection management, and bidirectional communication with all connected clients.

This transport is only available in Node.js environments. It automatically broadcasts packets to all connected clients.

Since

v0.0.0