225 lines
7.7 KiB
Groff
Executable File
225 lines
7.7 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, 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.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "BIO_F_BUFFER 3"
|
|
.TH BIO_F_BUFFER 3 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
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
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/bio.h>
|
|
\&
|
|
\& const BIO_METHOD *BIO_f_buffer(void);
|
|
\&
|
|
\& long BIO_get_buffer_num_lines(BIO *b);
|
|
\& long BIO_set_read_buffer_size(BIO *b, long size);
|
|
\& long BIO_set_write_buffer_size(BIO *b, long size);
|
|
\& long BIO_set_buffer_size(BIO *b, long size);
|
|
\& long BIO_set_buffer_read_data(BIO *b, void *buf, long num);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
\&\fIBIO_f_buffer()\fR returns the buffering \s-1BIO\s0 method.
|
|
.PP
|
|
Data written to a buffering \s-1BIO\s0 is buffered and periodically written
|
|
to the next \s-1BIO\s0 in the chain. Data read from a buffering \s-1BIO\s0 comes from
|
|
an internal buffer which is filled from the next \s-1BIO\s0 in the chain.
|
|
Both \fIBIO_gets()\fR and \fIBIO_puts()\fR are supported.
|
|
.PP
|
|
Calling \fIBIO_reset()\fR on a buffering \s-1BIO\s0 clears any buffered data.
|
|
.PP
|
|
\&\fIBIO_get_buffer_num_lines()\fR returns the number of lines currently buffered.
|
|
.PP
|
|
\&\fIBIO_set_read_buffer_size()\fR, \fIBIO_set_write_buffer_size()\fR and \fIBIO_set_buffer_size()\fR
|
|
set the read, write or both read and write buffer sizes to \fBsize\fR. The initial
|
|
buffer size is \s-1DEFAULT_BUFFER_SIZE\s0, currently 4096. Any attempt to reduce the
|
|
buffer size below \s-1DEFAULT_BUFFER_SIZE\s0 is ignored. Any buffered data is cleared
|
|
when the buffer is resized.
|
|
.PP
|
|
\&\fIBIO_set_buffer_read_data()\fR clears the read buffer and fills it with \fBnum\fR
|
|
bytes of \fBbuf\fR. If \fBnum\fR is larger than the current buffer size the buffer
|
|
is expanded.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
These functions, other than \fIBIO_f_buffer()\fR, are implemented as macros.
|
|
.PP
|
|
Buffering BIOs implement \fIBIO_read_ex()\fR and \fIBIO_gets()\fR by using
|
|
\&\fIBIO_read_ex()\fR operations on the next \s-1BIO\s0 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; a \fIBIO_gets()\fR is guaranteed to give
|
|
the caller a whole line, and \fIBIO_read_ex()\fR 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 \s-1BIO\s0. By prepending a
|
|
buffering \s-1BIO\s0 to a chain it is therefore possible to provide
|
|
\&\fIBIO_gets()\fR or exact size \fIBIO_read_ex()\fR functionality if the following
|
|
BIOs do not support it.
|
|
.PP
|
|
Do not add more than one \fIBIO_f_buffer()\fR to a \s-1BIO\s0 chain. The result of
|
|
doing so will force a full read of the size of the internal buffer of
|
|
the top \fIBIO_f_buffer()\fR, which is 4 KiB at a minimum.
|
|
.PP
|
|
Data is only written to the next \s-1BIO\s0 in the chain when the write buffer fills
|
|
or when \fIBIO_flush()\fR is called. It is therefore important to call \fIBIO_flush()\fR
|
|
whenever any pending data should be written such as when removing a buffering
|
|
\&\s-1BIO\s0 using \fIBIO_pop()\fR. \fIBIO_flush()\fR may need to be retried if the ultimate
|
|
source/sink \s-1BIO\s0 is non blocking.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fIBIO_f_buffer()\fR returns the buffering \s-1BIO\s0 method.
|
|
.PP
|
|
\&\fIBIO_get_buffer_num_lines()\fR returns the number of lines buffered (may be 0).
|
|
.PP
|
|
\&\fIBIO_set_read_buffer_size()\fR, \fIBIO_set_write_buffer_size()\fR and \fIBIO_set_buffer_size()\fR
|
|
return 1 if the buffer was successfully resized or 0 for failure.
|
|
.PP
|
|
\&\fIBIO_set_buffer_read_data()\fR returns 1 if the data was set correctly or 0 if
|
|
there was an error.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIbio\fR\|(7),
|
|
\&\fIBIO_reset\fR\|(3),
|
|
\&\fIBIO_flush\fR\|(3),
|
|
\&\fIBIO_pop\fR\|(3),
|
|
\&\fIBIO_ctrl\fR\|(3).
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2000\-2016 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
|
<https://www.openssl.org/source/license.html>.
|