MQTT Vuser Functions

MQTT Vuser Functions

MQTT (MQ Telemetry Transport) is a publish/subscribe-based messaging protocol for use over the TCP/IP protocol. The protocol is optimized for small bandwidth or unstable networks. It is most commonly used for device-to-device communication as in the Internet of things (IoT).

Alphabetical List of Functions

Function name Description
mqtt_await_messages Waits until there is at least one message in the inbox.
mqtt_clear_inbox Discards all messages in the inbox.
mqtt_connect Establishes connection.
mqtt_create Creates a new connection and returns its handle.
mqtt_disconnect Disconnects the client from the server.
mqtt_free_message Releases memory where message is stored.
mqtt_get_length Returns the message payload length.
mqtt_get_payload Returns the message payload.
mqtt_get_topic Returns the message topic.
mqtt_publish Publishes a message.
mqtt_read_inbox Reads one message from the inbox and removes the message.
mqtt_set_client_id Sets the MQTT Client ID.
mqtt_set_credentials Sets the user name and password.
mqtt_set_lwt Sets the Last Will and Testament message.
mqtt_set_tls_certificate Sets the TLS private key file, certificate file and the private key password.
mqtt_set_tls_parameters Sets the TLS version and cipher list.
mqtt_subscribe Subscribes the client to a topic.
mqtt_unsubscribe Unsubscribes the client from a topic.