1=pod
2
3=head1 NAME
4
5SSL_state_string, SSL_state_string_long - get textual description of state of an SSL object
6
7=head1 SYNOPSIS
8
9 #include <openssl/ssl.h>
10
11 const char *SSL_state_string(const SSL *ssl);
12 const char *SSL_state_string_long(const SSL *ssl);
13
14=head1 DESCRIPTION
15
16SSL_state_string() returns a 6 letter string indicating the current state
17of the SSL object B<ssl>.
18
19SSL_state_string_long() returns a string indicating the current state of
20the SSL object B<ssl>.
21
22=head1 NOTES
23
24During its use, an SSL objects passes several states. The state is internally
25maintained. Querying the state information is not very informative before
26or when a connection has been established. It however can be of significant
27interest during the handshake.
28
29When using non-blocking sockets, the function call performing the handshake
30may return with SSL_ERROR_WANT_READ or SSL_ERROR_WANT_WRITE condition,
31so that SSL_state_string[_long]() may be called.
32
33For both blocking or non-blocking sockets, the details state information
34can be used within the info_callback function set with the
35SSL_set_info_callback() call.
36
37=head1 RETURN VALUES
38
39Detailed description of possible states to be included later.
40
41=head1 SEE ALSO
42
43L<ssl(3)|ssl(3)>, L<SSL_CTX_set_info_callback(3)|SSL_CTX_set_info_callback(3)>
44
45=cut
46