Remove SSLeay history, etc., from docs

[openssl.git] / doc / ssl / SSL_pending.pod

diff --git a/doc/ssl/SSL_pending.pod b/doc/ssl/SSL_pending.pod
index 744e1855e151c3df77d2a98bea44bc7161aa81b8..c6a79dc53fe9dd96bc360407dc2305be24df6c9f 100644 (file)
--- a/doc/ssl/SSL_pending.pod
+++ b/doc/ssl/SSL_pending.pod
@@ -8,7 +8,7 @@ SSL_pending - obtain number of readable bytes buffered in an SSL object
 
  #include <openssl/ssl.h>
 
- int SSL_pending(SSL *ssl);
+ int SSL_pending(const SSL *ssl);
 
 =head1 DESCRIPTION
 
@@ -19,12 +19,24 @@ B<ssl> for immediate read.
 
 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)>.
+L<SSL_read(3)>.
 
 =head1 RETURN VALUES
 
 The number of bytes pending is returned.
 
-L<SSL_read(3)|SSL_read(3)>, L<ssl(3)|ssl(3)>
+=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 (see
+L<SSL_CTX_set_read_ahead(3)>), additional protocol
+bytes may have been read containing more TLS/SSL records; these are ignored by
+SSL_pending().
+
+=head1 SEE ALSO
+
+L<SSL_read(3)>,
+L<SSL_CTX_set_read_ahead(3)>, L<ssl(3)>
 
 =cut