| 1 | =pod
|
|---|
| 2 |
|
|---|
| 3 | =head1 NAME
|
|---|
| 4 |
|
|---|
| 5 | BIO_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 |
|
|---|
| 15 | BIO_s_null() returns the null sink BIO method. Data written to
|
|---|
| 16 | the null sink is discarded, reads return EOF.
|
|---|
| 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
|
|---|
| 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
|
|---|
| 30 |
|
|---|
| 31 | =head1 RETURN VALUES
|
|---|
| 32 |
|
|---|
| 33 | BIO_s_null() returns the null sink BIO method.
|
|---|
| 34 |
|
|---|
| 35 | =head1 COPYRIGHT
|
|---|
| 36 |
|
|---|
| 37 | Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
|
|---|
| 38 |
|
|---|
| 39 | Licensed under the Apache License 2.0 (the "License"). You may not use
|
|---|
| 40 | this file except in compliance with the License. You can obtain a copy
|
|---|
| 41 | in the file LICENSE in the source distribution or at
|
|---|
| 42 | L<https://www.openssl.org/source/license.html>.
|
|---|
| 43 |
|
|---|
| 44 | =cut
|
|---|
