diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/SSL_get_stream_read_state.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/SSL_get_stream_read_state.3 | 203 |
1 files changed, 203 insertions, 0 deletions
diff --git a/secure/lib/libcrypto/man/man3/SSL_get_stream_read_state.3 b/secure/lib/libcrypto/man/man3/SSL_get_stream_read_state.3 new file mode 100644 index 000000000000..c9ad51a3cafe --- /dev/null +++ b/secure/lib/libcrypto/man/man3/SSL_get_stream_read_state.3 @@ -0,0 +1,203 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) +.\" +.\" 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_READ_STATE 3ossl" +.TH SSL_GET_STREAM_READ_STATE 3ossl 2025-07-01 3.5.1 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_read_state, SSL_get_stream_write_state, +SSL_get_stream_read_error_code, SSL_get_stream_write_error_code, +SSL_STREAM_STATE_NONE, SSL_STREAM_STATE_OK, SSL_STREAM_STATE_WRONG_DIR, +SSL_STREAM_STATE_FINISHED, SSL_STREAM_STATE_RESET_LOCAL, +SSL_STREAM_STATE_RESET_REMOTE, SSL_STREAM_STATE_CONN_CLOSED \- get QUIC stream +state +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 1 +\& #include <openssl/ssl.h> +\& +\& #define SSL_STREAM_STATE_NONE +\& #define SSL_STREAM_STATE_OK +\& #define SSL_STREAM_STATE_WRONG_DIR +\& #define SSL_STREAM_STATE_FINISHED +\& #define SSL_STREAM_STATE_RESET_LOCAL +\& #define SSL_STREAM_STATE_RESET_REMOTE +\& #define SSL_STREAM_STATE_CONN_CLOSED +\& +\& int SSL_get_stream_read_state(SSL *ssl); +\& int SSL_get_stream_write_state(SSL *ssl); +\& +\& int SSL_get_stream_read_error_code(SSL *ssl, uint64_t *app_error_code); +\& int SSL_get_stream_write_error_code(SSL *ssl, uint64_t *app_error_code); +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +\&\fBSSL_get_stream_read_state()\fR and \fBSSL_get_stream_write_state()\fR retrieve the +overall state of the receiving and sending parts of a QUIC stream, respectively. +.PP +They both return one of the following values: +.IP \fBSSL_STREAM_STATE_NONE\fR 4 +.IX Item "SSL_STREAM_STATE_NONE" +This value is returned if called on a non-QUIC SSL object, or on a QUIC +connection SSL object without a default stream attached. +.IP \fBSSL_STREAM_STATE_OK\fR 4 +.IX Item "SSL_STREAM_STATE_OK" +This value is returned on a stream which has not been concluded and remains +healthy. +.IP \fBSSL_STREAM_STATE_WRONG_DIR\fR 4 +.IX Item "SSL_STREAM_STATE_WRONG_DIR" +This value is returned if \fBSSL_get_stream_read_state()\fR is called on a +locally-initiated (and thus send-only) unidirectional stream, or, conversely, if +\&\fBSSL_get_stream_write_state()\fR is called on a remotely-initiated (and thus +receive-only) unidirectional stream. +.IP \fBSSL_STREAM_STATE_FINISHED\fR 4 +.IX Item "SSL_STREAM_STATE_FINISHED" +For \fBSSL_get_stream_read_state()\fR, this value is returned when the remote peer has +signalled the end of the receiving part of the stream. Note that there may still +be residual data available to read via \fBSSL_read\fR\|(3) when this state is +returned. +.Sp +For \fBSSL_get_stream_write_state()\fR, this value is returned when the local +application has concluded the stream using \fBSSL_stream_conclude\fR\|(3). Future +\&\fBSSL_write\fR\|(3) calls will not succeed. +.IP \fBSSL_STREAM_STATE_RESET_LOCAL\fR 4 +.IX Item "SSL_STREAM_STATE_RESET_LOCAL" +This value is returned when the applicable stream part was reset by the local +application. +.Sp +For \fBSSL_get_stream_read_state()\fR, this means that the receiving part of the +stream was aborted using a locally transmitted QUIC \fBSTOP_SENDING\fR frame. It +may or may not still be possible to obtain any residual data which remains to be +read by calling \fBSSL_read\fR\|(3). +.Sp +For \fBSSL_get_stream_write_state()\fR, this means that the sending part of the stream +was aborted, for example because the application called \fBSSL_stream_reset\fR\|(3), +or because a QUIC stream SSL object with an un-concluded sending part was freed +using \fBSSL_free\fR\|(3). Calls to \fBSSL_write\fR\|(3) will fail. +.Sp +When this value is returned, the application error code which was signalled can +be obtained by calling \fBSSL_get_stream_read_error_code()\fR or +\&\fBSSL_get_stream_write_error_code()\fR as appropriate. +.IP \fBSSL_STREAM_STATE_RESET_REMOTE\fR 4 +.IX Item "SSL_STREAM_STATE_RESET_REMOTE" +This value is returned when the applicable stream part was reset by the remote +peer. +.Sp +For \fBSSL_get_stream_read_state()\fR, this means that the peer sent a QUIC +\&\fBRESET_STREAM\fR frame for the receiving part of the stream; the receiving part +of the stream was logically aborted by the peer. +.Sp +For \fBSSL_get_stream_write_state()\fR, this means that the peer sent a QUIC +\&\fBSTOP_SENDING\fR frame for the sending part of the stream; the peer has indicated +that it does not wish to receive further data on the sending part of the stream. +Calls to \fBSSL_write\fR\|(3) will fail. +.Sp +When this value is returned, the application error code which was signalled can +be obtained by calling \fBSSL_get_stream_read_error_code()\fR or +\&\fBSSL_get_stream_write_error_code()\fR as appropriate. +.IP \fBSSL_STREAM_STATE_CONN_CLOSED\fR 4 +.IX Item "SSL_STREAM_STATE_CONN_CLOSED" +The QUIC connection to which the stream belongs was closed. You can obtain +information about the circumstances of this closure using +\&\fBSSL_get_conn_close_info\fR\|(3). There may still be residual data available to +read via \fBSSL_read\fR\|(3) when this state is returned. Calls to \fBSSL_write\fR\|(3) +will fail. \fBSSL_get_stream_read_state()\fR will return this state if and only if +\&\fBSSL_get_stream_write_state()\fR will also return this state. +.PP +\&\fBSSL_get_stream_read_error_code()\fR and \fBSSL_get_stream_write_error_code()\fR provide +the application error code which was signalled during non-normal termination of +the receiving or sending parts of a stream, respectively. On success, the +application error code is written to \fI*app_error_code\fR. +.SH NOTES +.IX Header "NOTES" +If a QUIC connection is closed, the stream state for all streams transitions to +\&\fBSSL_STREAM_STATE_CONN_CLOSED\fR, but no application error code can be retrieved +using \fBSSL_get_stream_read_error_code()\fR or \fBSSL_get_stream_write_error_code()\fR, as +the QUIC connection closure process does not cause an application error code to +be associated with each individual stream still existing at the time of +connection closure. However, you can obtain the overall error code associated +with the connection closure using \fBSSL_get_conn_close_info\fR\|(3). +.SH "RETURN VALUES" +.IX Header "RETURN VALUES" +\&\fBSSL_get_stream_read_state()\fR and \fBSSL_get_stream_write_state()\fR return one of the +\&\fBSSL_STREAM_STATE\fR values. If called on a non-QUIC SSL object, or a QUIC +connection SSL object without a default stream, \fBSSL_STREAM_STATE_NONE\fR is +returned. +.PP +\&\fBSSL_get_stream_read_error_code()\fR and \fBSSL_get_stream_write_error_code()\fR return 1 +on success and 0 if the stream was terminated normally. They return \-1 on error, +for example if the stream is still healthy, was still healthy at the time of +connection closure, if called on a stream for which the respective stream part +does not exist (e.g. on a unidirectional stream), or if called on a non-QUIC +object or a QUIC connection SSL object without a default stream attached. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fBSSL_stream_conclude\fR\|(3), \fBSSL_stream_reset\fR\|(3), \fBSSL_new_stream\fR\|(3), +\&\fBSSL_accept_stream\fR\|(3), \fBSSL_get_conn_close_info\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>. |