mirror/mongoose
1
0
Fork 0
mirror of https://github.com/cesanta/mongoose.git synced 2024-11-24 11:09:01 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Merge pull request #2233 from cesanta/disambiguate

Browse Source 
disambiguate comments
This commit is contained in:
Sergio R. Caprile 2023-06-05 18:57:25 -03:00 committed by GitHub
commit 71e44d5b65
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 23 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
mongoose.h
View File

@ -1458,28 +1458,28 @@ struct mg_mqtt_opts {
struct mg_str user; // Username, can be empty struct mg_str user; // Username, can be empty
struct mg_str pass; // Password, can be empty struct mg_str pass; // Password, can be empty
struct mg_str client_id; // Client ID struct mg_str client_id; // Client ID
struct mg_str topic; // topic struct mg_str topic; // message/subscription topic
struct mg_str message; // message struct mg_str message; // message content
uint8_t qos; // message quality of service uint8_t qos; // message quality of service
uint8_t version; // Can be 4 (3.1.1), or 5. If 0, assume 4. uint8_t version; // Can be 4 (3.1.1), or 5. If 0, assume 4
uint16_t keepalive; // Keep-alive timer in seconds uint16_t keepalive; // Keep-alive timer in seconds
bool retain; // Retain last will bool retain; // Retain flag
bool clean; // Use clean session, 0 or 1 bool clean; // Clean session flag
struct mg_mqtt_prop *props; // MQTT5 props array struct mg_mqtt_prop *props; // MQTT5 props array
size_t num_props; // number of props size_t num_props; // number of props
struct mg_mqtt_prop *will_props; // Valid only for CONNECT packet struct mg_mqtt_prop *will_props; // Valid only for CONNECT packet (MQTT5)
size_t num_will_props; // Number of will props size_t num_will_props; // Number of will props
}; };
struct mg_mqtt_message { struct mg_mqtt_message {
struct mg_str topic; // Parsed topic struct mg_str topic; // Parsed topic for PUBLISH
struct mg_str data; // Parsed message struct mg_str data; // Parsed message for PUBLISH
struct mg_str dgram; // Whole MQTT datagram, including headers struct mg_str dgram; // Whole MQTT packet, including headers
uint16_t id; // For PUBACK, PUBREC, PUBREL, PUBCOMP, SUBACK, PUBLISH uint16_t id; // For PUBACK, PUBREC, PUBREL, PUBCOMP, SUBACK, PUBLISH
uint8_t cmd; // MQTT command, one of MQTT_CMD_* uint8_t cmd; // MQTT command, one of MQTT_CMD_*
uint8_t qos; // Quality of service uint8_t qos; // Quality of service
uint8_t ack; // Connack return code. 0 - success uint8_t ack; // CONNACK return code, 0 = success
size_t props_start; // Offset to the start of the properties size_t props_start; // Offset to the start of the properties (MQTT5)
size_t props_size; // Length of the properties size_t props_size; // Length of the properties
}; };

22
src/mqtt.h
View File

@ -70,28 +70,28 @@ struct mg_mqtt_opts {
struct mg_str user; // Username, can be empty struct mg_str user; // Username, can be empty
struct mg_str pass; // Password, can be empty struct mg_str pass; // Password, can be empty
struct mg_str client_id; // Client ID struct mg_str client_id; // Client ID
struct mg_str topic; // topic struct mg_str topic; // message/subscription topic
struct mg_str message; // message struct mg_str message; // message content
uint8_t qos; // message quality of service uint8_t qos; // message quality of service
uint8_t version; // Can be 4 (3.1.1), or 5. If 0, assume 4. uint8_t version; // Can be 4 (3.1.1), or 5. If 0, assume 4
uint16_t keepalive; // Keep-alive timer in seconds uint16_t keepalive; // Keep-alive timer in seconds
bool retain; // Retain last will bool retain; // Retain flag
bool clean; // Use clean session, 0 or 1 bool clean; // Clean session flag
struct mg_mqtt_prop *props; // MQTT5 props array struct mg_mqtt_prop *props; // MQTT5 props array
size_t num_props; // number of props size_t num_props; // number of props
struct mg_mqtt_prop *will_props; // Valid only for CONNECT packet struct mg_mqtt_prop *will_props; // Valid only for CONNECT packet (MQTT5)
size_t num_will_props; // Number of will props size_t num_will_props; // Number of will props
}; };
struct mg_mqtt_message { struct mg_mqtt_message {
struct mg_str topic; // Parsed topic struct mg_str topic; // Parsed topic for PUBLISH
struct mg_str data; // Parsed message struct mg_str data; // Parsed message for PUBLISH
struct mg_str dgram; // Whole MQTT datagram, including headers struct mg_str dgram; // Whole MQTT packet, including headers
uint16_t id; // For PUBACK, PUBREC, PUBREL, PUBCOMP, SUBACK, PUBLISH uint16_t id; // For PUBACK, PUBREC, PUBREL, PUBCOMP, SUBACK, PUBLISH
uint8_t cmd; // MQTT command, one of MQTT_CMD_* uint8_t cmd; // MQTT command, one of MQTT_CMD_*
uint8_t qos; // Quality of service uint8_t qos; // Quality of service
uint8_t ack; // Connack return code. 0 - success uint8_t ack; // CONNACK return code, 0 = success
size_t props_start; // Offset to the start of the properties size_t props_start; // Offset to the start of the properties (MQTT5)
size_t props_size; // Length of the properties size_t props_size; // Length of the properties
}; };

1
test/unit_test.c
View File

@ -564,6 +564,7 @@ connect_with_options:
for (i = 0; i < 500 && !(test_data.flags & flags_completed); i++) for (i = 0; i < 500 && !(test_data.flags & flags_completed); i++)
mg_mgr_poll(&mgr, 10); mg_mgr_poll(&mgr, 10);
// TODO(): retry sending PUBREL on failure after an expected timeout // TODO(): retry sending PUBREL on failure after an expected timeout
// or broker sends PUBREC again
ASSERT(test_data.flags & flags_completed); ASSERT(test_data.flags & flags_completed);
for (i = 0; i < 500 && buf[1] == 0; i++) mg_mgr_poll(&mgr, 10); for (i = 0; i < 500 && buf[1] == 0; i++) mg_mgr_poll(&mgr, 10);
if (strcmp(buf, "Xx/f12/hi") != 0) MG_INFO(("[%s]", buf)); if (strcmp(buf, "Xx/f12/hi") != 0) MG_INFO(("[%s]", buf));