Creates a new instance of the driver.
Configuration options for the driver.
OptionalackTimeout?: numberOptional timeout for acknowledgements in milliseconds (default: 10000). A value of 0 or less waits for acknowledgements indefinitely.
Optionalprefix?: stringOptional prefix prepended verbatim to event names (for example "peerix:").
Socket.IO socket instance.
If socket is not a valid Socket.IO socket.
Indicates whether the driver is currently active. Subclasses must keep it
in sync with their connection: signaling messages are only published while
the driver is active, and joined rooms announce themselves again when it
becomes active. A namespace that fails on its own leaves the driver
active, and emitting active once it is subscribed again makes rooms
announce themselves to the peers they missed.
Sets the active state of the driver and emits corresponding events.
Destroys the driver instance, cleaning up any resources.
Emits inactive if the driver was active, then removes all event handlers.
Emits an internal event with optional data.
The event name.
The data to pass to event handlers.
Unregisters an event handler for the specified internal event.
The event name.
The event handler function to remove.
Registers an event handler for the specified internal event.
The event name.
The event handler function.
Optionaloptions: { signal?: AbortSignal }
Listener options.
Optionalsignal?: AbortSignalRemoves the handler when aborted.
A function that removes the handler.
Publishes a signaling message to the specified namespace.
The namespace to publish the message to.
The message data to publish.
Nothing directly; resolves once the message is delivered (async drivers may return a promise).
Subscribes to signaling messages for the specified namespace.
The namespace to subscribe to.
The handler function to call when a message is received.
Nothing directly; resolves once the subscription is established (async drivers may return a promise).
Unsubscribes from signaling messages for the specified namespace.
The namespace to unsubscribe from.
The handler function to remove.
Nothing directly; resolves once the unsubscription is confirmed (async drivers may return a promise).
Socket.IO-based signaling driver.
This driver uses Socket.IO to relay signaling messages between clients via your own WebSocket server.
Expected Socket.IO events, where
prefixis prepended verbatim (include a separator such as:in it; it is empty by default):prefix+subscribe,unsubscribe,publishprefix+messageA namespace that fails to subscribe is retried with exponential backoff while the driver stays active, and rooms announce themselves again once it is restored.
This is the typical signaling flow:
Example
Client-side code (browser with Socket.IO client):
Server-side code (Node.js with Socket.IO):