Class: MqttTransport

Defined in: livelink.clients/livelink.agent/sources/data/transports/MqttTransport.ts:45

Transport that subscribes to an MQTT broker and forwards each JSON message as an event on its topic — the one bundled transport whose channel is a genuine routing key, so mappings can select on it with a channel pattern.

The QoS and retain flag travel along in the event's metadata.

Requires the optional dependency mqtt (loaded lazily on MqttTransport.start).

Implements

• Transport

Constructors

Constructor

new MqttTransport(config: {
  broker_url: string;
  topics?: string[];
}, sink: EventSink): MqttTransport;

Defined in: livelink.clients/livelink.agent/sources/data/transports/MqttTransport.ts:64

Parameters

Parameter	Type	Description
config	{ broker_url: string; topics?: string[]; }	-
config.broker_url	string	URL of the MQTT broker, e.g. mqtt://user:pass@broker.example.com:1883.
config.topics?	string[]	Topics to subscribe to. MQTT wildcards (+, #) are supported.
sink	EventSink	-

Returns

MqttTransport

Methods

start()

start(): Promise<void>;

Defined in: livelink.clients/livelink.agent/sources/data/transports/MqttTransport.ts:72

Connect to the broker and subscribe to the configured topics.

Returns

Promise<void>

Implementation of

Transport.start

---

stop()

stop(): Promise<void>;

Defined in: livelink.clients/livelink.agent/sources/data/transports/MqttTransport.ts:115

Disconnect from the broker.

Returns

Promise<void>

Implementation of

Transport.stop