QUIC: Update documentation to reflect compatibility of DTLS APIs

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/20879)

diff --git a/doc/man3/DTLSv1_get_timeout.pod b/doc/man3/DTLSv1_get_timeout.pod
index 91ebd2d570179af464623c1230835ee5ece3e767..0b9c33fdc0dcfe3bf478062268604fef8e4a11a6 100644 (file)
--- a/doc/man3/DTLSv1_get_timeout.pod
+++ b/doc/man3/DTLSv1_get_timeout.pod
@@ -2,8 +2,8 @@
 
 =head1 NAME
 
-DTLSv1_get_timeout - determine when a DTLS SSL object next needs a timeout
-event to be handled
+DTLSv1_get_timeout - determine when a DTLS or QUIC SSL object next needs a
+timeout event to be handled
 
 =head1 SYNOPSIS
 
@@ -13,8 +13,9 @@ event to be handled
 
 =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.
+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 I<*tv> being written with an amount of
 time left before the SSL object needs have DTLSv1_handle_timeout() called on it.
@@ -22,7 +23,7 @@ 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
+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

diff --git a/doc/man3/DTLSv1_handle_timeout.pod b/doc/man3/DTLSv1_handle_timeout.pod
index 4a91fcfc2c21849d4b43eb386dd02f0ade0c7efa..bb2bafe4e4baf71b88a954290649ecbd7c3a8be9 100644 (file)
--- a/doc/man3/DTLSv1_handle_timeout.pod
+++ b/doc/man3/DTLSv1_handle_timeout.pod
@@ -2,7 +2,8 @@
 
 =head1 NAME
 
-DTLSv1_handle_timeout - handle a pending timeout event for a DTLS SSL object
+DTLSv1_handle_timeout - handle a pending timeout event for a DTLS or QUIC SSL
+object
 
 =head1 SYNOPSIS
 
@@ -13,13 +14,13 @@ DTLSv1_handle_timeout - handle a pending timeout event for a DTLS SSL object
 =head1 DESCRIPTION
 
 DTLSv1_handle_timeout() handles any timeout events which have become pending
-on a DTLS SSL object.
+on a DTLS or QUIC SSL object.
 
 Use L<DTLSv1_get_timeout(3)> or L<SSL_get_event_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.
+This function is only applicable to DTLS or QUIC SSL objects. It returns 0 if
+called on any other kind of SSL object.
 
 L<SSL_handle_events(3)> supersedes all use cases for this this function and may
 be used instead of it.
@@ -29,7 +30,7 @@ be used instead of it.
 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.
+DTLS or QUIC object.
 
 Returns -1 if there was a pending timeout event but it could not be handled
 successfully.