mirror of
https://github.com/cuberite/polarssl.git
synced 2025-09-09 23:26:29 -04:00
Move clarification to a separate note
Signed-off-by: David Horstmann <david.horstmann@arm.com>
This commit is contained in:
parent
0e93877b66
commit
4184e5c926
@ -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);
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user