Skip to content

Commit ea036a5

Browse files
doc: Clarify deleted message event to cover QoS=0 case
Minor improvement on documentation for the event. Merges github.com//pull/290 Closes github.com//issues/289
1 parent b82c8f6 commit ea036a5

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

include/mqtt_client.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,13 @@ typedef enum esp_mqtt_event_id_t {
8080
MQTT_EVENT_BEFORE_CONNECT, /*!< The event occurs before connecting */
8181
MQTT_EVENT_DELETED, /*!< Notification on delete of one message from the
8282
internal outbox, if the message couldn't have been sent
83-
and acknowledged before expiring defined in
83+
or acknowledged before expiring defined in
8484
OUTBOX_EXPIRED_TIMEOUT_MS. (events are not posted upon
8585
deletion of successfully acknowledged messages)
8686
- This event id is posted only if
8787
MQTT_REPORT_DELETED_MESSAGES==1
8888
- Additional context: msg_id (id of the deleted
89-
message).
89+
message, always 0 for QoS = 0 messages).
9090
*/
9191
MQTT_USER_EVENT, /*!< Custom event used to queue tasks into mqtt event handler
9292
All fields from the esp_mqtt_event_t type could be used to pass

0 commit comments

Comments
 (0)