diff options
author | Hugo Landau <hlandau@openssl.org> | 2023-08-23 08:25:28 +0100 |
---|---|---|
committer | Hugo Landau <hlandau@openssl.org> | 2023-08-30 08:28:22 +0100 |
commit | 25a0c4b907b0dbef4f0e70bf35cd84c85aaee3ad (patch) | |
tree | b92ef397bf57723b09cbef28a523f94560a3d1cf /doc | |
parent | 96fe5e5f964d44dfff8667fb3c0111a25be58c87 (diff) | |
download | openssl-25a0c4b907b0dbef4f0e70bf35cd84c85aaee3ad.tar.gz |
QUIC APL: Support waiting for peer-initiated shutdown
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/21815)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/SSL_shutdown.pod | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/man3/SSL_shutdown.pod b/doc/man3/SSL_shutdown.pod index b1a5c94fd9..913b555977 100644 --- a/doc/man3/SSL_shutdown.pod +++ b/doc/man3/SSL_shutdown.pod @@ -347,6 +347,25 @@ If an application calls SSL_shutdown_ex() with B<SSL_SHUTDOWN_FLAG_RAPID>, an application can subsequently change its mind about performing a rapid shutdown by making a subsequent call to SSL_shutdown_ex() without the flag set. +=head2 Peer-Initiated Shutdown + +In some cases, an application may wish to wait for a shutdown initiated by the +peer rather than triggered locally. To do this, call SSL_shutdown_ex() with +I<SSL_SHUTDOWN_FLAG_WAIT_PEER> specified in I<flags>. In blocking mode, this +waits until the peer initiates a shutdown or the connection otherwise becomes +terminated for another reason. In nonblocking mode it exits immediately with +either success or failure depending on whether a shutdown has occurred. + +If a locally initiated shutdown has already been triggered or the connection has +started terminating for another reason, this flag has no effect. + +=head2 Nonblocking Mode + +SSL_shutdown() and SSL_shutdown_ex() block if the connection is configured in +blocking mode. This may be overridden by specifying +B<SSL_SHUTDOWN_FLAG_NO_BLOCK> in I<flags> when calling SSL_shutdown_ex(), which +causes the call to operate as though in nonblocking mode. + =head1 RETURN VALUES For both SSL_shutdown() and SSL_shutdown_ex() the following return values can occur: |