Zephyr API Documentation 4.1.99
A Scalable Open Source RTOS
 4.1.99
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
mqtt_connack_param Struct Reference

Parameters for a connection acknowledgment (CONNACK). More...

#include <mqtt.h>

Data Fields

uint8_t session_present_flag
 The Session Present flag enables a Client to establish whether the Client and Server have a consistent view about whether there is already stored Session state.
 
uint8_t return_code
 The appropriate non-zero Connect return code indicates if the Server is unable to process a connection request for some reason.
 
struct { 
 
   struct mqtt_utf8_pair   user_prop [CONFIG_MQTT_USER_PROPERTIES_MAX] 
 MQTT 5.0, chapter 3.2.2.3.10 User Property. More...
 
   struct mqtt_utf8   assigned_client_id 
 MQTT 5.0, chapter 3.2.2.3.7 Assigned Client Identifier. More...
 
   struct mqtt_utf8   reason_string 
 MQTT 5.0, chapter 3.2.2.3.9 Reason String. More...
 
   struct mqtt_utf8   response_information 
 MQTT 5.0, chapter 3.2.2.3.15 Response Information. More...
 
   struct mqtt_utf8   server_reference 
 MQTT 5.0, chapter 3.2.2.3.16 Server Reference. More...
 
   struct mqtt_utf8   auth_method 
 MQTT 5.0, chapter 3.2.2.3.17 Authentication Method. More...
 
   struct mqtt_binstr   auth_data 
 MQTT 5.0, chapter 3.2.2.3.18 Authentication Data. More...
 
   uint32_t   session_expiry_interval 
 MQTT 5.0, chapter 3.2.2.3.2 Session Expiry Interval. More...
 
   uint32_t   maximum_packet_size 
 MQTT 5.0, chapter 3.2.2.3.6 Maximum Packet Size. More...
 
   uint16_t   receive_maximum 
 MQTT 5.0, chapter 3.3.2.3.3 Receive Maximum. More...
 
   uint16_t   topic_alias_maximum 
 MQTT 5.0, chapter 3.2.2.3.8 Topic Alias Maximum. More...
 
   uint16_t   server_keep_alive 
 MQTT 5.0, chapter 3.2.2.3.14 Server Keep Alive. More...
 
   uint8_t   maximum_qos 
 MQTT 5.0, chapter 3.2.2.3.4 Maximum QoS. More...
 
   uint8_t   retain_available 
 MQTT 5.0, chapter 3.2.2.3.5 Retain Available. More...
 
   uint8_t   wildcard_sub_available 
 MQTT 5.0, chapter 3.2.2.3.11 Wildcard Subscription Available. More...
 
   uint8_t   subscription_ids_available 
 MQTT 5.0, chapter 3.2.2.3.12 Subscription Identifiers Available. More...
 
   uint8_t   shared_sub_available 
 MQTT 5.0, chapter 3.2.2.3.13 Shared Subscription Available. More...
 
   struct { 
 
      bool   has_session_expiry_interval 
 Session Expiry Interval property was present. More...
 
      bool   has_receive_maximum 
 Receive Maximum property was present. More...
 
      bool   has_maximum_qos 
 Maximum QoS property was present. More...
 
      bool   has_retain_available 
 Retain Available property was present. More...
 
      bool   has_maximum_packet_size 
 Maximum Packet Size property was present. More...
 
      bool   has_assigned_client_id 
 Assigned Client Identifier property was present. More...
 
      bool   has_topic_alias_maximum 
 Topic Alias Maximum 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_wildcard_sub_available 
 Wildcard Subscription Available property was present. More...
 
      bool   has_subscription_ids_available 
 Subscription Identifiers Available property was present. More...
 
      bool   has_shared_sub_available 
 Shared Subscription Available property was present. More...
 
      bool   has_server_keep_alive 
 Server Keep Alive property was present. More...
 
      bool   has_response_information 
 Response Information property was present. More...
 
      bool   has_server_reference 
 Server Reference property was present. More...
 
      bool   has_auth_method 
 Authentication Method property was present. More...
 
      bool   has_auth_data 
 Authentication Data property was present. More...
 
   }   rx 
 Flags indicating whether given property was present in received packet. More...
 
prop 
 

Detailed Description

Parameters for a connection acknowledgment (CONNACK).

Field Documentation

◆ assigned_client_id

struct mqtt_utf8 mqtt_connack_param::assigned_client_id

MQTT 5.0, chapter 3.2.2.3.7 Assigned Client Identifier.

◆ auth_data

struct mqtt_binstr mqtt_connack_param::auth_data

MQTT 5.0, chapter 3.2.2.3.18 Authentication Data.

◆ auth_method

struct mqtt_utf8 mqtt_connack_param::auth_method

MQTT 5.0, chapter 3.2.2.3.17 Authentication Method.

◆ has_assigned_client_id

bool mqtt_connack_param::has_assigned_client_id

Assigned Client Identifier property was present.

◆ has_auth_data

bool mqtt_connack_param::has_auth_data

Authentication Data property was present.

◆ has_auth_method

bool mqtt_connack_param::has_auth_method

Authentication Method property was present.

◆ has_maximum_packet_size

bool mqtt_connack_param::has_maximum_packet_size

Maximum Packet Size property was present.

◆ has_maximum_qos

bool mqtt_connack_param::has_maximum_qos

Maximum QoS property was present.

◆ has_reason_string

bool mqtt_connack_param::has_reason_string

Reason String property was present.

◆ has_receive_maximum

bool mqtt_connack_param::has_receive_maximum

Receive Maximum property was present.

◆ has_response_information

bool mqtt_connack_param::has_response_information

Response Information property was present.

◆ has_retain_available

bool mqtt_connack_param::has_retain_available

Retain Available property was present.

◆ has_server_keep_alive

bool mqtt_connack_param::has_server_keep_alive

Server Keep Alive property was present.

◆ has_server_reference

bool mqtt_connack_param::has_server_reference

Server Reference property was present.

◆ has_session_expiry_interval

bool mqtt_connack_param::has_session_expiry_interval

Session Expiry Interval property was present.

◆ has_shared_sub_available

bool mqtt_connack_param::has_shared_sub_available

Shared Subscription Available property was present.

◆ has_subscription_ids_available

bool mqtt_connack_param::has_subscription_ids_available

Subscription Identifiers Available property was present.

◆ has_topic_alias_maximum

bool mqtt_connack_param::has_topic_alias_maximum

Topic Alias Maximum property was present.

◆ has_user_prop

bool mqtt_connack_param::has_user_prop

User Property property was present.

◆ has_wildcard_sub_available

bool mqtt_connack_param::has_wildcard_sub_available

Wildcard Subscription Available property was present.

◆ maximum_packet_size

uint32_t mqtt_connack_param::maximum_packet_size

MQTT 5.0, chapter 3.2.2.3.6 Maximum Packet Size.

◆ maximum_qos

uint8_t mqtt_connack_param::maximum_qos

MQTT 5.0, chapter 3.2.2.3.4 Maximum QoS.

◆ [struct]

struct { ... } mqtt_connack_param::prop

◆ reason_string

struct mqtt_utf8 mqtt_connack_param::reason_string

MQTT 5.0, chapter 3.2.2.3.9 Reason String.

◆ receive_maximum

uint16_t mqtt_connack_param::receive_maximum

MQTT 5.0, chapter 3.3.2.3.3 Receive Maximum.

◆ response_information

struct mqtt_utf8 mqtt_connack_param::response_information

MQTT 5.0, chapter 3.2.2.3.15 Response Information.

◆ retain_available

uint8_t mqtt_connack_param::retain_available

MQTT 5.0, chapter 3.2.2.3.5 Retain Available.

◆ return_code

uint8_t mqtt_connack_param::return_code

The appropriate non-zero Connect return code indicates if the Server is unable to process a connection request for some reason.

MQTT 3.1 - Return codes specified in mqtt_conn_return_code MQTT 5.0 - Reason codes specified in mqtt_connack_reason_code

◆ [struct]

struct { ... } mqtt_connack_param::rx

Flags indicating whether given property was present in received packet.

◆ server_keep_alive

uint16_t mqtt_connack_param::server_keep_alive

MQTT 5.0, chapter 3.2.2.3.14 Server Keep Alive.

◆ server_reference

struct mqtt_utf8 mqtt_connack_param::server_reference

MQTT 5.0, chapter 3.2.2.3.16 Server Reference.

◆ session_expiry_interval

uint32_t mqtt_connack_param::session_expiry_interval

MQTT 5.0, chapter 3.2.2.3.2 Session Expiry Interval.

◆ session_present_flag

uint8_t mqtt_connack_param::session_present_flag

The Session Present flag enables a Client to establish whether the Client and Server have a consistent view about whether there is already stored Session state.

◆ shared_sub_available

uint8_t mqtt_connack_param::shared_sub_available

MQTT 5.0, chapter 3.2.2.3.13 Shared Subscription Available.

◆ subscription_ids_available

uint8_t mqtt_connack_param::subscription_ids_available

MQTT 5.0, chapter 3.2.2.3.12 Subscription Identifiers Available.

◆ topic_alias_maximum

uint16_t mqtt_connack_param::topic_alias_maximum

MQTT 5.0, chapter 3.2.2.3.8 Topic Alias Maximum.

◆ user_prop

struct mqtt_utf8_pair mqtt_connack_param::user_prop[CONFIG_MQTT_USER_PROPERTIES_MAX]

MQTT 5.0, chapter 3.2.2.3.10 User Property.

◆ wildcard_sub_available

uint8_t mqtt_connack_param::wildcard_sub_available

MQTT 5.0, chapter 3.2.2.3.11 Wildcard Subscription Available.


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