From 254397041914fc0388c6c8aff68a9fdda772c486 Mon Sep 17 00:00:00 2001 From: Eric Blankenhorn Date: Wed, 1 Jun 2022 12:03:36 -0500 Subject: [PATCH] Add doc for wolfSSL_dtls_retransmit --- doc/dox_comments/header_files/ssl.h | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/doc/dox_comments/header_files/ssl.h b/doc/dox_comments/header_files/ssl.h index 917b577c6..cc90a4ee3 100644 --- a/doc/dox_comments/header_files/ssl.h +++ b/doc/dox_comments/header_files/ssl.h @@ -3417,6 +3417,32 @@ int wolfSSL_dtls_set_timeout_max(WOLFSSL* ssl, int); */ int wolfSSL_dtls_got_timeout(WOLFSSL* ssl); +/*! + \brief When using non-blocking sockets with DTLS, this function retransmits + the last handshake flight ignoring the expected timeout value and + retransmit count. It is useful for applications that are using DTLS and + need to manage even the timeout and retry count. + + \return SSL_SUCCESS will be returned upon success + \return SSL_FATAL_ERROR will be returned if there have been too many + retransmissions/timeouts without getting a response from the peer. + + \param ssl a pointer to a WOLFSSL structure, created using wolfSSL_new(). + + _Example_ + \code + int ret = 0; + WOLFSSL* ssl; + ... + ret = wolfSSL_dtls_retransmit(ssl); + \endcode + + \sa wolfSSL_dtls_get_current_timeout + \sa wolfSSL_dtls_got_timeout + \sa wolfSSL_dtls +*/ +int wolfSSL_dtls_retransmit(WOLFSSL* ssl); + /*! \brief This function is used to determine if the SSL session has been configured to use DTLS.