Commit 9058d9bc authored by Boris Pismenny's avatar Boris Pismenny Committed by Matt Caswell
Browse files

add documentation 



Reviewed-by: default avatarBernd Edlinger <bernd.edlinger@hotmail.de>
Reviewed-by: default avatarMatt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/7848)
parent 005080aa

doc/man3/BIO_ctrl.pod

+11 −4
Original line number Diff line number Diff line
@@ -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

util/private.num

+1 −0
Original line number Diff line number Diff line
@@ -116,6 +116,7 @@ BIO_get_cipher_ctx define 
BIO_get_cipher_status                   define

BIO_get_close                           define

BIO_get_ktls_send                       define

BIO_get_ktls_recv                       define

BIO_get_conn_address                    define

BIO_get_conn_hostname                   define

BIO_get_conn_port                       define