lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-11-03 20:33:16 +03:00
Code Activity

Merge pull request #7827 from davidhorstmann-arm/reword-net-free-description-2544

Browse Source 
Reword the description of `mbedtls_net_free()`
This commit is contained in:
Gilles Peskine
2023-08-21 22:23:08 +00:00
committed by GitHub
parent 31b2d7414d 4506e7de61
commit d50562c33c
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
include/mbedtls/net_sockets.h
View File

@@ -286,6 +286,10 @@ int mbedtls_net_recv_timeout(void *ctx, unsigned char *buf, size_t len,
* \brief Closes down the connection and free associated data * \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);
@@ -293,6 +297,10 @@ void mbedtls_net_close(mbedtls_net_context *ctx);
* \brief Gracefully shutdown the connection and free associated data * \brief Gracefully shutdown the connection and free associated data
* *
* \param ctx The context to free * \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);