1*e7be843bSPierre Pronchery=pod 2*e7be843bSPierre Pronchery 3*e7be843bSPierre Pronchery=head1 NAME 4*e7be843bSPierre Pronchery 5*e7be843bSPierre ProncheryDTLSv1_handle_timeout - handle a pending timeout event for a DTLS or QUIC SSL 6*e7be843bSPierre Proncheryobject 7*e7be843bSPierre Pronchery 8*e7be843bSPierre Pronchery=head1 SYNOPSIS 9*e7be843bSPierre Pronchery 10*e7be843bSPierre Pronchery #include <openssl/ssl.h> 11*e7be843bSPierre Pronchery 12*e7be843bSPierre Pronchery int DTLSv1_handle_timeout(SSL *ssl); 13*e7be843bSPierre Pronchery 14*e7be843bSPierre Pronchery=head1 DESCRIPTION 15*e7be843bSPierre Pronchery 16*e7be843bSPierre ProncheryDTLSv1_handle_timeout() handles any timeout events which have become pending 17*e7be843bSPierre Proncheryon a DTLS or QUIC SSL object. 18*e7be843bSPierre Pronchery 19*e7be843bSPierre ProncheryUse L<DTLSv1_get_timeout(3)> or L<SSL_get_event_timeout(3)> to determine 20*e7be843bSPierre Proncherywhen to call DTLSv1_handle_timeout(). 21*e7be843bSPierre Pronchery 22*e7be843bSPierre ProncheryThis function is only applicable to DTLS or QUIC SSL objects. It returns 0 if 23*e7be843bSPierre Proncherycalled on any other kind of SSL object. 24*e7be843bSPierre Pronchery 25*e7be843bSPierre ProncheryL<SSL_handle_events(3)> supersedes all use cases for this function and may 26*e7be843bSPierre Proncherybe used instead of it. 27*e7be843bSPierre Pronchery 28*e7be843bSPierre Pronchery=head1 RETURN VALUES 29*e7be843bSPierre Pronchery 30*e7be843bSPierre ProncheryReturns 1 if there was a pending timeout event and it was handled successfully. 31*e7be843bSPierre Pronchery 32*e7be843bSPierre ProncheryReturns 0 if there was no pending timeout event, or if the SSL object is not a 33*e7be843bSPierre ProncheryDTLS or QUIC object. 34*e7be843bSPierre Pronchery 35*e7be843bSPierre ProncheryReturns -1 if there was a pending timeout event but it could not be handled 36*e7be843bSPierre Proncherysuccessfully. 37*e7be843bSPierre Pronchery 38*e7be843bSPierre Pronchery=head1 SEE ALSO 39*e7be843bSPierre Pronchery 40*e7be843bSPierre ProncheryL<DTLSv1_get_timeout(3)>, L<SSL_handle_events(3)>, L<ssl(7)> 41*e7be843bSPierre Pronchery 42*e7be843bSPierre Pronchery=head1 COPYRIGHT 43*e7be843bSPierre Pronchery 44*e7be843bSPierre ProncheryCopyright 2023 The OpenSSL Project Authors. All Rights Reserved. 45*e7be843bSPierre Pronchery 46*e7be843bSPierre ProncheryLicensed under the Apache License 2.0 (the "License"). You may not use 47*e7be843bSPierre Proncherythis file except in compliance with the License. You can obtain a copy 48*e7be843bSPierre Proncheryin the file LICENSE in the source distribution or at 49*e7be843bSPierre ProncheryL<https://www.openssl.org/source/license.html>. 50*e7be843bSPierre Pronchery 51*e7be843bSPierre Pronchery=cut 52