[thirdparty/openssl.git] / doc / crypto / BIO_s_null.pod

=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 SEE ALSO

TBA
Commit	Line	Data
5fd0cd9a DSH	1	=pod
	2
	3	=head1 NAME
	4
e117a890	5	BIO_s_null - null data sink
5fd0cd9a DSH	6
	7	=head1 SYNOPSIS
	8
	9	#include <openssl/bio.h>
	10
04f6b0fd	11	const BIO_METHOD * BIO_s_null(void);
5fd0cd9a DSH	12
	13	=head1 DESCRIPTION
	14
	15	BIO_s_null() returns the null sink BIO method. Data written to
b1ccd57b	16	the null sink is discarded, reads return EOF.
5fd0cd9a DSH	17
	18	=head1 NOTES
	19
	20	A null sink BIO behaves in a similar manner to the Unix /dev/null
	21	device.
	22
	23	A null bio can be placed on the end of a chain to discard any data
	24	passed through it.
	25
	26	A null sink is useful if, for example, an application wishes to digest some
b1ccd57b DSH	27	data by writing through a digest bio but not send the digested data anywhere.
	28	Since a BIO chain must normally include a source/sink BIO this can be achieved
	29	by adding a null sink BIO to the end of the chain
5fd0cd9a DSH	30
	31	=head1 RETURN VALUES
	32
	33	BIO_s_null() returns the null sink BIO method.
	34
	35	=head1 SEE ALSO
	36
	37	TBA