yuzu-emu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2024-11-23 03:55:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

ssl - improve documentation on mbedtls_ssl_read and PEER_CLOSE_NOTIFY

Browse Source 
Add a description of MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY to the
documentation, as suggested by hanno-arm.
Signed-off-by: Andrzej Kurek <andrzej.kurek@arm.com>
This commit is contained in:
Andrzej Kurek 2020-03-17 11:11:36 -04:00
parent 21d1cbccda
commit 03da0846df
No known key found for this signature in database
GPG Key ID: 89A90840DC388527
1 changed files with 8 additions and 1 deletions
Show Stats 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