Skip to content

Interface: RoomRelayDelegate<M>

Defined in: index.ts:95

The per-wire vocabulary the room core delegates to.

Extended by

Type Parameters

M

M extends object

Properties

logPrefix

logPrefix: string

Defined in: index.ts:97

Prefixes the registration log line ("<logPrefix>: host …").

Methods

decode()

decode(text): M | undefined

Defined in: index.ts:99

Parse a text frame, or undefined for a malformed one.

Parameters

text

string

Returns

M | undefined


encode()

encode(message): string

Defined in: index.ts:101

Serialize a frame to text.

Parameters

message

M

Returns

string


joinedExtras()?

optional joinedExtras(info): Record<string, unknown>

Defined in: index.ts:105

Fields the joined frame carries beyond { host, label } (e.g. presentation).

Parameters

info

RoomSessionInfo

Returns

Record<string, unknown>


onClientMessage()

onClientMessage(message, ctx): void

Defined in: index.ts:109

Route a joined client's non-join/leave frame (forward up to the host).

Parameters

message

M

ctx

ClientMessageContext<M>

Returns

void


onHostMessage()

onHostMessage(message, ctx): void

Defined in: index.ts:107

Route a host's non-register frame (cache-and-fan-out, or client-directed).

Parameters

message

M

ctx

HostMessageContext<M>

Returns

void


registerExtras()?

optional registerExtras(message): Record<string, unknown>

Defined in: index.ts:103

Fields a register frame contributes to the session (e.g. presentation, channelTag).

Parameters

message

M

Returns

Record<string, unknown>