logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

DTLSv1_get_timeout - determine when a DTLS or QUIC SSL object next needs a timeout event to be handled

Description

DTLSv1_get_timeout() can be used on a DTLS or QUIC SSL object to determine when the SSL object next needs
       to perform internal processing due to the passage of time.

       Calling DTLSv1_get_timeout() results in *tv being written with an amount of time left before the SSL
       object needs have DTLSv1_handle_timeout() called on it.  If the SSL object needs to be ticked
       immediately, *tv is zeroed and the function succeeds, returning 1. If no timeout is currently active,
       this function returns 0.

       This function is only applicable to DTLS and QUIC objects. It fails if called on any other kind of SSL
       object.

       Note that the value output by a call to DTLSv1_get_timeout() may change as a result of other calls to the
       SSL object.

       Once the timeout expires, DTLSv1_handle_timeout() should be called to handle any internal processing
       which is due; for more information, see DTLSv1_handle_timeout(3).

       SSL_get_event_timeout(3) supersedes all use cases for this this function and may be used instead of it.

Name

       DTLSv1_get_timeout - determine when a DTLS or QUIC SSL object next needs a timeout event to be handled

Return Values

       On success, writes a duration to *tv and returns 1.

       Returns 0 on failure, or if no timeout is currently active.

See Also

DTLSv1_handle_timeout(3), SSL_get_event_timeout(3), ssl(7)

Synopsis

        #include <openssl/ssl.h>

        int DTLSv1_get_timeout(SSL *s, struct timeval *tv);

See Also