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

Improve documentation of ssl_set_mtu().

Browse Source
This commit is contained in:
Manuel Pégourié-Gonnard 2018-08-20 11:16:40 +02:00
parent 065a2a3472
commit 050dd6ad35
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
include/mbedtls/ssl.h
View File

@ -1392,18 +1392,25 @@ void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
* 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.
* *
* \note This only controls the size of the packet we send. * \note This only controls the size of the packets we send.
* Client-side, you can request the server to use smaller * Client-side, you can request the server to use smaller
* records with \c mbedtls_ssl_conf_max_frag_len(). * records with \c mbedtls_ssl_conf_max_frag_len().
* *
* \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 lower limit * configured (or negotiated with the peer), the resulting
* is used. * lower limit (after translating the MTU setting to a limit
* on the record content length) is used.
* *
* \note Values larger than #MBEDTLS_SSL_OUT_CONTENT_LEN have no * \note This can only be used to decrease the maximum size
* effect. This can only be used to decrease the maximum size * of datagrams sent. It cannot be used to increase the
* of datagrams sent. Values lower than record layer expansion * maximum size of records over the limit set by
* are ignored. * #MBEDTLS_SSL_OUT_CONTENT_LEN.
*
* \note Values lower than the current record layer expansion will
* result in an error when trying to send data.
*
* \note Using record compression together with a non-zero MTU value
* will result in an error when trying to send data.
* *
* \param ssl SSL context * \param ssl SSL context
* \param mtu Value of the path MTU in bytes * \param mtu Value of the path MTU in bytes