1 .\" Automatically generated by Pod::Man version 1.15
2 .\" Wed Feb 19 16:42:45 2003
5 .\" ======================================================================
6 .de Sh \" Subsection heading
14 .de Sp \" Vertical space (when we can't use .PP)
20 .ie \\n(.$>=3 .ne \\$3
24 .de Vb \" Begin verbatim text
29 .de Ve \" End verbatim text
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<>
41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
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.
65 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" For nroff, turn off justification. Always turn off hyphenation; it
72 .\" makes way too many mistakes in technical documents.
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.
79 . \" fudge factors for nroff and troff
88 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
94 . \" simple accents for nroff and troff
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'
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 \
138 .\" ======================================================================
140 .IX Title "BIO_s_fd 3"
141 .TH BIO_s_fd 3 "0.9.7a" "2003-02-19" "OpenSSL"
144 BIO_s_fd, BIO_set_fd, BIO_get_fd, BIO_new_fd \- file descriptor \s-1BIO\s0
146 .IX Header "SYNOPSIS"
148 \& #include <openssl/bio.h>
151 \& BIO_METHOD * BIO_s_fd(void);
154 \& #define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
155 \& #define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c)
158 \& BIO *BIO_new_fd(int fd, int close_flag);
161 .IX Header "DESCRIPTION"
162 \&\fIBIO_s_fd()\fR returns the file descriptor \s-1BIO\s0 method. This is a wrapper
163 round the platforms file descriptor routines such as \fIread()\fR and \fIwrite()\fR.
165 \&\fIBIO_read()\fR and \fIBIO_write()\fR read or write the underlying descriptor.
166 \&\fIBIO_puts()\fR is supported but \fIBIO_gets()\fR is not.
168 If the close flag is set then then \fIclose()\fR is called on the underlying
169 file descriptor when the \s-1BIO\s0 is freed.
171 \&\fIBIO_reset()\fR attempts to change the file pointer to the start of file
172 using lseek(fd, 0, 0).
174 \&\fIBIO_seek()\fR sets the file pointer to position \fBofs\fR from start of file
175 using lseek(fd, ofs, 0).
177 \&\fIBIO_tell()\fR returns the current file position by calling lseek(fd, 0, 1).
179 \&\fIBIO_set_fd()\fR sets the file descriptor of \s-1BIO\s0 \fBb\fR to \fBfd\fR and the close
182 \&\fIBIO_get_fd()\fR places the file descriptor in \fBc\fR if it is not \s-1NULL\s0, it also
183 returns the file descriptor. If \fBc\fR is not \s-1NULL\s0 it should be of type
186 \&\fIBIO_new_fd()\fR returns a file descriptor \s-1BIO\s0 using \fBfd\fR and \fBclose_flag\fR.
189 The behaviour of \fIBIO_read()\fR and \fIBIO_write()\fR depends on the behavior of the
190 platforms \fIread()\fR and \fIwrite()\fR calls on the descriptor. If the underlying
191 file descriptor is in a non blocking mode then the \s-1BIO\s0 will behave in the
192 manner described in the BIO_read(3) and BIO_should_retry(3)
195 File descriptor BIOs should not be used for socket I/O. Use socket BIOs
198 .IX Header "RETURN VALUES"
199 \&\fIBIO_s_fd()\fR returns the file descriptor \s-1BIO\s0 method.
201 \&\fIBIO_reset()\fR returns zero for success and \-1 if an error occurred.
202 \&\fIBIO_seek()\fR and \fIBIO_tell()\fR return the current file position or \-1
203 is an error occurred. These values reflect the underlying \fIlseek()\fR
206 \&\fIBIO_set_fd()\fR always returns 1.
208 \&\fIBIO_get_fd()\fR returns the file descriptor or \-1 if the \s-1BIO\s0 has not
211 \&\fIBIO_new_fd()\fR returns the newly allocated \s-1BIO\s0 or \s-1NULL\s0 is an error
215 This is a file descriptor \s-1BIO\s0 version of \*(L"Hello World\*(R":
219 \& out = BIO_new_fd(fileno(stdout), BIO_NOCLOSE);
220 \& BIO_printf(out, "Hello World\en");
224 .IX Header "SEE ALSO"
225 BIO_seek(3), BIO_tell(3),
226 BIO_reset(3), BIO_read(3),
227 BIO_write(3), BIO_puts(3),
228 BIO_gets(3), BIO_printf(3),
229 BIO_set_close(3), BIO_get_close(3)