diff options
| author | cvs2svn <cvs2svn@FreeBSD.org> | 2002-07-19 16:59:44 +0000 |
|---|---|---|
| committer | cvs2svn <cvs2svn@FreeBSD.org> | 2002-07-19 16:59:44 +0000 |
| commit | 70080a3d23b2da1ab9448a0005cbc3d8da2c313a (patch) | |
| tree | f17bd9201caf5664462829b89fa58ae60e0fae90 /crypto/openssl/doc/ssl/SSL_rstate_string.pod | |
| parent | ed2ab961985926dd943b056cf7354c915e8f572c (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 6dbbb99b9358a..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> - - char *SSL_rstate_string(SSL *ssl); - 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 |
