diff options
author | cvs2svn <cvs2svn@FreeBSD.org> | 2003-01-29 02:25:31 +0000 |
---|---|---|
committer | cvs2svn <cvs2svn@FreeBSD.org> | 2003-01-29 02:25:31 +0000 |
commit | 0cd8860bb1828b29f5595409c8d80e2bbb77b0ca (patch) | |
tree | da69ff87785a5ded735797652d4138f98b53d5fb /crypto/openssl/doc/ssl/SSL_rstate_string.pod | |
parent | 6e955c8f09387c9e78e612f5f410b3c926eb23a4 (diff) |
Diffstat (limited to 'crypto/openssl/doc/ssl/SSL_rstate_string.pod')
-rw-r--r-- | crypto/openssl/doc/ssl/SSL_rstate_string.pod | 59 |
1 files changed, 0 insertions, 59 deletions
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 bdb8a1fcd55f8..0000000000000 --- 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 <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 |