QUIC: Document how blocking mode is automatically turned off

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/19703)
This commit is contained in:
Hugo Landau 2023-01-09 11:31:07 +00:00
parent 692df8d344
commit e6b653535f
2 changed files with 11 additions and 0 deletions

View File

@ -86,6 +86,12 @@ reference is consumed for the B<wbio>.
Because of this complexity, this function should be avoided;
use SSL_set0_rbio() and SSL_set0_wbio() instead.
Where a new BIO is set on a QUIC connection SSL object, blocking mode will be
disabled on that SSL object if the BIO cannot support blocking mode. If another
BIO is subsequently set on the SSL object which can support blocking mode,
blocking mode will not be automatically re-enabled. For more information, see
L<SSL_set_blocking_mode(3)>.
=head1 RETURN VALUES
SSL_set_bio(), SSL_set0_rbio() and SSL_set0_wbio() cannot fail.

View File

@ -39,6 +39,11 @@ Where a QUIC connection SSL object is used in nonblocking mode, an application
is responsible for ensuring that the SSL object is ticked regularly; see
L<SSL_tick(3)>.
Blocking mode is disabled automatically if the application provides a QUIC
connection SSL object with a network BIO which cannot support blocking mode. To
re-enable blocking mode in this case, an application must set a network BIO
which can support blocking mode and explicitly call SSL_set_blocking_mode().
=head1 RETURN VALUES
SSL_set_blocking_mode() returns 1 on success and 0 on failure. The function