From: Hugo Landau <hlandau@openssl.org>
Date: Wed, 24 Apr 2024 12:22:49 +0000 (+0100)
Subject: QUIC: Update listener documentation
X-Git-Tag: openssl-3.5.0-alpha1~372
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=c4d516db6a685adf7f6760e0a04fa13d12030e28;p=thirdparty%2Fopenssl.git

QUIC: Update listener documentation

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/24971)
---

diff --git a/doc/man3/SSL_new_listener.pod b/doc/man3/SSL_new_listener.pod
index bb390cc9e09..517df82a0fb 100644
--- a/doc/man3/SSL_new_listener.pod
+++ b/doc/man3/SSL_new_listener.pod
@@ -2,7 +2,8 @@
 
 =head1 NAME
 
-SSL_new_listener, SSL_is_listener, SSL_get0_listener, SSL_listen,
+SSL_new_listener, SSL_new_listener_from, SSL_is_listener, SSL_get0_listener,
+SSL_listen,
 SSL_accept_connection, SSL_get_accept_connection_queue_len,
 SSL_new_from_listener, SSL_LISTENER_FLAG_NO_ACCEPT,
 SSL_ACCEPT_CONNECTION_NO_BLOCK - SSL object interface for abstracted connection
@@ -14,6 +15,7 @@ acceptance
 
  #define SSL_LISTENER_FLAG_NO_ACCEPT
  SSL *SSL_new_listener(SSL_CTX *ctx, uint64_t flags);
+ SSL *SSL_new_listener_from(SSL *ssl, uint64_t flags);
 
  int SSL_is_listener(SSL *ssl);
  SSL *SSL_get0_listener(SSL *ssl);
@@ -36,6 +38,10 @@ manner. It cannot be used, for example, for sending or receiving data using
 L<SSL_write_ex(3)> or L<SSL_read_ex(3)>. In general, only those functions
 expressly documented as being supported on a listener SSL object are available.
 
+The SSL_new_listener_from() function creates a listener SSL object which is
+subordinate to a QUIC domain SSL object I<ssl>. See L<SSL_new_domain(3)> and
+L<openssl-quic-concurrency(7)> for details on QUIC domain SSL objects.
+
 A listener SSL object supports the following operations:
 
 =over 4
@@ -175,7 +181,8 @@ way of using the listener functionality in client-only mode.
 
 =head1 RETURN VALUES
 
-SSL_new_listener() returns a new listener SSL object or NULL on failure.
+SSL_new_listener() and SSL_new_listener_from() return a new listener SSL object
+or NULL on failure.
 
 SSL_is_listener() returns 0 or 1 depending on the type of the SSL object on
 which it is called.