1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.41)
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'.
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
62 . tm Index:\\$1\t\\n%\t"\\$2"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . \" simple accents for nroff and troff
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
133 .\" ========================================================================
135 .IX Title "BIO_S_FD 3"
136 .TH BIO_S_FD 3 "2020-12-08" "1.1.1i" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 BIO_s_fd, BIO_set_fd, BIO_get_fd, BIO_new_fd \- file descriptor BIO
144 .IX Header "SYNOPSIS"
146 \& #include <openssl/bio.h>
148 \& const BIO_METHOD *BIO_s_fd(void);
150 \& int BIO_set_fd(BIO *b, int fd, int c);
151 \& int BIO_get_fd(BIO *b, int *c);
153 \& BIO *BIO_new_fd(int fd, int close_flag);
156 .IX Header "DESCRIPTION"
157 \&\fBBIO_s_fd()\fR returns the file descriptor \s-1BIO\s0 method. This is a wrapper
158 round the platforms file descriptor routines such as \fBread()\fR and \fBwrite()\fR.
160 \&\fBBIO_read_ex()\fR and \fBBIO_write_ex()\fR read or write the underlying descriptor.
161 \&\fBBIO_puts()\fR is supported but \fBBIO_gets()\fR is not.
163 If the close flag is set then \fBclose()\fR is called on the underlying
164 file descriptor when the \s-1BIO\s0 is freed.
166 \&\fBBIO_reset()\fR attempts to change the file pointer to the start of file
167 such as by using \fBlseek(fd, 0, 0)\fR.
169 \&\fBBIO_seek()\fR sets the file pointer to position \fBofs\fR from start of file
170 such as by using \fBlseek(fd, ofs, 0)\fR.
172 \&\fBBIO_tell()\fR returns the current file position such as by calling
173 \&\fBlseek(fd, 0, 1)\fR.
175 \&\fBBIO_set_fd()\fR sets the file descriptor of \s-1BIO\s0 \fBb\fR to \fBfd\fR and the close
178 \&\fBBIO_get_fd()\fR places the file descriptor in \fBc\fR if it is not \s-1NULL,\s0 it also
179 returns the file descriptor.
181 \&\fBBIO_new_fd()\fR returns a file descriptor \s-1BIO\s0 using \fBfd\fR and \fBclose_flag\fR.
184 The behaviour of \fBBIO_read_ex()\fR and \fBBIO_write_ex()\fR depends on the behavior of the
185 platforms \fBread()\fR and \fBwrite()\fR calls on the descriptor. If the underlying
186 file descriptor is in a non blocking mode then the \s-1BIO\s0 will behave in the
187 manner described in the \fBBIO_read_ex\fR\|(3) and \fBBIO_should_retry\fR\|(3)
190 File descriptor BIOs should not be used for socket I/O. Use socket BIOs
193 \&\fBBIO_set_fd()\fR and \fBBIO_get_fd()\fR are implemented as macros.
195 .IX Header "RETURN VALUES"
196 \&\fBBIO_s_fd()\fR returns the file descriptor \s-1BIO\s0 method.
198 \&\fBBIO_set_fd()\fR always returns 1.
200 \&\fBBIO_get_fd()\fR returns the file descriptor or \-1 if the \s-1BIO\s0 has not
203 \&\fBBIO_new_fd()\fR returns the newly allocated \s-1BIO\s0 or \s-1NULL\s0 is an error
206 .IX Header "EXAMPLES"
207 This is a file descriptor \s-1BIO\s0 version of \*(L"Hello World\*(R":
212 \& out = BIO_new_fd(fileno(stdout), BIO_NOCLOSE);
213 \& BIO_printf(out, "Hello World\en");
217 .IX Header "SEE ALSO"
218 \&\fBBIO_seek\fR\|(3), \fBBIO_tell\fR\|(3),
219 \&\fBBIO_reset\fR\|(3), \fBBIO_read_ex\fR\|(3),
220 \&\fBBIO_write_ex\fR\|(3), \fBBIO_puts\fR\|(3),
221 \&\fBBIO_gets\fR\|(3), \fBBIO_printf\fR\|(3),
222 \&\fBBIO_set_close\fR\|(3), \fBBIO_get_close\fR\|(3)
224 .IX Header "COPYRIGHT"
225 Copyright 2000\-2019 The OpenSSL Project Authors. All Rights Reserved.
227 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
228 this file except in compliance with the License. You can obtain a copy
229 in the file \s-1LICENSE\s0 in the source distribution or at
230 <https://www.openssl.org/source/license.html>.