BIO_new.pod 1.9 KB

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