$NetBSD: BIO_f_readbuffer.3,v 1.5 2024/09/08 13:08:15 christos Exp $
-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
Standard preamble:
========================================================================
..
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================
Title "BIO_f_readbuffer 3"
way too many mistakes in technical documents.
-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
Standard preamble:
========================================================================
..
.... \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================
Title "BIO_f_readbuffer 3"
BIO_f_readbuffer 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makesway too many mistakes in technical documents.
NAME
BIO_f_readbuffer
\- read only buffering BIO that supports BIO_tell() and BIO_seek()
SYNOPSIS
Header "SYNOPSIS" .Vb 1
#include <openssl/bio.h>
\&
const BIO_METHOD *BIO_f_readbuffer(void);
.Ve
DESCRIPTION
Header "DESCRIPTION" \fBBIO_f_readbuffer() returns the read buffering BIO method.
This BIO filter can be inserted on top of BIO's that do not support BIO_tell() or BIO_seek() (e.g. A file BIO that uses stdin).
Data read from a read buffering BIO comes from an internal buffer which is filled from the next BIO in the chain.
\fBBIO_gets() is supported for read buffering BIOs. Writing data to a read buffering BIO is not supported.
Calling BIO_reset() on a read buffering BIO does not clear any buffered data.
NOTES
Header "NOTES" Read buffering BIOs implement BIO_read_ex() by using BIO_read_ex() operations
on the next BIO (e.g. a file BIO) in the chain and storing the result in an
internal buffer, from which bytes are given back to the caller as appropriate
for the call. BIO_read_ex() is guaranteed to give the caller the number of bytes
it asks for, unless there's an error or end of communication is reached in the
next BIO. The internal buffer can grow to cache the entire contents of the next
BIO in the chain. BIO_seek() uses the internal buffer, so that it can only seek
into data that is already read.
"RETURN VALUES"
Header "RETURN VALUES" \fBBIO_f_readbuffer() returns the read buffering BIO method.
"SEE ALSO"
Header "SEE ALSO" \fBbio\|(7),
\fBBIO_read\|(3),
\fBBIO_gets\|(3),
\fBBIO_reset\|(3),
\fBBIO_ctrl\|(3).
COPYRIGHT
Header "COPYRIGHT" Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.