Merge pull request #4807 from hanno-arm/bio_recv_ret_0_eof
Document that returning 0 from the recv callback means EOF
This commit is contained in:
commit
684543a3a8
1 changed files with 4 additions and 3 deletions
|
@ -543,10 +543,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
|
||||||
|
|
Loading…
Reference in a new issue