aboutsummaryrefslogtreecommitdiff
path: root/doc/man3/BIO_s_null.pod
blob: dd39423db1d7e18c809b05b4ae168e6f58f293e8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
=pod

=head1 NAME

BIO_s_null - null data sink

=head1 SYNOPSIS

 #include <openssl/bio.h>

 const BIO_METHOD *BIO_s_null(void);

=head1 DESCRIPTION

BIO_s_null() returns the null sink BIO method. Data written to
the null sink is discarded, reads return EOF.

=head1 NOTES

A null sink BIO behaves in a similar manner to the Unix /dev/null
device.

A null bio can be placed on the end of a chain to discard any data
passed through it.

A null sink is useful if, for example, an application wishes to digest some
data by writing through a digest bio but not send the digested data anywhere.
Since a BIO chain must normally include a source/sink BIO this can be achieved
by adding a null sink BIO to the end of the chain

=head1 RETURN VALUES

BIO_s_null() returns the null sink BIO method.

=head1 COPYRIGHT

Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut