eden-emu/mbedtls
15
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #3103 from AndrzejKurek/ssl-read-improve-ret-code-doc

Browse source 
ssl - improve documentation on mbedtls_ssl_read and PEER_CLOSE_NOTIFY
This commit is contained in:
Manuel Pégourié-Gonnard 2020-03-23 11:36:31 +01:00 • committed by GitHub
commit 1fce45da6a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

9
include/mbedtls/ssl.h
View file

@ -3739,7 +3739,14 @@ int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
* *
* \return The (positive) number of bytes read if successful. * \return The (positive) number of bytes read if successful.
* \return \c 0 if the read end of the underlying transport was closed * \return \c 0 if the read end of the underlying transport was closed
* - in this case you must stop using the context (see below). * without sending a CloseNotify beforehand, which might happen
* because of various reasons (internal error of an underlying
* stack, non-conformant peer not sending a CloseNotify and
* such) - in this case you must stop using the context
* (see below).
* \return #MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY if the underlying
* transport is still functional, but the peer has
* acknowledged to not send anything anymore.
* \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
* if the handshake is incomplete and waiting for data to * if the handshake is incomplete and waiting for data to
* be available for reading from or writing to the underlying * be available for reading from or writing to the underlying