From 53f8bb4660ffd645a37cbe1eaa07adfa262e94b9 Mon Sep 17 00:00:00 2001 From: cvs2svn Date: Sun, 1 Oct 2006 08:09:47 +0000 Subject: This commit was manufactured by cvs2svn to create tag 'openssl-vendor-crypto-b0_9_8-20060929'. --- crypto/openssl/doc/ssl/SSL_rstate_string.pod | 59 ---------------------------- 1 file changed, 59 deletions(-) delete mode 100644 crypto/openssl/doc/ssl/SSL_rstate_string.pod (limited to 'crypto/openssl/doc/ssl/SSL_rstate_string.pod') diff --git a/crypto/openssl/doc/ssl/SSL_rstate_string.pod b/crypto/openssl/doc/ssl/SSL_rstate_string.pod deleted file mode 100644 index bdb8a1fcd55f..000000000000 --- a/crypto/openssl/doc/ssl/SSL_rstate_string.pod +++ /dev/null @@ -1,59 +0,0 @@ -=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 - - 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_rstate_string_long() returns a string indicating the current read state of -the SSL object B. - -=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 - -=cut -- cgit v1.3