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.

This driver requires the mqtt module in the browser.

Example

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

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

Hierarchy (View Summary)

Driver
- MqttDriver

Index

Constructors

constructor

new MqttDriver(options: { client: MqttClient; prefix?: string }): MqttDriver
Creates a new instance of the driver.
Parameters
- options: { client: MqttClient; prefix?: string }
  Optional configuration for the driver.
  - client: MqttClient
    The MQTT client instance.
  - Optionalprefix?: string
    Optional prefix for MQTT topics.
Returns MqttDriver
Overrides Driver.constructor
- Defined in src/drivers/mqtt.ts:57

Accessors

active

get active(): boolean
Indicates whether the driver is currently active.

Returns boolean
Inherited from Driver.active
- Defined in src/drivers/driver.ts:47
set active(value: boolean): void
Sets the active state of the driver and emits corresponding events.
Parameters
- value: boolean
Returns void
Inherited from Driver.active
- Defined in src/drivers/driver.ts:52

Methods

destroy

destroy(): void
Destroys the driver instance, cleaning up any resources.

Returns void
Overrides Driver.destroy
- Defined in src/drivers/mqtt.ts:146

emit

emit<K extends keyof DriverEvents>(event: K, ...args: DriverEvents[K]): void
Emits an internal event with optional data.
Type Parameters
- K extends keyof DriverEvents
Parameters
- event: K
  The event name.
- ...args: DriverEvents[K]
  The data to pass to event handlers.
Returns void
Inherited from Driver.emit
- Defined in src/drivers/driver.ts:99

off

off<K extends keyof DriverEvents>(
event: K,
handler: (...args: DriverEvents[K]) => void,
): void
Unregisters an event handler for the specified internal event.
Type Parameters
- K extends keyof DriverEvents
Parameters
- event: K
  The event name.
- handler: (...args: DriverEvents[K]) => void
  The event handler function to remove.
Returns void
Inherited from Driver.off
- Defined in src/drivers/driver.ts:86

on

on<K extends keyof DriverEvents>(
event: K,
handler: (...args: DriverEvents[K]) => void,
): void
Registers an event handler for the specified internal event.
Type Parameters
- K extends keyof DriverEvents
Parameters
- event: K
  The event name.
- handler: (...args: DriverEvents[K]) => void
  The event handler function.
Returns void
Inherited from Driver.on
- Defined in src/drivers/driver.ts:73

publish

publish(namespace: string[], data: number[]): Promise<void>
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>
Overrides Driver.publish
- Defined in src/drivers/mqtt.ts:139

subscribe(namespace: string[], handler: (data: number[]) => void): Promise<void>
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>
Overrides Driver.subscribe
- Defined in src/drivers/mqtt.ts:105

unsubscribe

unsubscribe(
namespace: string[],
handler: (data: number[]) => void,
): Promise<void>
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>
Overrides Driver.unsubscribe
- Defined in src/drivers/mqtt.ts:125

Class MqttDriver

Example

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

client: MqttClient

Optionalprefix?: string

Returns MqttDriver

Accessors

active

Returns boolean

Parameters

Returns void

Methods

destroy

Returns void

emit

Type Parameters

Parameters

Returns void

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns void

publish

Parameters

Returns Promise<void>

subscribe

Parameters

Returns Promise<void>

unsubscribe

Parameters

Returns Promise<void>

Settings

On This Page

`Optional`prefix?: string