Clarified mbedtls_ssl_conf_alpn_protocols() doc

Clarified the lifetime of the protos parameter passed in the
function mbedtls_ssl_conf_alpn_protocols().
This commit is contained in:
Simon Butcher 2016-02-13 23:19:04 +00:00
parent 02049dcbd1
commit 157cb656a9

View file

@ -1882,8 +1882,11 @@ int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
* \brief Set the supported Application Layer Protocols.
*
* \param conf SSL configuration
* \param protos NULL-terminated list of supported protocols,
* in decreasing preference order.
* \param protos Pointer to a NULL-terminated list of supported protocols,
* in decreasing preference order. The pointer to the list is
* recorded by the library for later reference as required, so
* the lifetime of the table should be as long as the
* SSL configuration structure.
*
* \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
*/