189837Skris=pod
289837Skris
389837Skris=head1 NAME
489837Skris
589837SkrisSSL_state_string, SSL_state_string_long - get textual description of state of an SSL object
689837Skris
789837Skris=head1 SYNOPSIS
889837Skris
989837Skris #include <openssl/ssl.h>
1089837Skris
11160814Ssimon const char *SSL_state_string(const SSL *ssl);
12160814Ssimon const char *SSL_state_string_long(const SSL *ssl);
1389837Skris
1489837Skris=head1 DESCRIPTION
1589837Skris
1689837SkrisSSL_state_string() returns a 6 letter string indicating the current state
1789837Skrisof the SSL object B<ssl>.
1889837Skris
1989837SkrisSSL_state_string_long() returns a string indicating the current state of
2089837Skristhe SSL object B<ssl>.
2189837Skris
2289837Skris=head1 NOTES
2389837Skris
2489837SkrisDuring its use, an SSL objects passes several states. The state is internally
2589837Skrismaintained. Querying the state information is not very informative before
2689837Skrisor when a connection has been established. It however can be of significant
2789837Skrisinterest during the handshake.
2889837Skris
2989837SkrisWhen using non-blocking sockets, the function call performing the handshake
3089837Skrismay return with SSL_ERROR_WANT_READ or SSL_ERROR_WANT_WRITE condition,
3189837Skrisso that SSL_state_string[_long]() may be called.
3289837Skris
3389837SkrisFor both blocking or non-blocking sockets, the details state information
3489837Skriscan be used within the info_callback function set with the
3589837SkrisSSL_set_info_callback() call.
3689837Skris
3789837Skris=head1 RETURN VALUES
3889837Skris
3989837SkrisDetailed description of possible states to be included later.
4089837Skris
4189837Skris=head1 SEE ALSO
4289837Skris
4389837SkrisL<ssl(3)|ssl(3)>, L<SSL_CTX_set_info_callback(3)|SSL_CTX_set_info_callback(3)>
4489837Skris
4589837Skris=cut
46