Correct PPTP server firewall rules chain.
[tomato/davidwu.git] / release / src / router / openssl / doc / ssl / SSL_pending.pod
blob43f2874e8b6aee252bf1db30398f456620a52746
1 =pod
3 =head1 NAME
5 SSL_pending - obtain number of readable bytes buffered in an SSL object
7 =head1 SYNOPSIS
9  #include <openssl/ssl.h>
11  int SSL_pending(const SSL *ssl);
13 =head1 DESCRIPTION
15 SSL_pending() returns the number of bytes which are available inside
16 B<ssl> for immediate read.
18 =head1 NOTES
20 Data are received in blocks from the peer. Therefore data can be buffered
21 inside B<ssl> and are ready for immediate retrieval with
22 L<SSL_read(3)|SSL_read(3)>.
24 =head1 RETURN VALUES
26 The number of bytes pending is returned.
28 =head1 BUGS
30 SSL_pending() takes into account only bytes from the TLS/SSL record
31 that is currently being processed (if any).  If the B<SSL> object's
32 I<read_ahead> flag is set, additional protocol bytes may have been
33 read containing more TLS/SSL records; these are ignored by
34 SSL_pending().
36 Up to OpenSSL 0.9.6, SSL_pending() does not check if the record type
37 of pending data is application data.
39 =head1 SEE ALSO
41 L<SSL_read(3)|SSL_read(3)>, L<ssl(3)|ssl(3)>
43 =cut