diff options
| author | Boris Pismenny <borisp@mellanox.com> | 2018-12-06 21:36:08 +0200 |
|---|---|---|
| committer | Matt Caswell <matt@openssl.org> | 2019-04-01 11:54:48 +0100 |
| commit | 9058d9bcd0a0391353720f7728a48596b575ad64 (patch) | |
| tree | 94b46b64b4ea9fbf907b376b3367b0832451b7fa /doc/man3/BIO_ctrl.pod | |
| parent | 005080aa62a8da4a64cd749a2620a89b29e5be26 (diff) | |
add documentation
Reviewed-by: Bernd Edlinger <bernd.edlinger@hotmail.de>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/7848)
Diffstat (limited to 'doc/man3/BIO_ctrl.pod')
| -rw-r--r-- | doc/man3/BIO_ctrl.pod | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/doc/man3/BIO_ctrl.pod b/doc/man3/BIO_ctrl.pod index 29e72aad03..f51593fb6e 100644 --- a/doc/man3/BIO_ctrl.pod +++ b/doc/man3/BIO_ctrl.pod @@ -5,7 +5,8 @@ BIO_ctrl, BIO_callback_ctrl, BIO_ptr_ctrl, BIO_int_ctrl, BIO_reset, BIO_seek, BIO_tell, BIO_flush, BIO_eof, BIO_set_close, BIO_get_close, BIO_pending, BIO_wpending, BIO_ctrl_pending, BIO_ctrl_wpending, -BIO_get_info_callback, BIO_set_info_callback, BIO_info_cb, BIO_get_ktls_send +BIO_get_info_callback, BIO_set_info_callback, BIO_info_cb, BIO_get_ktls_send, +BIO_get_ktls_recv - BIO control operations =head1 SYNOPSIS @@ -35,6 +36,7 @@ BIO_get_info_callback, BIO_set_info_callback, BIO_info_cb, BIO_get_ktls_send int BIO_set_info_callback(BIO *b, BIO_info_cb *cb); int BIO_get_ktls_send(BIO *b); + int BIO_get_ktls_recv(BIO *b); =head1 DESCRIPTION @@ -74,8 +76,10 @@ Not all BIOs support these calls. BIO_ctrl_pending() and BIO_ctrl_wpending() return a size_t type and are functions, BIO_pending() and BIO_wpending() are macros which call BIO_ctrl(). -BIO_get_ktls_send() return 1 if the BIO is using the Kernel TLS data-path for +BIO_get_ktls_send() returns 1 if the BIO is using the Kernel TLS data-path for sending. Otherwise, it returns zero. +BIO_get_ktls_recv() returns 1 if the BIO is using the Kernel TLS data-path for +receiving. Otherwise, it returns zero. =head1 RETURN VALUES @@ -97,8 +101,10 @@ BIO_get_close() returns the close flag value: BIO_CLOSE or BIO_NOCLOSE. BIO_pending(), BIO_ctrl_pending(), BIO_wpending() and BIO_ctrl_wpending() return the amount of pending data. -BIO_get_ktls_send() return 1 if the BIO is using the Kernel TLS data-path for +BIO_get_ktls_send() returns 1 if the BIO is using the Kernel TLS data-path for sending. Otherwise, it returns zero. +BIO_get_ktls_recv() returns 1 if the BIO is using the Kernel TLS data-path for +receiving. Otherwise, it returns zero. =head1 NOTES @@ -134,7 +140,8 @@ the case of BIO_seek() on a file BIO for a successful operation. =head1 HISTORY -The BIO_get_ktls_send() function was added in OpenSSL 3.0.0. +The BIO_get_ktls_send() and BIO_get_ktls_recv() functions were added in +OpenSSL 3.0.0. =head1 COPYRIGHT |