CommsChampion Ecosystem MQTT v5 Client
MQTT v5 Client Library.
|
Classes | |
struct | CC_Mqtt5AuthConfig |
Authentication Configuration. More... | |
struct | CC_Mqtt5AuthInfo |
Authentication handshake information. More... | |
struct | CC_Mqtt5DisconnectInfo |
Broker disconnection information. More... | |
struct | CC_Mqtt5MessageInfo |
Received message information. More... | |
struct | CC_Mqtt5UserProp |
Wraping structre of the single "User Property". More... | |
Macros | |
#define | CC_MQTT5_CLIENT_MAJOR_VERSION 1U |
Major verion of the library. | |
#define | CC_MQTT5_CLIENT_MAKE_VERSION(major_, minor_, patch_) |
Macro to create numeric version as single unsigned number. | |
#define | CC_MQTT5_CLIENT_MINOR_VERSION 0U |
Minor verion of the library. | |
#define | CC_MQTT5_CLIENT_PATCH_VERSION 0U |
Patch level of the library. | |
#define | CC_MQTT5_CLIENT_VERSION CC_MQTT5_CLIENT_MAKE_VERSION(CC_MQTT5_CLIENT_MAJOR_VERSION, CC_MQTT5_CLIENT_MINOR_VERSION, CC_MQTT5_CLIENT_PATCH_VERSION) |
Version of the library as single numeric value. | |
#define | CC_MQTT5_MAX_TOPIC_ALIASES_LIMIT 0xffff |
MQTT5 protocol limit to topic alias. More... | |
#define | CC_MQTT5_SESSION_NEVER_EXPIRES 0xffffffff |
Special value for "Session Expiry Interval" property to specify that session never expires. More... | |
Functions | |
void | cc_mqtt5_client_init_user_prop (CC_Mqtt5UserProp *prop) |
Intialize the CC_Mqtt5UserProp structure. More... | |
#define CC_MQTT5_MAX_TOPIC_ALIASES_LIMIT 0xffff |
MQTT5 protocol limit to topic alias.
The application is expected not to allocate more than 65535 topic aliases.
#define CC_MQTT5_SESSION_NEVER_EXPIRES 0xffffffff |
Special value for "Session Expiry Interval" property to specify that session never expires.
Status of the asynchronous operation.
Error code returned by the CC_Mqtt5AuthCb callback.
Reason for reporting unsolicited broker disconnection.
enum CC_Mqtt5ErrorCode |
Error code returned by various API functions.
enum CC_Mqtt5QoS |
enum CC_Mqtt5ReasonCode |
"Reason Code" as defined in MQTT v5 specification
void cc_mqtt5_client_init_user_prop | ( | CC_Mqtt5UserProp * | prop | ) |
Intialize the CC_Mqtt5UserProp structure.
[out] | prop | User property info. Must not be NULL. |