$NetBSD: BIO_new.3,v 1.25 2024/09/08 13:08:15 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "BIO_new 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
BIO_new_ex, BIO_new, BIO_up_ref, BIO_free, BIO_vfree, BIO_free_all \- BIO allocation and freeing functions Header "SYNOPSIS" .Vb 1 #include <openssl/bio.h> \& BIO *BIO_new_ex(OSSL_LIB_CTX *libctx, const BIO_METHOD *type); BIO *BIO_new(const BIO_METHOD *type); int BIO_up_ref(BIO *a); int BIO_free(BIO *a); void BIO_vfree(BIO *a); void BIO_free_all(BIO *a); .Ve Header "DESCRIPTION" The BIO_new_ex() function returns a new BIO using method type associated with the library context libctx (see OSSL_LIB_CTX\|(3)). The library context may be NULL to indicate the default library context.

The BIO_new() is the same as BIO_new_ex() except the default library context is always used.

\fBBIO_up_ref() increments the reference count associated with the BIO object.

\fBBIO_free() frees up a single BIO, BIO_vfree() also frees up a single BIO but it does not return a value. If a is NULL nothing is done. Calling BIO_free() may also have some effect on the underlying I/O structure, for example it may close the file being referred to under certain circumstances. For more details see the individual BIO_METHOD descriptions.

\fBBIO_free_all() frees up an entire BIO chain, it does not halt if an error occurs freeing up an individual BIO in the chain. If a is NULL nothing is done.

Header "RETURN VALUES" \fBBIO_new_ex() and BIO_new() return a newly created BIO or NULL if the call fails.

\fBBIO_up_ref() and BIO_free() return 1 for success and 0 for failure.

\fBBIO_free_all() and BIO_vfree() do not return values.

Header "NOTES" If BIO_free() is called on a BIO chain it will only free one BIO resulting in a memory leak.

Calling BIO_free_all() on a single BIO has the same effect as calling BIO_free() on it other than the discarded return value.

Header "HISTORY" \fBBIO_set() was removed in OpenSSL 1.1.0 as BIO type is now opaque.

\fBBIO_new_ex() was added in OpenSSL 3.0.

Header "EXAMPLES" Create a memory BIO:

.Vb 1 BIO *mem = BIO_new(BIO_s_mem()); .Ve

Header "COPYRIGHT" Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.