Class WebSocketService

Creates the service.

Whether the underlying HTTP adapter can perform WebSocket upgrades.

Current number of open connections across all routes.

Current number of live rooms.

Number of registered routes — reported by the health indicator.

Closes every connection and stops the heartbeat. Called from the plugin's shutdown hook (AI_GUIDELINES §14.5).

The router handed to the HTTP adapter. Matches the request against the route table, applies admission control, and builds the sink the adapter binds its native socket into.

Kept at its public single-parameter shape: the adapter consults it with the native request alone and has no principal to thread, so an adapter-side call routes the upgrade as anonymous. A failure is reported through the logger before it is turned into a 500 refusal, via the same #routeReported wrapper routeUpgrade uses, so the logging behavior has one implementation. The adapter-side UpgradeRouterStore also catches, but it runs inside @setu-ts/runtime, which has no logger and therefore has nowhere to put the cause — so the only place a routing bug can be made visible is here, at its source.

Delivers a frame that arrived from another replica to this replica's local room members.

Called only by the plugin's backplane subscription. It uses the room registry's local-only delivery path, so an arriving frame is never re-published — which would echo it around the cluster forever.

Frames of another kind, and frames this instance published itself, are ignored: one backplane topic carries both WebSocket rooms and SSE channels, and a room may legitimately share a name with a channel.

Returns the named room if one already exists, without creating it.

The non-allocating counterpart to WebSocketService.room. A presence endpoint reading size for a request-supplied name must use this: room() registers one room per distinct name polled, and a room nobody joined is reclaimed only on the next disconnection.

Replaces the plugin-level ingress chain around onMessage with the resolved declared sequence.

Called once by the plugin's onInit hook, after every RegistryFactory entry of WebSocketPlugin({ behaviors }) has been resolved — the first phase at which the registry holds every capability, and still before the application serves, so no frame is ever dispatched without the final chain. With no factory behaviours configured it is never called with a non-empty list, and frame dispatch keeps the direct, synchronous form.

Returns the named room, creating it on first use.

Creating is the point: the first call for a name registers a room. Use IWebSocketService.peek to read a caller-supplied name without registering anything.

Registers a WebSocket route. Paths match exactly; the query string is ignored for matching and exposed to onOpen instead.

The upgrade router the kernel terminal handler consults after the middleware pipeline has run without short-circuiting.

Delegates to the shared #routeReported reporting wrapper: a routing failure is written to the logger here, at its source, before it becomes a refusal. Calling #route directly would make this the one entry point whose failures are invisible — the kernel has no logger to write them to.