SSL_pending - obtain number of readable bytes buffered in an SSL object
#include <openssl/ssl.h> int SSL_pending(const SSL *ssl);
SSL_pending(3openssl) OpenSSL SSL_pending(3openssl)
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.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+--------------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+--------------------------+
|Availability | library/security/openssl |
+---------------+--------------------------+
|Stability | Pass-through uncommitted |
+---------------+--------------------------+
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).
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from
https://www.openssl.org/source/openssl-1.0.2ze.tar.gz.
Further information about this software can be found on the open source
community website at https://www.openssl.org/.
RETURN VALUES
The number of bytes pending is returned.
BUGS
SSL_pending() takes into account only bytes from the TLS/SSL record
that is currently being processed (if any). If the SSL object's
read_ahead flag is set (see SSL_CTX_set_read_ahead(3)), 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.
SEE ALSO
SSL_read(3), SSL_CTX_set_read_ahead(3), ssl(3)
1.0.2ze 2022-05-03 SSL_pending(3openssl)