xref: /onnv-gate/usr/src/common/openssl/doc/crypto/BIO_s_null.pod (revision 2175:b0b2f052a486)
1*2175Sjp161948=pod
2*2175Sjp161948
3*2175Sjp161948=head1 NAME
4*2175Sjp161948
5*2175Sjp161948BIO_s_null - null data sink
6*2175Sjp161948
7*2175Sjp161948=head1 SYNOPSIS
8*2175Sjp161948
9*2175Sjp161948 #include <openssl/bio.h>
10*2175Sjp161948
11*2175Sjp161948 BIO_METHOD *	BIO_s_null(void);
12*2175Sjp161948
13*2175Sjp161948=head1 DESCRIPTION
14*2175Sjp161948
15*2175Sjp161948BIO_s_null() returns the null sink BIO method. Data written to
16*2175Sjp161948the null sink is discarded, reads return EOF.
17*2175Sjp161948
18*2175Sjp161948=head1 NOTES
19*2175Sjp161948
20*2175Sjp161948A null sink BIO behaves in a similar manner to the Unix /dev/null
21*2175Sjp161948device.
22*2175Sjp161948
23*2175Sjp161948A null bio can be placed on the end of a chain to discard any data
24*2175Sjp161948passed through it.
25*2175Sjp161948
26*2175Sjp161948A null sink is useful if, for example, an application wishes to digest some
27*2175Sjp161948data by writing through a digest bio but not send the digested data anywhere.
28*2175Sjp161948Since a BIO chain must normally include a source/sink BIO this can be achieved
29*2175Sjp161948by adding a null sink BIO to the end of the chain
30*2175Sjp161948
31*2175Sjp161948=head1 RETURN VALUES
32*2175Sjp161948
33*2175Sjp161948BIO_s_null() returns the null sink BIO method.
34*2175Sjp161948
35*2175Sjp161948=head1 SEE ALSO
36*2175Sjp161948
37*2175Sjp161948TBA
38