diff options
author | Tomas Mraz <tomas@openssl.org> | 2022-09-19 10:36:21 +0200 |
---|---|---|
committer | Hugo Landau <hlandau@openssl.org> | 2022-09-23 14:27:14 +0100 |
commit | e9809f8a09147bc27f974caa908b04439c006625 (patch) | |
tree | 9548341ec682f686167385f770876fbc525177a3 /doc | |
parent | 538ee4e0977492009f8ca39d577d8a1aeb8d27fd (diff) |
Fix error return values from BIO_ctrl_(w)pending()
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/19240)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/BIO_ctrl.pod | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/man3/BIO_ctrl.pod b/doc/man3/BIO_ctrl.pod index eb312bcd0c..f7e9217b16 100644 --- a/doc/man3/BIO_ctrl.pod +++ b/doc/man3/BIO_ctrl.pod @@ -112,7 +112,9 @@ BIO_get_close() returns the close flag value: BIO_CLOSE or BIO_NOCLOSE. It also returns other negative values if an error occurs. BIO_pending(), BIO_ctrl_pending(), BIO_wpending() and BIO_ctrl_wpending() -return the amount of pending data. +return the amount of pending data. BIO_pending() and BIO_wpending() return +negative value or 0 on error. BIO_ctrl_pending() and BIO_ctrl_wpending() return +0 on error. BIO_get_ktls_send() returns 1 if the BIO is using the Kernel TLS data-path for sending. Otherwise, it returns zero. @@ -164,6 +166,9 @@ particular a return value of 0 can be returned if an operation is not supported, if an error occurred, if EOF has not been reached and in the case of BIO_seek() on a file BIO for a successful operation. +In older versions of OpenSSL the BIO_ctrl_pending() and +BIO_ctrl_wpending() could return values greater than INT_MAX on error. + =head1 HISTORY The BIO_get_ktls_send() and BIO_get_ktls_recv() macros were added in |