SSL_pending (3)

Leading comments

Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/SSL_pending.3ssl".)

NAME

SSL_pending - obtain number of readable bytes buffered in an SSL object

SYNOPSIS

 #include <openssl/ssl.h>

 int SSL_pending(const SSL *ssl);

DESCRIPTION

SSL_pending() returns the number of bytes which are available inside ssl for immediate read.

NOTES

Data are received in blocks from the peer. Therefore data can be buffered inside ssl and are ready for immediate retrieval with SSL_read(3).

RETURN VALUES

The number of bytes pending is returned.

BUGS

SSL_pending() takes into account only bytes from the record that is currently being processed (if any). If the object's read_ahead flag is set (see SSL_CTX_set_read_ahead(3)), additional protocol bytes may have been read containing more 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.

SEE ALSO

SSL_read(3), SSL_CTX_set_read_ahead(3), ssl(3)