1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
29 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD. Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
61 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear. Run. Save yourself. No user-serviceable parts.
73 . \" fudge factors for nroff and troff
82 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
88 . \" simple accents for nroff and troff
98 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 . \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 . \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 . \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
132 .\" ========================================================================
135 .TH bio 3 "2009-01-11" "0.9.8j" "OpenSSL"
136 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
141 bio \- I/O abstraction
143 .IX Header "SYNOPSIS"
145 \& #include <openssl/bio.h>
150 .IX Header "DESCRIPTION"
151 A \s-1BIO\s0 is an I/O abstraction, it hides many of the underlying I/O
152 details from an application. If an application uses a \s-1BIO\s0 for its
153 I/O it can transparently handle \s-1SSL\s0 connections, unencrypted network
154 connections and file I/O.
156 There are two type of \s-1BIO\s0, a source/sink \s-1BIO\s0 and a filter \s-1BIO\s0.
158 As its name implies a source/sink \s-1BIO\s0 is a source and/or sink of data,
159 examples include a socket \s-1BIO\s0 and a file \s-1BIO\s0.
161 A filter \s-1BIO\s0 takes data from one \s-1BIO\s0 and passes it through to
162 another, or the application. The data may be left unmodified (for
163 example a message digest \s-1BIO\s0) or translated (for example an
164 encryption \s-1BIO\s0). The effect of a filter \s-1BIO\s0 may change according
165 to the I/O operation it is performing: for example an encryption
166 \&\s-1BIO\s0 will encrypt data if it is being written to and decrypt data
167 if it is being read from.
169 BIOs can be joined together to form a chain (a single \s-1BIO\s0 is a chain
170 with one component). A chain normally consist of one source/sink
171 \&\s-1BIO\s0 and one or more filter BIOs. Data read from or written to the
172 first \s-1BIO\s0 then traverses the chain to the end (normally a source/sink
175 .IX Header "SEE ALSO"
176 \&\fIBIO_ctrl\fR\|(3),
177 \&\fIBIO_f_base64\fR\|(3), \fIBIO_f_buffer\fR\|(3),
178 \&\fIBIO_f_cipher\fR\|(3), \fIBIO_f_md\fR\|(3),
179 \&\fIBIO_f_null\fR\|(3), \fIBIO_f_ssl\fR\|(3),
180 \&\fIBIO_find_type\fR\|(3), \fIBIO_new\fR\|(3),
181 \&\fIBIO_new_bio_pair\fR\|(3),
182 \&\fIBIO_push\fR\|(3), \fIBIO_read\fR\|(3),
183 \&\fIBIO_s_accept\fR\|(3), \fIBIO_s_bio\fR\|(3),
184 \&\fIBIO_s_connect\fR\|(3), \fIBIO_s_fd\fR\|(3),
185 \&\fIBIO_s_file\fR\|(3), \fIBIO_s_mem\fR\|(3),
186 \&\fIBIO_s_null\fR\|(3), \fIBIO_s_socket\fR\|(3),
187 \&\fIBIO_set_callback\fR\|(3),
188 \&\fIBIO_should_retry\fR\|(3)