BIO_s_null.pod 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. =pod
  2. =head1 NAME
  3. BIO_s_null - null data sink
  4. =head1 SYNOPSIS
  5. #include <openssl/bio.h>
  6. const BIO_METHOD *BIO_s_null(void);
  7. =head1 DESCRIPTION
  8. BIO_s_null() returns the null sink BIO method. Data written to
  9. the null sink is discarded, reads return EOF.
  10. =head1 NOTES
  11. A null sink BIO behaves in a similar manner to the Unix /dev/null
  12. device.
  13. A null bio can be placed on the end of a chain to discard any data
  14. passed through it.
  15. A null sink is useful if, for example, an application wishes to digest some
  16. data by writing through a digest bio but not send the digested data anywhere.
  17. Since a BIO chain must normally include a source/sink BIO this can be achieved
  18. by adding a null sink BIO to the end of the chain
  19. =head1 RETURN VALUES
  20. BIO_s_null() returns the null sink BIO method.
  21. =head1 COPYRIGHT
  22. Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  23. Licensed under the OpenSSL license (the "License"). You may not use
  24. this file except in compliance with the License. You can obtain a copy
  25. in the file LICENSE in the source distribution or at
  26. L<https://www.openssl.org/source/license.html>.
  27. =cut