secure/lib/libcrypto/man/BIO_s_fd.3

   1 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
   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_s_fd 3"
 127 .TH BIO_s_fd 3 "2010-12-02" "1.0.0c" "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_s_fd, BIO_set_fd, BIO_get_fd, BIO_new_fd \- file descriptor BIO
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 .Vb 1
 137 \& #include <openssl/bio.h>
 138 \&
 139 \& BIO_METHOD *   BIO_s_fd(void);
 140 \&
 141 \& #define BIO_set_fd(b,fd,c)     BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
 142 \& #define BIO_get_fd(b,c)        BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c)
 143 \&
 144 \& BIO *BIO_new_fd(int fd, int close_flag);
 145 .Ve
 146 .SH "DESCRIPTION"
 147 .IX Header "DESCRIPTION"
 148 \&\fIBIO_s_fd()\fR returns the file descriptor \s-1BIO\s0 method. This is a wrapper
 149 round the platforms file descriptor routines such as \fIread()\fR and \fIwrite()\fR.
 150 .PP
 151 \&\fIBIO_read()\fR and \fIBIO_write()\fR read or write the underlying descriptor.
 152 \&\fIBIO_puts()\fR is supported but \fIBIO_gets()\fR is not.
 153 .PP
 154 If the close flag is set then then \fIclose()\fR is called on the underlying
 155 file descriptor when the \s-1BIO\s0 is freed.
 156 .PP
 157 \&\fIBIO_reset()\fR attempts to change the file pointer to the start of file
 158 using lseek(fd, 0, 0).
 159 .PP
 160 \&\fIBIO_seek()\fR sets the file pointer to position \fBofs\fR from start of file
 161 using lseek(fd, ofs, 0).
 162 .PP
 163 \&\fIBIO_tell()\fR returns the current file position by calling lseek(fd, 0, 1).
 164 .PP
 165 \&\fIBIO_set_fd()\fR sets the file descriptor of \s-1BIO\s0 \fBb\fR to \fBfd\fR and the close
 166 flag to \fBc\fR.
 167 .PP
 168 \&\fIBIO_get_fd()\fR places the file descriptor in \fBc\fR if it is not \s-1NULL\s0, it also
 169 returns the file descriptor. If \fBc\fR is not \s-1NULL\s0 it should be of type
 170 (int *).
 171 .PP
 172 \&\fIBIO_new_fd()\fR returns a file descriptor \s-1BIO\s0 using \fBfd\fR and \fBclose_flag\fR.
 173 .SH "NOTES"
 174 .IX Header "NOTES"
 175 The behaviour of \fIBIO_read()\fR and \fIBIO_write()\fR depends on the behavior of the
 176 platforms \fIread()\fR and \fIwrite()\fR calls on the descriptor. If the underlying
 177 file descriptor is in a non blocking mode then the \s-1BIO\s0 will behave in the
 178 manner described in the \fIBIO_read\fR\|(3) and \fIBIO_should_retry\fR\|(3)
 179 manual pages.
 180 .PP
 181 File descriptor BIOs should not be used for socket I/O. Use socket BIOs
 182 instead.
 183 .SH "RETURN VALUES"
 184 .IX Header "RETURN VALUES"
 185 \&\fIBIO_s_fd()\fR returns the file descriptor \s-1BIO\s0 method.
 186 .PP
 187 \&\fIBIO_reset()\fR returns zero for success and \-1 if an error occurred.
 188 \&\fIBIO_seek()\fR and \fIBIO_tell()\fR return the current file position or \-1
 189 is an error occurred. These values reflect the underlying \fIlseek()\fR
 190 behaviour.
 191 .PP
 192 \&\fIBIO_set_fd()\fR always returns 1.
 193 .PP
 194 \&\fIBIO_get_fd()\fR returns the file descriptor or \-1 if the \s-1BIO\s0 has not
 195 been initialized.
 196 .PP
 197 \&\fIBIO_new_fd()\fR returns the newly allocated \s-1BIO\s0 or \s-1NULL\s0 is an error
 198 occurred.
 199 .SH "EXAMPLE"
 200 .IX Header "EXAMPLE"
 201 This is a file descriptor \s-1BIO\s0 version of \*(L"Hello World\*(R":
 202 .PP
 203 .Vb 4
 204 \& BIO *out;
 205 \& out = BIO_new_fd(fileno(stdout), BIO_NOCLOSE);
 206 \& BIO_printf(out, "Hello World\en");
 207 \& BIO_free(out);
 208 .Ve
 209 .SH "SEE ALSO"
 210 .IX Header "SEE ALSO"
 211 \&\fIBIO_seek\fR\|(3), \fIBIO_tell\fR\|(3),
 212 \&\fIBIO_reset\fR\|(3), \fIBIO_read\fR\|(3),
 213 \&\fIBIO_write\fR\|(3), \fIBIO_puts\fR\|(3),
 214 \&\fIBIO_gets\fR\|(3), \fIBIO_printf\fR\|(3),
 215 \&\fIBIO_set_close\fR\|(3), \fIBIO_get_close\fR\|(3)