Debian Codegraph @

upstream/debian-unstable/man3/BIO_find_type.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "BIO_FIND_TYPE 3SSL"
58 .TH BIO_FIND_TYPE 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 BIO_find_type, BIO_next, BIO_method_type \- BIO chain traversal
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/bio.h>
69 \&
70 \& BIO *BIO_find_type(BIO *b, int bio_type);
71 \& BIO *BIO_next(BIO *b);
72 \& int BIO_method_type(const BIO *b);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 The \fBBIO_find_type()\fR searches for a \fBBIO\fR of a given type in a chain, starting
77 at \fBBIO\fR \fIb\fR. If \fItype\fR is a specific type (such as \fBBIO_TYPE_MEM\fR) then a
78 search is made for a \fBBIO\fR of that type. If \fItype\fR is a general type (such as
79 \&\fBBIO_TYPE_SOURCE_SINK\fR) then the next matching \fBBIO\fR of the given general type is
80 searched for. \fBBIO_find_type()\fR returns the next matching \fBBIO\fR or NULL if none is
81 found. If \fItype\fR is \fBBIO_TYPE_NONE\fR it will not find a match.
82 .PP
83 The following general types are defined:
84 \&\fBBIO_TYPE_DESCRIPTOR\fR, \fBBIO_TYPE_FILTER\fR, and \fBBIO_TYPE_SOURCE_SINK\fR.
85 .PP
86 For a list of the specific types, see the \fI<openssl/bio.h>\fR header file.
87 .PP
88 \&\fBBIO_next()\fR returns the next BIO in a chain. It can be used to traverse all BIOs
89 in a chain or used in conjunction with \fBBIO_find_type()\fR to find all BIOs of a
90 certain type.
91 .PP
92 \&\fBBIO_method_type()\fR returns the type of a BIO.
93 .SH "RETURN VALUES"
94 .IX Header "RETURN VALUES"
95 \&\fBBIO_find_type()\fR returns a matching BIO or NULL for no match.
96 .PP
97 \&\fBBIO_next()\fR returns the next BIO in a chain.
98 .PP
99 \&\fBBIO_method_type()\fR returns the type of the BIO \fIb\fR.
100 .SH EXAMPLES
101 .IX Header "EXAMPLES"
102 Traverse a chain looking for digest BIOs:
103 .PP
104 .Vb 1
105 \& BIO *btmp;
106 \&
107 \& btmp = in_bio; /* in_bio is chain to search through */
108 \& do {
109 \& btmp = BIO_find_type(btmp, BIO_TYPE_MD);
110 \& if (btmp == NULL)
111 \& break; /* Not found */
112 \& /* btmp is a digest BIO, do something with it ...*/
113 \& ...
114 \&
115 \& btmp = BIO_next(btmp);
116 \& } while (btmp);
117 .Ve
118 .SH COPYRIGHT
119 .IX Header "COPYRIGHT"
120 Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved.
121 .PP
122 Licensed under the Apache License 2.0 (the "License"). You may not use
123 this file except in compliance with the License. You can obtain a copy
124 in the file LICENSE in the source distribution or at
125 <https://www.openssl.org/source/license.html>.