Debian Codegraph @

upstream/debian-unstable/man3/BIO_f_readbuffer.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "BIO_F_READBUFFER 3SSL"
58 .TH BIO_F_READBUFFER 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 BIO_f_readbuffer
65 \&\- read only buffering BIO that supports BIO_tell() and BIO_seek()
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/bio.h>
70 \&
71 \& const BIO_METHOD *BIO_f_readbuffer(void);
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 \&\fBBIO_f_readbuffer()\fR returns the read buffering BIO method.
76 .PP
77 This BIO filter can be inserted on top of BIO's that do not support \fBBIO_tell()\fR
78 or \fBBIO_seek()\fR (e.g. A file BIO that uses stdin).
79 .PP
80 Data read from a read buffering BIO comes from an internal buffer which is
81 filled from the next BIO in the chain.
82 .PP
83 \&\fBBIO_gets()\fR is supported for read buffering BIOs.
84 Writing data to a read buffering BIO is not supported.
85 .PP
86 Calling \fBBIO_reset()\fR on a read buffering BIO does not clear any buffered data.
87 .SH NOTES
88 .IX Header "NOTES"
89 Read buffering BIOs implement \fBBIO_read_ex()\fR by using \fBBIO_read_ex()\fR operations
90 on the next BIO (e.g. a file BIO) in the chain and storing the result in an
91 internal buffer, from which bytes are given back to the caller as appropriate
92 for the call. \fBBIO_read_ex()\fR is guaranteed to give the caller the number of bytes
93 it asks for, unless there's an error or end of communication is reached in the
94 next BIO. The internal buffer can grow to cache the entire contents of the next
95 BIO in the chain. \fBBIO_seek()\fR uses the internal buffer, so that it can only seek
96 into data that is already read.
97 .SH "RETURN VALUES"
98 .IX Header "RETURN VALUES"
99 \&\fBBIO_f_readbuffer()\fR returns the read buffering BIO method.
100 .SH "SEE ALSO"
101 .IX Header "SEE ALSO"
102 \&\fBbio\fR\|(7),
103 \&\fBBIO_read\fR\|(3),
104 \&\fBBIO_gets\fR\|(3),
105 \&\fBBIO_reset\fR\|(3),
106 \&\fBBIO_ctrl\fR\|(3).
107 .SH COPYRIGHT
108 .IX Header "COPYRIGHT"
109 Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
110 .PP
111 Licensed under the Apache License 2.0 (the "License"). You may not use
112 this file except in compliance with the License. You can obtain a copy
113 in the file LICENSE in the source distribution or at
114 <https://www.openssl.org/source/license.html>.