mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-03-28 19:21:08 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve documentation of record expansion API

Browse Source 
Signed-off-by: Hanno Becker <hanno.becker@arm.com>
This commit is contained in:
Hanno Becker 2021-05-23 05:59:46 +01:00
parent 24628b69be
commit ebd6ab7f6e
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
include/mbedtls/ssl.h
View File

@ -3647,10 +3647,13 @@ int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl );
/** /**
* \brief Return the current maximum outgoing record payload in bytes. * \brief Return the current maximum outgoing record payload in bytes.
* This takes into account various factors, such as the config.h *
* setting \c MBEDTLS_SSL_OUT_CONTENT_LEN, extensions such as the * \note The logic to determine the maximum outgoing record payload is
* max fragment length or record size limit extension if used, and * version-specific. It takes into account various factors, such as
* for DTLS the path MTU as configured and current record expansion. * the config.h setting \c MBEDTLS_SSL_OUT_CONTENT_LEN, extensions
* such as the max fragment length or record size limit extension if
* used, and for DTLS the path MTU as configured and current
* record expansion.
* *
* \note With DTLS, \c mbedtls_ssl_write() will return an error if * \note With DTLS, \c mbedtls_ssl_write() will return an error if
* called with a larger length value. * called with a larger length value.
@ -3671,8 +3674,10 @@ int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl );
/** /**
* \brief Return the current maximum incoming record payload in bytes. * \brief Return the current maximum incoming record payload in bytes.
* This takes into account various factors, such as the *
* config.h setting \c MBEDTLS_SSL_IN_CONTENT_LEN, extensions * \note The logic to determine the maximum outgoing record payload is
* version-specific. It takes into account various factors, such as
* the config.h setting \c MBEDTLS_SSL_IN_CONTENT_LEN, extensions
* such as the max fragment length extension or record size limit * such as the max fragment length extension or record size limit
* extension if used, and the current record expansion. * extension if used, and the current record expansion.
* *