SSL_rstate_string.pod revision 109998
189837Skris=pod 289837Skris 389837Skris=head1 NAME 489837Skris 589837SkrisSSL_rstate_string, SSL_rstate_string_long - get textual description of state of an SSL object during read operation 689837Skris 789837Skris=head1 SYNOPSIS 889837Skris 989837Skris #include <openssl/ssl.h> 1089837Skris 11109998Smarkm const char *SSL_rstate_string(SSL *ssl); 12109998Smarkm const char *SSL_rstate_string_long(SSL *ssl); 1389837Skris 1489837Skris=head1 DESCRIPTION 1589837Skris 1689837SkrisSSL_rstate_string() returns a 2 letter string indicating the current read state 1789837Skrisof the SSL object B<ssl>. 1889837Skris 1989837SkrisSSL_rstate_string_long() returns a string indicating the current read state of 2089837Skristhe SSL object B<ssl>. 2189837Skris 2289837Skris=head1 NOTES 2389837Skris 2489837SkrisWhen performing a read operation, the SSL/TLS engine must parse the record, 2589837Skrisconsisting of header and body. When working in a blocking environment, 2689837SkrisSSL_rstate_string[_long]() should always return "RD"/"read done". 2789837Skris 2889837SkrisThis function should only seldom be needed in applications. 2989837Skris 3089837Skris=head1 RETURN VALUES 3189837Skris 3289837SkrisSSL_rstate_string() and SSL_rstate_string_long() can return the following 3389837Skrisvalues: 3489837Skris 3589837Skris=over 4 3689837Skris 3789837Skris=item "RH"/"read header" 3889837Skris 3989837SkrisThe header of the record is being evaluated. 4089837Skris 4189837Skris=item "RB"/"read body" 4289837Skris 4389837SkrisThe body of the record is being evaluated. 4489837Skris 4589837Skris=item "RD"/"read done" 4689837Skris 4789837SkrisThe record has been completely processed. 4889837Skris 4989837Skris=item "unknown"/"unknown" 5089837Skris 5189837SkrisThe read state is unknown. This should never happen. 5289837Skris 5389837Skris=back 5489837Skris 5589837Skris=head1 SEE ALSO 5689837Skris 5789837SkrisL<ssl(3)|ssl(3)> 5889837Skris 5989837Skris=cut 60