- update OpenSSL to 0.9.8
[dragonfly.git] / secure / lib / libcrypto / man / BIO_find_type.3
CommitLineData
8b0cefbb
JR
1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
8b0cefbb 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
8b0cefbb 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
8b0cefbb 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
8b0cefbb
JR
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<>.
984263bc 32.tr \(*W-|\(bv\*(Tr
8b0cefbb 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
8b0cefbb
JR
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' ""
984263bc
MD
43'br\}
44.el\{\
8b0cefbb
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
8b0cefbb
JR
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"
984263bc 58..
8b0cefbb
JR
59. nr % 0
60. rr F
984263bc 61.\}
8b0cefbb
JR
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
984263bc 66.if n .na
8b0cefbb
JR
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
984263bc 71.if n \{\
8b0cefbb
JR
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
984263bc
MD
77.\}
78.if t \{\
8b0cefbb
JR
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
984263bc 84.\}
8b0cefbb 85. \" simple accents for nroff and troff
984263bc 86.if n \{\
8b0cefbb
JR
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
984263bc
MD
93.\}
94.if t \{\
8b0cefbb
JR
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'
984263bc 101.\}
8b0cefbb 102. \" troff and (daisy-wheel) nroff accents
984263bc
MD
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
8b0cefbb 112. \" corrections for vroff
984263bc
MD
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'
8b0cefbb 115. \" for low resolution devices (crt and lpr)
984263bc
MD
116.if \n(.H>23 .if \n(.V>19 \
117\{\
8b0cefbb
JR
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
984263bc
MD
127.\}
128.rm #[ #] #H #V #F C
8b0cefbb
JR
129.\" ========================================================================
130.\"
131.IX Title "BIO_find_type 3"
a561f9ff 132.TH BIO_find_type 3 "2005-07-06" "0.9.8" "OpenSSL"
984263bc 133.SH "NAME"
74dab6c2 134BIO_find_type, BIO_next \- BIO chain traversal
984263bc 135.SH "SYNOPSIS"
8b0cefbb 136.IX Header "SYNOPSIS"
984263bc
MD
137.Vb 1
138\& #include <openssl/bio.h>
139.Ve
8b0cefbb 140.PP
984263bc
MD
141.Vb 2
142\& BIO * BIO_find_type(BIO *b,int bio_type);
143\& BIO * BIO_next(BIO *b);
144.Ve
8b0cefbb 145.PP
984263bc
MD
146.Vb 1
147\& #define BIO_method_type(b) ((b)->method->type)
148.Ve
8b0cefbb 149.PP
984263bc
MD
150.Vb 3
151\& #define BIO_TYPE_NONE 0
152\& #define BIO_TYPE_MEM (1|0x0400)
153\& #define BIO_TYPE_FILE (2|0x0400)
154.Ve
8b0cefbb 155.PP
984263bc
MD
156.Vb 16
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)
173.Ve
8b0cefbb 174.PP
984263bc
MD
175.Vb 3
176\& #define BIO_TYPE_DESCRIPTOR 0x0100
177\& #define BIO_TYPE_FILTER 0x0200
178\& #define BIO_TYPE_SOURCE_SINK 0x0400
179.Ve
180.SH "DESCRIPTION"
8b0cefbb
JR
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
984263bc
MD
187found.
188.PP
8b0cefbb 189Note: not all the \fBBIO_TYPE_*\fR types above have corresponding \s-1BIO\s0 implementations.
984263bc 190.PP
8b0cefbb 191\&\fIBIO_next()\fR returns the next \s-1BIO\s0 in a chain. It can be used to traverse all BIOs
984263bc
MD
192in a chain or used in conjunction with \fIBIO_find_type()\fR to find all BIOs of a
193certain type.
194.PP
8b0cefbb 195\&\fIBIO_method_type()\fR returns the type of a \s-1BIO\s0.
984263bc 196.SH "RETURN VALUES"
8b0cefbb
JR
197.IX Header "RETURN VALUES"
198\&\fIBIO_find_type()\fR returns a matching \s-1BIO\s0 or \s-1NULL\s0 for no match.
984263bc 199.PP
8b0cefbb 200\&\fIBIO_next()\fR returns the next \s-1BIO\s0 in a chain.
984263bc 201.PP
8b0cefbb 202\&\fIBIO_method_type()\fR returns the type of the \s-1BIO\s0 \fBb\fR.
984263bc 203.SH "NOTES"
8b0cefbb
JR
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
984263bc
MD
206chain or find multiple matches using \fIBIO_find_type()\fR. Previous versions had to
207use:
208.PP
209.Vb 1
210\& next = bio->next_bio;
211.Ve
212.SH "BUGS"
8b0cefbb
JR
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.
984263bc 216.SH "EXAMPLE"
8b0cefbb 217.IX Header "EXAMPLE"
984263bc
MD
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 */
223.Ve
8b0cefbb 224.PP
984263bc
MD
225.Vb 5
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\& ...
231.Ve
8b0cefbb 232.PP
984263bc
MD
233.Vb 2
234\& btmp = BIO_next(btmp);
235\& } while(btmp);
236.Ve
237.SH "SEE ALSO"
238.IX Header "SEE ALSO"
8b0cefbb 239\&\s-1TBA\s0