diff options
author | Arran Cudbard-Bell <a.cudbardb@freeradius.org> | 2022-03-28 13:13:39 -0600 |
---|---|---|
committer | Todd Short <todd.short@me.com> | 2022-04-05 11:27:14 -0400 |
commit | dedb1927751bc9a7ada08cfc4dcc481b8ce1ad81 (patch) | |
tree | 255895d4d61fce573890600e17a84e5db619df2d /doc | |
parent | 1c529128f53ed1cb33a829dafe7fb4201c7ce69a (diff) |
Document the fact that setting a BIO create function means the BIO will no longer be marked as initialised
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Todd Short <todd.short@me.com>
(Merged from https://github.com/openssl/openssl/pull/17983)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/BIO_meth_new.pod | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/man3/BIO_meth_new.pod b/doc/man3/BIO_meth_new.pod index 15c369e7a9..51db3af0d4 100644 --- a/doc/man3/BIO_meth_new.pod +++ b/doc/man3/BIO_meth_new.pod @@ -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 |