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