1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.35
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. | will give a
29 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "SSL_rstate_string 3"
132 .TH SSL_rstate_string 3 "2007-03-15" "0.9.8e" "OpenSSL"
134 SSL_rstate_string, SSL_rstate_string_long \- get textual description of state of an SSL object during read operation
136 .IX Header "SYNOPSIS"
138 \& #include <openssl/ssl.h>
142 \& const char *SSL_rstate_string(SSL *ssl);
143 \& const char *SSL_rstate_string_long(SSL *ssl);
146 .IX Header "DESCRIPTION"
147 \&\fISSL_rstate_string()\fR returns a 2 letter string indicating the current read state
148 of the \s-1SSL\s0 object \fBssl\fR.
150 \&\fISSL_rstate_string_long()\fR returns a string indicating the current read state of
151 the \s-1SSL\s0 object \fBssl\fR.
154 When performing a read operation, the \s-1SSL/TLS\s0 engine must parse the record,
155 consisting of header and body. When working in a blocking environment,
156 SSL_rstate_string[_long]() should always return \*(L"\s-1RD\s0\*(R"/\*(L"read done\*(R".
158 This function should only seldom be needed in applications.
160 .IX Header "RETURN VALUES"
161 \&\fISSL_rstate_string()\fR and \fISSL_rstate_string_long()\fR can return the following
163 .ie n .IP """\s-1RH\s0""/""read header""" 4
164 .el .IP "``\s-1RH\s0''/``read header''" 4
165 .IX Item "RH/read header"
166 The header of the record is being evaluated.
167 .ie n .IP """\s-1RB\s0""/""read body""" 4
168 .el .IP "``\s-1RB\s0''/``read body''" 4
169 .IX Item "RB/read body"
170 The body of the record is being evaluated.
171 .ie n .IP """\s-1RD\s0""/""read done""" 4
172 .el .IP "``\s-1RD\s0''/``read done''" 4
173 .IX Item "RD/read done"
174 The record has been completely processed.
175 .ie n .IP """unknown""/""unknown""" 4
176 .el .IP "``unknown''/``unknown''" 4
177 .IX Item "unknown/unknown"
178 The read state is unknown. This should never happen.
180 .IX Header "SEE ALSO"