summaryrefslogtreecommitdiff
path: root/crypto/openssl/doc/ssl/SSL_pending.pod
diff options
context:
space:
mode:
authorcvs2svn <cvs2svn@FreeBSD.org>2002-08-05 16:25:18 +0000
committercvs2svn <cvs2svn@FreeBSD.org>2002-08-05 16:25:18 +0000
commitb511ae2f1f196288ae21fd8ef86946e50dacbbcd (patch)
treec77ed69a9d89e7b50ec49f9e17f03e1daaf0c328 /crypto/openssl/doc/ssl/SSL_pending.pod
parentb1357e1cec95464ca388f5ea85e0b24cfac69efc (diff)
Notes
Diffstat (limited to 'crypto/openssl/doc/ssl/SSL_pending.pod')
-rw-r--r--crypto/openssl/doc/ssl/SSL_pending.pod43
1 files changed, 0 insertions, 43 deletions
diff --git a/crypto/openssl/doc/ssl/SSL_pending.pod b/crypto/openssl/doc/ssl/SSL_pending.pod
deleted file mode 100644
index b4c48598b25d..000000000000
--- a/crypto/openssl/doc/ssl/SSL_pending.pod
+++ /dev/null
@@ -1,43 +0,0 @@
-=pod
-
-=head1 NAME
-
-SSL_pending - obtain number of readable bytes buffered in an SSL object
-
-=head1 SYNOPSIS
-
- #include <openssl/ssl.h>
-
- int SSL_pending(SSL *ssl);
-
-=head1 DESCRIPTION
-
-SSL_pending() returns the number of bytes which are available inside
-B<ssl> for immediate read.
-
-=head1 NOTES
-
-Data are received in blocks from the peer. Therefore data can be buffered
-inside B<ssl> and are ready for immediate retrieval with
-L<SSL_read(3)|SSL_read(3)>.
-
-=head1 RETURN VALUES
-
-The number of bytes pending is returned.
-
-=head1 BUGS
-
-SSL_pending() takes into account only bytes from the TLS/SSL record
-that is currently being processed (if any). If the B<SSL> object's
-I<read_ahead> flag is set, additional protocol bytes may have been
-read containing more TLS/SSL records; these are ignored by
-SSL_pending().
-
-Up to OpenSSL 0.9.6, SSL_pending() does not check if the record type
-of pending data is application data.
-
-=head1 SEE ALSO
-
-L<SSL_read(3)|SSL_read(3)>, L<ssl(3)|ssl(3)>
-
-=cut