cuberite/polarssl
1
0
Fork 0
mirror of https://github.com/cuberite/polarssl.git synced 2025-09-12 00:26:27 -04:00
Code Issues Packages Projects Releases Wiki Activity

Move clarification to a separate note

Browse Source 
Signed-off-by: David Horstmann <david.horstmann@arm.com>
This commit is contained in:
David Horstmann 2023-06-27 12:20:32 +01:00
parent 0e93877b66
commit 4184e5c926
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
include/mbedtls/net_sockets.h
View File

@ -280,16 +280,24 @@ int mbedtls_net_recv_timeout(void *ctx, unsigned char *buf, size_t len,
uint32_t timeout); uint32_t timeout);
/** /**
* \brief Close down the connection and clear the context * \brief Closes down the connection and free associated data
* *
* \param ctx The context to close * \param ctx The context to close
*
* \note This function frees and clears data associated with the
* context but does not free the memory pointed to by \p ctx.
* This memory is the responsibility of the caller.
*/ */
void mbedtls_net_close(mbedtls_net_context *ctx); void mbedtls_net_close(mbedtls_net_context *ctx);
/** /**
* \brief Gracefully shutdown the connection and clear the context * \brief Gracefully shutdown the connection and free associated data
* *
* \param ctx The context to gracefully shutdown * \param ctx The context to free
*
* \note This function frees and clears data associated with the
* context but does not free the memory pointed to by \p ctx.
* This memory is the responsibility of the caller.
*/ */
void mbedtls_net_free(mbedtls_net_context *ctx); void mbedtls_net_free(mbedtls_net_context *ctx);