Skip to content

Commit

Permalink
Merge pull request #7828 from davidhorstmann-arm/2.28-reword-net-free…
Browse files Browse the repository at this point in the history
…-description-2544

[Backport 2.28] Reword the description of `mbedtls_net_free()`
  • Loading branch information
gilles-peskine-arm authored Aug 21, 2023
2 parents 27adfd8 + 4184e5c commit 9471815
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions include/mbedtls/net_sockets.h
Original file line number Diff line number Diff line change
Expand Up @@ -283,13 +283,21 @@ int mbedtls_net_recv_timeout(void *ctx, unsigned char *buf, size_t len,
* \brief Closes down the connection and free associated data
*
* \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);

/**
* \brief Gracefully shutdown the connection and free associated data
*
* \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);

Expand Down

0 comments on commit 9471815

Please sign in to comment.