RTCForge API Reference v1.1.1
    Preparing search index...

    Type Alias ConnectionState

    The connection lifecycle state of an RTCForgeClient, reflecting the status of its underlying signaling Transport.

    type ConnectionState = {
        Connected: "connected";
        Connecting: "connecting";
        Disconnected: "disconnected";
        Reconnecting: "reconnecting";
    }
    Index

    Properties

    Connected: "connected" = 'connected'

    The signaling socket is open and the room has been joined.

    Connecting: "connecting" = 'connecting'

    A join is in progress and the initial handshake has not yet completed.

    Disconnected: "disconnected" = 'disconnected'

    Not connected: before the first join, or after RTCForgeClient.leave or a terminal close.

    Reconnecting: "reconnecting" = 'reconnecting'

    The socket dropped and automatic reconnection is underway.