diff options
Diffstat (limited to 'src/lib/libssl/man/SSL_pending.3')
| -rw-r--r-- | src/lib/libssl/man/SSL_pending.3 | 25 |
1 files changed, 3 insertions, 22 deletions
diff --git a/src/lib/libssl/man/SSL_pending.3 b/src/lib/libssl/man/SSL_pending.3 index b3efa4260d..bbc2e9bdd2 100644 --- a/src/lib/libssl/man/SSL_pending.3 +++ b/src/lib/libssl/man/SSL_pending.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: SSL_pending.3,v 1.4 2018/03/27 17:35:50 schwarze Exp $ | 1 | .\" $OpenBSD: SSL_pending.3,v 1.5 2020/01/23 03:40:18 beck Exp $ |
| 2 | .\" OpenSSL a528d4f0 Oct 27 13:40:11 2015 -0400 | 2 | .\" OpenSSL a528d4f0 Oct 27 13:40:11 2015 -0400 |
| 3 | .\" | 3 | .\" |
| 4 | .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>, | 4 | .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>, |
| @@ -50,7 +50,7 @@ | |||
| 50 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 50 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
| 51 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 51 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
| 52 | .\" | 52 | .\" |
| 53 | .Dd $Mdocdate: March 27 2018 $ | 53 | .Dd $Mdocdate: January 23 2020 $ |
| 54 | .Dt SSL_PENDING 3 | 54 | .Dt SSL_PENDING 3 |
| 55 | .Os | 55 | .Os |
| 56 | .Sh NAME | 56 | .Sh NAME |
| @@ -67,37 +67,18 @@ is buffered until it is read by the application via a call to | |||
| 67 | .Xr SSL_read 3 . | 67 | .Xr SSL_read 3 . |
| 68 | .Pp | 68 | .Pp |
| 69 | .Fn SSL_pending | 69 | .Fn SSL_pending |
| 70 | returns the number of bytes which are available inside | 70 | returns the number of bytes of application data which are available |
| 71 | .Fa ssl | ||
| 72 | for immediate read. | 71 | for immediate read. |
| 73 | .Pp | 72 | .Pp |
| 74 | .Fn SSL_pending | 73 | .Fn SSL_pending |
| 75 | takes into account only bytes from the TLS/SSL record that is | 74 | takes into account only bytes from the TLS/SSL record that is |
| 76 | currently being processed (if any). | 75 | currently being processed (if any). |
| 77 | If the | ||
| 78 | .Fa ssl->read_ahead | ||
| 79 | flag is set (see | ||
| 80 | .Xr SSL_CTX_set_read_ahead 3 ) , | ||
| 81 | additional protocol bytes beyond the current record may have been | ||
| 82 | read containing more TLS/SSL records. | ||
| 83 | This also applies to DTLS. | ||
| 84 | These additional bytes will be buffered but will remain unprocessed | ||
| 85 | until they are needed. | ||
| 86 | As these bytes are still in an unprocessed state, | ||
| 87 | .Fn SSL_pending | ||
| 88 | will ignore them. | ||
| 89 | Therefore it is possible for no more bytes to be readable from the | ||
| 90 | underlying BIO (because the library has already read them) and for | ||
| 91 | .Fn SSL_pending | ||
| 92 | to return 0, even though readable application data bytes are available | ||
| 93 | (because the data is in unprocessed buffered records). | ||
| 94 | .Sh RETURN VALUES | 76 | .Sh RETURN VALUES |
| 95 | .Fn SSL_pending | 77 | .Fn SSL_pending |
| 96 | returns the number of buffered and processed application data | 78 | returns the number of buffered and processed application data |
| 97 | bytes that are pending and are available for immediate read. | 79 | bytes that are pending and are available for immediate read. |
| 98 | .Sh SEE ALSO | 80 | .Sh SEE ALSO |
| 99 | .Xr ssl 3 , | 81 | .Xr ssl 3 , |
| 100 | .Xr SSL_CTX_set_read_ahead 3 , | ||
| 101 | .Xr SSL_read 3 | 82 | .Xr SSL_read 3 |
| 102 | .Sh HISTORY | 83 | .Sh HISTORY |
| 103 | .Fn SSL_pending | 84 | .Fn SSL_pending |