peerix - v0.8.0
    Preparing search index...

    Class MqttDriver

    MQTT-based signaling driver.

    This driver uses MQTT as the underlying messaging system, allowing signaling messages to be exchanged through an MQTT broker such as Mosquitto.

    Subscribing fails if the broker doesn't acknowledge it within 10 seconds.

    A namespace that fails to subscribe is retried with exponential backoff while the driver stays active, and rooms announce themselves again once it is restored.

    For testing, you can use the public server at wss://broker.emqx.io:8084/mqtt.

    This driver requires the mqtt module in the browser.

    import { connect } from "mqtt";

    // connect to an MQTT server (e.g., the local server)
    const client = connect("ws://localhost:9001/mqtt");

    // create a new driver instance
    const driver = new MqttDriver({ client });

    Running a local MQTT broker with WebSocket support for testing:

    cat << EOF > /tmp/mosquitto.conf
    listener 9001
    protocol websockets
    allow_anonymous true
    EOF

    podman run --rm -p 1883:1883 -p 9001:9001 \
    -v /tmp/mosquitto.conf:/mosquitto.conf \
    docker.io/eclipse-mosquitto:latest \
    mosquitto -c /mosquitto.conf

    Hierarchy (View Summary)

    Index
    • Creates a new instance of the driver.

      Parameters

      • options: { client: MqttClient; prefix?: string }

        Configuration options for the driver.

        • client: MqttClient

          The MQTT client instance.

        • Optionalprefix?: string

          Optional prefix for MQTT topics.

      Returns MqttDriver

      If client is not a valid MQTT client.

    • get active(): boolean

      Indicates whether the driver is currently active. Subclasses must keep it in sync with their connection: signaling messages are only published while the driver is active, and joined rooms announce themselves again when it becomes active. A namespace that fails on its own leaves the driver active, and emitting active once it is subscribed again makes rooms announce themselves to the peers they missed.

      Returns boolean

    • set active(value: boolean): void

      Sets the active state of the driver and emits corresponding events.

      Parameters

      • value: boolean

      Returns void

    • Destroys the driver instance, cleaning up any resources. Emits inactive if the driver was active, then removes all event handlers.

      Returns void

    • Registers an event handler for the specified internal event.

      Type Parameters

      Parameters

      • event: K

        The event name.

      • handler: (...args: DriverEvents[K]) => void

        The event handler function.

      • Optionaloptions: { signal?: AbortSignal }

        Listener options.

        • Optionalsignal?: AbortSignal

          Removes the handler when aborted.

      Returns () => void

      A function that removes the handler.

    • Publishes a signaling message to the specified namespace.

      Parameters

      • namespace: string

        The namespace to publish the message to.

      • data: number[]

        The message data to publish.

      Returns Promise<void>

      Nothing directly; resolves once the message is delivered (async drivers may return a promise).

    • Subscribes to signaling messages for the specified namespace.

      Parameters

      • namespace: string

        The namespace to subscribe to.

      • handler: (data: number[]) => void

        The handler function to call when a message is received.

      Returns Promise<void>

      Nothing directly; resolves once the subscription is established (async drivers may return a promise).

    • Unsubscribes from signaling messages for the specified namespace.

      Parameters

      • namespace: string

        The namespace to unsubscribe from.

      • handler: (data: number[]) => void

        The handler function to remove.

      Returns Promise<void>

      Nothing directly; resolves once the unsubscription is confirmed (async drivers may return a promise).