espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-12 21:57:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

[tcp] update otTcpConnect() doc to indicate currently supported behavior (#8835)

Browse Source 
This commit updates the documentation for `otTcpConnect()` indicating
that caller need to wait for `otTcpEstablished` callback indicating
that TCP connection was established  before it can start sending
data (e.g., calling `otTcpSendByReference()`).

It also removes the mention of "TCP Fast Open" which is not yet
supported.
This commit is contained in:
Abtin Keshavarzian
2023-03-13 22:17:51 -07:00
committed by GitHub
parent 5ddd9d7346
commit 2d0d9bef88
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/openthread/instance.h
+1 -1
View File
@@ -53,7 +53,7 @@ extern "C" {
* @note This number versions both OpenThread platform and user APIs.
*
*/
#define OPENTHREAD_API_VERSION (298)
#define OPENTHREAD_API_VERSION (299)
/**
* @addtogroup api-instance
include/openthread/tcp.h
+5 -5
View File
@@ -401,11 +401,11 @@ enum
/**
* Records the remote host and port for this connection.
*
* By default TCP Fast Open is used. This means that this function merely
* records the remote host and port, and that the TCP connection establishment
* handshake only happens on the first call to otTcpSendByReference(). TCP Fast
* Open can be explicitly disabled using @p aFlags, in which case the TCP
* connection establishment handshake is initiated immediately.
* Caller must wait for `otTcpEstablished` callback indicating that TCP
* connection establishment handshake is done before it can start sending data
* e.g., calling `otTcpSendByReference()`.
*
* The TCP Fast Open is not yet supported and @p aFlags is ignored.
*
* @param[in] aEndpoint A pointer to the TCP endpoint structure to connect.
* @param[in] aSockName The IP address and port of the host to which to connect.