secure/lib/libcrypto/man/BIO_ctrl.3

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