1SSL_rstate_string(3)                OpenSSL               SSL_rstate_string(3)
2
3
4

NAME

6       SSL_rstate_string, SSL_rstate_string_long - get textual description of
7       state of an SSL object during read operation
8

SYNOPSIS

10        #include <openssl/ssl.h>
11
12        const char *SSL_rstate_string(SSL *ssl);
13        const char *SSL_rstate_string_long(SSL *ssl);
14

DESCRIPTION

16       SSL_rstate_string() returns a 2 letter string indicating the current
17       read state of the SSL object ssl.
18
19       SSL_rstate_string_long() returns a string indicating the current read
20       state of the SSL object ssl.
21

NOTES

23       When performing a read operation, the SSL/TLS engine must parse the
24       record, consisting of header and body. When working in a blocking envi‐
25       ronment, SSL_rstate_string[_long]() should always return "RD"/"read
26       done".
27
28       This function should only seldom be needed in applications.
29

RETURN VALUES

31       SSL_rstate_string() and SSL_rstate_string_long() can return the follow‐
32       ing values:
33
34       "RH"/"read header"
35           The header of the record is being evaluated.
36
37       "RB"/"read body"
38           The body of the record is being evaluated.
39
40       "RD"/"read done"
41           The record has been completely processed.
42
43       "unknown"/"unknown"
44           The read state is unknown. This should never happen.
45

SEE ALSO

47       ssl(3)
48
49
50
510.9.8b                            2001-08-23              SSL_rstate_string(3)
Impressum