doc/crypto/BIO_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 BIO_new, BIO_set, BIO_free, BIO_vfree, BIO_free_all - BIO allocation and freeing functions
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/bio.h>
  10
  11  BIO *  BIO_new(BIO_METHOD *type);
  12  int    BIO_set(BIO *a,BIO_METHOD *type);
  13  int    BIO_free(BIO *a);
  14  void   BIO_vfree(BIO *a);
  15  void   BIO_free_all(BIO *a);
  16
  17 =head1 DESCRIPTION
  18
  19 The BIO_new() function returns a new BIO using method B<type>.
  20
  21 BIO_set() sets the method of an already existing BIO.
  22
  23 BIO_free() frees up a single BIO, BIO_vfree() also frees up a single BIO
  24 but it does not return a value.
  25 If B<a> is NULL nothing is done.
  26 Calling BIO_free() may also have some effect
  27 on the underlying I/O structure, for example it may close the file being
  28 referred to under certain circumstances. For more details see the individual
  29 BIO_METHOD descriptions.
  30
  31 BIO_free_all() frees up an entire BIO chain, it does not halt if an error
  32 occurs freeing up an individual BIO in the chain.
  33 If B<a> is NULL nothing is done.
  34
  35 =head1 RETURN VALUES
  36
  37 BIO_new() returns a newly created BIO or NULL if the call fails.
  38
  39 BIO_set(), BIO_free() return 1 for success and 0 for failure.
  40
  41 BIO_free_all() and BIO_vfree() do not return values.
  42
  43 =head1 NOTES
  44
  45 Some BIOs (such as memory BIOs) can be used immediately after calling
  46 BIO_new(). Others (such as file BIOs) need some additional initialization,
  47 and frequently a utility function exists to create and initialize such BIOs.
  48
  49 If BIO_free() is called on a BIO chain it will only free one BIO resulting
  50 in a memory leak.
  51
  52 Calling BIO_free_all() a single BIO has the same effect as calling BIO_free()
  53 on it other than the discarded return value.
  54
  55 Normally the B<type> argument is supplied by a function which returns a
  56 pointer to a BIO_METHOD. There is a naming convention for such functions:
  57 a source/sink BIO is normally called BIO_s_*() and a filter BIO
  58 BIO_f_*();
  59
  60 =head1 EXAMPLE
  61
  62 Create a memory BIO:
  63
  64  BIO *mem = BIO_new(BIO_s_mem());
  65
  66 =head1 SEE ALSO
  67
  68 TBA