Add the parsing of DISCONNECT packet for MQTT 5 (IDFGH-14489) #295
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In mqtt5 protocol the disconnect packet is sent from the broker with a reason code. Create the function to parse it and get it back in the disconnect_rsp_code variable. Signed-off-by: Flavia Caforio <[email protected]>
Add this variable to the esp_mqtt_error_codes_t structure. In the mqtt5 protocol the broker can disconnect the client with a disconnect packet. This packet contains a reason value that can be useful for certain applications in which it is important to know the reason of disconnection. Signed-off-by: Flavia Caforio <[email protected]>
While the client is connected is possible that a disconnect packet is reaceived by the broker to force a disconnection. Before this patch this approach causes a generic error on transport in case of disconnection from the broker. If the packet is managed before getting an error it is possible to save the reason code in the disconnect_return_code variable in the error_handle, and dispatch the disconnect event that can be managed by the application event loop, that now can know the reason of disconnection from the broker. Reset the variable in case of error. Signed-off-by: Flavia Caforio <[email protected]>
github-actions
bot
changed the title
|
Hi @bogdankolendovskyy! Sorry to bother you, can you please approve the workflows? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
In the MQTT 5 protocol the broker can disconnect the client with a DISCONNECT packet. This packet contains the reason code of the forced disconnection.
Before these patches the DISCONNECT packet was not parsed and it was not possible to know and check the disconnection reason by the broker at application level.
So now in mqtt_process_receive also the disconnect packets are processed, setting the disconnect_return_code variable in the error_handle structure (as per the connect_return_code) and sending the event to the application event loop.
Related
Testing
I tested it with a mqtt 5 server and 2 ESP32-S3-WROOM-1-N16R8V modules.
When the two modules were connected to the broker with same client ID, the first one was kicked out (as per specification). I wanted to have the reason code of the DISCONNECT packet so if it was 0x8E (MQTT5_SESSION_TAKEN_OVER), the first client is not continuing reconnecting in my application (it was creating a loop of connection and disconnection between the first and the second client).
I found this solutions, but I am open to suggestion! Thanks!
Checklist
Before submitting a Pull Request, please ensure the following: