yuzu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2025-03-24 22:15:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve clarity of mbedtls_ssl_conf_max_frag_len documentation

Browse source
This commit is contained in:
k-stachowiak 2019-02-08 17:03:33 +01:00
parent db850c63b2
commit 6d72212d45
1 changed files with 7 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
include/mbedtls/ssl.h
View file

@ -2754,19 +2754,18 @@ void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
/** /**
* \brief Set the maximum fragment length to emit and/or negotiate * \brief Set the maximum fragment length to emit and/or negotiate.
* (Typical: the smaller of MBEDTLS_SSL_IN_CONTENT_LEN and * (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and
* MBEDTLS_SSL_OUT_CONTENT_LEN, usually 2^14 bytes) * #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes)
* (Server: set maximum fragment length to emit, * (Server: set maximum fragment length to emit,
* usually negotiated by the client during handshake) * usually negotiated by the client during handshake)
* (Client: set maximum fragment length to emit *and* * (Client: set maximum fragment length to emit *and*
* negotiate with the server during handshake) * negotiate with the server during handshake)
* *
* \note By default the \c mfl_code field of the \c mbedtls_ssl_config * \note On the client side, the maximum fragment length extension
* structure is equal to `0 == MBEDTLS_SSL_MAX_FRAG_LEN_NONE`. * *will not* be used, unless the maximum fragment length has
* Therefore, the maximum fragment length extension *will not* * been set via this function to a value different than
* be used, unless the maximum fragment length has been set to a * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
* different value via this function.
* *
* \note With TLS, this currently only affects ApplicationData (sent * \note With TLS, this currently only affects ApplicationData (sent
* with \c mbedtls_ssl_read()), not handshake messages. * with \c mbedtls_ssl_read()), not handshake messages.