-
-
Notifications
You must be signed in to change notification settings - Fork 10.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
QUIC CSM: Tweak docs for tick functions, add DTLSv1 docs
Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from #19703)
- Loading branch information
Showing
6 changed files
with
146 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
=pod | ||
|
||
=head1 NAME | ||
|
||
DTLSv1_get_timeout - determine when a DTLS SSL object next needs a timeout | ||
event to be handled | ||
|
||
=head1 SYNOPSIS | ||
|
||
#include <openssl/ssl.h> | ||
|
||
int DTLSv1_get_timeout(SSL *s, struct timeval *tv); | ||
|
||
=head1 DESCRIPTION | ||
|
||
DTLSv1_get_timeout() can be used on a DTLS 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 I<*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, I<*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 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 | ||
L<DTLSv1_handle_timeout(3)>. | ||
|
||
L<SSL_get_tick_timeout(3)> supercedes all use cases for this this function and | ||
may be used instead of it. | ||
|
||
=head1 RETURN VALUES | ||
|
||
On success, writes a duration to I<*tv> and returns 1. | ||
|
||
Returns 0 on failure, or if no timeout is currently active. | ||
|
||
=head1 SEE ALSO | ||
|
||
L<DTLSv1_handle_timeout(3)>, L<SSL_get_tick_timeout(3)>, L<ssl(7)> | ||
|
||
=head1 COPYRIGHT | ||
|
||
Copyright 2023 The OpenSSL Project Authors. All Rights Reserved. | ||
|
||
Licensed under the Apache License 2.0 (the "License"). You may not use | ||
this file except in compliance with the License. You can obtain a copy | ||
in the file LICENSE in the source distribution or at | ||
L<https://www.openssl.org/source/license.html>. | ||
|
||
=cut |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
=pod | ||
|
||
=head1 NAME | ||
|
||
DTLSv1_handle_timeout - handle a pending timeout event for a DTLS SSL object | ||
|
||
=head1 SYNOPSIS | ||
|
||
#include <openssl/ssl.h> | ||
|
||
int DTLSv1_handle_timeout(SSL *ssl); | ||
|
||
=head1 DESCRIPTION | ||
|
||
DTLSv1_handle_timeout() handles any timeout events which have become pending | ||
on a DTLS SSL object. | ||
|
||
Use L<DTLSv1_get_timeout(3)> or L<SSL_get_tick_timeout(3)> to determine | ||
when to call DTLSv1_handle_timeout(). | ||
|
||
This function is only applicable to DTLS objects. It returns 0 if called on | ||
any other kind of SSL object. | ||
|
||
L<SSL_tick(3)> supercedes all use cases for this this function and may be used | ||
instead of it. | ||
|
||
=head1 RETURN VALUES | ||
|
||
Returns 1 if there was a pending timeout event and it was handled successfully. | ||
|
||
Returns 0 if there was no pending timeout event, or if the SSL object is not a | ||
DTLS object. | ||
|
||
Returns -1 if there was a pending timeout event but it could not be handled | ||
successfully. | ||
|
||
=head1 SEE ALSO | ||
|
||
L<DTLSv1_get_timeout(3)>, L<SSL_tick(3)>, L<ssl(7)> | ||
|
||
=head1 COPYRIGHT | ||
|
||
Copyright 2023 The OpenSSL Project Authors. All Rights Reserved. | ||
|
||
Licensed under the Apache License 2.0 (the "License"). You may not use | ||
this file except in compliance with the License. You can obtain a copy | ||
in the file LICENSE in the source distribution or at | ||
L<https://www.openssl.org/source/license.html>. | ||
|
||
=cut |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters