Skip to content

Commit

Permalink
QUIC MSST: Documentation fixes
Browse files Browse the repository at this point in the history
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #20765)
  • Loading branch information
hlandau committed May 12, 2023
1 parent 433d107 commit 47238a3
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
4 changes: 1 addition & 3 deletions doc/man3/SSL_accept_stream.pod
Expand Up @@ -27,9 +27,7 @@ function may still return NULL in blocking mode, for example if the underlying
connection is terminated.

The caller is responsible for managing the lifetime of the returned QUIC stream
SSL object. The lifespan of the parent QUIC connection SSL object must exceed
that of the QUIC stream SSL object; that is, the stream object must be freed
first, using L<SSL_free(3)>.
SSL object; for more information, see L<SSL_free(3)>.

This function will block if the QUIC connection SSL object is configured in
blocking mode (see L<SSL_set_blocking_mode(3)>), but this may be bypassed by
Expand Down
4 changes: 4 additions & 0 deletions doc/man3/SSL_free.pod
Expand Up @@ -62,6 +62,10 @@ stream in turn (which is its sending part).

=back

A QUIC stream SSL object maintains a reference to a QUIC connection SSL object
internally, therefore a QUIC stream SSL object and its parent QUIC connection
SSL object can be freed in either order.

=head1 RETURN VALUES

SSL_free() does not provide diagnostic information.
Expand Down

0 comments on commit 47238a3

Please sign in to comment.