secure/lib/libcrypto/man/BIO_f_buffer.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "BIO_F_BUFFER 3"
 132 .TH BIO_F_BUFFER 3 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 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
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/bio.h>
 143 \&
 144 \& const BIO_METHOD *BIO_f_buffer(void);
 145 \&
 146 \& long BIO_get_buffer_num_lines(BIO *b);
 147 \& long BIO_set_read_buffer_size(BIO *b, long size);
 148 \& long BIO_set_write_buffer_size(BIO *b, long size);
 149 \& long BIO_set_buffer_size(BIO *b, long size);
 150 \& long BIO_set_buffer_read_data(BIO *b, void *buf, long num);
 151 .Ve
 152 .SH "DESCRIPTION"
 153 .IX Header "DESCRIPTION"
 154 \&\fIBIO_f_buffer()\fR returns the buffering \s-1BIO\s0 method.
 155 .PP
 156 Data written to a buffering \s-1BIO\s0 is buffered and periodically written
 157 to the next \s-1BIO\s0 in the chain. Data read from a buffering \s-1BIO\s0 comes from
 158 an internal buffer which is filled from the next \s-1BIO\s0 in the chain.
 159 Both \fIBIO_gets()\fR and \fIBIO_puts()\fR are supported.
 160 .PP
 161 Calling \fIBIO_reset()\fR on a buffering \s-1BIO\s0 clears any buffered data.
 162 .PP
 163 \&\fIBIO_get_buffer_num_lines()\fR returns the number of lines currently buffered.
 164 .PP
 165 \&\fIBIO_set_read_buffer_size()\fR, \fIBIO_set_write_buffer_size()\fR and \fIBIO_set_buffer_size()\fR
 166 set the read, write or both read and write buffer sizes to \fBsize\fR. The initial
 167 buffer size is \s-1DEFAULT_BUFFER_SIZE,\s0 currently 4096. Any attempt to reduce the
 168 buffer size below \s-1DEFAULT_BUFFER_SIZE\s0 is ignored. Any buffered data is cleared
 169 when the buffer is resized.
 170 .PP
 171 \&\fIBIO_set_buffer_read_data()\fR clears the read buffer and fills it with \fBnum\fR
 172 bytes of \fBbuf\fR. If \fBnum\fR is larger than the current buffer size the buffer
 173 is expanded.
 174 .SH "NOTES"
 175 .IX Header "NOTES"
 176 These functions, other than \fIBIO_f_buffer()\fR, are implemented as macros.
 177 .PP
 178 Buffering BIOs implement \fIBIO_gets()\fR by using \fIBIO_read_ex()\fR operations on the
 179 next \s-1BIO\s0 in the chain. By prepending a buffering \s-1BIO\s0 to a chain it is therefore
 180 possible to provide \fIBIO_gets()\fR functionality if the following BIOs do not
 181 support it (for example \s-1SSL\s0 BIOs).
 182 .PP
 183 Data is only written to the next \s-1BIO\s0 in the chain when the write buffer fills
 184 or when \fIBIO_flush()\fR is called. It is therefore important to call \fIBIO_flush()\fR
 185 whenever any pending data should be written such as when removing a buffering
 186 \&\s-1BIO\s0 using \fIBIO_pop()\fR. \fIBIO_flush()\fR may need to be retried if the ultimate
 187 source/sink \s-1BIO\s0 is non blocking.
 188 .SH "RETURN VALUES"
 189 .IX Header "RETURN VALUES"
 190 \&\fIBIO_f_buffer()\fR returns the buffering \s-1BIO\s0 method.
 191 .PP
 192 \&\fIBIO_get_buffer_num_lines()\fR returns the number of lines buffered (may be 0).
 193 .PP
 194 \&\fIBIO_set_read_buffer_size()\fR, \fIBIO_set_write_buffer_size()\fR and \fIBIO_set_buffer_size()\fR
 195 return 1 if the buffer was successfully resized or 0 for failure.
 196 .PP
 197 \&\fIBIO_set_buffer_read_data()\fR returns 1 if the data was set correctly or 0 if
 198 there was an error.
 199 .SH "SEE ALSO"
 200 .IX Header "SEE ALSO"
 201 \&\fIbio\fR\|(7),
 202 \&\fIBIO_reset\fR\|(3),
 203 \&\fIBIO_flush\fR\|(3),
 204 \&\fIBIO_pop\fR\|(3),
 205 \&\fIBIO_ctrl\fR\|(3).
 206 .SH "COPYRIGHT"
 207 .IX Header "COPYRIGHT"
 208 Copyright 2000\-2016 The OpenSSL Project Authors. All Rights Reserved.
 209 .PP
 210 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 211 this file except in compliance with the License.  You can obtain a copy
 212 in the file \s-1LICENSE\s0 in the source distribution or at
 213 <https://www.openssl.org/source/license.html>.