API Reference
    Preparing search index...

    Interface SignalingDriver

    Transport contract used by Peer to exchange signaling messages.

    Implementations are expected to route payloads by namespace and invoke subscribed handlers when matching messages arrive.

    interface SignalingDriver {
        emit(namespace: string[], data: any): void;
        off(namespace: string[], handler: (data: any) => void): void;
        on(namespace: string[], handler: (data: any) => void): void;
    }

    Implemented by

    Index

    Methods

    emit off on

    Methods

    • Publish a signaling message to a namespace.

      Parameters

      • namespace: string[]

        Target namespace segments.

      • data: any

        Signaling payload to deliver.

      Returns void

    • Unsubscribe a previously registered namespace handler.

      Parameters

      • namespace: string[]

        Namespace segments used for message routing.

      • handler: (data: any) => void

        Handler reference originally passed to on.

      Returns void

    • Subscribe to signaling messages in a namespace.

      Parameters

      • namespace: string[]

        Namespace segments used for message routing.

      • handler: (data: any) => void

        Callback invoked with message payload.

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods