diff options
| author | Hugo Landau <hlandau@openssl.org> | 2023-01-09 11:18:06 +0000 |
|---|---|---|
| committer | Hugo Landau <hlandau@openssl.org> | 2023-01-13 13:20:36 +0000 |
| commit | 8ccc567ef0af03a312d7742f451556eb788d5286 (patch) | |
| tree | 4a4b61f3d38b714683b8410f3d5b0196b849d34a /doc/man3/SSL_get_tick_timeout.pod | |
| parent | 75b2920a219f9ec222e663ec5d2bb6101dc612f9 (diff) | |
| download | openssl-new-8ccc567ef0af03a312d7742f451556eb788d5286.tar.gz | |
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 https://github.com/openssl/openssl/pull/19703)
Diffstat (limited to 'doc/man3/SSL_get_tick_timeout.pod')
| -rw-r--r-- | doc/man3/SSL_get_tick_timeout.pod | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/man3/SSL_get_tick_timeout.pod b/doc/man3/SSL_get_tick_timeout.pod index e944620bed..8decc35a62 100644 --- a/doc/man3/SSL_get_tick_timeout.pod +++ b/doc/man3/SSL_get_tick_timeout.pod @@ -25,19 +25,27 @@ This function is currently applicable only to DTLS and QUIC connection SSL objects. If it is called on any other kind of SSL object, it always outputs infinity. This is considered a success condition. +For DTLS, this function can be used instead of the older +L<DTLSv1_get_timeout(3)> function. Note that this function differs from +L<DTLSv1_get_timeout(3)> in that the case where no timeout is active is +considered a success condition. + Note that the value output by a call to SSL_get_tick_timeout() may change as a result of other calls to the SSL object. Once the timeout expires, SSL_tick() should be called to handle any internal processing which is due; for more information, see L<SSL_tick(3)>. +Note that SSL_get_tick_timeout() supersedes the older L<DTLSv1_get_timeout(3)> +function for all use cases. + =head1 RETURN VALUES Returns 1 on success and 0 on failure. =head1 SEE ALSO -L<SSL_tick(3)>, L<ssl(7)> +L<SSL_tick(3)>, L<DTLSv1_get_timeout(3)>, L<ssl(7)> =head1 HISTORY |