Debian Codegraph @

upstream/debian-unstable/man3/SSL_get_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 "SSL_GET_FD 3SSL"
58 .TH SSL_GET_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 SSL_get_fd, SSL_get_rfd, SSL_get_wfd \- get file descriptor linked to an SSL object
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& int SSL_get_fd(const SSL *ssl);
71 \& int SSL_get_rfd(const SSL *ssl);
72 \& int SSL_get_wfd(const SSL *ssl);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 \&\fBSSL_get_fd()\fR returns the file descriptor which is linked to \fBssl\fR.
77 \&\fBSSL_get_rfd()\fR and \fBSSL_get_wfd()\fR return the file descriptors for the
78 read or the write channel, which can be different. If the read and the
79 write channel are different, \fBSSL_get_fd()\fR will return the file descriptor
80 of the read channel.
81 .SH "RETURN VALUES"
82 .IX Header "RETURN VALUES"
83 The following return values can occur:
84 .IP \-1 4
85 .IX Item "-1"
86 The operation failed, because the underlying BIO is not of the correct type
87 (suitable for file descriptors).
88 .IP >=0 4
89 .IX Item ">=0"
90 The file descriptor linked to \fBssl\fR.
91 .SH "SEE ALSO"
92 .IX Header "SEE ALSO"
93 \&\fBSSL_set_fd\fR\|(3), \fBssl\fR\|(7) , \fBbio\fR\|(7)
94 .SH COPYRIGHT
95 .IX Header "COPYRIGHT"
96 Copyright 2000\-2016 The OpenSSL Project Authors. All Rights Reserved.
97 .PP
98 Licensed under the Apache License 2.0 (the "License"). You may not use
99 this file except in compliance with the License. You can obtain a copy
100 in the file LICENSE in the source distribution or at
101 <https://www.openssl.org/source/license.html>.