espressif/esp-mqtt
1
0
Fork 1
mirror of https://github.com/espressif/esp-mqtt.git synced 2025-06-25 17:31:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

doc: Clarify deleted message event to cover QoS=0 case

Browse Source 
Minor improvement on documentation for the event.

Merges github.com/espressif/esp-mqtt/pull/290
Closes github.com/espressif/esp-mqtt/issues/289
This commit is contained in:
Euripedes Rocha
2024-11-15 10:38:10 +01:00
parent b82c8f6c87
commit ea036a5819
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
include/mqtt_client.h
View File

@ -80,13 +80,13 @@ typedef enum esp_mqtt_event_id_t {
MQTT_EVENT_BEFORE_CONNECT, /*!< The event occurs before connecting */ MQTT_EVENT_BEFORE_CONNECT, /*!< The event occurs before connecting */
MQTT_EVENT_DELETED, /*!< Notification on delete of one message from the MQTT_EVENT_DELETED, /*!< Notification on delete of one message from the
internal outbox, if the message couldn't have been sent internal outbox, if the message couldn't have been sent
and acknowledged before expiring defined in or acknowledged before expiring defined in
OUTBOX_EXPIRED_TIMEOUT_MS. (events are not posted upon OUTBOX_EXPIRED_TIMEOUT_MS. (events are not posted upon
deletion of successfully acknowledged messages) deletion of successfully acknowledged messages)
- This event id is posted only if - This event id is posted only if
MQTT_REPORT_DELETED_MESSAGES==1 MQTT_REPORT_DELETED_MESSAGES==1
- Additional context: msg_id (id of the deleted - Additional context: msg_id (id of the deleted
message). message, always 0 for QoS = 0 messages).
*/ */
MQTT_USER_EVENT, /*!< Custom event used to queue tasks into mqtt event handler MQTT_USER_EVENT, /*!< Custom event used to queue tasks into mqtt event handler
All fields from the esp_mqtt_event_t type could be used to pass All fields from the esp_mqtt_event_t type could be used to pass