Android_verify/lib/openssl/share/man/man3/SSL_get_stream_id.3ossl

.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "SSL_GET_STREAM_ID 3ossl"
.TH SSL_GET_STREAM_ID 3ossl 2025-01-17 3.4.0 OpenSSL
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
SSL_get_stream_id, SSL_get_stream_type, SSL_STREAM_TYPE_NONE,
SSL_STREAM_TYPE_READ, SSL_STREAM_TYPE_WRITE, SSL_STREAM_TYPE_BIDI,
SSL_is_stream_local \- get QUIC stream ID and stream type information
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/ssl.h>
\&
\& uint64_t SSL_get_stream_id(SSL *ssl);
\&
\& #define SSL_STREAM_TYPE_NONE
\& #define SSL_STREAM_TYPE_BIDI
\& #define SSL_STREAM_TYPE_READ
\& #define SSL_STREAM_TYPE_WRITE
\& int SSL_get_stream_type(SSL *ssl);
\&
\& int SSL_is_stream_local(SSL *ssl);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBSSL_get_stream_id()\fR function returns the QUIC stream ID for a QUIC stream
SSL object, or for a QUIC connection SSL object which has a default stream
attached.
.PP
The \fBSSL_get_stream_type()\fR function identifies what operations can be performed
on the stream, and returns one of the following values:
.IP \fBSSL_STREAM_TYPE_NONE\fR 4
.IX Item "SSL_STREAM_TYPE_NONE"
The SSL object is a QUIC connection SSL object without a default stream
attached.
.IP \fBSSL_STREAM_TYPE_BIDI\fR 4
.IX Item "SSL_STREAM_TYPE_BIDI"
The SSL object is a non-QUIC SSL object, or is a QUIC stream object (or QUIC
connection SSL object with a default stream attached), and that stream is a
bidirectional QUIC stream.
.IP \fBSSL_STREAM_TYPE_READ\fR 4
.IX Item "SSL_STREAM_TYPE_READ"
The SSL object is a QUIC stream object (or QUIC connection SSL object with a
default stream attached), and that stream is a unidirectional QUIC stream which
was initiated by the remote peer; thus, it can be read from, but not written to.
.IP \fBSSL_STREAM_TYPE_WRITE\fR 4
.IX Item "SSL_STREAM_TYPE_WRITE"
The SSL object is a QUIC stream object (or QUIC connection SSL object with a
default stream attached), and that stream is a unidirectional QUIC stream which
was initiated by the local application; thus, it can be written to, but not read
from.
.PP
The \fBSSL_is_stream_local()\fR function determines whether a stream was locally
created.
.SH NOTES
.IX Header "NOTES"
While QUICv1 assigns specific meaning to the low two bits of a QUIC stream ID,
QUIC stream IDs in future versions of QUIC are not required to have the same
semantics. Do not determine stream properties using these bits. Instead, use
\&\fBSSL_get_stream_type()\fR to determine the stream type and \fBSSL_get_stream_is_local()\fR
to determine the stream initiator.
.PP
The \fBSSL_get_stream_type()\fR identifies the type of a QUIC stream based on its
identity, and does not indicate whether an operation can currently be
successfully performed on a stream. For example, you might locally initiate a
unidirectional stream, write to it, and then conclude the stream using
\&\fBSSL_stream_conclude\fR\|(3), meaning that it can no longer be written to, but
\&\fBSSL_get_stream_type()\fR would still return \fBSSL_STREAM_TYPE_WRITE\fR. The value
returned by \fBSSL_get_stream_type()\fR does not vary over the lifespan of a stream.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
\&\fBSSL_get_stream_id()\fR returns a QUIC stream ID, or \fBUINT64_MAX\fR if called on an
SSL object which is not a QUIC SSL object, or if called on a QUIC connection SSL
object without a default stream attached. Note that valid QUIC stream IDs are
always below 2**62.
.PP
\&\fBSSL_get_stream_type()\fR returns one of the \fBSSL_STREAM_TYPE\fR values.
.PP
\&\fBSSL_is_stream_local()\fR returns 1 if called on a QUIC stream SSL object which
represents a stream which was locally initiated. It returns 0 if called on a
QUIC stream SSL object which represents a stream which was remotely initiated by
a peer, and \-1 if called on any other kind of SSL object.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBSSL_new_stream\fR\|(3), \fBSSL_accept_stream\fR\|(3)
.SH HISTORY
.IX Header "HISTORY"
These functions were added in OpenSSL 3.2.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2002\-2023 The OpenSSL Project Authors. All Rights Reserved.
.PP
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
<https://www.openssl.org/source/license.html>.