yuzu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2025-02-02 12:31:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Reword ssl_conf_max_frag_len documentation to clarify its necessity

Browse source
This commit is contained in:
k-stachowiak 2019-02-04 10:43:40 +01:00
parent 75d9a333ce
commit eb1bb3d2d0
1 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
include/mbedtls/ssl.h
View file

@ -2755,13 +2755,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
* (Default: 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 ofthe \c mbedtls_ssl_config
* structure is equal `0 == MBEDTLS_SSL_MAX_FRAG_LEN_NONE`.
* This means the max fragment length extension *will not* be
* used unless set to other 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.
* With DTLS, this affects both ApplicationData and handshake. * With DTLS, this affects both ApplicationData and handshake.