Improve documentation of mbedtls_ssl_write()

This commit is contained in:
Darryl Green 2018-03-29 16:05:44 +01:00
parent 4ba87fc958
commit eea1c4ee5a
2 changed files with 5 additions and 1 deletions

View file

@ -54,6 +54,8 @@ Changes
Wilson #481
* Improve the documentation of mbedtls_net_accept(). Contributed by Ivan
Krylov.
* Improve the documentation of mbedtls_ssl_write(). Suggested by
Paul Sokolovsky in #1356.
= mbed TLS 2.8.0 branch released 2018-03-16

View file

@ -2537,7 +2537,9 @@ int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
*
* \note When this function returns MBEDTLS_ERR_SSL_WANT_WRITE/READ,
* it must be called later with the *same* arguments,
* until it returns a positive value.
* until it returns a positive value. When the function returns
* MBEDTLS_ERR_SSL_WANT_WRITE there may be some partial
* data in the output buffer, however this is not yet sent.
*
* \note If the requested length is greater than the maximum
* fragment length (either the built-in limit or the one set