1 .\" Automatically generated by Pod::Man 2.12 (Pod::Simple 3.05)
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
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. \*(C+ will
29 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
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.
57 . tm Index:\\$1\t\\n%\t"\\$2"
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
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 . \" simple accents for nroff and troff
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'
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 \
124 .\" ========================================================================
126 .IX Title "BIO_s_fd 3"
127 .TH BIO_s_fd 3 "2007-10-24" "0.9.8g" "OpenSSL"
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
133 BIO_s_fd, BIO_set_fd, BIO_get_fd, BIO_new_fd \- file descriptor BIO
135 .IX Header "SYNOPSIS"
137 \& #include <openssl/bio.h>
139 \& BIO_METHOD * BIO_s_fd(void);
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)
144 \& BIO *BIO_new_fd(int fd, int close_flag);
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.
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.
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.
157 \&\fIBIO_reset()\fR attempts to change the file pointer to the start of file
158 using lseek(fd, 0, 0).
160 \&\fIBIO_seek()\fR sets the file pointer to position \fBofs\fR from start of file
161 using lseek(fd, ofs, 0).
163 \&\fIBIO_tell()\fR returns the current file position by calling lseek(fd, 0, 1).
165 \&\fIBIO_set_fd()\fR sets the file descriptor of \s-1BIO\s0 \fBb\fR to \fBfd\fR and the close
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
172 \&\fIBIO_new_fd()\fR returns a file descriptor \s-1BIO\s0 using \fBfd\fR and \fBclose_flag\fR.
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)
181 File descriptor BIOs should not be used for socket I/O. Use socket BIOs
184 .IX Header "RETURN VALUES"
185 \&\fIBIO_s_fd()\fR returns the file descriptor \s-1BIO\s0 method.
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
192 \&\fIBIO_set_fd()\fR always returns 1.
194 \&\fIBIO_get_fd()\fR returns the file descriptor or \-1 if the \s-1BIO\s0 has not
197 \&\fIBIO_new_fd()\fR returns the newly allocated \s-1BIO\s0 or \s-1NULL\s0 is an error
201 This is a file descriptor \s-1BIO\s0 version of \*(L"Hello World\*(R":
205 \& out = BIO_new_fd(fileno(stdout), BIO_NOCLOSE);
206 \& BIO_printf(out, "Hello World\en");
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)