Debian Codegraph @

upstream/debian-unstable/man3/BIO_s_fd.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "BIO_S_FD 3SSL"
58 .TH BIO_S_FD 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 BIO_s_fd, BIO_set_fd, BIO_get_fd, BIO_new_fd \- file descriptor BIO
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/bio.h>
69 \&
70 \& const BIO_METHOD *BIO_s_fd(void);
71 \&
72 \& int BIO_set_fd(BIO *b, int fd, int c);
73 \& int BIO_get_fd(BIO *b, int *c);
74 \&
75 \& BIO *BIO_new_fd(int fd, int close_flag);
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 \&\fBBIO_s_fd()\fR returns the file descriptor BIO method. This is a wrapper
80 round the platforms file descriptor routines such as \fBread()\fR and \fBwrite()\fR.
81 .PP
82 \&\fBBIO_read_ex()\fR and \fBBIO_write_ex()\fR read or write the underlying descriptor.
83 \&\fBBIO_puts()\fR is supported but \fBBIO_gets()\fR is not.
84 .PP
85 If the close flag is set then \fBclose()\fR is called on the underlying
86 file descriptor when the BIO is freed.
87 .PP
88 \&\fBBIO_reset()\fR attempts to change the file pointer to the start of file
89 such as by using \fBlseek(fd, 0, 0)\fR.
90 .PP
91 \&\fBBIO_seek()\fR sets the file pointer to position \fBofs\fR from start of file
92 such as by using \fBlseek(fd, ofs, 0)\fR.
93 .PP
94 \&\fBBIO_tell()\fR returns the current file position such as by calling
95 \&\fBlseek(fd, 0, 1)\fR.
96 .PP
97 \&\fBBIO_set_fd()\fR sets the file descriptor of BIO \fBb\fR to \fBfd\fR and the close
98 flag to \fBc\fR.
99 .PP
100 \&\fBBIO_get_fd()\fR places the file descriptor of BIO \fBb\fR in \fBc\fR if it is not NULL.
101 It also returns the file descriptor.
102 .PP
103 \&\fBBIO_new_fd()\fR returns a file descriptor BIO using \fBfd\fR and \fBclose_flag\fR.
104 .SH NOTES
105 .IX Header "NOTES"
106 The behaviour of \fBBIO_read_ex()\fR and \fBBIO_write_ex()\fR depends on the behavior of the
107 platforms \fBread()\fR and \fBwrite()\fR calls on the descriptor. If the underlying
108 file descriptor is in a non blocking mode then the BIO will behave in the
109 manner described in the \fBBIO_read_ex\fR\|(3) and \fBBIO_should_retry\fR\|(3)
110 manual pages.
111 .PP
112 File descriptor BIOs should not be used for socket I/O. Use socket BIOs
113 instead.
114 .PP
115 \&\fBBIO_set_fd()\fR and \fBBIO_get_fd()\fR are implemented as macros.
116 .SH "RETURN VALUES"
117 .IX Header "RETURN VALUES"
118 \&\fBBIO_s_fd()\fR returns the file descriptor BIO method.
119 .PP
120 \&\fBBIO_set_fd()\fR returns 1 on success or <=0 for failure.
121 .PP
122 \&\fBBIO_get_fd()\fR returns the file descriptor or \-1 if the BIO has not
123 been initialized. It also returns zero and negative values if other error occurs.
124 .PP
125 \&\fBBIO_new_fd()\fR returns the newly allocated BIO or NULL is an error
126 occurred.
127 .SH EXAMPLES
128 .IX Header "EXAMPLES"
129 This is a file descriptor BIO version of "Hello World":
130 .PP
131 .Vb 1
132 \& BIO *out;
133 \&
134 \& out = BIO_new_fd(fileno(stdout), BIO_NOCLOSE);
135 \& BIO_printf(out, "Hello World\en");
136 \& BIO_free(out);
137 .Ve
138 .SH "SEE ALSO"
139 .IX Header "SEE ALSO"
140 \&\fBBIO_seek\fR\|(3), \fBBIO_tell\fR\|(3),
141 \&\fBBIO_reset\fR\|(3), \fBBIO_read_ex\fR\|(3),
142 \&\fBBIO_write_ex\fR\|(3), \fBBIO_puts\fR\|(3),
143 \&\fBBIO_gets\fR\|(3), \fBBIO_printf\fR\|(3),
144 \&\fBBIO_set_close\fR\|(3), \fBBIO_get_close\fR\|(3)
145 .SH COPYRIGHT
146 .IX Header "COPYRIGHT"
147 Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
148 .PP
149 Licensed under the Apache License 2.0 (the "License"). You may not use
150 this file except in compliance with the License. You can obtain a copy
151 in the file LICENSE in the source distribution or at
152 <https://www.openssl.org/source/license.html>.