kaven-utils - v6.1.8
    Preparing search index...

    Interface IRelayClientEvents

    Events emitted by RelayClient.

    interface IRelayClientEvents {
        broadcast: (message: IRelayMessage) => void;
        close: (hadError: boolean) => void;
        data: (message: IRelayMessage) => void;
        error: (err: Error) => void;
        identify: (clientId: string, name: string | undefined) => void;
        join: (clientId: string) => void;
        leave: (clientId: string) => void;
        ready: (clientId: string) => void;
        tunnel: (from: string, payload: IRelayTunnelPayload) => void;
    }
    Index
    broadcast close data error identify join leave ready tunnel
    broadcast: (message: IRelayMessage) => void

    A broadcast message was received from another peer.

    close: (hadError: boolean) => void

    The connection was fully closed.

    data: (message: IRelayMessage) => void

    A data message was received, either addressed to this client or broadcast by another peer.

    error: (err: Error) => void

    The underlying socket emitted an error.

    identify: (clientId: string, name: string | undefined) => void

    Another client advertised its name via an identify message, or the server reported an already-identified peer's name on connect. name is undefined if the peer cleared its identification.

    join: (clientId: string) => void

    Another client has joined the server.

    leave: (clientId: string) => void

    Another client has left the server.

    ready: (clientId: string) => void

    The connection was established and the server has assigned the client its ID.

    tunnel: (from: string, payload: IRelayTunnelPayload) => void

    A tunnel message was received from another peer. Used by RelayTunnel to bridge proxied TCP connections.

    Settings
    Member Visibility

    On This Page
    Properties