mirror of
https://github.com/yuzu-emu/mbedtls.git
synced 2024-11-26 12:05:38 +01:00
Improve clarity of mbedtls_ssl_conf_max_frag_len documentation
This commit is contained in:
parent
db850c63b2
commit
6d72212d45
@ -2754,19 +2754,18 @@ void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
|
||||
|
||||
#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
|
||||
/**
|
||||
* \brief Set the maximum fragment length to emit and/or negotiate
|
||||
* (Typical: the smaller of MBEDTLS_SSL_IN_CONTENT_LEN and
|
||||
* MBEDTLS_SSL_OUT_CONTENT_LEN, usually 2^14 bytes)
|
||||
* \brief Set the maximum fragment length to emit and/or negotiate.
|
||||
* (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and
|
||||
* #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes)
|
||||
* (Server: set maximum fragment length to emit,
|
||||
* usually negotiated by the client during handshake)
|
||||
* (Client: set maximum fragment length to emit *and*
|
||||
* negotiate with the server during handshake)
|
||||
*
|
||||
* \note By default the \c mfl_code field of the \c mbedtls_ssl_config
|
||||
* structure is equal to `0 == MBEDTLS_SSL_MAX_FRAG_LEN_NONE`.
|
||||
* Therefore, the maximum fragment length extension *will not*
|
||||
* be used, unless the maximum fragment length has been set to a
|
||||
* different value via this function.
|
||||
* \note On the client side, the maximum fragment length extension
|
||||
* *will not* be used, unless the maximum fragment length has
|
||||
* been set via this function to a value different than
|
||||
* #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
|
||||
*
|
||||
* \note With TLS, this currently only affects ApplicationData (sent
|
||||
* with \c mbedtls_ssl_read()), not handshake messages.
|
||||
|
Loading…
Reference in New Issue
Block a user