| 1 | =pod
|
|---|
| 2 |
|
|---|
| 3 | =head1 NAME
|
|---|
| 4 |
|
|---|
| 5 | BIO_f_readbuffer
|
|---|
| 6 | - read only buffering BIO that supports BIO_tell() and BIO_seek()
|
|---|
| 7 |
|
|---|
| 8 | =head1 SYNOPSIS
|
|---|
| 9 |
|
|---|
| 10 | #include <openssl/bio.h>
|
|---|
| 11 |
|
|---|
| 12 | const BIO_METHOD *BIO_f_readbuffer(void);
|
|---|
| 13 |
|
|---|
| 14 | =head1 DESCRIPTION
|
|---|
| 15 |
|
|---|
| 16 | BIO_f_readbuffer() returns the read buffering BIO method.
|
|---|
| 17 |
|
|---|
| 18 | This BIO filter can be inserted on top of BIO's that do not support BIO_tell()
|
|---|
| 19 | or BIO_seek() (e.g. A file BIO that uses stdin).
|
|---|
| 20 |
|
|---|
| 21 | Data read from a read buffering BIO comes from an internal buffer which is
|
|---|
| 22 | filled from the next BIO in the chain.
|
|---|
| 23 |
|
|---|
| 24 | BIO_gets() is supported for read buffering BIOs.
|
|---|
| 25 | Writing data to a read buffering BIO is not supported.
|
|---|
| 26 |
|
|---|
| 27 | Calling BIO_reset() on a read buffering BIO does not clear any buffered data.
|
|---|
| 28 |
|
|---|
| 29 | =head1 NOTES
|
|---|
| 30 |
|
|---|
| 31 | Read buffering BIOs implement BIO_read_ex() by using BIO_read_ex() operations
|
|---|
| 32 | on the next BIO (e.g. a file BIO) in the chain and storing the result in an
|
|---|
| 33 | internal buffer, from which bytes are given back to the caller as appropriate
|
|---|
| 34 | for the call. BIO_read_ex() is guaranteed to give the caller the number of bytes
|
|---|
| 35 | it asks for, unless there's an error or end of communication is reached in the
|
|---|
| 36 | next BIO. The internal buffer can grow to cache the entire contents of the next
|
|---|
| 37 | BIO in the chain. BIO_seek() uses the internal buffer, so that it can only seek
|
|---|
| 38 | into data that is already read.
|
|---|
| 39 |
|
|---|
| 40 | =head1 RETURN VALUES
|
|---|
| 41 |
|
|---|
| 42 | BIO_f_readbuffer() returns the read buffering BIO method.
|
|---|
| 43 |
|
|---|
| 44 | =head1 SEE ALSO
|
|---|
| 45 |
|
|---|
| 46 | L<bio(7)>,
|
|---|
| 47 | L<BIO_read(3)>,
|
|---|
| 48 | L<BIO_gets(3)>,
|
|---|
| 49 | L<BIO_reset(3)>,
|
|---|
| 50 | L<BIO_ctrl(3)>.
|
|---|
| 51 |
|
|---|
| 52 | =head1 COPYRIGHT
|
|---|
| 53 |
|
|---|
| 54 | Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
|
|---|
| 55 |
|
|---|
| 56 | Licensed under the Apache License 2.0 (the "License"). You may not use
|
|---|
| 57 | this file except in compliance with the License. You can obtain a copy
|
|---|
| 58 | in the file LICENSE in the source distribution or at
|
|---|
| 59 | L<https://www.openssl.org/source/license.html>.
|
|---|
| 60 |
|
|---|
| 61 | =cut
|
|---|
