feedc0de/wolfssl
1
0
Fork 0
forked from wolfSSL/wolfssl
Code Pull Requests Activity

Merge pull request #5199 from embhorn/zd12999

Browse Source 
Add doc for wolfSSL_dtls_retransmit
This commit is contained in:
David Garske
2022-06-10 10:57:17 -07:00
committed by GitHub
parent ba3991af5e 2543970419
commit afc63a3bfa
1 changed files with 26 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
doc/dox_comments/header_files/ssl.h
View File

@@ -3417,6 +3417,32 @@ int wolfSSL_dtls_set_timeout_max(WOLFSSL* ssl, int);
*/ */
int wolfSSL_dtls_got_timeout(WOLFSSL* ssl); 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 \brief This function is used to determine if the SSL session has been
configured to use DTLS. configured to use DTLS.