summaryrefslogtreecommitdiff
path: root/crypto/openssl/doc/ssl/SSL_state_string.pod
diff options
context:
space:
mode:
authorcvs2svn <cvs2svn@FreeBSD.org>2003-01-29 02:25:31 +0000
committercvs2svn <cvs2svn@FreeBSD.org>2003-01-29 02:25:31 +0000
commit0cd8860bb1828b29f5595409c8d80e2bbb77b0ca (patch)
treeda69ff87785a5ded735797652d4138f98b53d5fb /crypto/openssl/doc/ssl/SSL_state_string.pod
parent6e955c8f09387c9e78e612f5f410b3c926eb23a4 (diff)
Diffstat (limited to 'crypto/openssl/doc/ssl/SSL_state_string.pod')
-rw-r--r--crypto/openssl/doc/ssl/SSL_state_string.pod45
1 files changed, 0 insertions, 45 deletions
diff --git a/crypto/openssl/doc/ssl/SSL_state_string.pod b/crypto/openssl/doc/ssl/SSL_state_string.pod
deleted file mode 100644
index b4be1aaa4863c..0000000000000
--- a/crypto/openssl/doc/ssl/SSL_state_string.pod
+++ /dev/null
@@ -1,45 +0,0 @@
-=pod
-
-=head1 NAME
-
-SSL_state_string, SSL_state_string_long - get textual description of state of an SSL object
-
-=head1 SYNOPSIS
-
- #include <openssl/ssl.h>
-
- const char *SSL_state_string(SSL *ssl);
- const char *SSL_state_string_long(SSL *ssl);
-
-=head1 DESCRIPTION
-
-SSL_state_string() returns a 6 letter string indicating the current state
-of the SSL object B<ssl>.
-
-SSL_state_string_long() returns a string indicating the current state of
-the SSL object B<ssl>.
-
-=head1 NOTES
-
-During its use, an SSL objects passes several states. The state is internally
-maintained. Querying the state information is not very informative before
-or when a connection has been established. It however can be of significant
-interest during the handshake.
-
-When using non-blocking sockets, the function call performing the handshake
-may return with SSL_ERROR_WANT_READ or SSL_ERROR_WANT_WRITE condition,
-so that SSL_state_string[_long]() may be called.
-
-For both blocking or non-blocking sockets, the details state information
-can be used within the info_callback function set with the
-SSL_set_info_callback() call.
-
-=head1 RETURN VALUES
-
-Detailed description of possible states to be included later.
-
-=head1 SEE ALSO
-
-L<ssl(3)|ssl(3)>, L<SSL_CTX_set_info_callback(3)|SSL_CTX_set_info_callback(3)>
-
-=cut