1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
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<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
54 .\" Avoid warning from groff about undefined register 'F'.
60 . tm Index:\\$1\t\\n%\t"\\$2"
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
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
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'
102 . \" troff and (daisy-wheel) nroff accents
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
112 . \" corrections for vroff
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'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "BIO_s_fd 3"
132 .TH BIO_s_fd 3 "2017-12-07" "1.0.2n" "OpenSSL"
133 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
134 .\" way too many mistakes in technical documents.
138 BIO_s_fd, BIO_set_fd, BIO_get_fd, BIO_new_fd \- file descriptor BIO
140 .IX Header "SYNOPSIS"
142 \& #include <openssl/bio.h>
144 \& BIO_METHOD * BIO_s_fd(void);
146 \& #define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
147 \& #define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c)
149 \& BIO *BIO_new_fd(int fd, int close_flag);
152 .IX Header "DESCRIPTION"
153 \&\fIBIO_s_fd()\fR returns the file descriptor \s-1BIO\s0 method. This is a wrapper
154 round the platforms file descriptor routines such as \fIread()\fR and \fIwrite()\fR.
156 \&\fIBIO_read()\fR and \fIBIO_write()\fR read or write the underlying descriptor.
157 \&\fIBIO_puts()\fR is supported but \fIBIO_gets()\fR is not.
159 If the close flag is set then then \fIclose()\fR is called on the underlying
160 file descriptor when the \s-1BIO\s0 is freed.
162 \&\fIBIO_reset()\fR attempts to change the file pointer to the start of file
163 using lseek(fd, 0, 0).
165 \&\fIBIO_seek()\fR sets the file pointer to position \fBofs\fR from start of file
166 using lseek(fd, ofs, 0).
168 \&\fIBIO_tell()\fR returns the current file position by calling lseek(fd, 0, 1).
170 \&\fIBIO_set_fd()\fR sets the file descriptor of \s-1BIO \s0\fBb\fR to \fBfd\fR and the close
173 \&\fIBIO_get_fd()\fR places the file descriptor in \fBc\fR if it is not \s-1NULL,\s0 it also
174 returns the file descriptor. If \fBc\fR is not \s-1NULL\s0 it should be of type
177 \&\fIBIO_new_fd()\fR returns a file descriptor \s-1BIO\s0 using \fBfd\fR and \fBclose_flag\fR.
180 The behaviour of \fIBIO_read()\fR and \fIBIO_write()\fR depends on the behavior of the
181 platforms \fIread()\fR and \fIwrite()\fR calls on the descriptor. If the underlying
182 file descriptor is in a non blocking mode then the \s-1BIO\s0 will behave in the
183 manner described in the \fIBIO_read\fR\|(3) and \fIBIO_should_retry\fR\|(3)
186 File descriptor BIOs should not be used for socket I/O. Use socket BIOs
189 .IX Header "RETURN VALUES"
190 \&\fIBIO_s_fd()\fR returns the file descriptor \s-1BIO\s0 method.
192 \&\fIBIO_reset()\fR returns zero for success and \-1 if an error occurred.
193 \&\fIBIO_seek()\fR and \fIBIO_tell()\fR return the current file position or \-1
194 is an error occurred. These values reflect the underlying \fIlseek()\fR
197 \&\fIBIO_set_fd()\fR always returns 1.
199 \&\fIBIO_get_fd()\fR returns the file descriptor or \-1 if the \s-1BIO\s0 has not
202 \&\fIBIO_new_fd()\fR returns the newly allocated \s-1BIO\s0 or \s-1NULL\s0 is an error
206 This is a file descriptor \s-1BIO\s0 version of \*(L"Hello World\*(R":
210 \& out = BIO_new_fd(fileno(stdout), BIO_NOCLOSE);
211 \& BIO_printf(out, "Hello World\en");
215 .IX Header "SEE ALSO"
216 \&\fIBIO_seek\fR\|(3), \fIBIO_tell\fR\|(3),
217 \&\fIBIO_reset\fR\|(3), \fIBIO_read\fR\|(3),
218 \&\fIBIO_write\fR\|(3), \fIBIO_puts\fR\|(3),
219 \&\fIBIO_gets\fR\|(3), \fIBIO_printf\fR\|(3),
220 \&\fIBIO_set_close\fR\|(3), \fIBIO_get_close\fR\|(3)