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