1BIO_NEW(3)                          OpenSSL                         BIO_NEW(3)
2
3
4

NAME

6       BIO_new, BIO_up_ref, BIO_free, BIO_vfree, BIO_free_all - BIO allocation
7       and freeing functions
8

SYNOPSIS

10        #include <openssl/bio.h>
11
12        BIO *  BIO_new(const BIO_METHOD *type);
13        int    BIO_up_ref(BIO *a);
14        int    BIO_free(BIO *a);
15        void   BIO_vfree(BIO *a);
16        void   BIO_free_all(BIO *a);
17

DESCRIPTION

19       The BIO_new() function returns a new BIO using method type.
20
21       BIO_up_ref() increments the reference count associated with the BIO
22       object.
23
24       BIO_free() frees up a single BIO, BIO_vfree() also frees up a single
25       BIO but it does not return a value.  If a is NULL nothing is done.
26       Calling BIO_free() may also have some effect on the underlying I/O
27       structure, for example it may close the file being referred to under
28       certain circumstances. For more details see the individual BIO_METHOD
29       descriptions.
30
31       BIO_free_all() frees up an entire BIO chain, it does not halt if an
32       error occurs freeing up an individual BIO in the chain.  If a is NULL
33       nothing is done.
34

RETURN VALUES

36       BIO_new() returns a newly created BIO or NULL if the call fails.
37
38       BIO_up_ref() and BIO_free() return 1 for success and 0 for failure.
39
40       BIO_free_all() and BIO_vfree() do not return values.
41

NOTES

43       If BIO_free() is called on a BIO chain it will only free one BIO
44       resulting in a memory leak.
45
46       Calling BIO_free_all() on a single BIO has the same effect as calling
47       BIO_free() on it other than the discarded return value.
48

HISTORY

50       BIO_set() was removed in OpenSSL 1.1.0 as BIO type is now opaque.
51

EXAMPLES

53       Create a memory BIO:
54
55        BIO *mem = BIO_new(BIO_s_mem());
56

58       Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
59
60       Licensed under the OpenSSL license (the "License").  You may not use
61       this file except in compliance with the License.  You can obtain a copy
62       in the file LICENSE in the source distribution or at
63       <https://www.openssl.org/source/license.html>.
64
65
66
671.1.1q                            2023-02-06                        BIO_NEW(3)
Impressum