lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-04-26 15:08:51 +03:00
Code

Document that returning 0 from the recv callback means EOF

Browse Source 
Signed-off-by: Hanno Becker <hanno.becker@arm.com>
This commit is contained in:
Hanno Becker 2021-07-23 07:23:47 +01:00
parent ac6cc9fbc4
commit 218dec824e
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
include/mbedtls/ssl.h
View File

@ -493,10 +493,11 @@ typedef int mbedtls_ssl_send_t( void *ctx,
* \param buf Buffer to write the received data to * \param buf Buffer to write the received data to
* \param len Length of the receive buffer * \param len Length of the receive buffer
* *
* \return The callback must return the number of bytes received, * \returns If data has been received, the positive number of bytes received.
* or a non-zero error code. * \returns \c 0 if the connection has been closed.
* If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ * \returns If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
* must be returned when the operation would block. * must be returned when the operation would block.
* \returns Another negative error code on other kinds of failures.
* *
* \note The callback may receive fewer bytes than the length of the * \note The callback may receive fewer bytes than the length of the
* buffer. It must always return the number of bytes actually * buffer. It must always return the number of bytes actually