pkg/paho-mqtt: Update doc.txt #21136
Open
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
Add some Information about the paho stack
github-actions
bot
added
Area: network
OlegHahm
reviewed
Jan 14, 2025
| @see https://github.com/eclipse/paho.mqtt.embedded-c | ||
|
|
||
| The Eclipse Paho project provides open-source client | ||
| implementations of MQTT. |
There was a problem hiding this comment.
Isn't that redundant to the @brief text?
|
|
||
| # Implementation specific information | ||
|
|
||
| - The Main-Loop is running in the Task mqtt_riot_run() with a default-cyclus of 30ms (MQTT_YIELD_POLLING_MS) |
There was a problem hiding this comment.
Suggested change
| - The Main-Loop is running in the Task mqtt_riot_run() with a default-cyclus of 30ms (MQTT_YIELD_POLLING_MS) | |
| - The main loop is running in a dedicated thread (` paho_mqtt_riot`) in the function `mqtt_riot_run()` with a default-cyclus of 30ms (MQTT_YIELD_POLLING_MS) |
I'm not sure if we have a well defined meaning for the term "Task" in RIOT.
Comment on lines
+20
to
+21
| - During publish a topic with MQTTPublish() and QoS>0, the functions blocks until | ||
| it receive des One Acknowledge (QoS=1) or two Acknowledges (Qos=2). |
There was a problem hiding this comment.
Suggested change
| - During publish a topic with MQTTPublish() and QoS>0, the functions blocks until | |
| it receive des One Acknowledge (QoS=1) or two Acknowledges (Qos=2). | |
| - When publishing a topic with `MQTTPublish()` and QoS>0, the functions blocks until | |
| it one acknowledgement (QoS=1) or two acknowledgements (QoS=2) are received.. |
|
Thanks for the contribution and improvement - and welcome to RIOT! And sorry for my somewhat pedantic review: actually I thought to review a PR my a fellow RIOT maintainer. 😅 |
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.
Add some Information about the paho stack in the doc.txt file
Contribution description
Testing procedure
Issues/PRs references