113d40330Schristos=pod 213d40330Schristos 313d40330Schristos=head1 NAME 413d40330Schristos 513d40330SchristosSSL_state_string, SSL_state_string_long - get textual description of state of an SSL object 613d40330Schristos 713d40330Schristos=head1 SYNOPSIS 813d40330Schristos 913d40330Schristos #include <openssl/ssl.h> 1013d40330Schristos 1113d40330Schristos const char *SSL_state_string(const SSL *ssl); 1213d40330Schristos const char *SSL_state_string_long(const SSL *ssl); 1313d40330Schristos 1413d40330Schristos=head1 DESCRIPTION 1513d40330Schristos 16*b0d17251SchristosSSL_state_string() returns an abbreviated string indicating the current state 17*b0d17251Schristosof the SSL object B<ssl>. The returned NUL-terminated string contains 6 or fewer characters. 1813d40330Schristos 19*b0d17251SchristosSSL_state_string_long() returns a descriptive string indicating the current state of 2013d40330Schristosthe SSL object B<ssl>. 2113d40330Schristos 2213d40330Schristos=head1 NOTES 2313d40330Schristos 2413d40330SchristosDuring its use, an SSL objects passes several states. The state is internally 2513d40330Schristosmaintained. Querying the state information is not very informative before 2613d40330Schristosor when a connection has been established. It however can be of significant 2713d40330Schristosinterest during the handshake. 2813d40330Schristos 29f30e0929SchristosWhen using nonblocking sockets, the function call performing the handshake 3013d40330Schristosmay return with SSL_ERROR_WANT_READ or SSL_ERROR_WANT_WRITE condition, 3113d40330Schristosso that SSL_state_string[_long]() may be called. 3213d40330Schristos 33f30e0929SchristosFor both blocking or nonblocking sockets, the details state information 3413d40330Schristoscan be used within the info_callback function set with the 3513d40330SchristosSSL_set_info_callback() call. 3613d40330Schristos 3713d40330Schristos=head1 RETURN VALUES 3813d40330Schristos 3913d40330SchristosDetailed description of possible states to be included later. 4013d40330Schristos 4113d40330Schristos=head1 SEE ALSO 4213d40330Schristos 4313d40330SchristosL<ssl(7)>, L<SSL_CTX_set_info_callback(3)> 4413d40330Schristos 4513d40330Schristos=head1 COPYRIGHT 4613d40330Schristos 47*b0d17251SchristosCopyright 2001-2021 The OpenSSL Project Authors. All Rights Reserved. 4813d40330Schristos 49*b0d17251SchristosLicensed under the Apache License 2.0 (the "License"). You may not use 5013d40330Schristosthis file except in compliance with the License. You can obtain a copy 5113d40330Schristosin the file LICENSE in the source distribution or at 5213d40330SchristosL<https://www.openssl.org/source/license.html>. 5313d40330Schristos 5413d40330Schristos=cut 55