Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Minor README rewording to better fit API documentation
  • Loading branch information
TwistedTwigleg committed Aug 12, 2022
commit 41137bbffc2b42533abd58d0530fd038ac4bff60
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,10 +240,11 @@ client.subscribe(topic);

**Note**: all operations (publish, subscribe, unsubscribe) will not timeout unless
you define a timeout when performing the operation. If no timeout is defined, then
a value of `0` is used, meaning the operation will never timeout and will wait
forever for the server to respond.
It is recommended to set a timeout for QoS1 operations so that if your application
does not get an acknowledgement from the server for whatever reason, it is not stuck.
a value of `0` is used, meaning the operation will never timeout and, in rare cases,
wait forever for the server to respond and block the calling thread indefinitely.
It is recommended to set a timeout for QoS1 operations if your application expects
responses within a fixed duration or if there is the possibility the server you are
communicating with may not respond.

### Shadow Methods
To access a shadow using a blocking API:
Expand Down