Debian Codegraph @

upstream/debian-unstable/man3/SSL_stream_conclude.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SSL_STREAM_CONCLUDE 3SSL"
58 .TH SSL_STREAM_CONCLUDE 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SSL_stream_conclude \- conclude the sending part of a QUIC stream
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& _\|_owur int SSL_stream_conclude(SSL *s, uint64_t flags);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 \&\fBSSL_stream_conclude()\fR signals the normal end-of-stream condition for the send
75 part of a QUIC stream. If called on a QUIC connection SSL object with an
76 associated default stream, it signals the end of the single stream to the peer.
77 .PP
78 Any data already queued for transmission via a call to \fBSSL_write()\fR will still be
79 written in a reliable manner before the end-of-stream is signalled, assuming the
80 connection remains healthy. This function can be thought of as appending a
81 logical end-of-stream marker after any data which has previously been written to
82 the stream via calls to \fBSSL_write()\fR. Further attempts to call \fBSSL_write()\fR after
83 calling this function will fail.
84 .PP
85 When calling this on a stream, the receive part of the stream remains
86 unaffected, and the peer may continue to send data until it also signals the end
87 of the stream. Thus, \fBSSL_read()\fR can still be used.
88 .PP
89 \&\fIflags\fR is reserved and should be set to 0.
90 .PP
91 Only the first call to this function has any effect for a given stream;
92 subsequent calls are no-ops. This is considered a success case.
93 .PP
94 This function is not supported on an object other than a QUIC stream SSL object.
95 .SH "RETURN VALUES"
96 .IX Header "RETURN VALUES"
97 Returns 1 on success and 0 on failure.
98 .PP
99 Returns 0 if called on an SSL object not representing a QUIC stream.
100 .SH "SEE ALSO"
101 .IX Header "SEE ALSO"
102 \&\fBopenssl\-quic\fR\|(7), \fBssl\fR\|(7), \fBSSL_shutdown_ex\fR\|(3)
103 .SH HISTORY
104 .IX Header "HISTORY"
105 The \fBSSL_stream_conclude()\fR function was added in OpenSSL 3.2.
106 .SH COPYRIGHT
107 .IX Header "COPYRIGHT"
108 Copyright 2022\-2023 The OpenSSL Project Authors. All Rights Reserved.
109 .PP
110 Licensed under the Apache License 2.0 (the "License"). You may not use
111 this file except in compliance with the License. You can obtain a copy
112 in the file LICENSE in the source distribution or at
113 <https://www.openssl.org/source/license.html>.