diff options
Diffstat (limited to 'src/lib/libssl/src/doc/crypto/BIO_new.pod')
-rw-r--r-- | src/lib/libssl/src/doc/crypto/BIO_new.pod | 64 |
1 files changed, 0 insertions, 64 deletions
diff --git a/src/lib/libssl/src/doc/crypto/BIO_new.pod b/src/lib/libssl/src/doc/crypto/BIO_new.pod deleted file mode 100644 index bd7b7381f3..0000000000 --- a/src/lib/libssl/src/doc/crypto/BIO_new.pod +++ /dev/null | |||
@@ -1,64 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | BIO_new, BIO_set, BIO_free, BIO_vfree, BIO_free_all - BIO allocation and | ||
6 | freeing functions | ||
7 | |||
8 | =head1 SYNOPSIS | ||
9 | |||
10 | #include <openssl/bio.h> | ||
11 | |||
12 | BIO * BIO_new(BIO_METHOD *type); | ||
13 | int BIO_set(BIO *a,BIO_METHOD *type); | ||
14 | int BIO_free(BIO *a); | ||
15 | void BIO_vfree(BIO *a); | ||
16 | void BIO_free_all(BIO *a); | ||
17 | |||
18 | =head1 DESCRIPTION | ||
19 | |||
20 | The BIO_new() function returns a new BIO using method B<type>. | ||
21 | |||
22 | BIO_set() sets the method of an already existing BIO. | ||
23 | |||
24 | BIO_free() frees up a single BIO, BIO_vfree() also frees up a single BIO | ||
25 | but it does not return a value. Calling BIO_free() may also have some effect | ||
26 | on the underlying I/O structure, for example it may close the file being | ||
27 | referred to under certain circumstances. For more details see the individual | ||
28 | BIO_METHOD descriptions. | ||
29 | |||
30 | BIO_free_all() frees up an entire BIO chain, it does not halt if an error | ||
31 | occurs freeing up an individual BIO in the chain. | ||
32 | |||
33 | =head1 RETURN VALUES | ||
34 | |||
35 | BIO_new() returns a newly created BIO or NULL if the call fails. | ||
36 | |||
37 | BIO_set(), BIO_free() return 1 for success and 0 for failure. | ||
38 | |||
39 | BIO_free_all() and BIO_vfree() do not return values. | ||
40 | |||
41 | =head1 NOTES | ||
42 | |||
43 | Some BIOs (such as memory BIOs) can be used immediately after calling | ||
44 | BIO_new(). Others (such as file BIOs) need some additional initialization, | ||
45 | and frequently a utility function exists to create and initialize such BIOs. | ||
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() a single BIO has the same effect as calling BIO_free() | ||
51 | on it other than the discarded return value. | ||
52 | |||
53 | Normally the B<type> argument is supplied by a function which returns a | ||
54 | pointer to a BIO_METHOD. There is a naming convention for such functions: | ||
55 | a source/sink BIO is normally called BIO_s_*() and a filter BIO | ||
56 | BIO_f_*(); | ||
57 | |||
58 | =head1 EXAMPLE | ||
59 | |||
60 | Create a memory BIO: | ||
61 | |||
62 | BIO *mem = BIO_new(BIO_s_mem()); | ||
63 | |||
64 | =cut | ||