yuzu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2025-01-24 23:20:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Try to further clarify documentation

Browse source
This commit is contained in:
Manuel Pégourié-Gonnard 2018-08-21 11:55:40 +02:00
parent 000281e07d
commit 661103595e
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
include/mbedtls/ssl.h
View file

@ -1388,6 +1388,10 @@ void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
* the maximum size datagram the DTLS layer will pass to the * the maximum size datagram the DTLS layer will pass to the
* \c f_send() callback set using \c mbedtls_ssl_set_bio(). * \c f_send() callback set using \c mbedtls_ssl_set_bio().
* *
* \note The limit on datagram size is converted to a limit on
* record payload by subtracting the current overhead of
* encapsulation and encryption/authentication if any.
*
* \note This can be called at any point during the connection, for * \note This can be called at any point during the connection, for
* example when a PMTU estimate becomes available from other * example when a PMTU estimate becomes available from other
* sources, such as lower (or higher) protocol layers. * sources, such as lower (or higher) protocol layers.
@ -1400,14 +1404,12 @@ void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
* *
* \note If both a MTU and a maximum fragment length have been * \note If both a MTU and a maximum fragment length have been
* configured (or negotiated with the peer), the resulting * configured (or negotiated with the peer), the resulting
* lower limit (after translating the MTU setting to a limit * lower limit on record payload (see first note) is used.
* on the record content length) is used.
* *
* \note This can only be used to decrease the maximum size * \note This can only be used to decrease the maximum size
* of datagrams (hence records, as records cannot span * of datagrams (hence records, see first note) sent. It
* multiple datagrams) sent. It cannot be used to increase the * cannot be used to increase the maximum size of records over
* maximum size of records over the limit set by * the limit set by #MBEDTLS_SSL_OUT_CONTENT_LEN.
* #MBEDTLS_SSL_OUT_CONTENT_LEN.
* *
* \note Values lower than the current record layer expansion will * \note Values lower than the current record layer expansion will
* result in an error when trying to send data. * result in an error when trying to send data.