Class Room

A named group of connections that can be addressed as one.

Since

0.1.0

Implements

WebSocketRoom

Index

Constructors

Accessors

name rawSize size

Methods

add broadcast broadcastJson broadcastLocal remove

Constructors

constructor

new Room(
    name: string,
    listener?: RoomMembershipListener,
    publish?: RoomPublisher,
): Room
Creates a room.
Parameters
- name: string
  The room name
- Optionallistener: RoomMembershipListener
  Notified on every membership change. Supplied by a RoomRegistry; omit for a standalone room.
- Optionalpublish: RoomPublisher
  Forwards broadcasts to other replicas. Omit for a room that stays in-process.
Returns Room
- Defined in packages/websocket-plugin/src/rooms/room-registry.ts:86

Accessors

name

get name(): string
The room name.

Returns string
Implementation of WebSocketRoom.name
- Defined in packages/websocket-plugin/src/rooms/room-registry.ts:92

rawSize

get rawSize(): number
Total membership including connections that have since closed.

Returns number
- Defined in packages/websocket-plugin/src/rooms/room-registry.ts:107

size

get size(): number
Number of currently open members.

Returns number
Implementation of WebSocketRoom.size
- Defined in packages/websocket-plugin/src/rooms/room-registry.ts:96

Methods

add

add(conn: IWebSocketConnection): void
Adds a connection to this room.
Parameters
- conn: IWebSocketConnection
  The connection to add
Returns void
Implementation of WebSocketRoom.add
- Defined in packages/websocket-plugin/src/rooms/room-registry.ts:111

broadcast

broadcast(
data: string | Uint8Array<ArrayBufferLike>,
options?: RoomBroadcastOptions,
): void
Sends a frame to every open member, skipping any closed member and any member named by options.except.
Parameters
- data: string | Uint8Array<ArrayBufferLike>
  Text as string, binary as Uint8Array
- Optionaloptions: RoomBroadcastOptions
  Broadcast options
Returns void
Implementation of WebSocketRoom.broadcast
- Defined in packages/websocket-plugin/src/rooms/room-registry.ts:125

broadcastJson

broadcastJson<T>(payload: T, options?: RoomBroadcastOptions): void
Serializes a value to JSON once and broadcasts it as a text frame.
Type Parameters
- T
  The payload type
Parameters
- payload: T
  The value to serialize
- Optionaloptions: RoomBroadcastOptions
  Broadcast options
Returns void
Implementation of WebSocketRoom.broadcastJson
- Defined in packages/websocket-plugin/src/rooms/room-registry.ts:189

broadcastLocal

broadcastLocal(
data: string | Uint8Array<ArrayBufferLike>,
options?: LocalBroadcastOptions,
): void
Sends a frame to this replica's own members only, without forwarding it to the backplane.

This is the delivery path for a frame that ARRIVED from another replica: re-publishing it would echo it back around the cluster forever. Applications call Room.broadcast; only the plugin's backplane subscriber calls this.

Exclusion is honored two ways: options.except names a live connection object (the local path), and options.exceptId names one by ID (the path a frame arriving from another replica takes, since the excluded connection object does not exist here).
Parameters
- data: string | Uint8Array<ArrayBufferLike>
  Text as string, binary as Uint8Array
- Optionaloptions: LocalBroadcastOptions
  Broadcast options, including exclusion by ID
Returns void

Since
0.2.0
- Defined in packages/websocket-plugin/src/rooms/room-registry.ts:151

remove

remove(conn: IWebSocketConnection): void
Removes a connection from this room.
Parameters
- conn: IWebSocketConnection
  The connection to remove
Returns void
Implementation of WebSocketRoom.remove
- Defined in packages/websocket-plugin/src/rooms/room-registry.ts:121