diff options
Diffstat (limited to 'src/lib/libssl/man/SSL_pending.3')
| -rw-r--r-- | src/lib/libssl/man/SSL_pending.3 | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/src/lib/libssl/man/SSL_pending.3 b/src/lib/libssl/man/SSL_pending.3 new file mode 100644 index 0000000000..dadeec4b92 --- /dev/null +++ b/src/lib/libssl/man/SSL_pending.3 | |||
| @@ -0,0 +1,44 @@ | |||
| 1 | .\" | ||
| 2 | .\" $OpenBSD: SSL_pending.3,v 1.1 2016/11/05 15:32:20 schwarze Exp $ | ||
| 3 | .\" | ||
| 4 | .Dd $Mdocdate: November 5 2016 $ | ||
| 5 | .Dt SSL_PENDING 3 | ||
| 6 | .Os | ||
| 7 | .Sh NAME | ||
| 8 | .Nm SSL_pending | ||
| 9 | .Nd obtain number of readable bytes buffered in an SSL object | ||
| 10 | .Sh SYNOPSIS | ||
| 11 | .In openssl/ssl.h | ||
| 12 | .Ft int | ||
| 13 | .Fn SSL_pending "const SSL *ssl" | ||
| 14 | .Sh DESCRIPTION | ||
| 15 | .Fn SSL_pending | ||
| 16 | returns the number of bytes which are available inside | ||
| 17 | .Fa ssl | ||
| 18 | for immediate read. | ||
| 19 | .Sh NOTES | ||
| 20 | Data are received in blocks from the peer. | ||
| 21 | Therefore data can be buffered inside | ||
| 22 | .Fa ssl | ||
| 23 | and are ready for immediate retrieval with | ||
| 24 | .Xr SSL_read 3 . | ||
| 25 | .Sh RETURN VALUES | ||
| 26 | The number of bytes pending is returned. | ||
| 27 | .Sh SEE ALSO | ||
| 28 | .Xr ssl 3 , | ||
| 29 | .Xr SSL_read 3 | ||
| 30 | .Sh BUGS | ||
| 31 | .Fn SSL_pending | ||
| 32 | takes into account only bytes from the TLS/SSL record that is currently being | ||
| 33 | processed (if any). | ||
| 34 | If the | ||
| 35 | .Vt SSL | ||
| 36 | object's | ||
| 37 | .Em read_ahead | ||
| 38 | flag is set, additional protocol bytes may have been read containing more | ||
| 39 | TLS/SSL records; these are ignored by | ||
| 40 | .Fn SSL_pending . | ||
| 41 | .Pp | ||
| 42 | Up to OpenSSL 0.9.6, | ||
| 43 | .Fn SSL_pending | ||
| 44 | does not check if the record type of pending data is application data. | ||
