diff options
author | Rob Austein <sra@hactrn.net> | 2006-10-09 16:00:16 +0000 |
---|---|---|
committer | Rob Austein <sra@hactrn.net> | 2006-10-09 16:00:16 +0000 |
commit | eb9264fc2ef786e8c4e3d430834b9b9e9e0b9c0a (patch) | |
tree | a72b0dcff12c4934f29502390553f0b2305b05fa /openssl/vendor/0.9.8d/doc/ssl/SSL_pending.pod | |
parent | 3a6e89edc0a52c58e2c08d3de4e360de777f14a7 (diff) |
OpenSSL 0.9.8d base code import
svn path=/openssl/vendor/0.9.8d/CHANGES; revision=373
Diffstat (limited to 'openssl/vendor/0.9.8d/doc/ssl/SSL_pending.pod')
-rw-r--r-- | openssl/vendor/0.9.8d/doc/ssl/SSL_pending.pod | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/openssl/vendor/0.9.8d/doc/ssl/SSL_pending.pod b/openssl/vendor/0.9.8d/doc/ssl/SSL_pending.pod new file mode 100644 index 00000000..43f2874e --- /dev/null +++ b/openssl/vendor/0.9.8d/doc/ssl/SSL_pending.pod @@ -0,0 +1,43 @@ +=pod + +=head1 NAME + +SSL_pending - obtain number of readable bytes buffered in an SSL object + +=head1 SYNOPSIS + + #include <openssl/ssl.h> + + int SSL_pending(const 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 |