mqtt_auth_param Struct Reference

Parameters for auth message. More...

#include <mqtt.h>

Data Fields
enum mqtt_auth_reason_code	reason_code
struct {
struct mqtt_utf8_pair   user_prop [CONFIG_MQTT_USER_PROPERTIES_MAX]
	MQTT 5.0, chapter 3.15.2.2.5 User Property. More...
struct mqtt_utf8   auth_method
	MQTT 5.0, chapter 3.15.2.2.2 Authentication Method. More...
struct mqtt_binstr   auth_data
	MQTT 5.0, chapter 3.15.2.2.3 Authentication Data. More...
struct mqtt_utf8   reason_string
	MQTT 5.0, chapter 3.15.2.2.4 Reason String. More...
struct {
bool   has_auth_method
	Authentication Method property was present. More...
bool   has_auth_data
	Authentication Data property was present. More...
bool   has_reason_string
	Reason String property was present. More...
bool   has_user_prop
	User Property property was present. More...
}   rx
	Flags indicating whether given property was present in received packet. More...
}	prop

Detailed Description

Parameters for auth message.

Field Documentation

auth_data

struct mqtt_binstr mqtt_auth_param::auth_data

MQTT 5.0, chapter 3.15.2.2.3 Authentication Data.

auth_method

struct mqtt_utf8 mqtt_auth_param::auth_method

MQTT 5.0, chapter 3.15.2.2.2 Authentication Method.

has_auth_data

bool mqtt_auth_param::has_auth_data

Authentication Data property was present.

has_auth_method

bool mqtt_auth_param::has_auth_method

Authentication Method property was present.

has_reason_string

bool mqtt_auth_param::has_reason_string

Reason String property was present.

has_user_prop

bool mqtt_auth_param::has_user_prop

User Property property was present.

[struct]

struct { ... } mqtt_auth_param::prop

reason_code

enum mqtt_auth_reason_code mqtt_auth_param::reason_code

reason_string

struct mqtt_utf8 mqtt_auth_param::reason_string

MQTT 5.0, chapter 3.15.2.2.4 Reason String.

[struct]

struct { ... } mqtt_auth_param::rx

Flags indicating whether given property was present in received packet.

user_prop

struct mqtt_utf8_pair mqtt_auth_param::user_prop[CONFIG_MQTT_USER_PROPERTIES_MAX]

MQTT 5.0, chapter 3.15.2.2.5 User Property.

---

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

• zephyr/net/mqtt.h