CommsChampion Ecosystem MQTT v5 Client
MQTT v5 Client Library.
|
Classes | |
struct | CC_Mqtt5DisconnectConfig |
Configuration structure of the "disconnect" operation. More... | |
Typedefs | |
typedef struct CC_Mqtt5Disconnect * | CC_Mqtt5DisconnectHandle |
Handle for "disconnect" operation. More... | |
typedef struct CC_Mqtt5Disconnect* CC_Mqtt5DisconnectHandle |
Handle for "disconnect" operation.
Returned by cc_mqtt5_client_disconnect_prepare() function.
CC_Mqtt5ErrorCode cc_mqtt5_client_disconnect | ( | CC_Mqtt5ClientHandle | handle, |
const CC_Mqtt5DisconnectConfig * | config | ||
) |
Prepare, configure, and send "disconnect" request in one go.
Abstracts away sequence of the following functions invocation:
[in] | handle | Handle returned by cc_mqtt5_client_alloc() function. |
[in] | config | Configuration. Can be NULL. |
CC_Mqtt5ErrorCode cc_mqtt5_client_disconnect_add_user_prop | ( | CC_Mqtt5DisconnectHandle | handle, |
const CC_Mqtt5UserProp * | prop | ||
) |
Add user property to the configuration of the "disconnect" operation.
[in] | handle | Handle returned by cc_mqtt5_client_disconnect_prepare() function. |
[in] | prop | Single user property info. Must NOT be NULL. Does not need to be preserved after invocation. |
CC_Mqtt5ErrorCode cc_mqtt5_client_disconnect_cancel | ( | CC_Mqtt5DisconnectHandle | handle | ) |
Cancel the allocated "disconnect" operation.
[in] | handle | Handle returned by cc_mqtt5_client_disconnect_prepare() function. |
CC_Mqtt5ErrorCode cc_mqtt5_client_disconnect_config | ( | CC_Mqtt5DisconnectHandle | handle, |
const CC_Mqtt5DisconnectConfig * | config | ||
) |
Perform configuration of the "disconnect" operation.
[in] | handle | Handle returned by cc_mqtt5_client_disconnect_prepare() function. |
[in] | config | Extra properties configuration structure. Must NOT be NULL. Does not need to be preserved after invocation. |
void cc_mqtt5_client_disconnect_init_config | ( | CC_Mqtt5DisconnectConfig * | config | ) |
Intialize the CC_Mqtt5DisconnectConfig configuration structure.
[out] | config | Configuration structure. Must not be NULL. |
CC_Mqtt5DisconnectHandle cc_mqtt5_client_disconnect_prepare | ( | CC_Mqtt5ClientHandle | handle, |
CC_Mqtt5ErrorCode * | ec | ||
) |
Prepare "disconnect" operation.
For successful operation the client needs to be in the "connected" state and there were no other prepared or complete "disconnect" operation since last "connect" operation.
[in] | handle | Handle returned by cc_mqtt5_client_alloc() function. |
[out] | ec | Error code reporting result of the operation. Can be NULL. |
CC_Mqtt5ErrorCode cc_mqtt5_client_disconnect_send | ( | CC_Mqtt5DisconnectHandle | handle | ) |
Send the configured "disconnect" operation to broker.
[in] | handle | Handle returned by cc_mqtt5_client_disconnect_prepare() function. |