Zephyr API Documentation 4.1.99
A Scalable Open Source RTOS
|
|
4.1.99 |
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 | |
Parameters for a connection acknowledgment (CONNACK).
struct mqtt_utf8 mqtt_connack_param::assigned_client_id |
MQTT 5.0, chapter 3.2.2.3.7 Assigned Client Identifier.
struct mqtt_binstr mqtt_connack_param::auth_data |
MQTT 5.0, chapter 3.2.2.3.18 Authentication Data.
struct mqtt_utf8 mqtt_connack_param::auth_method |
MQTT 5.0, chapter 3.2.2.3.17 Authentication Method.
bool mqtt_connack_param::has_assigned_client_id |
Assigned Client Identifier property was present.
bool mqtt_connack_param::has_auth_data |
Authentication Data property was present.
bool mqtt_connack_param::has_auth_method |
Authentication Method property was present.
bool mqtt_connack_param::has_maximum_packet_size |
Maximum Packet Size property was present.
bool mqtt_connack_param::has_maximum_qos |
Maximum QoS property was present.
bool mqtt_connack_param::has_reason_string |
Reason String property was present.
bool mqtt_connack_param::has_receive_maximum |
Receive Maximum property was present.
bool mqtt_connack_param::has_response_information |
Response Information property was present.
bool mqtt_connack_param::has_retain_available |
Retain Available property was present.
bool mqtt_connack_param::has_server_keep_alive |
Server Keep Alive property was present.
bool mqtt_connack_param::has_server_reference |
Server Reference property was present.
bool mqtt_connack_param::has_session_expiry_interval |
Session Expiry Interval property was present.
bool mqtt_connack_param::has_shared_sub_available |
Shared Subscription Available property was present.
bool mqtt_connack_param::has_subscription_ids_available |
Subscription Identifiers Available property was present.
bool mqtt_connack_param::has_topic_alias_maximum |
Topic Alias Maximum property was present.
bool mqtt_connack_param::has_user_prop |
User Property property was present.
bool mqtt_connack_param::has_wildcard_sub_available |
Wildcard Subscription Available property was present.
uint32_t mqtt_connack_param::maximum_packet_size |
MQTT 5.0, chapter 3.2.2.3.6 Maximum Packet Size.
uint8_t mqtt_connack_param::maximum_qos |
MQTT 5.0, chapter 3.2.2.3.4 Maximum QoS.
struct { ... } mqtt_connack_param::prop |
struct mqtt_utf8 mqtt_connack_param::reason_string |
MQTT 5.0, chapter 3.2.2.3.9 Reason String.
uint16_t mqtt_connack_param::receive_maximum |
MQTT 5.0, chapter 3.3.2.3.3 Receive Maximum.
struct mqtt_utf8 mqtt_connack_param::response_information |
MQTT 5.0, chapter 3.2.2.3.15 Response Information.
uint8_t mqtt_connack_param::retain_available |
MQTT 5.0, chapter 3.2.2.3.5 Retain Available.
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 { ... } mqtt_connack_param::rx |
Flags indicating whether given property was present in received packet.
uint16_t mqtt_connack_param::server_keep_alive |
MQTT 5.0, chapter 3.2.2.3.14 Server Keep Alive.
struct mqtt_utf8 mqtt_connack_param::server_reference |
MQTT 5.0, chapter 3.2.2.3.16 Server Reference.
uint32_t mqtt_connack_param::session_expiry_interval |
MQTT 5.0, chapter 3.2.2.3.2 Session Expiry Interval.
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.
uint8_t mqtt_connack_param::shared_sub_available |
MQTT 5.0, chapter 3.2.2.3.13 Shared Subscription Available.
uint8_t mqtt_connack_param::subscription_ids_available |
MQTT 5.0, chapter 3.2.2.3.12 Subscription Identifiers Available.
uint16_t mqtt_connack_param::topic_alias_maximum |
MQTT 5.0, chapter 3.2.2.3.8 Topic Alias Maximum.
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.
uint8_t mqtt_connack_param::wildcard_sub_available |
MQTT 5.0, chapter 3.2.2.3.11 Wildcard Subscription Available.