From 82b7f378b6907ab315a6e50322d2a0a8794a0aa9 Mon Sep 17 00:00:00 2001 From: bentley <> Date: Sun, 12 Oct 2014 09:33:04 +0000 Subject: Convert libssl manpages from pod to mdoc(7). libcrypto has not been started yet. ok schwarze@ miod@ --- src/lib/libssl/doc/SSL_pending.3 | 41 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 src/lib/libssl/doc/SSL_pending.3 (limited to 'src/lib/libssl/doc/SSL_pending.3') diff --git a/src/lib/libssl/doc/SSL_pending.3 b/src/lib/libssl/doc/SSL_pending.3 new file mode 100644 index 0000000000..e07ba48283 --- /dev/null +++ b/src/lib/libssl/doc/SSL_pending.3 @@ -0,0 +1,41 @@ +.Dd $Mdocdate: October 12 2014 $ +.Dt SSL_PENDING 3 +.Os +.Sh NAME +.Nm SSL_pending +.Nd obtain number of readable bytes buffered in an SSL object +.Sh SYNOPSIS +.In openssl/ssl.h +.Ft int +.Fn SSL_pending "const SSL *ssl" +.Sh DESCRIPTION +.Fn SSL_pending +returns the number of bytes which are available inside +.Fa ssl +for immediate read. +.Sh NOTES +Data are received in blocks from the peer. +Therefore data can be buffered inside +.Fa ssl +and are ready for immediate retrieval with +.Xr SSL_read 3 . +.Sh RETURN VALUES +The number of bytes pending is returned. +.Sh SEE ALSO +.Xr ssl 3 , +.Xr SSL_read 3 +.Sh BUGS +.Fn SSL_pending +takes into account only bytes from the TLS/SSL record that is currently being +processed (if any). +If the +.Vt SSL +object's +.Em read_ahead +flag is set, additional protocol bytes may have been read containing more +TLS/SSL records; these are ignored by +.Fn SSL_pending . +.Pp +Up to OpenSSL 0.9.6, +.Fn SSL_pending +does not check if the record type of pending data is application data. -- cgit v1.2.3-55-g6feb