Debian Codegraph @

upstream/debian-unstable/man3/BIO_get_data.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_GET_DATA 3SSL"
58 .TH BIO_GET_DATA 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_set_data, BIO_get_data, BIO_set_init, BIO_get_init, BIO_set_shutdown,
65 BIO_get_shutdown \- functions for managing BIO state information
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/bio.h>
70 \&
71 \& void BIO_set_data(BIO *a, void *ptr);
72 \& void *BIO_get_data(BIO *a);
73 \& void BIO_set_init(BIO *a, int init);
74 \& int BIO_get_init(BIO *a);
75 \& void BIO_set_shutdown(BIO *a, int shut);
76 \& int BIO_get_shutdown(BIO *a);
77 .Ve
78 .SH DESCRIPTION
79 .IX Header "DESCRIPTION"
80 These functions can be used when implementing a custom BIO.
81 .PP
82 The \fBBIO_set_data()\fR function associates the custom data pointed to by \fBptr\fR with
83 the BIO. This data can subsequently be retrieved via a call to \fBBIO_get_data()\fR.
84 This can be used by custom BIOs for storing implementation specific information.
85 .PP
86 The \fBBIO_set_init()\fR function sets the value of the BIO's "init" flag to indicate
87 whether initialisation has been completed for this BIO or not. A nonzero value
88 indicates that initialisation is complete, whilst zero indicates that it is not.
89 Often initialisation will complete during initial construction of the BIO. For
90 some BIOs however, initialisation may not complete until after additional steps
91 have occurred (for example through calling custom ctrls). The \fBBIO_get_init()\fR
92 function returns the value of the "init" flag.
93 .PP
94 The \fBBIO_set_shutdown()\fR and \fBBIO_get_shutdown()\fR functions set and get the state of
95 this BIO's shutdown (i.e. BIO_CLOSE) flag. If set then the underlying resource
96 is also closed when the BIO is freed.
97 .SH WARNINGS
98 .IX Header "WARNINGS"
99 Do not use \fBBIO_set_data()\fR, \fBBIO_get_data()\fR, \fBBIO_set_init()\fR, \fBBIO_get_init()\fR, outside
100 the implementation of a custom BIO.
101 Calling \fBBIO_set_data()\fR on an existing BIO implementation with data that it does
102 not expect will lead to unexpected results.
103 .SH "RETURN VALUES"
104 .IX Header "RETURN VALUES"
105 \&\fBBIO_get_data()\fR returns a pointer to the implementation specific custom data
106 associated with this BIO, or NULL if none has been set.
107 .PP
108 \&\fBBIO_get_init()\fR returns the state of the BIO's init flag.
109 .PP
110 \&\fBBIO_get_shutdown()\fR returns the stat of the BIO's shutdown (i.e. BIO_CLOSE) flag.
111 .SH "SEE ALSO"
112 .IX Header "SEE ALSO"
113 \&\fBbio\fR\|(7), \fBBIO_meth_new\fR\|(3)
114 .SH HISTORY
115 .IX Header "HISTORY"
116 The functions described here were added in OpenSSL 1.1.0.
117 .SH COPYRIGHT
118 .IX Header "COPYRIGHT"
119 Copyright 2016\-2026 The OpenSSL Project Authors. All Rights Reserved.
120 .PP
121 Licensed under the Apache License 2.0 (the "License"). You may not use
122 this file except in compliance with the License. You can obtain a copy
123 in the file LICENSE in the source distribution or at
124 <https://www.openssl.org/source/license.html>.