X-Git-Url: https://code.wpia.club/?a=blobdiff_plain;f=lib%2Fopenssl%2Fdoc%2Fcrypto%2Fbio.pod;h=1e1dd02106db03c1c0f1b90390e097477f2f5b6b;hb=02ed66432c92de70694700164f986190aad3cbc5;hp=f9239226ffccf4470c59e71e02cd9a6a9db36aee;hpb=89016837dcbf2775cd15dc8cbaba00dc6379f86e;p=cassiopeia.git diff --git a/lib/openssl/doc/crypto/bio.pod b/lib/openssl/doc/crypto/bio.pod index f923922..1e1dd02 100644 --- a/lib/openssl/doc/crypto/bio.pod +++ b/lib/openssl/doc/crypto/bio.pod @@ -1,16 +1,17 @@ =pod +=for comment openssl_manual_section 7 + =head1 NAME -bio - I/O abstraction +bio - Basic I/O abstraction + +=for comment generic =head1 SYNOPSIS #include -TBA - - =head1 DESCRIPTION A BIO is an I/O abstraction, it hides many of the underlying I/O @@ -37,18 +38,53 @@ BIO and one or more filter BIOs. Data read from or written to the first BIO then traverses the chain to the end (normally a source/sink BIO). + +Some BIOs (such as memory BIOs) can be used immediately after calling +BIO_new(). Others (such as file BIOs) need some additional initialization, +and frequently a utility function exists to create and initialize such BIOs. + +If BIO_free() is called on a BIO chain it will only free one BIO resulting +in a memory leak. + +Calling BIO_free_all() a single BIO has the same effect as calling BIO_free() +on it other than the discarded return value. + +Normally the B argument is supplied by a function which returns a +pointer to a BIO_METHOD. There is a naming convention for such functions: +a source/sink BIO is normally called BIO_s_*() and a filter BIO +BIO_f_*(); + +=head1 EXAMPLE + +Create a memory BIO: + + BIO *mem = BIO_new(BIO_s_mem()); + =head1 SEE ALSO -L, -L, L, -L, L, -L, L, -L, L, -L, -L, L, -L, L, -L, L, -L, L, -L, L, -L, -L +L, +L, L, +L, L, +L, L, +L, L, +L, +L, L, +L, L, +L, L, +L, L, +L, +L, L, +L, +L + +=head1 COPYRIGHT + +Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (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 +L. + +=cut +