mqttclient

Availability

Agent

Description

Instances of the mqttclient class are created using mqtt.createclient() and are used to communicate with a single MQTT broker.

Only one mqttclient instance can be created per agent. Calling mqtt.createclient() again while the first mqttclient is within scope will cause an exception to be thrown.

Member Entities

The mqttclient object has the following member methods:

mqttclient.connect() — Open a new connection to an MQTT broker

mqttclient.connectionstate() — Report the current state of the connection

mqttclient.createmessage() — Create a message

mqttclient.disconnect() — Close an open connection to an MQTT broker

mqttclient.id() — Retrieve an MQTT connection’s client ID

mqttclient.isconnected() — Determine whether an MQTT client is connected to a broker

mqttclient.onconnect() — Register a handler for completed connections

mqttclient.onconnectionlost() — Register a handler for broken connections

mqttclient.onmessage() — Register a handler for incoming messages

mqttclient.subscribe() — Subscribe to one or more specific MQTT topics

mqttclient.unsubscribe() — Stop subscribing to one or more MQTT topics

mqttclient.url() — Retrieve the URL of the broker to which an MQTT client is connected

mqttclient

Availability

Description

Member Entities

See Also