d4eb7aa334c8b8ad2178bf3ab0f30d1c3c9ef74c
[dragonfly.git] / secure / lib / libcrypto / man / BIO_find_type.3
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.23)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
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
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-
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 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
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 .\"
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"
127 .TH BIO_find_type 3 "2013-02-11" "1.0.1e" "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
132 .SH "NAME"
133 BIO_find_type, BIO_next \- BIO chain traversal
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 .Vb 1
137 \& #include <openssl/bio.h>
138 \&
139 \& BIO *  BIO_find_type(BIO *b,int bio_type);
140 \& BIO *  BIO_next(BIO *b);
141 \&
142 \& #define BIO_method_type(b)             ((b)\->method\->type)
143 \&
144 \& #define BIO_TYPE_NONE          0
145 \& #define BIO_TYPE_MEM           (1|0x0400)
146 \& #define BIO_TYPE_FILE          (2|0x0400)
147 \&
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)
164 \&
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"
171 The \fIBIO_find_type()\fR searches for a \s-1BIO\s0 of a given type in a chain, starting
172 at \s-1BIO\s0 \fBb\fR. If \fBtype\fR is a specific type (such as \s-1BIO_TYPE_MEM\s0) then a search
173 is 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
175 searched for. \fIBIO_find_type()\fR returns the next matching \s-1BIO\s0 or \s-1NULL\s0 if none is
176 found.
177 .PP
178 Note: 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
181 in a chain or used in conjunction with \fIBIO_find_type()\fR to find all BIOs of a
182 certain 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
195 chain or find multiple matches using \fIBIO_find_type()\fR. Previous versions had to
196 use:
197 .PP
198 .Vb 1
199 \& next = bio\->next_bio;
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"
207 Traverse 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 */
212 \&
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 \&        ...
218 \&
219 \&        btmp = BIO_next(btmp);
220 \& } while(btmp);
221 .Ve
222 .SH "SEE ALSO"
223 .IX Header "SEE ALSO"
224 \&\s-1TBA\s0