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