secure/lib/libcrypto/man/BIO_find_type.3

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