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