aboutsummaryrefslogtreecommitdiff
path: root/openssl/trunk/doc/ssl/SSL_rstate_string.pod
diff options
context:
space:
mode:
authorRob Austein <sra@hactrn.net>2007-06-07 02:37:32 +0000
committerRob Austein <sra@hactrn.net>2007-06-07 02:37:32 +0000
commit5dadf34209c288b8fffba1016e6a3c9446381153 (patch)
tree2ec36232cafd0da10fffda780f08a43c97d70aad /openssl/trunk/doc/ssl/SSL_rstate_string.pod
parent6fcf9830cfea5236faf42cc3437ed4bed06c16de (diff)
Replace hacked OpenSSL code with OpenSSL 0.9.8e distribution.
svn path=/openssl/Makefile; revision=659
Diffstat (limited to 'openssl/trunk/doc/ssl/SSL_rstate_string.pod')
-rw-r--r--openssl/trunk/doc/ssl/SSL_rstate_string.pod59
1 files changed, 0 insertions, 59 deletions
diff --git a/openssl/trunk/doc/ssl/SSL_rstate_string.pod b/openssl/trunk/doc/ssl/SSL_rstate_string.pod
deleted file mode 100644
index bdb8a1fc..00000000
--- a/openssl/trunk/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