Skip to content

Commit 17b966f

Browse files
committed
Fix SSOT check
Signed-off-by: Gaurav Aggarwal <aggarg@amazon.com>
1 parent 4a5da11 commit 17b966f

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

source/interface/transport_interface.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@
9696
* without TLS, it is typically implemented by calling the TCP layer receive
9797
* function. @ref TransportRecv_t may be invoked multiple times by the protocol
9898
* library, if fewer bytes than were requested to receive are returned.
99+
* Please note that it is HIGHLY RECOMMENDED that the transport receive implementation does NOT block.
99100
* <br><br>
100101
* <b>Example code:</b>
101102
* @code{c}
@@ -200,6 +201,9 @@ typedef struct NetworkContext NetworkContext_t;
200201
* coreMQTT will continue to call the transport interface if it receives
201202
* a partial packet until it accumulates enough data to get the complete
202203
* MQTT packet.
204+
* A non‐blocking implementation is also essential so that the library's inbuilt
205+
* keep‐alive mechanism can work properly, given the user chooses to use
206+
* that over their own keep alive mechanism.
203207
*
204208
* @param[in] pNetworkContext Implementation-defined network context.
205209
* @param[in] pBuffer Buffer to receive the data into.

0 commit comments

Comments
 (0)