$NetBSD: BIO_s_fd.3,v 1.25 2024/09/08 13:08:15 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

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

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, 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 ========================================================================

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> \& const BIO_METHOD *BIO_s_fd(void); \& int BIO_set_fd(BIO *b, int fd, int c); int BIO_get_fd(BIO *b, int *c); \& BIO *BIO_new_fd(int fd, int close_flag); .Ve Header "DESCRIPTION" \fBBIO_s_fd() returns the file descriptor BIO method. This is a wrapper round the platforms file descriptor routines such as read() and write().

\fBBIO_read_ex() and BIO_write_ex() read or write the underlying descriptor. \fBBIO_puts() is supported but BIO_gets() is not.

If the close flag is set then close() is called on the underlying file descriptor when the BIO is freed.

\fBBIO_reset() attempts to change the file pointer to the start of file such as by using lseek(fd, 0, 0).

\fBBIO_seek() sets the file pointer to position ofs from start of file such as by using lseek(fd, ofs, 0).

\fBBIO_tell() returns the current file position such as by calling \fBlseek(fd, 0, 1).

\fBBIO_set_fd() sets the file descriptor of BIO b to fd and the close flag to c.

\fBBIO_get_fd() places the file descriptor of BIO b in c if it is not NULL. It also returns the file descriptor.

\fBBIO_new_fd() returns a file descriptor BIO using fd and close_flag.

Header "NOTES" The behaviour of BIO_read_ex() and BIO_write_ex() 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 BIO will behave in the manner described in the BIO_read_ex\|(3) and BIO_should_retry\|(3) manual pages.

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

\fBBIO_set_fd() and BIO_get_fd() are implemented as macros.

Header "RETURN VALUES" \fBBIO_s_fd() returns the file descriptor BIO method.

\fBBIO_set_fd() returns 1 on success or <=0 for failure.

\fBBIO_get_fd() returns the file descriptor or -1 if the BIO has not been initialized. It also returns zero and negative values if other error occurs.

\fBBIO_new_fd() returns the newly allocated BIO or NULL is an error occurred.

Header "EXAMPLES" This is a file descriptor BIO version of "Hello World":

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

Header "SEE ALSO" \fBBIO_seek\|(3), BIO_tell\|(3), \fBBIO_reset\|(3), BIO_read_ex\|(3), \fBBIO_write_ex\|(3), BIO_puts\|(3), \fBBIO_gets\|(3), BIO_printf\|(3), \fBBIO_set_close\|(3), BIO_get_close\|(3) Header "COPYRIGHT" Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.