mqtt_disconnect_param Struct Reference

Parameters for disconnect message. More...

#include <mqtt.h>

Data Fields
enum mqtt_disconnect_reason_code	reason_code
struct {
struct mqtt_utf8_pair   user_prop [CONFIG_MQTT_USER_PROPERTIES_MAX]
	MQTT 5.0, chapter 3.14.2.2.4 User Property. More...
struct mqtt_utf8   reason_string
	MQTT 5.0, chapter 3.14.2.2.3 Reason String. More...
struct mqtt_utf8   server_reference
	MQTT 5.0, chapter 3.14.2.2.5 Server Reference. More...
uint32_t   session_expiry_interval
	MQTT 5.0, chapter 3.14.2.2.2 Session Expiry Interval. More...
struct {
bool   has_session_expiry_interval
	Session Expiry Interval property was present. More...
bool   has_reason_string
	Reason String property was present. More...
bool   has_user_prop
	User Property property was present. More...
bool   has_server_reference
	Server Reference property was present. More...
}   rx
	Flags indicating whether given property was present in received packet. More...
}	prop
	MQTT 5.0 properties.

Detailed Description

Parameters for disconnect message.

Field Documentation

has_reason_string

bool mqtt_disconnect_param::has_reason_string

Reason String property was present.

has_server_reference

bool mqtt_disconnect_param::has_server_reference

Server Reference property was present.

has_session_expiry_interval

bool mqtt_disconnect_param::has_session_expiry_interval

Session Expiry Interval property was present.

has_user_prop

bool mqtt_disconnect_param::has_user_prop

User Property property was present.

[struct]

struct { ... } mqtt_disconnect_param::prop

MQTT 5.0 properties.

reason_code

enum mqtt_disconnect_reason_code mqtt_disconnect_param::reason_code

reason_string

struct mqtt_utf8 mqtt_disconnect_param::reason_string

MQTT 5.0, chapter 3.14.2.2.3 Reason String.

[struct]

struct { ... } mqtt_disconnect_param::rx

Flags indicating whether given property was present in received packet.

server_reference

struct mqtt_utf8 mqtt_disconnect_param::server_reference

MQTT 5.0, chapter 3.14.2.2.5 Server Reference.

session_expiry_interval

uint32_t mqtt_disconnect_param::session_expiry_interval

MQTT 5.0, chapter 3.14.2.2.2 Session Expiry Interval.

user_prop

struct mqtt_utf8_pair mqtt_disconnect_param::user_prop[CONFIG_MQTT_USER_PROPERTIES_MAX]

MQTT 5.0, chapter 3.14.2.2.4 User Property.

---

The documentation for this struct was generated from the following file:

• include/zephyr/net/mqtt.h