...
The following callbacks are of type MQTTc_CMPL_CALLBACK
. Even though they are optional, they are necessary to know that a particular message has been completely sent, in order to re-use it for another message. The generic complete callback may be used to emulate all other callbacks in this category.
Panel |
---|
title | Table - MQTTc On Complete Callback Functions |
---|
|
Trigger Event | Description | MQTTc_ConnSetParam type |
---|
Any message completed (in this section, not a received PUBLISH message) | Generic notification for any event. | MQTTc_PARAM_TYPE_CALLBACK_ON_COMPL | CONNECT message completed | Notify that a CONNECT message has completed. | MQTTc_PARAM_TYPE_CALLBACK_ON_CONNECT_CMPL | PUBLISH (to broker) message completed | Notify that a PUBLISH message has completed. | MQTTc_PARAM_TYPE_CALLBACK_ON_PUBLISH_CMPL | SUBSCRIBE message completed | Notify that a SUBSCRIBE message has completed. | MQTTc_PARAM_TYPE_CALLBACK_ON_SUBSCRIBE_CMPL | UNSUBSCRIBE message completed | Notify that an UNSUBSCRIBE message has completed. | MQTTc_PARAM_TYPE_CALLBACK_ON_UNSUBSCRIBE_CMPL | PINGREQ message completed | Notify that a PINGREQ message has completed. | MQTTc_PARAM_TYPE_CALLBACK_ON_PINGREQ_CMPL | DISCONNECT message completed | Notify that a DISCONNECT message has completed. | MQTTc_PARAM_TYPE_CALLBACK_ON_DISCONNECT_CMPL |
|
On Error Callback
This callback is of type MQTTc_ERR_CALLBACK
. Even though it is optional, it is recommended to have it, to know if a problem occurs.
Panel |
---|
title | Table - MQTTc On Error Callback Function |
---|
|
Trigger Event | Description | MQTTc_ConnSetParam type |
---|
At any time an error occurs on the connection and is not related to a particular message | Notify that an error occurred on the connection. | MQTTc_PARAM_TYPE_CALLBACK_ON_ERR_CALLBACK |
|
On PUBLISH
message received callback
This callback is of type MQTTc_PUBLISH_RX_CALLBACK
. This callback is required only if the application expects to receive data from the broker. If not, it will never be called.
Panel |
---|
title | Table - MQTTc On PUBLISH received Callback Function |
---|
|
Trigger Event | Description | MQTTc_ConnSetParam type |
---|
A PUBLISH message has been completely received | Notify that a PUBLISH message has completed to be received. | MQTTc_PARAM_TYPE_CALLBACK_ON_PUBLISH_RX |
|