summaryrefslogtreecommitdiffstats
path: root/doc/man3/BIO_f_ssl.pod
diff options
context:
space:
mode:
authorHugo Landau <hlandau@openssl.org>2023-06-26 13:47:03 +0100
committerPauli <pauli@openssl.org>2023-07-05 09:03:04 +1000
commitd6e7ebba3370e06ea4dfae6381dfe0e1c21070e3 (patch)
treedfe11d5e37d4bffe5c2f0de725c34cd884cc5c3a /doc/man3/BIO_f_ssl.pod
parent5f69db396c61165b25c38a7506d608200561f228 (diff)
Minor fixes
Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/20061)
Diffstat (limited to 'doc/man3/BIO_f_ssl.pod')
-rw-r--r--doc/man3/BIO_f_ssl.pod6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/man3/BIO_f_ssl.pod b/doc/man3/BIO_f_ssl.pod
index 371c124388..629aeb5e64 100644
--- a/doc/man3/BIO_f_ssl.pod
+++ b/doc/man3/BIO_f_ssl.pod
@@ -131,7 +131,8 @@ BIO_set_ssl(), BIO_get_ssl(), BIO_set_ssl_mode(),
BIO_set_ssl_renegotiate_bytes(), BIO_set_ssl_renegotiate_timeout(),
BIO_get_num_renegotiates(), and BIO_do_handshake() are implemented as macros.
-BIO_ssl_copy_session_id() is not currently supported on QUIC SSL objects.
+BIO_ssl_copy_session_id() is not currently supported on QUIC SSL objects and
+fails if called on such an object.
=head1 RETURN VALUES
@@ -144,7 +145,8 @@ success or a value which is less than or equal to 0 if an error occurred.
BIO_new_ssl(), BIO_new_ssl_connect() and BIO_new_buffer_ssl_connect() return
a valid B<BIO> structure on success or B<NULL> if an error occurred.
-BIO_ssl_copy_session_id() returns 1 on success or 0 on error.
+BIO_ssl_copy_session_id() returns 1 on success or 0 on error, or if called
+on a QUIC SSL object.
BIO_do_handshake() returns 1 if the connection was established successfully.
A zero or negative value is returned if the connection could not be established.