Android_verify/lib/openssl/share/man/man3/SSL_stream_reset.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_STREAM_RESET 3ossl"
.TH SSL_STREAM_RESET 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_stream_reset \- reset a QUIC stream
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/ssl.h>
\&
\& typedef struct ssl_stream_reset_args_st {
\&     uint64_t quic_error_code;
\& } SSL_STREAM_RESET_ARGS;
\&
\& int SSL_stream_reset(SSL *ssl,
\&                      const SSL_STREAM_RESET_ARGS *args,
\&                      size_t args_len);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBSSL_stream_reset()\fR function resets the send part of a QUIC stream when
called on a QUIC stream SSL object, or on a QUIC connection SSL object with  a
default stream attached.
.PP
If \fIargs\fR is non-NULL, \fIargs_len\fR must be set to \f(CWsizeof(*args)\fR.
.PP
\&\fIquic_error_code\fR is an application-specified error code, which must be in the
range [0, 2**62\-1]. If \fIargs\fR is NULL, a value of 0 is used.
.PP
Resetting a stream indicates to an application that the sending part of the
stream is terminating abnormally. When a stream is reset, the implementation
does not guarantee that any data already passed to \fBSSL_write\fR\|(3) will be
received by the peer, and data already passed to \fBSSL_write\fR\|(3) but not yet
transmitted may or may not be discarded. As such, you should only reset
a stream when the information transmitted on the stream no longer matters, for
example due to an error condition.
.PP
This function cannot be called on a unidirectional stream initiated by the peer,
as only the sending side of a stream can initiate a stream reset.
.PP
It is also possible to trigger a stream reset by calling \fBSSL_free\fR\|(3); see the
documentation for \fBSSL_free\fR\|(3) for details.
.PP
The receiving part of the stream (for bidirectional streams) continues to
function normally.
.SH NOTES
.IX Header "NOTES"
This function corresponds to the QUIC \fBRESET_STREAM\fR frame.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
Returns 1 on success and 0 on failure.
.PP
This function fails if called on a QUIC connection SSL object without a default
stream attached, or on a non-QUIC SSL object.
.PP
After the first call to this function succeeds for a given stream,
subsequent calls succeed but are ignored. The application error code
used is that passed to the first successful call to this function.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBSSL_free\fR\|(3)
.SH HISTORY
.IX Header "HISTORY"
\&\fBSSL_stream_reset()\fR was 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>.