Deleted Added
full compact
BIO_find_type.3 (206048) BIO_find_type.3 (215698)
1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.37
1.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
2.\"
3.\" Standard preamble:
4.\" ========================================================================
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
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
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
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-
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.\"
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'br\}
42.\"
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
47.\" 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
48.\" titles (.TH), headers (.SH), subsections (.SS), 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.
49.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion.
55.if \nF \{\
51.ie \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
52. de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
54..
55. nr % 0
56. rr F
57.\}
58.el \{\
59. de IX
60..
61.\}
62.\"
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
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_find_type 3"
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear. Run. Save yourself. No user-serviceable parts.
65. \" fudge factors for nroff and troff
66.if n \{\
67. ds #H 0
68. ds #V .8m
69. ds #F .3m
70. ds #[ \f1
71. ds #] \fP
72.\}
73.if t \{\
74. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75. ds #V .6m
76. ds #F 0
77. ds #[ \&
78. ds #] \&
79.\}
80. \" simple accents for nroff and troff
81.if n \{\
82. ds ' \&
83. ds ` \&
84. ds ^ \&
85. ds , \&
86. ds ~ ~
87. ds /
88.\}
89.if t \{\
90. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96.\}
97. \" troff and (daisy-wheel) nroff accents
98.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105.ds ae a\h'-(\w'a'u*4/10)'e
106.ds Ae A\h'-(\w'A'u*4/10)'E
107. \" corrections for vroff
108.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110. \" for low resolution devices (crt and lpr)
111.if \n(.H>23 .if \n(.V>19 \
112\{\
113. ds : e
114. ds 8 ss
115. ds o a
116. ds d- d\h'-1'\(ga
117. ds D- D\h'-1'\(hy
118. ds th \o'bp'
119. ds Th \o'LP'
120. ds ae ae
121. ds Ae AE
122.\}
123.rm #[ #] #H #V #F C
124.\" ========================================================================
125.\"
126.IX Title "BIO_find_type 3"
132.TH BIO_find_type 3 "2010-03-24" "0.9.8n" "OpenSSL"
127.TH BIO_find_type 3 "2010-11-16" "0.9.8p" "OpenSSL"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
133.SH "NAME"
134BIO_find_type, BIO_next \- BIO chain traversal
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 1
138\& #include <openssl/bio.h>
132.SH "NAME"
133BIO_find_type, BIO_next \- BIO chain traversal
134.SH "SYNOPSIS"
135.IX Header "SYNOPSIS"
136.Vb 1
137\& #include <openssl/bio.h>
139.Ve
140.PP
141.Vb 2
138\&
142\& BIO * BIO_find_type(BIO *b,int bio_type);
143\& BIO * BIO_next(BIO *b);
139\& BIO * BIO_find_type(BIO *b,int bio_type);
140\& BIO * BIO_next(BIO *b);
144.Ve
145.PP
146.Vb 1
147\& #define BIO_method_type(b) ((b)->method->type)
148.Ve
149.PP
150.Vb 3
141\&
142\& #define BIO_method_type(b) ((b)\->method\->type)
143\&
151\& #define BIO_TYPE_NONE 0
152\& #define BIO_TYPE_MEM (1|0x0400)
153\& #define BIO_TYPE_FILE (2|0x0400)
144\& #define BIO_TYPE_NONE 0
145\& #define BIO_TYPE_MEM (1|0x0400)
146\& #define BIO_TYPE_FILE (2|0x0400)
154.Ve
155.PP
156.Vb 16
147\&
157\& #define BIO_TYPE_FD (4|0x0400|0x0100)
158\& #define BIO_TYPE_SOCKET (5|0x0400|0x0100)
159\& #define BIO_TYPE_NULL (6|0x0400)
160\& #define BIO_TYPE_SSL (7|0x0200)
161\& #define BIO_TYPE_MD (8|0x0200)
162\& #define BIO_TYPE_BUFFER (9|0x0200)
163\& #define BIO_TYPE_CIPHER (10|0x0200)
164\& #define BIO_TYPE_BASE64 (11|0x0200)
165\& #define BIO_TYPE_CONNECT (12|0x0400|0x0100)
166\& #define BIO_TYPE_ACCEPT (13|0x0400|0x0100)
167\& #define BIO_TYPE_PROXY_CLIENT (14|0x0200)
168\& #define BIO_TYPE_PROXY_SERVER (15|0x0200)
169\& #define BIO_TYPE_NBIO_TEST (16|0x0200)
170\& #define BIO_TYPE_NULL_FILTER (17|0x0200)
171\& #define BIO_TYPE_BER (18|0x0200)
172\& #define BIO_TYPE_BIO (19|0x0400)
148\& #define BIO_TYPE_FD (4|0x0400|0x0100)
149\& #define BIO_TYPE_SOCKET (5|0x0400|0x0100)
150\& #define BIO_TYPE_NULL (6|0x0400)
151\& #define BIO_TYPE_SSL (7|0x0200)
152\& #define BIO_TYPE_MD (8|0x0200)
153\& #define BIO_TYPE_BUFFER (9|0x0200)
154\& #define BIO_TYPE_CIPHER (10|0x0200)
155\& #define BIO_TYPE_BASE64 (11|0x0200)
156\& #define BIO_TYPE_CONNECT (12|0x0400|0x0100)
157\& #define BIO_TYPE_ACCEPT (13|0x0400|0x0100)
158\& #define BIO_TYPE_PROXY_CLIENT (14|0x0200)
159\& #define BIO_TYPE_PROXY_SERVER (15|0x0200)
160\& #define BIO_TYPE_NBIO_TEST (16|0x0200)
161\& #define BIO_TYPE_NULL_FILTER (17|0x0200)
162\& #define BIO_TYPE_BER (18|0x0200)
163\& #define BIO_TYPE_BIO (19|0x0400)
173.Ve
174.PP
175.Vb 3
164\&
176\& #define BIO_TYPE_DESCRIPTOR 0x0100
177\& #define BIO_TYPE_FILTER 0x0200
178\& #define BIO_TYPE_SOURCE_SINK 0x0400
179.Ve
180.SH "DESCRIPTION"
181.IX Header "DESCRIPTION"
182The \fIBIO_find_type()\fR searches for a \s-1BIO\s0 of a given type in a chain, starting
183at \s-1BIO\s0 \fBb\fR. If \fBtype\fR is a specific type (such as \s-1BIO_TYPE_MEM\s0) then a search
184is made for a \s-1BIO\s0 of that type. If \fBtype\fR is a general type (such as
185\&\fB\s-1BIO_TYPE_SOURCE_SINK\s0\fR) then the next matching \s-1BIO\s0 of the given general type is
186searched for. \fIBIO_find_type()\fR returns the next matching \s-1BIO\s0 or \s-1NULL\s0 if none is
187found.
188.PP
189Note: not all the \fBBIO_TYPE_*\fR types above have corresponding \s-1BIO\s0 implementations.
190.PP
191\&\fIBIO_next()\fR returns the next \s-1BIO\s0 in a chain. It can be used to traverse all BIOs
192in a chain or used in conjunction with \fIBIO_find_type()\fR to find all BIOs of a
193certain type.
194.PP
195\&\fIBIO_method_type()\fR returns the type of a \s-1BIO\s0.
196.SH "RETURN VALUES"
197.IX Header "RETURN VALUES"
198\&\fIBIO_find_type()\fR returns a matching \s-1BIO\s0 or \s-1NULL\s0 for no match.
199.PP
200\&\fIBIO_next()\fR returns the next \s-1BIO\s0 in a chain.
201.PP
202\&\fIBIO_method_type()\fR returns the type of the \s-1BIO\s0 \fBb\fR.
203.SH "NOTES"
204.IX Header "NOTES"
205\&\fIBIO_next()\fR was added to OpenSSL 0.9.6 to provide a 'clean' way to traverse a \s-1BIO\s0
206chain or find multiple matches using \fIBIO_find_type()\fR. Previous versions had to
207use:
208.PP
209.Vb 1
165\& #define BIO_TYPE_DESCRIPTOR 0x0100
166\& #define BIO_TYPE_FILTER 0x0200
167\& #define BIO_TYPE_SOURCE_SINK 0x0400
168.Ve
169.SH "DESCRIPTION"
170.IX Header "DESCRIPTION"
171The \fIBIO_find_type()\fR searches for a \s-1BIO\s0 of a given type in a chain, starting
172at \s-1BIO\s0 \fBb\fR. If \fBtype\fR is a specific type (such as \s-1BIO_TYPE_MEM\s0) then a search
173is made for a \s-1BIO\s0 of that type. If \fBtype\fR is a general type (such as
174\&\fB\s-1BIO_TYPE_SOURCE_SINK\s0\fR) then the next matching \s-1BIO\s0 of the given general type is
175searched for. \fIBIO_find_type()\fR returns the next matching \s-1BIO\s0 or \s-1NULL\s0 if none is
176found.
177.PP
178Note: not all the \fBBIO_TYPE_*\fR types above have corresponding \s-1BIO\s0 implementations.
179.PP
180\&\fIBIO_next()\fR returns the next \s-1BIO\s0 in a chain. It can be used to traverse all BIOs
181in a chain or used in conjunction with \fIBIO_find_type()\fR to find all BIOs of a
182certain type.
183.PP
184\&\fIBIO_method_type()\fR returns the type of a \s-1BIO\s0.
185.SH "RETURN VALUES"
186.IX Header "RETURN VALUES"
187\&\fIBIO_find_type()\fR returns a matching \s-1BIO\s0 or \s-1NULL\s0 for no match.
188.PP
189\&\fIBIO_next()\fR returns the next \s-1BIO\s0 in a chain.
190.PP
191\&\fIBIO_method_type()\fR returns the type of the \s-1BIO\s0 \fBb\fR.
192.SH "NOTES"
193.IX Header "NOTES"
194\&\fIBIO_next()\fR was added to OpenSSL 0.9.6 to provide a 'clean' way to traverse a \s-1BIO\s0
195chain or find multiple matches using \fIBIO_find_type()\fR. Previous versions had to
196use:
197.PP
198.Vb 1
210\& next = bio->next_bio;
199\& next = bio\->next_bio;
211.Ve
212.SH "BUGS"
213.IX Header "BUGS"
214\&\fIBIO_find_type()\fR in OpenSSL 0.9.5a and earlier could not be safely passed a
215\&\s-1NULL\s0 pointer for the \fBb\fR argument.
216.SH "EXAMPLE"
217.IX Header "EXAMPLE"
218Traverse a chain looking for digest BIOs:
219.PP
220.Vb 2
221\& BIO *btmp;
222\& btmp = in_bio; /* in_bio is chain to search through */
200.Ve
201.SH "BUGS"
202.IX Header "BUGS"
203\&\fIBIO_find_type()\fR in OpenSSL 0.9.5a and earlier could not be safely passed a
204\&\s-1NULL\s0 pointer for the \fBb\fR argument.
205.SH "EXAMPLE"
206.IX Header "EXAMPLE"
207Traverse a chain looking for digest BIOs:
208.PP
209.Vb 2
210\& BIO *btmp;
211\& btmp = in_bio; /* in_bio is chain to search through */
223.Ve
224.PP
225.Vb 5
212\&
226\& do {
227\& btmp = BIO_find_type(btmp, BIO_TYPE_MD);
228\& if(btmp == NULL) break; /* Not found */
229\& /* btmp is a digest BIO, do something with it ...*/
230\& ...
213\& do {
214\& btmp = BIO_find_type(btmp, BIO_TYPE_MD);
215\& if(btmp == NULL) break; /* Not found */
216\& /* btmp is a digest BIO, do something with it ...*/
217\& ...
231.Ve
232.PP
233.Vb 2
218\&
234\& btmp = BIO_next(btmp);
235\& } while(btmp);
236.Ve
237.SH "SEE ALSO"
238.IX Header "SEE ALSO"
239\&\s-1TBA\s0
219\& btmp = BIO_next(btmp);
220\& } while(btmp);
221.Ve
222.SH "SEE ALSO"
223.IX Header "SEE ALSO"
224\&\s-1TBA\s0