GitHub/nodemcu-firmware
1
0
Fork 0
mirror of https://github.com/nodemcu/nodemcu-firmware.git synced 2025-01-30 21:12:55 +08:00
Code Issues Projects Releases Wiki Activity

Update mqtt documentation indicating the limitations of the subscribe(),

Browse Source 
unsubscribe() and publish() callback functions.
This commit is contained in:
Rick Lettow 2016-04-02 12:01:38 -05:00
parent a1ffe2e9fd
commit ca87271692
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/en/modules/mqtt.md
View File

@ -154,7 +154,8 @@ Publishes a message.
- `message` the message to publish, (buffer or string) - `message` the message to publish, (buffer or string)
- `qos` QoS level - `qos` QoS level
- `retain` retain flag - `retain` retain flag
- `function(client)` optional callback fired when PUBACK received - `function(client)` optional callback fired when PUBACK received. NOTE: When calling publish() more than once, the last callback function defined will be called for ALL publish commands.
#### Returns #### Returns
`true` on success, `false` otherwise `true` on success, `false` otherwise
@ -171,7 +172,7 @@ Subscribes to one or several topics.
- `topic` a [topic string](http://www.hivemq.com/blog/mqtt-essentials-part-5-mqtt-topics-best-practices) - `topic` a [topic string](http://www.hivemq.com/blog/mqtt-essentials-part-5-mqtt-topics-best-practices)
- `qos` QoS subscription level, default 0 - `qos` QoS subscription level, default 0
- `table` array of 'topic, qos' pairs to subscribe to - `table` array of 'topic, qos' pairs to subscribe to
- `function(client)` optional callback fired when subscription(s) succeeded - `function(client)` optional callback fired when subscription(s) succeeded. NOTE: When calling subscribe() more than once, the last callback function defined will be called for ALL subscribe commands.
#### Returns #### Returns
`true` on success, `false` otherwise `true` on success, `false` otherwise
@ -196,7 +197,7 @@ Unsubscribes from one or several topics.
#### Parameters #### Parameters
- `topic` a [topic string](http://www.hivemq.com/blog/mqtt-essentials-part-5-mqtt-topics-best-practices) - `topic` a [topic string](http://www.hivemq.com/blog/mqtt-essentials-part-5-mqtt-topics-best-practices)
- `table` array of 'topic, anything' pairs to unsubscribe from - `table` array of 'topic, anything' pairs to unsubscribe from
- `function(client)` optional callback fired when unsubscription(s) succeeded - `function(client)` optional callback fired when unsubscription(s) succeeded. NOTE: When calling unsubscribe() more than once, the last callback function defined will be called for ALL unsubscribe commands.
#### Returns #### Returns
`true` on success, `false` otherwise `true` on success, `false` otherwise