Fix outdated documentation of effect of hardcoded timer cb's on API

This commit is contained in:
Hanno Becker 2019-07-04 11:34:40 +01:00
parent 1f1e9eff06
commit 99b6b6b6c9

View file

@ -1804,8 +1804,6 @@ void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
* \note On constrained systems, the timer callbacks \p f_set_timer * \note On constrained systems, the timer callbacks \p f_set_timer
* and \p f_get_timer may also be configured at compile-time * and \p f_get_timer may also be configured at compile-time
* via MBEDTLS_SSL_CONF_GET_TIMER and MBEDTLS_SSL_CONF_SET_TIMER. * via MBEDTLS_SSL_CONF_GET_TIMER and MBEDTLS_SSL_CONF_SET_TIMER.
* In this case, the corresponding arguments to this function
* are ignored.
* *
* \note See also the "DTLS tutorial" article in our knowledge base. * \note See also the "DTLS tutorial" article in our knowledge base.
* https://tls.mbed.org/kb/how-to/dtls-tutorial * https://tls.mbed.org/kb/how-to/dtls-tutorial
@ -1814,7 +1812,8 @@ void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
void *p_timer, void *p_timer,
mbedtls_ssl_set_timer_t *f_set_timer, mbedtls_ssl_set_timer_t *f_set_timer,
mbedtls_ssl_get_timer_t *f_get_timer ); mbedtls_ssl_get_timer_t *f_get_timer );
#else #else /* !( MBEDTLS_SSL_CONF_SET_TIMER &&
MBEDTLS_SSL_CONF_GET_TIMER ) */
/** /**
* \brief Set the context to be passed to the timer callbacks * \brief Set the context to be passed to the timer callbacks
* (Mandatory for DTLS.) * (Mandatory for DTLS.)
@ -1825,7 +1824,8 @@ void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
*/ */
void mbedtls_ssl_set_timer_cb_ctx( mbedtls_ssl_context *ssl, void mbedtls_ssl_set_timer_cb_ctx( mbedtls_ssl_context *ssl,
void *p_timer ); void *p_timer );
#endif #endif /* MBEDTLS_SSL_CONF_SET_TIMER &&
MBEDTLS_SSL_CONF_GET_TIMER */
/** /**
* \brief Callback type: generate and write session ticket * \brief Callback type: generate and write session ticket