MQTT client. More...
#include "lwip/apps/mqtt_opts.h"#include "lwip/err.h"#include "lwip/ip_addr.h"#include "lwip/prot/iana.h"Go to the source code of this file.
Data Structures | |
| struct | mqtt_connect_client_info_t |
| Client information and connection parameters. More... | |
Macros | |
| #define | MQTT_PORT LWIP_IANA_PORT_MQTT |
| Default MQTT port (non-TLS) More... | |
| #define | MQTT_TLS_PORT LWIP_IANA_PORT_SECURE_MQTT |
| Default MQTT TLS port. More... | |
| #define | mqtt_subscribe(client, topic, qos, cb, arg) mqtt_sub_unsub(client, topic, qos, cb, arg, 1) |
| Subscribe to topic. More... | |
| #define | mqtt_unsubscribe(client, topic, cb, arg) mqtt_sub_unsub(client, topic, 0, cb, arg, 0) |
| Unsubscribe to topic. More... | |
Typedefs | |
| typedef void(* | mqtt_connection_cb_t) (mqtt_client_t *client, void *arg, mqtt_connection_status_t status) |
| Function prototype for mqtt connection status callback. More... | |
| typedef void(* | mqtt_incoming_data_cb_t) (void *arg, const u8_t *data, u16_t len, u8_t flags) |
| Function prototype for MQTT incoming publish data callback function. More... | |
| typedef void(* | mqtt_incoming_publish_cb_t) (void *arg, const char *topic, u32_t tot_len) |
| Function prototype for MQTT incoming publish function. More... | |
| typedef void(* | mqtt_request_cb_t) (void *arg, err_t err) |
| Function prototype for mqtt request callback. More... | |
Enumerations |
MQTT client.
Definition in file mqtt.h.
| #define MQTT_PORT LWIP_IANA_PORT_MQTT |
| #define mqtt_subscribe | ( | client, | |
| topic, | |||
| qos, | |||
| cb, | |||
| arg | |||
| ) | mqtt_sub_unsub(client, topic, qos, cb, arg, 1) |
| #define MQTT_TLS_PORT LWIP_IANA_PORT_SECURE_MQTT |
| #define mqtt_unsubscribe | ( | client, | |
| topic, | |||
| cb, | |||
| arg | |||
| ) | mqtt_sub_unsub(client, topic, 0, cb, arg, 0) |
| typedef void(* mqtt_connection_cb_t) (mqtt_client_t *client, void *arg, mqtt_connection_status_t status) |
Function prototype for mqtt connection status callback.
Called when client has connected to the server after initiating a mqtt connection attempt by calling mqtt_client_connect() or when connection is closed by server or an error
| client | MQTT client itself |
| arg | Additional argument to pass to the callback function |
| status | Connect result code or disconnection notification |
| typedef void(* mqtt_incoming_data_cb_t) (void *arg, const u8_t *data, u16_t len, u8_t flags) |
Function prototype for MQTT incoming publish data callback function.
Called when data arrives to a subscribed topic
| arg | Additional argument to pass to the callback function |
| data | User data, pointed object, data may not be referenced after callback return, NULL is passed when all publish data are delivered |
| len | Length of publish data fragment |
| flags | MQTT_DATA_FLAG_LAST set when this call contains the last part of data from publish message |
| typedef void(* mqtt_incoming_publish_cb_t) (void *arg, const char *topic, u32_t tot_len) |
Function prototype for MQTT incoming publish function.
Called when an incoming publish arrives to a subscribed topic
| arg | Additional argument to pass to the callback function |
| topic | Zero terminated Topic text string, topic may not be referenced after callback return |
| tot_len | Total length of publish data, if set to 0 (no publish payload) data callback will not be invoked |
| typedef void(* mqtt_request_cb_t) (void *arg, err_t err) |
Function prototype for mqtt request callback.
Called when a subscribe, unsubscribe or publish request has completed
| arg | Pointer to user data supplied when invoking request |
| err | ERR_OK on success ERR_TIMEOUT if no response was received within timeout, ERR_ABRT if (un)subscribe was denied |
| anonymous enum |
Connection status codes.