diff options
author | Dr. Stephen Henson <steve@openssl.org> | 2000-09-10 17:36:15 +0000 |
---|---|---|
committer | Dr. Stephen Henson <steve@openssl.org> | 2000-09-10 17:36:15 +0000 |
commit | 5fd0cd9a9b7ee101c93719b01c5fccf2ae5cee99 (patch) | |
tree | c5cbf9a7acf05275ed3e17a46dea7129c50ae7ec /doc/crypto/BIO_s_null.pod | |
parent | 97d8e82c4c622b8896e37634c6d4ee43ab6a4432 (diff) |
More new BIO docs, correct some old ones.
Diffstat (limited to 'doc/crypto/BIO_s_null.pod')
-rw-r--r-- | doc/crypto/BIO_s_null.pod | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/crypto/BIO_s_null.pod b/doc/crypto/BIO_s_null.pod new file mode 100644 index 0000000000..b9a3c2cf3f --- /dev/null +++ b/doc/crypto/BIO_s_null.pod @@ -0,0 +1,37 @@ +=pod + +=head1 NAME + + BIO_s_null - null data sink + +=head1 SYNOPSIS + + #include <openssl/bio.h> + + BIO_METHOD * BIO_s_null(void); + +=head1 DESCRIPTION + +BIO_s_null() returns the null sink BIO method. Data written to +the null sink is discraded, 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 but not write the result 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 |