summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHugo Landau <hlandau@openssl.org>2024-04-09 08:08:04 +0100
committerHugo Landau <hlandau@openssl.org>2024-04-19 09:33:54 +0100
commit89b47ad9e3f4b9a4496fcbe03bbff6fd10d14c13 (patch)
tree33f3fe12fcaf58662f8a76038a69265c79e51be3
parent961d4f214e93043f96df32e288fb3ff0b8eee4d3 (diff)
QUIC: Clarify SSL_new_listener API in docs
Reviewed-by: Neil Horman <nhorman@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/24037)
-rw-r--r--doc/man3/SSL_new_listener.pod11
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/man3/SSL_new_listener.pod b/doc/man3/SSL_new_listener.pod
index 6d81fabbeb..df869e0753 100644
--- a/doc/man3/SSL_new_listener.pod
+++ b/doc/man3/SSL_new_listener.pod
@@ -58,6 +58,11 @@ L<SSL_net_write_desired(3)>;
=item
+Certain configurable parameters described in L<SSL_get_value(3)> (see
+L<SSL_get_value(3)> for details);
+
+=item
+
Accepting network connections using the functions documented in this manual
page, such as SSL_accept_connection().
@@ -127,8 +132,10 @@ to SSL_accept_connection(). Note that since this may change between subsequent
API calls to the listener SSL object, it should be used for informational
purposes only.
-Currently, listener SSL objects are only supported for QUIC usage via
-L<OSSL_QUIC_server_method(3)>. It is expected that the listener interface, which
+Currently, listener SSL objects are only supported for QUIC server usage via
+L<OSSL_QUIC_server_method(3)>, or QUIC client-only usage via
+L<OSSL_QUIC_client_method(3)> or L<OSSL_QUIC_client_thread_method(3)> (see
+L</CLIENT-ONLY USAGE>). It is expected that the listener interface, which
provides an abstracted API for connection acceptance, will be expanded to
support other protocols, such as TLS over TCP, plain TCP or DTLS in future.