Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is turned on, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "BIO_s_fd 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
BIO_s_fd, BIO_set_fd, BIO_get_fd, BIO_new_fd - file descriptor BIO Header "SYNOPSIS" .Vb 1 #include <openssl/bio.h> \& BIO_METHOD * BIO_s_fd(void); \& #define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd) #define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c) \& BIO *BIO_new_fd(int fd, int close_flag); .Ve Header "DESCRIPTION" \fIBIO_s_fd() returns the file descriptor \s-1BIO\s0 method. This is a wrapper round the platforms file descriptor routines such as read() and write().

\fIBIO_read() and BIO_write() read or write the underlying descriptor. \fIBIO_puts() is supported but BIO_gets() is not.

If the close flag is set then then close() is called on the underlying file descriptor when the \s-1BIO\s0 is freed.

\fIBIO_reset() attempts to change the file pointer to the start of file using lseek(fd, 0, 0).

\fIBIO_seek() sets the file pointer to position ofs from start of file using lseek(fd, ofs, 0).

\fIBIO_tell() returns the current file position by calling lseek(fd, 0, 1).

\fIBIO_set_fd() sets the file descriptor of \s-1BIO \s0b to fd and the close flag to c.

\fIBIO_get_fd() places the file descriptor in c if it is not \s-1NULL,\s0 it also returns the file descriptor. If c is not \s-1NULL\s0 it should be of type (int *).

\fIBIO_new_fd() returns a file descriptor \s-1BIO\s0 using fd and close_flag.

Header "NOTES" The behaviour of BIO_read() and BIO_write() depends on the behavior of the platforms read() and write() calls on the descriptor. If the underlying file descriptor is in a non blocking mode then the \s-1BIO\s0 will behave in the manner described in the BIO_read\|(3) and BIO_should_retry\|(3) manual pages.

File descriptor BIOs should not be used for socket I/O. Use socket BIOs instead.

Header "RETURN VALUES" \fIBIO_s_fd() returns the file descriptor \s-1BIO\s0 method.

\fIBIO_reset() returns zero for success and -1 if an error occurred. \fIBIO_seek() and BIO_tell() return the current file position or -1 is an error occurred. These values reflect the underlying lseek() behaviour.

\fIBIO_set_fd() always returns 1.

\fIBIO_get_fd() returns the file descriptor or -1 if the \s-1BIO\s0 has not been initialized.

\fIBIO_new_fd() returns the newly allocated \s-1BIO\s0 or \s-1NULL\s0 is an error occurred.

Header "EXAMPLE" This is a file descriptor \s-1BIO\s0 version of \*(L"Hello World\*(R":

.Vb 4 BIO *out; out = BIO_new_fd(fileno(stdout), BIO_NOCLOSE); BIO_printf(out, "Hello World\en"); BIO_free(out); .Ve

Header "SEE ALSO" \fIBIO_seek\|(3), BIO_tell\|(3), \fIBIO_reset\|(3), BIO_read\|(3), \fIBIO_write\|(3), BIO_puts\|(3), \fIBIO_gets\|(3), BIO_printf\|(3), \fIBIO_set_close\|(3), BIO_get_close\|(3)