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