| 1 | =pod
|
|---|
| 2 |
|
|---|
| 3 | =head1 NAME
|
|---|
| 4 |
|
|---|
| 5 | SSL_stream_conclude - conclude the sending part of a QUIC stream
|
|---|
| 6 |
|
|---|
| 7 | =head1 SYNOPSIS
|
|---|
| 8 |
|
|---|
| 9 | #include <openssl/ssl.h>
|
|---|
| 10 |
|
|---|
| 11 | __owur int SSL_stream_conclude(SSL *s, uint64_t flags);
|
|---|
| 12 |
|
|---|
| 13 | =head1 DESCRIPTION
|
|---|
| 14 |
|
|---|
| 15 | SSL_stream_conclude() signals the normal end-of-stream condition for the send
|
|---|
| 16 | part of a QUIC stream. If called on a QUIC connection SSL object with an
|
|---|
| 17 | associated default stream, it signals the end of the single stream to the peer.
|
|---|
| 18 |
|
|---|
| 19 | Any data already queued for transmission via a call to SSL_write() will still be
|
|---|
| 20 | written in a reliable manner before the end-of-stream is signalled, assuming the
|
|---|
| 21 | connection remains healthy. This function can be thought of as appending a
|
|---|
| 22 | logical end-of-stream marker after any data which has previously been written to
|
|---|
| 23 | the stream via calls to SSL_write(). Further attempts to call SSL_write() after
|
|---|
| 24 | calling this function will fail.
|
|---|
| 25 |
|
|---|
| 26 | When calling this on a stream, the receive part of the stream remains
|
|---|
| 27 | unaffected, and the peer may continue to send data until it also signals the end
|
|---|
| 28 | of the stream. Thus, SSL_read() can still be used.
|
|---|
| 29 |
|
|---|
| 30 | I<flags> is reserved and should be set to 0.
|
|---|
| 31 |
|
|---|
| 32 | Only the first call to this function has any effect for a given stream;
|
|---|
| 33 | subsequent calls are no-ops. This is considered a success case.
|
|---|
| 34 |
|
|---|
| 35 | This function is not supported on an object other than a QUIC stream SSL object.
|
|---|
| 36 |
|
|---|
| 37 | =head1 RETURN VALUES
|
|---|
| 38 |
|
|---|
| 39 | Returns 1 on success and 0 on failure.
|
|---|
| 40 |
|
|---|
| 41 | Returns 0 if called on an SSL object not representing a QUIC stream.
|
|---|
| 42 |
|
|---|
| 43 | =head1 SEE ALSO
|
|---|
| 44 |
|
|---|
| 45 | L<openssl-quic(7)>, L<ssl(7)>, L<SSL_shutdown_ex(3)>
|
|---|
| 46 |
|
|---|
| 47 | =head1 HISTORY
|
|---|
| 48 |
|
|---|
| 49 | The SSL_stream_conclude() function was added in OpenSSL 3.2.
|
|---|
| 50 |
|
|---|
| 51 | =head1 COPYRIGHT
|
|---|
| 52 |
|
|---|
| 53 | Copyright 2022-2023 The OpenSSL Project Authors. All Rights Reserved.
|
|---|
| 54 |
|
|---|
| 55 | Licensed under the Apache License 2.0 (the "License"). You may not use
|
|---|
| 56 | this file except in compliance with the License. You can obtain a copy
|
|---|
| 57 | in the file LICENSE in the source distribution or at
|
|---|
| 58 | L<https://www.openssl.org/source/license.html>.
|
|---|
| 59 |
|
|---|
| 60 | =cut
|
|---|
