46633f6499454c6c971fcf9d42a6207f0ce420ca
[dragonfly.git] / secure / lib / libcrypto / man / BIO_ctrl.3
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
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 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "BIO_ctrl 3"
127 .TH BIO_ctrl 3 "2014-06-05" "1.0.1h" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 BIO_ctrl, BIO_callback_ctrl, BIO_ptr_ctrl, BIO_int_ctrl, BIO_reset,
134 BIO_seek, BIO_tell, BIO_flush, BIO_eof, BIO_set_close, BIO_get_close,
135 BIO_pending, BIO_wpending, BIO_ctrl_pending, BIO_ctrl_wpending,
136 BIO_get_info_callback, BIO_set_info_callback \- BIO control operations
137 .SH "SYNOPSIS"
138 .IX Header "SYNOPSIS"
139 .Vb 1
140 \& #include <openssl/bio.h>
141 \&
142 \& long BIO_ctrl(BIO *bp,int cmd,long larg,void *parg);
143 \& long BIO_callback_ctrl(BIO *b, int cmd, void (*fp)(struct bio_st *, int, const char *, int, long, long));
144 \& char * BIO_ptr_ctrl(BIO *bp,int cmd,long larg);
145 \& long BIO_int_ctrl(BIO *bp,int cmd,long larg,int iarg);
146 \&
147 \& int BIO_reset(BIO *b);
148 \& int BIO_seek(BIO *b, int ofs);
149 \& int BIO_tell(BIO *b);
150 \& int BIO_flush(BIO *b);
151 \& int BIO_eof(BIO *b);
152 \& int BIO_set_close(BIO *b,long flag);
153 \& int BIO_get_close(BIO *b);
154 \& int BIO_pending(BIO *b);
155 \& int BIO_wpending(BIO *b);
156 \& size_t BIO_ctrl_pending(BIO *b);
157 \& size_t BIO_ctrl_wpending(BIO *b);
158 \&
159 \& int BIO_get_info_callback(BIO *b,bio_info_cb **cbp);
160 \& int BIO_set_info_callback(BIO *b,bio_info_cb *cb);
161 \&
162 \& typedef void bio_info_cb(BIO *b, int oper, const char *ptr, int arg1, long arg2, long arg3);
163 .Ve
164 .SH "DESCRIPTION"
165 .IX Header "DESCRIPTION"
166 \&\fIBIO_ctrl()\fR, \fIBIO_callback_ctrl()\fR, \fIBIO_ptr_ctrl()\fR and \fIBIO_int_ctrl()\fR
167 are \s-1BIO\s0 \*(L"control\*(R" operations taking arguments of various types.
168 These functions are not normally called directly, various macros
169 are used instead. The standard macros are described below, macros
170 specific to a particular type of \s-1BIO\s0 are described in the specific
171 BIOs manual page as well as any special features of the standard
172 calls.
173 .PP
174 \&\fIBIO_reset()\fR typically resets a \s-1BIO\s0 to some initial state, in the case
175 of file related BIOs for example it rewinds the file pointer to the
176 start of the file.
177 .PP
178 \&\fIBIO_seek()\fR resets a file related \s-1BIO\s0's (that is file descriptor and
179 \&\s-1FILE\s0 BIOs) file position pointer to \fBofs\fR bytes from start of file.
180 .PP
181 \&\fIBIO_tell()\fR returns the current file position of a file related \s-1BIO\s0.
182 .PP
183 \&\fIBIO_flush()\fR normally writes out any internally buffered data, in some
184 cases it is used to signal \s-1EOF\s0 and that no more data will be written.
185 .PP
186 \&\fIBIO_eof()\fR returns 1 if the \s-1BIO\s0 has read \s-1EOF\s0, the precise meaning of
187 \&\*(L"\s-1EOF\s0\*(R" varies according to the \s-1BIO\s0 type.
188 .PP
189 \&\fIBIO_set_close()\fR sets the \s-1BIO\s0 \fBb\fR close flag to \fBflag\fR. \fBflag\fR can
190 take the value \s-1BIO_CLOSE\s0 or \s-1BIO_NOCLOSE\s0. Typically \s-1BIO_CLOSE\s0 is used
191 in a source/sink \s-1BIO\s0 to indicate that the underlying I/O stream should
192 be closed when the \s-1BIO\s0 is freed.
193 .PP
194 \&\fIBIO_get_close()\fR returns the BIOs close flag.
195 .PP
196 \&\fIBIO_pending()\fR, \fIBIO_ctrl_pending()\fR, \fIBIO_wpending()\fR and \fIBIO_ctrl_wpending()\fR
197 return the number of pending characters in the BIOs read and write buffers.
198 Not all BIOs support these calls. \fIBIO_ctrl_pending()\fR and \fIBIO_ctrl_wpending()\fR
199 return a size_t type and are functions, \fIBIO_pending()\fR and \fIBIO_wpending()\fR are
200 macros which call \fIBIO_ctrl()\fR.
201 .SH "RETURN VALUES"
202 .IX Header "RETURN VALUES"
203 \&\fIBIO_reset()\fR normally returns 1 for success and 0 or \-1 for failure. File
204 BIOs are an exception, they return 0 for success and \-1 for failure.
205 .PP
206 \&\fIBIO_seek()\fR and \fIBIO_tell()\fR both return the current file position on success
207 and \-1 for failure, except file BIOs which for \fIBIO_seek()\fR always return 0
208 for success and \-1 for failure.
209 .PP
210 \&\fIBIO_flush()\fR returns 1 for success and 0 or \-1 for failure.
211 .PP
212 \&\fIBIO_eof()\fR returns 1 if \s-1EOF\s0 has been reached 0 otherwise.
213 .PP
214 \&\fIBIO_set_close()\fR always returns 1.
215 .PP
216 \&\fIBIO_get_close()\fR returns the close flag value: \s-1BIO_CLOSE\s0 or \s-1BIO_NOCLOSE\s0.
217 .PP
218 \&\fIBIO_pending()\fR, \fIBIO_ctrl_pending()\fR, \fIBIO_wpending()\fR and \fIBIO_ctrl_wpending()\fR
219 return the amount of pending data.
220 .SH "NOTES"
221 .IX Header "NOTES"
222 \&\fIBIO_flush()\fR, because it can write data may return 0 or \-1 indicating
223 that the call should be retried later in a similar manner to \fIBIO_write()\fR. 
224 The \fIBIO_should_retry()\fR call should be used and appropriate action taken
225 is the call fails.
226 .PP
227 The return values of \fIBIO_pending()\fR and \fIBIO_wpending()\fR may not reliably
228 determine the amount of pending data in all cases. For example in the
229 case of a file \s-1BIO\s0 some data may be available in the \s-1FILE\s0 structures
230 internal buffers but it is not possible to determine this in a
231 portably way. For other types of \s-1BIO\s0 they may not be supported.
232 .PP
233 Filter BIOs if they do not internally handle a particular \fIBIO_ctrl()\fR
234 operation usually pass the operation to the next \s-1BIO\s0 in the chain.
235 This often means there is no need to locate the required \s-1BIO\s0 for
236 a particular operation, it can be called on a chain and it will
237 be automatically passed to the relevant \s-1BIO\s0. However this can cause
238 unexpected results: for example no current filter BIOs implement
239 \&\fIBIO_seek()\fR, but this may still succeed if the chain ends in a \s-1FILE\s0
240 or file descriptor \s-1BIO\s0.
241 .PP
242 Source/sink BIOs return an 0 if they do not recognize the \fIBIO_ctrl()\fR
243 operation.
244 .SH "BUGS"
245 .IX Header "BUGS"
246 Some of the return values are ambiguous and care should be taken. In
247 particular a return value of 0 can be returned if an operation is not
248 supported, if an error occurred, if \s-1EOF\s0 has not been reached and in
249 the case of \fIBIO_seek()\fR on a file \s-1BIO\s0 for a successful operation.
250 .SH "SEE ALSO"
251 .IX Header "SEE ALSO"
252 \&\s-1TBA\s0