diff options
author | Richard Levitte <levitte@openssl.org> | 2000-09-21 06:46:15 +0000 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2000-09-21 06:46:15 +0000 |
commit | c19b6c922a6575974455404be3c1409de60fb1eb (patch) | |
tree | 9028e11834ce68083ad559adaf34f83c4e12a7e7 /doc/ssl/SSL_pending.pod | |
parent | c5f8bbbc0b94f3ec3f3f8f2aabbe3cc81f7b8158 (diff) |
Clarifications and new documents.
Submitted by Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE>
Diffstat (limited to 'doc/ssl/SSL_pending.pod')
-rw-r--r-- | doc/ssl/SSL_pending.pod | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/ssl/SSL_pending.pod b/doc/ssl/SSL_pending.pod new file mode 100644 index 0000000000..744e1855e1 --- /dev/null +++ b/doc/ssl/SSL_pending.pod @@ -0,0 +1,30 @@ +=pod + +=head1 NAME + +SSL_pending - obtain number of readable bytes buffered in an SSL object + +=head1 SYNOPSIS + + #include <openssl/ssl.h> + + int SSL_pending(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. + +L<SSL_read(3)|SSL_read(3)>, L<ssl(3)|ssl(3)> + +=cut |