1=pod 2 3=head1 NAME 4 5BIO_new_ex, BIO_new, BIO_up_ref, BIO_free, BIO_vfree, BIO_free_all 6- BIO allocation and freeing functions 7 8=head1 SYNOPSIS 9 10 #include <openssl/bio.h> 11 12 BIO *BIO_new_ex(OSSL_LIB_CTX *libctx, const BIO_METHOD *type); 13 BIO *BIO_new(const BIO_METHOD *type); 14 int BIO_up_ref(BIO *a); 15 int BIO_free(BIO *a); 16 void BIO_vfree(BIO *a); 17 void BIO_free_all(BIO *a); 18 19=head1 DESCRIPTION 20 21The BIO_new_ex() function returns a new BIO using method B<type> associated with 22the library context I<libctx> (see OSSL_LIB_CTX(3)). The library context may be 23NULL to indicate the default library context. 24 25The BIO_new() is the same as BIO_new_ex() except the default library context is 26always used. 27 28BIO_up_ref() increments the reference count associated with the BIO object. 29 30BIO_free() frees up a single BIO, BIO_vfree() also frees up a single BIO 31but it does not return a value. 32If B<a> is NULL nothing is done. 33Calling BIO_free() may also have some effect 34on the underlying I/O structure, for example it may close the file being 35referred to under certain circumstances. For more details see the individual 36BIO_METHOD descriptions. 37 38BIO_free_all() frees up an entire BIO chain, it does not halt if an error 39occurs freeing up an individual BIO in the chain. 40If B<a> is NULL nothing is done. 41 42=head1 RETURN VALUES 43 44BIO_new_ex() and BIO_new() return a newly created BIO or NULL if the call fails. 45 46BIO_up_ref() and BIO_free() return 1 for success and 0 for failure. 47 48BIO_free_all() and BIO_vfree() do not return values. 49 50=head1 NOTES 51 52If BIO_free() is called on a BIO chain it will only free one BIO resulting 53in a memory leak. 54 55Calling BIO_free_all() on a single BIO has the same effect as calling BIO_free() 56on it other than the discarded return value. 57 58=head1 HISTORY 59 60BIO_set() was removed in OpenSSL 1.1.0 as BIO type is now opaque. 61 62BIO_new_ex() was added in OpenSSL 3.0. 63 64=head1 EXAMPLES 65 66Create a memory BIO: 67 68 BIO *mem = BIO_new(BIO_s_mem()); 69 70=head1 COPYRIGHT 71 72Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved. 73 74Licensed under the Apache License 2.0 (the "License"). You may not use 75this file except in compliance with the License. You can obtain a copy 76in the file LICENSE in the source distribution or at 77L<https://www.openssl.org/source/license.html>. 78 79=cut 80