Debian Codegraph @

upstream/debian-unstable/man3/SSL_rstate_string.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_RSTATE_STRING 3SSL"
58 .TH SSL_RSTATE_STRING 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_rstate_string, SSL_rstate_string_long \- get textual description of state of an SSL object during read operation
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& const char *SSL_rstate_string(SSL *ssl);
71 \& const char *SSL_rstate_string_long(SSL *ssl);
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 \&\fBSSL_rstate_string()\fR returns a 2 letter string indicating the current read state
76 of the SSL object \fBssl\fR.
77 .PP
78 \&\fBSSL_rstate_string_long()\fR returns a string indicating the current read state of
79 the SSL object \fBssl\fR.
80 .SH NOTES
81 .IX Header "NOTES"
82 When performing a read operation, the SSL/TLS engine must parse the record,
83 consisting of header and body. When working in a blocking environment,
84 SSL_rstate_string[_long]() should always return "RD"/"read done".
85 .PP
86 This function should only seldom be needed in applications.
87 .SH "RETURN VALUES"
88 .IX Header "RETURN VALUES"
89 \&\fBSSL_rstate_string()\fR and \fBSSL_rstate_string_long()\fR can return the following
90 values:
91 .IP """RH""/""read header""" 4
92 .IX Item """RH""/""read header"""
93 The header of the record is being evaluated.
94 .IP """RB""/""read body""" 4
95 .IX Item """RB""/""read body"""
96 The body of the record is being evaluated.
97 .IP """unknown""/""unknown""" 4
98 .IX Item """unknown""/""unknown"""
99 The read state is unknown. This should never happen.
100 .PP
101 When used with QUIC SSL objects, these functions always return "RH"/"read
102 header" in normal conditions.
103 .SH "SEE ALSO"
104 .IX Header "SEE ALSO"
105 \&\fBssl\fR\|(7)
106 .SH COPYRIGHT
107 .IX Header "COPYRIGHT"
108 Copyright 2001\-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>.