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