sergiotarxz/nuttx-apps
sergiotarxz/nuttx-apps
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

webclient_get_tunnel: A comment about how to dispose the returned "conn"

Browse Source
This commit is contained in:
YAMAMOTO Takashi 2022-06-20 09:59:22 +09:00 committed by Xiang Xiao
parent d435858c53
commit fe109998c9
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
netutils/webclient/webclient.c
View File

@ -2504,6 +2504,17 @@ int webclient_get_poll_info(FAR struct webclient_context *ctx,
* This function also disposes the given webclient_context. * This function also disposes the given webclient_context.
* The context will be invalid after a call of this function. * The context will be invalid after a call of this function.
* *
* It's the caller's responsibility to close the returned
* webclient_conn_s, either using webclient_conn_close() or
* using the internal knowledge about the structure. (E.g.
* It's sometimes convenient/efficient for the caller to
* only keep conn->sockfd descriptor and free the rest of the
* structure using webclient_conn_free(). In that case, it will
* need to close() the descriptor after finishing on it.)
*
* It's the caller's responsibility to free the returned
* webclient_conn_s using webclient_conn_free().
*
****************************************************************************/ ****************************************************************************/
void webclient_get_tunnel(FAR struct webclient_context *ctx, void webclient_get_tunnel(FAR struct webclient_context *ctx,