Blame doc/man3/BIO_s_null.pod

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