diff options
Diffstat (limited to 'doc/man3/BIO_meth_new.pod')
| -rw-r--r-- | doc/man3/BIO_meth_new.pod | 31 |
1 files changed, 17 insertions, 14 deletions
diff --git a/doc/man3/BIO_meth_new.pod b/doc/man3/BIO_meth_new.pod index 7a1e72d4fc6c..d626277c03b1 100644 --- a/doc/man3/BIO_meth_new.pod +++ b/doc/man3/BIO_meth_new.pod @@ -60,23 +60,23 @@ BIO_meth_set_callback_ctrl - Routines to build up BIO methods The B<BIO_METHOD> type is a structure used for the implementation of new BIO types. It provides a set of functions used by OpenSSL for the implementation -of the various BIO capabilities. See the L<bio> page for more information. +of the various BIO capabilities. See the L<bio(7)> page for more information. BIO_meth_new() creates a new B<BIO_METHOD> structure. It should be given a unique integer B<type> and a string that represents its B<name>. Use BIO_get_new_index() to get the value for B<type>. The set of -standard OpenSSL provided BIO types is provided in B<bio.h>. Some examples -include B<BIO_TYPE_BUFFER> and B<BIO_TYPE_CIPHER>. Filter BIOs should have a -type which have the "filter" bit set (B<BIO_TYPE_FILTER>). Source/sink BIOs -should have the "source/sink" bit set (B<BIO_TYPE_SOURCE_SINK>). File descriptor -based BIOs (e.g. socket, fd, connect, accept etc) should additionally have the -"descriptor" bit set (B<BIO_TYPE_DESCRIPTOR>). See the L<BIO_find_type> page for -more information. +standard OpenSSL provided BIO types is provided in F<< <openssl/bio.h> >>. +Some examples include B<BIO_TYPE_BUFFER> and B<BIO_TYPE_CIPHER>. Filter BIOs +should have a type which have the "filter" bit set (B<BIO_TYPE_FILTER>). +Source/sink BIOs should have the "source/sink" bit set (B<BIO_TYPE_SOURCE_SINK>). +File descriptor based BIOs (e.g. socket, fd, connect, accept etc) should +additionally have the "descriptor" bit set (B<BIO_TYPE_DESCRIPTOR>). See the +L<BIO_find_type(3)> page for more information. BIO_meth_free() destroys a B<BIO_METHOD> structure and frees up any memory -associated with it. +associated with it. If the argument is NULL, nothing is done. BIO_meth_get_write_ex() and BIO_meth_set_write_ex() get and set the function used for writing arbitrary length data to the BIO respectively. This function @@ -108,7 +108,7 @@ application calling BIO_gets(). The parameters for the function have the same meaning as for BIO_gets(). BIO_meth_get_ctrl() and BIO_meth_set_ctrl() get and set the function used for -processing ctrl messages in the BIO respectively. See the L<BIO_ctrl> page for +processing ctrl messages in the BIO respectively. See the L<BIO_ctrl(3)> page for more information. This function will be called in response to the application calling BIO_ctrl(). The parameters for the function have the same meaning as for BIO_ctrl(). @@ -118,7 +118,10 @@ for creating a new instance of the BIO respectively. This function will be called in response to the application calling BIO_new() and passing in a pointer to the current BIO_METHOD. The BIO_new() function will allocate the memory for the new BIO, and a pointer to this newly allocated structure will -be passed as a parameter to the function. +be passed as a parameter to the function. If a create function is set, +BIO_new() will not mark the BIO as initialised on allocation. +L<BIO_set_init(3)> must then be called either by the create function, or later, +by a BIO ctrl function, once BIO initialisation is complete. BIO_meth_get_destroy() and BIO_meth_set_destroy() get and set the function used for destroying an instance of a BIO respectively. This function will be @@ -146,7 +149,7 @@ The B<BIO_meth_get> functions return the corresponding function pointers. =head1 SEE ALSO -L<bio>, L<BIO_find_type>, L<BIO_ctrl>, L<BIO_read_ex>, L<BIO_new> +L<bio(7)>, L<BIO_find_type(3)>, L<BIO_ctrl(3)>, L<BIO_read_ex(3)>, L<BIO_new(3)> =head1 HISTORY @@ -154,9 +157,9 @@ The functions described here were added in OpenSSL 1.1.0. =head1 COPYRIGHT -Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2016-2024 The OpenSSL Project Authors. All Rights Reserved. -Licensed under the OpenSSL license (the "License"). You may not use +Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at L<https://www.openssl.org/source/license.html>. |