diff options
author | Hugo Landau <hlandau@openssl.org> | 2023-05-02 15:23:01 +0100 |
---|---|---|
committer | Hugo Landau <hlandau@openssl.org> | 2023-05-12 14:47:14 +0100 |
commit | 5e125829c01afcc21daad07ac19cf57d1a5ca579 (patch) | |
tree | ade6a86c6c5995fdd528449a11a48c87ae4fd702 | |
parent | 3a61a96c1e43694199f5ec0887d0ad21a4650e3f (diff) | |
download | openssl-new-5e125829c01afcc21daad07ac19cf57d1a5ca579.tar.gz |
QUIC MSST: Further documentation fixes
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/20765)
-rw-r--r-- | doc/man3/SSL_attach_stream.pod | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/man3/SSL_attach_stream.pod b/doc/man3/SSL_attach_stream.pod index e83224bbd0..8f837acc6e 100644 --- a/doc/man3/SSL_attach_stream.pod +++ b/doc/man3/SSL_attach_stream.pod @@ -52,10 +52,10 @@ SSL_detach_stream(), which detaches the default stream and returns it as an explicit QUIC stream SSL object. Once detached, the caller is responsible for managing the lifetime of the QUIC -stream SSL object and must free it by calling L<SSL_free(3)>. The lifetime of a -QUIC connection SSL object must exceed that of any subsidiary QUIC stream SSL -objects; in other words, QUIC stream SSL objects must be freed before the parent -QUIC connection SSL object is freed. +stream SSL object and must free it by calling L<SSL_free(3)>. A QUIC stream SSL +object maintains a reference to a QUIC connection SSL object, therefore a QUIC +connection SSL object and its child stream objects may be freed in either order; +for details, see L<SSL_free(3)>. When a QUIC connection SSL object has no default stream currently associated with it, for example because the default stream was detached or because default @@ -75,7 +75,9 @@ SSL_attach_stream(), the QUIC connection SSL object becomes responsible for managing its lifetime. Calling SSL_free() on the QUIC connection SSL object will free the stream automatically. Moreover, once the call to SSL_attach_stream() succeeds, the application must make no further use of the QUIC stream SSL object -pointer that it passed to SSL_attach_stream(). +pointer that it passed to SSL_attach_stream(). An application must not call +SSL_attach_stream() with a QUIC stream SSL object that has more than one +reference to it. It is recommended that new applications and applications which rely on multiple streams forego use of the default stream functionality, which is intended for |