Zephyr API Documentation 4.2.0-rc3
A Scalable Open Source RTOS
|
|
4.2.0-rc3 |
MQTT Client definition to maintain information relevant to the client. More...
#include <zephyr/net/mqtt.h>
Data Fields | |
struct mqtt_internal | internal |
MQTT client internal state. | |
struct mqtt_transport | transport |
MQTT transport configuration and data. | |
struct mqtt_utf8 | client_id |
Unique client identification to be used for the connection. | |
const void * | broker |
Broker details, for example, address, port. | |
struct mqtt_utf8 * | user_name |
User name (if any) to be used for the connection. | |
struct mqtt_utf8 * | password |
Password (if any) to be used for the connection. | |
struct { | |
struct mqtt_utf8_pair user_prop [CONFIG_MQTT_USER_PROPERTIES_MAX] | |
MQTT 5.0, chapter 3.1.3.2.8 User Property. More... | |
struct mqtt_utf8 content_type | |
MQTT 5.0, chapter 3.1.3.2.5 Content Type. More... | |
struct mqtt_utf8 response_topic | |
MQTT 5.0, chapter 3.1.3.2.6 Response Topic. More... | |
struct mqtt_binstr correlation_data | |
MQTT 5.0, chapter 3.1.3.2.7 Correlation Data. More... | |
uint32_t will_delay_interval | |
MQTT 5.0, chapter 3.1.3.2.2 Will Delay Interval. More... | |
uint32_t message_expiry_interval | |
MQTT 5.0, chapter 3.1.3.2.4 Message Expiry Interval. More... | |
uint8_t payload_format_indicator | |
MQTT 5.0, chapter 3.1.3.2.3 Payload Format Indicator. More... | |
} | will_prop |
MQTT 5.0 Will properties. | |
struct mqtt_topic * | will_topic |
Will topic and QoS. | |
struct mqtt_utf8 * | will_message |
Will message. | |
mqtt_evt_cb_t | evt_cb |
Application callback registered with the module to get MQTT events. | |
uint8_t * | rx_buf |
Receive buffer used for MQTT packet reception in RX path. | |
uint32_t | rx_buf_size |
Size of receive buffer. | |
uint8_t * | tx_buf |
Transmit buffer used for creating MQTT packet in TX path. | |
uint32_t | tx_buf_size |
Size of transmit buffer. | |
uint16_t | keepalive |
Keepalive interval for this client in seconds. | |
uint8_t | protocol_version |
MQTT protocol version. | |
int8_t | unacked_ping |
Unanswered PINGREQ count on this connection. | |
struct { | |
struct mqtt_utf8_pair user_prop [CONFIG_MQTT_USER_PROPERTIES_MAX] | |
MQTT 5.0, chapter 3.1.2.11.8 User Property. More... | |
struct mqtt_utf8 auth_method | |
MQTT 5.0, chapter 3.1.2.11.9 Authentication Method. More... | |
struct mqtt_binstr auth_data | |
MQTT 5.0, chapter 3.1.2.11.10 Authentication Data. More... | |
uint32_t session_expiry_interval | |
MQTT 5.0, chapter 3.1.2.11.2 Session Expiry Interval. More... | |
uint32_t maximum_packet_size | |
MQTT 5.0, chapter 3.1.2.11.4 Maximum Packet Size. More... | |
uint16_t receive_maximum | |
MQTT 5.0, chapter 3.1.2.11.3 Receive Maximum. More... | |
bool request_response_info | |
MQTT 5.0, chapter 3.1.2.11.6 Request Response Information. More... | |
bool request_problem_info | |
MQTT 5.0, chapter 3.1.2.11.7 Request Response Information. More... | |
} | prop |
MQTT 5.0 properties. | |
uint8_t | will_retain: 1 |
Will retain flag, 1 if will message shall be retained persistently. | |
uint8_t | clean_session: 1 |
Clean session flag indicating a fresh (1) or a retained session (0). | |
void * | user_data |
User specific opaque data. |
MQTT Client definition to maintain information relevant to the client.
struct mqtt_binstr mqtt_client::auth_data |
MQTT 5.0, chapter 3.1.2.11.10 Authentication Data.
struct mqtt_utf8 mqtt_client::auth_method |
MQTT 5.0, chapter 3.1.2.11.9 Authentication Method.
const void* mqtt_client::broker |
Broker details, for example, address, port.
Address type should be compatible with transport used.
uint8_t mqtt_client::clean_session |
Clean session flag indicating a fresh (1) or a retained session (0).
Default is CONFIG_MQTT_CLEAN_SESSION.
struct mqtt_utf8 mqtt_client::client_id |
Unique client identification to be used for the connection.
struct mqtt_utf8 mqtt_client::content_type |
MQTT 5.0, chapter 3.1.3.2.5 Content Type.
struct mqtt_binstr mqtt_client::correlation_data |
MQTT 5.0, chapter 3.1.3.2.7 Correlation Data.
mqtt_evt_cb_t mqtt_client::evt_cb |
Application callback registered with the module to get MQTT events.
struct mqtt_internal mqtt_client::internal |
MQTT client internal state.
uint16_t mqtt_client::keepalive |
Keepalive interval for this client in seconds.
Default is CONFIG_MQTT_KEEPALIVE.
uint32_t mqtt_client::maximum_packet_size |
MQTT 5.0, chapter 3.1.2.11.4 Maximum Packet Size.
uint32_t mqtt_client::message_expiry_interval |
MQTT 5.0, chapter 3.1.3.2.4 Message Expiry Interval.
struct mqtt_utf8* mqtt_client::password |
Password (if any) to be used for the connection.
Note that if password is provided, user name shall also be provided. NULL indicates no password.
uint8_t mqtt_client::payload_format_indicator |
MQTT 5.0, chapter 3.1.3.2.3 Payload Format Indicator.
struct { ... } mqtt_client::prop |
MQTT 5.0 properties.
uint8_t mqtt_client::protocol_version |
MQTT protocol version.
uint16_t mqtt_client::receive_maximum |
MQTT 5.0, chapter 3.1.2.11.3 Receive Maximum.
bool mqtt_client::request_problem_info |
MQTT 5.0, chapter 3.1.2.11.7 Request Response Information.
bool mqtt_client::request_response_info |
MQTT 5.0, chapter 3.1.2.11.6 Request Response Information.
struct mqtt_utf8 mqtt_client::response_topic |
MQTT 5.0, chapter 3.1.3.2.6 Response Topic.
uint8_t* mqtt_client::rx_buf |
Receive buffer used for MQTT packet reception in RX path.
uint32_t mqtt_client::rx_buf_size |
Size of receive buffer.
uint32_t mqtt_client::session_expiry_interval |
MQTT 5.0, chapter 3.1.2.11.2 Session Expiry Interval.
struct mqtt_transport mqtt_client::transport |
MQTT transport configuration and data.
uint8_t* mqtt_client::tx_buf |
Transmit buffer used for creating MQTT packet in TX path.
uint32_t mqtt_client::tx_buf_size |
Size of transmit buffer.
int8_t mqtt_client::unacked_ping |
Unanswered PINGREQ count on this connection.
void* mqtt_client::user_data |
User specific opaque data.
struct mqtt_utf8* mqtt_client::user_name |
User name (if any) to be used for the connection.
NULL indicates no user name.
struct mqtt_utf8_pair mqtt_client::user_prop[CONFIG_MQTT_USER_PROPERTIES_MAX] |
MQTT 5.0, chapter 3.1.3.2.8 User Property.
MQTT 5.0, chapter 3.1.2.11.8 User Property.
uint32_t mqtt_client::will_delay_interval |
MQTT 5.0, chapter 3.1.3.2.2 Will Delay Interval.
struct mqtt_utf8* mqtt_client::will_message |
Will message.
Can be NULL. Non NULL value valid only if will topic is not NULL.
struct { ... } mqtt_client::will_prop |
MQTT 5.0 Will properties.
uint8_t mqtt_client::will_retain |
Will retain flag, 1 if will message shall be retained persistently.
struct mqtt_topic* mqtt_client::will_topic |
Will topic and QoS.
Can be NULL.