Class JoinHandshake

Drives the connect-and-join exchange, resolving once the server confirms the room.

Remarks

run connects the Transport and waits for a RoomJoined frame, rejecting on an Error frame or after joinTimeoutMs. The message listener stays attached after settling and buffers any frames that arrive in the same batch as RoomJoined (the transport can deliver several synchronously); those are replayed to steady-state handling via drain.

Index

Constructors

constructor

Methods

cancel dispose drain run

Constructors

constructor

new JoinHandshake(transport: Transport, joinTimeoutMs: number): JoinHandshake
Parameters
- transport: Transport
- joinTimeoutMs: number
Returns JoinHandshake
- Defined in packages/sdk/src/JoinHandshake.ts:26

Methods

cancel

cancel(reason: string): void
Parameters
- reason: string
Returns void
- Defined in packages/sdk/src/JoinHandshake.ts:88

dispose

dispose(): void
Detach the listener and drop any buffered frames without replaying them.

Returns void
- Defined in packages/sdk/src/JoinHandshake.ts:83

drain

drain(
    handler: (
        msg:
            | {
                iceServers?: {
                    credential?: string;
                    urls: string
                    | string[];
                    username?: string;
                }[];
                localRole?: string;
                peerId: string;
                peerMetadata?: Record<string, Record<string, string>>;
                peerRoles?: Record<string, string>;
                peers: string[];
                roomId: string;
                type: "room-joined";
                v?: number;
            }
            | {
                metadata?: Record<string, string>;
                peerId: string;
                role?: string;
                type: "peer-joined";
            }
            | { peerId: string; type: "peer-left" }
            | { peerId: string; type: "presence-online" }
            | { peerId: string; type: "presence-offline" }
            | { peerId: string; reason?: string; type: "kicked" }
            | { data: unknown; from: string; type: "signal" }
            | {
                channel: string;
                data?: unknown;
                from: string;
                ts: number;
                type: "broadcast";
            }
            | { code: string; message: string; type: "error" }
            | { type: "ping" }
            | { peerId: string; role: string; type: "role-changed" },
    ) => void,
): void
Detach the handshake listener and replay any frames buffered between the room-joined settle and now, so no early signal is lost. Call once, after the steady-state message handler is attached.
Parameters
- handler: (
      msg:
          | {
              iceServers?: {
                  credential?: string;
                  urls: string
                  | string[];
                  username?: string;
              }[];
              localRole?: string;
              peerId: string;
              peerMetadata?: Record<string, Record<string, string>>;
              peerRoles?: Record<string, string>;
              peers: string[];
              roomId: string;
              type: "room-joined";
              v?: number;
          }
          | {
              metadata?: Record<string, string>;
              peerId: string;
              role?: string;
              type: "peer-joined";
          }
          | { peerId: string; type: "peer-left" }
          | { peerId: string; type: "presence-online" }
          | { peerId: string; type: "presence-offline" }
          | { peerId: string; reason?: string; type: "kicked" }
          | { data: unknown; from: string; type: "signal" }
          | {
              channel: string;
              data?: unknown;
              from: string;
              ts: number;
              type: "broadcast";
          }
          | { code: string; message: string; type: "error" }
          | { type: "ping" }
          | { peerId: string; role: string; type: "role-changed" },
  ) => void
Returns void
- Defined in packages/sdk/src/JoinHandshake.ts:75

run

run(): Promise<
    {
        iceServers?: {
            credential?: string;
            urls: string
            | string[];
            username?: string;
        }[];
        localRole?: string;
        peerId: string;
        peerMetadata?: Record<string, Record<string, string>>;
        peerRoles?: Record<string, string>;
        peers: string[];
        roomId: string;
        type: "room-joined";
        v?: number;
    },
>
Returns Promise<
    {
        iceServers?: {
            credential?: string;
            urls: string
            | string[];
            username?: string;
        }[];
        localRole?: string;
        peerId: string;
        peerMetadata?: Record<string, Record<string, string>>;
        peerRoles?: Record<string, string>;
        peers: string[];
        roomId: string;
        type: "room-joined";
        v?: number;
    },
>
- Defined in packages/sdk/src/JoinHandshake.ts:31

Class JoinHandshake

Remarks

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns JoinHandshake

Methods

cancel

Parameters

Returns void

dispose

Returns void

drain

Parameters

Returns void

run

Settings

On This Page