secure/lib/libcrypto/man/BIO_find_type.3

   1 .rn '' }`
   2 ''' $RCSfile$$Revision$$Date$
   3 '''
   4 ''' $Log$
   5 '''
   6 .de Sh
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve
  30 .ft R
  31
  32 .fi
  33 ..
  34 '''
  35 '''
  36 '''     Set up \*(-- to give an unbreakable dash;
  37 '''     string Tr holds user defined translation string.
  38 '''     Bell System Logo is used as a dummy character.
  39 '''
  40 .tr \(*W-|\(bv\*(Tr
  41 .ie n \{\
  42 .ds -- \(*W-
  43 .ds PI pi
  44 .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  45 .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  46 .ds L" ""
  47 .ds R" ""
  48 '''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
  49 '''   \*(L" and \*(R", except that they are used on ".xx" lines,
  50 '''   such as .IP and .SH, which do another additional levels of
  51 '''   double-quote interpretation
  52 .ds M" """
  53 .ds S" """
  54 .ds N" """""
  55 .ds T" """""
  56 .ds L' '
  57 .ds R' '
  58 .ds M' '
  59 .ds S' '
  60 .ds N' '
  61 .ds T' '
  62 'br\}
  63 .el\{\
  64 .ds -- \(em\|
  65 .tr \*(Tr
  66 .ds L" ``
  67 .ds R" ''
  68 .ds M" ``
  69 .ds S" ''
  70 .ds N" ``
  71 .ds T" ''
  72 .ds L' `
  73 .ds R' '
  74 .ds M' `
  75 .ds S' '
  76 .ds N' `
  77 .ds T' '
  78 .ds PI \(*p
  79 'br\}
  80 .\"     If the F register is turned on, we'll generate
  81 .\"     index entries out stderr for the following things:
  82 .\"             TH      Title
  83 .\"             SH      Header
  84 .\"             Sh      Subsection
  85 .\"             Ip      Item
  86 .\"             X<>     Xref  (embedded
  87 .\"     Of course, you have to process the output yourself
  88 .\"     in some meaninful fashion.
  89 .if \nF \{
  90 .de IX
  91 .tm Index:\\$1\t\\n%\t"\\$2"
  92 ..
  93 .nr % 0
  94 .rr F
  95 .\}
  96 .TH BIO_find_type 3 "0.9.7d" "2/Sep/2004" "OpenSSL"
  97 .UC
  98 .if n .hy 0
  99 .if n .na
 100 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 101 .de CQ          \" put $1 in typewriter font
 102 .ft CW
 103 'if n "\c
 104 'if t \\&\\$1\c
 105 'if n \\&\\$1\c
 106 'if n \&"
 107 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
 108 '.ft R
 109 ..
 110 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
 111 .       \" AM - accent mark definitions
 112 .bd B 3
 113 .       \" fudge factors for nroff and troff
 114 .if n \{\
 115 .       ds #H 0
 116 .       ds #V .8m
 117 .       ds #F .3m
 118 .       ds #[ \f1
 119 .       ds #] \fP
 120 .\}
 121 .if t \{\
 122 .       ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 123 .       ds #V .6m
 124 .       ds #F 0
 125 .       ds #[ \&
 126 .       ds #] \&
 127 .\}
 128 .       \" simple accents for nroff and troff
 129 .if n \{\
 130 .       ds ' \&
 131 .       ds ` \&
 132 .       ds ^ \&
 133 .       ds , \&
 134 .       ds ~ ~
 135 .       ds ? ?
 136 .       ds ! !
 137 .       ds /
 138 .       ds q
 139 .\}
 140 .if t \{\
 141 .       ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 142 .       ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 143 .       ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 144 .       ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 145 .       ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 146 .       ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
 147 .       ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
 148 .       ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 149 .       ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
 150 .\}
 151 .       \" troff and (daisy-wheel) nroff accents
 152 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 153 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 154 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
 155 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
 156 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
 157 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
 158 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 159 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 160 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 161 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 162 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 163 .ds ae a\h'-(\w'a'u*4/10)'e
 164 .ds Ae A\h'-(\w'A'u*4/10)'E
 165 .ds oe o\h'-(\w'o'u*4/10)'e
 166 .ds Oe O\h'-(\w'O'u*4/10)'E
 167 .       \" corrections for vroff
 168 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 169 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 170 .       \" for low resolution devices (crt and lpr)
 171 .if \n(.H>23 .if \n(.V>19 \
 172 \{\
 173 .       ds : e
 174 .       ds 8 ss
 175 .       ds v \h'-1'\o'\(aa\(ga'
 176 .       ds _ \h'-1'^
 177 .       ds . \h'-1'.
 178 .       ds 3 3
 179 .       ds o a
 180 .       ds d- d\h'-1'\(ga
 181 .       ds D- D\h'-1'\(hy
 182 .       ds th \o'bp'
 183 .       ds Th \o'LP'
 184 .       ds ae ae
 185 .       ds Ae AE
 186 .       ds oe oe
 187 .       ds Oe OE
 188 .\}
 189 .rm #[ #] #H #V #F C
 190 .SH "NAME"
 191 BIO_find_type, BIO_next \- BIO chain traversal
 192 .SH "SYNOPSIS"
 193 .PP
 194 .Vb 1
 195 \& #include <openssl/bio.h>
 196 .Ve
 197 .Vb 2
 198 \& BIO *  BIO_find_type(BIO *b,int bio_type);
 199 \& BIO *  BIO_next(BIO *b);
 200 .Ve
 201 .Vb 1
 202 \& #define BIO_method_type(b)             ((b)->method->type)
 203 .Ve
 204 .Vb 3
 205 \& #define BIO_TYPE_NONE          0
 206 \& #define BIO_TYPE_MEM           (1|0x0400)
 207 \& #define BIO_TYPE_FILE          (2|0x0400)
 208 .Ve
 209 .Vb 16
 210 \& #define BIO_TYPE_FD            (4|0x0400|0x0100)
 211 \& #define BIO_TYPE_SOCKET                (5|0x0400|0x0100)
 212 \& #define BIO_TYPE_NULL          (6|0x0400)
 213 \& #define BIO_TYPE_SSL           (7|0x0200)
 214 \& #define BIO_TYPE_MD            (8|0x0200)
 215 \& #define BIO_TYPE_BUFFER                (9|0x0200)
 216 \& #define BIO_TYPE_CIPHER                (10|0x0200)
 217 \& #define BIO_TYPE_BASE64                (11|0x0200)
 218 \& #define BIO_TYPE_CONNECT       (12|0x0400|0x0100)
 219 \& #define BIO_TYPE_ACCEPT                (13|0x0400|0x0100)
 220 \& #define BIO_TYPE_PROXY_CLIENT  (14|0x0200)
 221 \& #define BIO_TYPE_PROXY_SERVER  (15|0x0200)
 222 \& #define BIO_TYPE_NBIO_TEST     (16|0x0200)
 223 \& #define BIO_TYPE_NULL_FILTER   (17|0x0200)
 224 \& #define BIO_TYPE_BER           (18|0x0200)
 225 \& #define BIO_TYPE_BIO           (19|0x0400)
 226 .Ve
 227 .Vb 3
 228 \& #define BIO_TYPE_DESCRIPTOR    0x0100
 229 \& #define BIO_TYPE_FILTER                0x0200
 230 \& #define BIO_TYPE_SOURCE_SINK   0x0400
 231 .Ve
 232 .SH "DESCRIPTION"
 233 The \fIBIO_find_type()\fR searches for a BIO of a given type in a chain, starting
 234 at BIO \fBb\fR. If \fBtype\fR is a specific type (such as BIO_TYPE_MEM) then a search
 235 is made for a BIO of that type. If \fBtype\fR is a general type (such as
 236 \fBBIO_TYPE_SOURCE_SINK\fR) then the next matching BIO of the given general type is
 237 searched for. \fIBIO_find_type()\fR returns the next matching BIO or NULL if none is
 238 found.
 239 .PP
 240 Note: not all the \fBBIO_TYPE_*\fR types above have corresponding BIO implementations.
 241 .PP
 242 \fIBIO_next()\fR returns the next BIO in a chain. It can be used to traverse all BIOs
 243 in a chain or used in conjunction with \fIBIO_find_type()\fR to find all BIOs of a
 244 certain type.
 245 .PP
 246 \fIBIO_method_type()\fR returns the type of a BIO.
 247 .SH "RETURN VALUES"
 248 \fIBIO_find_type()\fR returns a matching BIO or NULL for no match.
 249 .PP
 250 \fIBIO_next()\fR returns the next BIO in a chain.
 251 .PP
 252 \fIBIO_method_type()\fR returns the type of the BIO \fBb\fR.
 253 .SH "NOTES"
 254 \fIBIO_next()\fR was added to OpenSSL 0.9.6 to provide a \*(L'clean\*(R' way to traverse a BIO
 255 chain or find multiple matches using \fIBIO_find_type()\fR. Previous versions had to
 256 use:
 257 .PP
 258 .Vb 1
 259 \& next = bio->next_bio;
 260 .Ve
 261 .SH "BUGS"
 262 \fIBIO_find_type()\fR in OpenSSL 0.9.5a and earlier could not be safely passed a
 263 NULL pointer for the \fBb\fR argument.
 264 .SH "EXAMPLE"
 265 Traverse a chain looking for digest BIOs:
 266 .PP
 267 .Vb 2
 268 \& BIO *btmp;
 269 \& btmp = in_bio; /* in_bio is chain to search through */
 270 .Ve
 271 .Vb 5
 272 \& do {
 273 \&        btmp = BIO_find_type(btmp, BIO_TYPE_MD);
 274 \&        if(btmp == NULL) break; /* Not found */
 275 \&        /* btmp is a digest BIO, do something with it ...*/
 276 \&        ...
 277 .Ve
 278 .Vb 2
 279 \&        btmp = BIO_next(btmp);
 280 \& } while(btmp);
 281 .Ve
 282 .SH "SEE ALSO"
 283 TBA
 284
 285 .rn }` ''
 286 .IX Title "BIO_find_type 3"
 287 .IX Name "BIO_find_type, BIO_next - BIO chain traversal"
 288
 289 .IX Header "NAME"
 290
 291 .IX Header "SYNOPSIS"
 292
 293 .IX Header "DESCRIPTION"
 294
 295 .IX Header "RETURN VALUES"
 296
 297 .IX Header "NOTES"
 298
 299 .IX Header "BUGS"
 300
 301 .IX Header "EXAMPLE"
 302
 303 .IX Header "SEE ALSO"
 304