doc: Add MQTT high-level description #13125
Merged
Conversation
This file contains hidden or 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
Codecov Report
@@ Coverage Diff @@
## master #13125 +/- ##
=======================================
Coverage 48.73% 48.73%
=======================================
Files 315 315
Lines 46540 46540
Branches 10743 10743
=======================================
Hits 22679 22679
Misses 19349 19349
Partials 4512 4512Continue to review full report at Codecov.
|
jukkar
reviewed
Feb 7, 2019
doc/reference/networking/mqtt.rst
Outdated
| client_ctx.broker = &broker; | ||
| client_ctx.evt_cb = mqtt_evt_handler; | ||
| client_ctx.client_id.utf8 = (u8_t *)"zephyr_mqtt_client"; | ||
| client_ctx.client_id.size = strlen("zephyr_mqtt_client"); |
There was a problem hiding this comment.
It probably does not matter much for example code but it is better to write this
client_ctx.client_id.size = sizeof("zephyr_mqtt_client") - 1;
That way we avoid a function call as the sizeof() is evaluated at compile time.
dbkinder
previously requested changes
Feb 7, 2019
|
Thank you @dbkinder for review and suggestions, I've updated the PR. |
Add high-level documentation for MQTT library. Signed-off-by: Robert Lubos <[email protected]>
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 high-level documentation for MQTT library.
Fixes #12957.
Signed-off-by: Robert Lubos [email protected]