This commit was manufactured by cvs2svn to create branch

=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

=pod

=head1 NAME

SSL_state_string, SSL_state_string_long - get textual description of state of an SSL object

=head1 SYNOPSIS

 #include <openssl/ssl.h>

 const char *SSL_state_string(SSL *ssl);

 const char *SSL_state_string_long(SSL *ssl);

=head1 DESCRIPTION

SSL_state_string() returns a 6 letter string indicating the current state

of the SSL object B<ssl>.

SSL_state_string_long() returns a string indicating the current state of

the SSL object B<ssl>.

=head1 NOTES

During its use, an SSL objects passes several states. The state is internally

maintained. Querying the state information is not very informative before

or when a connection has been established. It however can be of significant

interest during the handshake.

When using non-blocking sockets, the function call performing the handshake

may return with SSL_ERROR_WANT_READ or SSL_ERROR_WANT_WRITE condition,

so that SSL_state_string[_long]() may be called.

For both blocking or non-blocking sockets, the details state information

can be used within the info_callback function set with the

SSL_set_info_callback() call.

=head1 RETURN VALUES

Detailed description of possible states to be included later.

=head1 SEE ALSO

L<ssl(3)|ssl(3)>

=cut