diff options
Diffstat (limited to 'doc/man3/SSL_new_stream.pod')
-rw-r--r-- | doc/man3/SSL_new_stream.pod | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/doc/man3/SSL_new_stream.pod b/doc/man3/SSL_new_stream.pod new file mode 100644 index 0000000000..13f66474ab --- /dev/null +++ b/doc/man3/SSL_new_stream.pod @@ -0,0 +1,62 @@ +=pod + +=head1 NAME + +SSL_new_stream, SSL_STREAM_FLAG_UNI - create a new locally-initiated QUIC stream + +=head1 SYNOPSIS + + #include <openssl/ssl.h> + + #define SSL_STREAM_FLAG_UNI (1U << 0) + SSL *SSL_new_stream(SSL *ssl, uint64_t flags); + +=head1 DESCRIPTION + +The SSL_new_stream() function, when passed a QUIC connection SSL object, creates +a new locally-initiated bidirectional or unidirectional QUIC stream and returns +the newly created QUIC stream SSL object. + +If the B<SSL_STREAM_FLAG_UNI> flag is passed, a unidirectional stream is +created; else a bidirectional stream is created. + +To retrieve the stream ID of the newly created stream, use +L<SSL_get_stream_id(3)>. + +It is the caller's responsibility to free the QUIC stream SSL object using +L<SSL_free(3)>. The lifetime of the QUIC connection SSL object must exceed that +of the QUIC stream SSL object; in other words, the QUIC stream SSL object must +be freed first. + +Once a stream has been created using SSL_new_stream(), it may be used in the +normal way using L<SSL_read(3)> and L<SSL_write(3)>. + +This function can only be used to create stream objects for locally-initiated +streams. To accept incoming streams initiated by a peer, use +L<SSL_accept_stream(3)>. + +=head1 RETURN VALUES + +SSL_new_stream() returns a new stream object, or NULL on error. + +This function fails if called on a QUIC stream SSL object or on a non-QUIC SSL +object. + +=head1 SEE ALSO + +L<SSL_accept_stream(3)>, L<SSL_free(3)> + +=head1 HISTORY + +SSL_new_stream() was added in OpenSSL 3.2. + +=head1 COPYRIGHT + +Copyright 2002-2023 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L<https://www.openssl.org/source/license.html>. + +=cut |