secure/lib/libcrypto/man/man3/BIO_f_buffer.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "BIO_F_BUFFER 3"
 136 .TH BIO_F_BUFFER 3 "2022-05-03" "1.1.1o" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 BIO_get_buffer_num_lines, BIO_set_read_buffer_size, BIO_set_write_buffer_size, BIO_set_buffer_size, BIO_set_buffer_read_data, BIO_f_buffer \&\- buffering BIO
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/bio.h>
 147 \&
 148 \& const BIO_METHOD *BIO_f_buffer(void);
 149 \&
 150 \& long BIO_get_buffer_num_lines(BIO *b);
 151 \& long BIO_set_read_buffer_size(BIO *b, long size);
 152 \& long BIO_set_write_buffer_size(BIO *b, long size);
 153 \& long BIO_set_buffer_size(BIO *b, long size);
 154 \& long BIO_set_buffer_read_data(BIO *b, void *buf, long num);
 155 .Ve
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 \&\fBBIO_f_buffer()\fR returns the buffering \s-1BIO\s0 method.
 159 .PP
 160 Data written to a buffering \s-1BIO\s0 is buffered and periodically written
 161 to the next \s-1BIO\s0 in the chain. Data read from a buffering \s-1BIO\s0 comes from
 162 an internal buffer which is filled from the next \s-1BIO\s0 in the chain.
 163 Both \fBBIO_gets()\fR and \fBBIO_puts()\fR are supported.
 164 .PP
 165 Calling \fBBIO_reset()\fR on a buffering \s-1BIO\s0 clears any buffered data.
 166 .PP
 167 \&\fBBIO_get_buffer_num_lines()\fR returns the number of lines currently buffered.
 168 .PP
 169 \&\fBBIO_set_read_buffer_size()\fR, \fBBIO_set_write_buffer_size()\fR and \fBBIO_set_buffer_size()\fR
 170 set the read, write or both read and write buffer sizes to \fBsize\fR. The initial
 171 buffer size is \s-1DEFAULT_BUFFER_SIZE,\s0 currently 4096. Any attempt to reduce the
 172 buffer size below \s-1DEFAULT_BUFFER_SIZE\s0 is ignored. Any buffered data is cleared
 173 when the buffer is resized.
 174 .PP
 175 \&\fBBIO_set_buffer_read_data()\fR clears the read buffer and fills it with \fBnum\fR
 176 bytes of \fBbuf\fR. If \fBnum\fR is larger than the current buffer size the buffer
 177 is expanded.
 178 .SH "NOTES"
 179 .IX Header "NOTES"
 180 These functions, other than \fBBIO_f_buffer()\fR, are implemented as macros.
 181 .PP
 182 Buffering BIOs implement \fBBIO_read_ex()\fR and \fBBIO_gets()\fR by using
 183 \&\fBBIO_read_ex()\fR operations on the next \s-1BIO\s0 in the chain and storing the
 184 result in an internal buffer, from which bytes are given back to the
 185 caller as appropriate for the call; a \fBBIO_gets()\fR is guaranteed to give
 186 the caller a whole line, and \fBBIO_read_ex()\fR is guaranteed to give the
 187 caller the number of bytes it asks for, unless there's an error or end
 188 of communication is reached in the next \s-1BIO.\s0  By prepending a
 189 buffering \s-1BIO\s0 to a chain it is therefore possible to provide
 190 \&\fBBIO_gets()\fR or exact size \fBBIO_read_ex()\fR functionality if the following
 191 BIOs do not support it.
 192 .PP
 193 Do not add more than one \fBBIO_f_buffer()\fR to a \s-1BIO\s0 chain.  The result of
 194 doing so will force a full read of the size of the internal buffer of
 195 the top \fBBIO_f_buffer()\fR, which is 4 KiB at a minimum.
 196 .PP
 197 Data is only written to the next \s-1BIO\s0 in the chain when the write buffer fills
 198 or when \fBBIO_flush()\fR is called. It is therefore important to call \fBBIO_flush()\fR
 199 whenever any pending data should be written such as when removing a buffering
 200 \&\s-1BIO\s0 using \fBBIO_pop()\fR. \fBBIO_flush()\fR may need to be retried if the ultimate
 201 source/sink \s-1BIO\s0 is non blocking.
 202 .SH "RETURN VALUES"
 203 .IX Header "RETURN VALUES"
 204 \&\fBBIO_f_buffer()\fR returns the buffering \s-1BIO\s0 method.
 205 .PP
 206 \&\fBBIO_get_buffer_num_lines()\fR returns the number of lines buffered (may be 0).
 207 .PP
 208 \&\fBBIO_set_read_buffer_size()\fR, \fBBIO_set_write_buffer_size()\fR and \fBBIO_set_buffer_size()\fR
 209 return 1 if the buffer was successfully resized or 0 for failure.
 210 .PP
 211 \&\fBBIO_set_buffer_read_data()\fR returns 1 if the data was set correctly or 0 if
 212 there was an error.
 213 .SH "SEE ALSO"
 214 .IX Header "SEE ALSO"
 215 \&\fBbio\fR\|(7),
 216 \&\fBBIO_reset\fR\|(3),
 217 \&\fBBIO_flush\fR\|(3),
 218 \&\fBBIO_pop\fR\|(3),
 219 \&\fBBIO_ctrl\fR\|(3).
 220 .SH "COPYRIGHT"
 221 .IX Header "COPYRIGHT"
 222 Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved.
 223 .PP
 224 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 225 this file except in compliance with the License.  You can obtain a copy
 226 in the file \s-1LICENSE\s0 in the source distribution or at
 227 <https://www.openssl.org/source/license.html>.