1*2175Sjp161948=pod 2*2175Sjp161948 3*2175Sjp161948=head1 NAME 4*2175Sjp161948 5*2175Sjp161948SSL_rstate_string, SSL_rstate_string_long - get textual description of state of an SSL object during read operation 6*2175Sjp161948 7*2175Sjp161948=head1 SYNOPSIS 8*2175Sjp161948 9*2175Sjp161948 #include <openssl/ssl.h> 10*2175Sjp161948 11*2175Sjp161948 const char *SSL_rstate_string(SSL *ssl); 12*2175Sjp161948 const char *SSL_rstate_string_long(SSL *ssl); 13*2175Sjp161948 14*2175Sjp161948=head1 DESCRIPTION 15*2175Sjp161948 16*2175Sjp161948SSL_rstate_string() returns a 2 letter string indicating the current read state 17*2175Sjp161948of the SSL object B<ssl>. 18*2175Sjp161948 19*2175Sjp161948SSL_rstate_string_long() returns a string indicating the current read state of 20*2175Sjp161948the SSL object B<ssl>. 21*2175Sjp161948 22*2175Sjp161948=head1 NOTES 23*2175Sjp161948 24*2175Sjp161948When performing a read operation, the SSL/TLS engine must parse the record, 25*2175Sjp161948consisting of header and body. When working in a blocking environment, 26*2175Sjp161948SSL_rstate_string[_long]() should always return "RD"/"read done". 27*2175Sjp161948 28*2175Sjp161948This function should only seldom be needed in applications. 29*2175Sjp161948 30*2175Sjp161948=head1 RETURN VALUES 31*2175Sjp161948 32*2175Sjp161948SSL_rstate_string() and SSL_rstate_string_long() can return the following 33*2175Sjp161948values: 34*2175Sjp161948 35*2175Sjp161948=over 4 36*2175Sjp161948 37*2175Sjp161948=item "RH"/"read header" 38*2175Sjp161948 39*2175Sjp161948The header of the record is being evaluated. 40*2175Sjp161948 41*2175Sjp161948=item "RB"/"read body" 42*2175Sjp161948 43*2175Sjp161948The body of the record is being evaluated. 44*2175Sjp161948 45*2175Sjp161948=item "RD"/"read done" 46*2175Sjp161948 47*2175Sjp161948The record has been completely processed. 48*2175Sjp161948 49*2175Sjp161948=item "unknown"/"unknown" 50*2175Sjp161948 51*2175Sjp161948The read state is unknown. This should never happen. 52*2175Sjp161948 53*2175Sjp161948=back 54*2175Sjp161948 55*2175Sjp161948=head1 SEE ALSO 56*2175Sjp161948 57*2175Sjp161948L<ssl(3)|ssl(3)> 58*2175Sjp161948 59*2175Sjp161948=cut 60