1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.37
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
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. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
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
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
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
--- 48 unchanged lines hidden (view full) ---
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_s_bio 3"
132.TH BIO_s_bio 3 "2010-03-24" "0.9.8n" "OpenSSL"
133.SH "NAME"
134BIO_s_bio, BIO_make_bio_pair, BIO_destroy_bio_pair, BIO_shutdown_wr,
135BIO_set_write_buf_size, BIO_get_write_buf_size, BIO_new_bio_pair,
136BIO_get_write_guarantee, BIO_ctrl_get_write_guarantee, BIO_get_read_request,
137BIO_ctrl_get_read_request, BIO_ctrl_reset_read_request \- BIO pair BIO
138.SH "SYNOPSIS"
139.IX Header "SYNOPSIS"
140.Vb 1
141\& #include <openssl/bio.h>
142.Ve
143.PP
144.Vb 1
145\& BIO_METHOD *BIO_s_bio(void);
146.Ve
147.PP
148.Vb 2
149\& #define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
150\& #define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
151.Ve
152.PP
153.Vb 1
154\& #define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL)
155.Ve
156.PP
157.Vb 2
158\& #define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
159\& #define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
160.Ve
161.PP
162.Vb 1
163\& int BIO_new_bio_pair(BIO **bio1, size_t writebuf1, BIO **bio2, size_t writebuf2);
164.Ve
165.PP
166.Vb 2
167\& #define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
168\& size_t BIO_ctrl_get_write_guarantee(BIO *b);
169.Ve
170.PP
171.Vb 2
172\& #define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
173\& size_t BIO_ctrl_get_read_request(BIO *b);
174.Ve
175.PP
176.Vb 1
177\& int BIO_ctrl_reset_read_request(BIO *b);
178.Ve
179.SH "DESCRIPTION"
180.IX Header "DESCRIPTION"
181\&\fIBIO_s_bio()\fR returns the method for a \s-1BIO\s0 pair. A \s-1BIO\s0 pair is a pair of source/sink
182BIOs where data written to either half of the pair is buffered and can be read from
183the other half. Both halves must usually by handled by the same application thread
184since no locking is done on the internal data structures.
--- 20 unchanged lines hidden (view full) ---
205\&\fIBIO_make_bio_pair()\fR joins two separate BIOs into a connected pair.
206.PP
207\&\fIBIO_destroy_pair()\fR destroys the association between two connected BIOs. Freeing
208up any half of the pair will automatically destroy the association.
209.PP
210\&\fIBIO_shutdown_wr()\fR is used to close down a \s-1BIO\s0 \fBb\fR. After this call no further
211writes on \s-1BIO\s0 \fBb\fR are allowed (they will return an error). Reads on the other
212half of the pair will return any pending data or \s-1EOF\s0 when all pending data has
213been read.
214.PP
215\&\fIBIO_set_write_buf_size()\fR sets the write buffer size of \s-1BIO\s0 \fBb\fR to \fBsize\fR.
216If the size is not initialized a default value is used. This is currently
21717K, sufficient for a maximum size \s-1TLS\s0 record.
218.PP
219\&\fIBIO_get_write_buf_size()\fR returns the size of the write buffer.
220.PP
221\&\fIBIO_new_bio_pair()\fR combines the calls to \fIBIO_new()\fR, \fIBIO_make_bio_pair()\fR and
--- 47 unchanged lines hidden (view full) ---
269\&\fBbio1\fR and \fBbio2\fR, or 0 on failure, with \s-1NULL\s0 pointers stored into the
270locations for \fBbio1\fR and \fBbio2\fR. Check the error stack for more information.
271.PP
272[\s-1XXXXX:\s0 More return values need to be added here]
273.SH "EXAMPLE"
274.IX Header "EXAMPLE"
275The \s-1BIO\s0 pair can be used to have full control over the network access of an
276application. The application can call \fIselect()\fR on the socket as required
277without having to go through the SSL\-interface.
278.PP
279.Vb 6
280\& BIO *internal_bio, *network_bio;
281\& ...
282\& BIO_new_bio_pair(internal_bio, 0, network_bio, 0);
283\& SSL_set_bio(ssl, internal_bio, internal_bio);
284\& SSL_operations();
285\& ...
286.Ve
287.PP
288.Vb 9
289\& application | TLS-engine
290\& | |
291\& +----------> SSL_operations()
292\& | /\e ||
293\& | || \e/
294\& | BIO-pair (internal_bio)
295\& +----------< BIO-pair (network_bio)
296\& | |
297\& socket |
298.Ve
299.PP
300.Vb 4
301\& ...
302\& SSL_free(ssl); /* implicitly frees internal_bio */
303\& BIO_free(network_bio);
304\& ...
305.Ve
306.PP
307As the \s-1BIO\s0 pair will only buffer the data and never directly access the
308connection, it behaves non-blocking and will return as soon as the write
--- 18 unchanged lines hidden ---
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
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. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
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
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
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
--- 48 unchanged lines hidden (view full) ---
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_s_bio 3"
132.TH BIO_s_bio 3 "2010-03-24" "0.9.8n" "OpenSSL"
133.SH "NAME"
134BIO_s_bio, BIO_make_bio_pair, BIO_destroy_bio_pair, BIO_shutdown_wr,
135BIO_set_write_buf_size, BIO_get_write_buf_size, BIO_new_bio_pair,
136BIO_get_write_guarantee, BIO_ctrl_get_write_guarantee, BIO_get_read_request,
137BIO_ctrl_get_read_request, BIO_ctrl_reset_read_request \- BIO pair BIO
138.SH "SYNOPSIS"
139.IX Header "SYNOPSIS"
140.Vb 1
141\& #include <openssl/bio.h>
142.Ve
143.PP
144.Vb 1
145\& BIO_METHOD *BIO_s_bio(void);
146.Ve
147.PP
148.Vb 2
149\& #define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
150\& #define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
151.Ve
152.PP
153.Vb 1
154\& #define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL)
155.Ve
156.PP
157.Vb 2
158\& #define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
159\& #define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
160.Ve
161.PP
162.Vb 1
163\& int BIO_new_bio_pair(BIO **bio1, size_t writebuf1, BIO **bio2, size_t writebuf2);
164.Ve
165.PP
166.Vb 2
167\& #define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
168\& size_t BIO_ctrl_get_write_guarantee(BIO *b);
169.Ve
170.PP
171.Vb 2
172\& #define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
173\& size_t BIO_ctrl_get_read_request(BIO *b);
174.Ve
175.PP
176.Vb 1
177\& int BIO_ctrl_reset_read_request(BIO *b);
178.Ve
179.SH "DESCRIPTION"
180.IX Header "DESCRIPTION"
181\&\fIBIO_s_bio()\fR returns the method for a \s-1BIO\s0 pair. A \s-1BIO\s0 pair is a pair of source/sink
182BIOs where data written to either half of the pair is buffered and can be read from
183the other half. Both halves must usually by handled by the same application thread
184since no locking is done on the internal data structures.
--- 20 unchanged lines hidden (view full) ---
205\&\fIBIO_make_bio_pair()\fR joins two separate BIOs into a connected pair.
206.PP
207\&\fIBIO_destroy_pair()\fR destroys the association between two connected BIOs. Freeing
208up any half of the pair will automatically destroy the association.
209.PP
210\&\fIBIO_shutdown_wr()\fR is used to close down a \s-1BIO\s0 \fBb\fR. After this call no further
211writes on \s-1BIO\s0 \fBb\fR are allowed (they will return an error). Reads on the other
212half of the pair will return any pending data or \s-1EOF\s0 when all pending data has
213been read.
214.PP
215\&\fIBIO_set_write_buf_size()\fR sets the write buffer size of \s-1BIO\s0 \fBb\fR to \fBsize\fR.
216If the size is not initialized a default value is used. This is currently
21717K, sufficient for a maximum size \s-1TLS\s0 record.
218.PP
219\&\fIBIO_get_write_buf_size()\fR returns the size of the write buffer.
220.PP
221\&\fIBIO_new_bio_pair()\fR combines the calls to \fIBIO_new()\fR, \fIBIO_make_bio_pair()\fR and
--- 47 unchanged lines hidden (view full) ---
269\&\fBbio1\fR and \fBbio2\fR, or 0 on failure, with \s-1NULL\s0 pointers stored into the
270locations for \fBbio1\fR and \fBbio2\fR. Check the error stack for more information.
271.PP
272[\s-1XXXXX:\s0 More return values need to be added here]
273.SH "EXAMPLE"
274.IX Header "EXAMPLE"
275The \s-1BIO\s0 pair can be used to have full control over the network access of an
276application. The application can call \fIselect()\fR on the socket as required
277without having to go through the SSL\-interface.
278.PP
279.Vb 6
280\& BIO *internal_bio, *network_bio;
281\& ...
282\& BIO_new_bio_pair(internal_bio, 0, network_bio, 0);
283\& SSL_set_bio(ssl, internal_bio, internal_bio);
284\& SSL_operations();
285\& ...
286.Ve
287.PP
288.Vb 9
289\& application | TLS-engine
290\& | |
291\& +----------> SSL_operations()
292\& | /\e ||
293\& | || \e/
294\& | BIO-pair (internal_bio)
295\& +----------< BIO-pair (network_bio)
296\& | |
297\& socket |
298.Ve
299.PP
300.Vb 4
301\& ...
302\& SSL_free(ssl); /* implicitly frees internal_bio */
303\& BIO_free(network_bio);
304\& ...
305.Ve
306.PP
307As the \s-1BIO\s0 pair will only buffer the data and never directly access the
308connection, it behaves non-blocking and will return as soon as the write
--- 18 unchanged lines hidden ---