blob: bdb8a1fcd55f87414e33ced8f951d0516afc5e23 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
=pod
=head1 NAME
SSL_rstate_string, SSL_rstate_string_long - get textual description of state of an SSL object during read operation
=head1 SYNOPSIS
#include <openssl/ssl.h>
const char *SSL_rstate_string(SSL *ssl);
const char *SSL_rstate_string_long(SSL *ssl);
=head1 DESCRIPTION
SSL_rstate_string() returns a 2 letter string indicating the current read state
of the SSL object B<ssl>.
SSL_rstate_string_long() returns a string indicating the current read state of
the SSL object B<ssl>.
=head1 NOTES
When performing a read operation, the SSL/TLS engine must parse the record,
consisting of header and body. When working in a blocking environment,
SSL_rstate_string[_long]() should always return "RD"/"read done".
This function should only seldom be needed in applications.
=head1 RETURN VALUES
SSL_rstate_string() and SSL_rstate_string_long() can return the following
values:
=over 4
=item "RH"/"read header"
The header of the record is being evaluated.
=item "RB"/"read body"
The body of the record is being evaluated.
=item "RD"/"read done"
The record has been completely processed.
=item "unknown"/"unknown"
The read state is unknown. This should never happen.
=back
=head1 SEE ALSO
L<ssl(3)|ssl(3)>
=cut
|
