Debian Codegraph @

upstream/debian-unstable/man3/BIO_s_socket.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_SOCKET 3SSL"
58 .TH BIO_S_SOCKET 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_socket, BIO_new_socket \- socket BIO
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/bio.h>
69 \&
70 \& const BIO_METHOD *BIO_s_socket(void);
71 \&
72 \& BIO *BIO_new_socket(int sock, int close_flag);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 \&\fBBIO_s_socket()\fR returns the socket BIO method. This is a wrapper
77 round the platform's socket routines.
78 .PP
79 \&\fBBIO_read_ex()\fR and \fBBIO_write_ex()\fR read or write the underlying socket.
80 \&\fBBIO_puts()\fR is supported but \fBBIO_gets()\fR is not.
81 .PP
82 If the close flag is set then the socket is shut down and closed
83 when the BIO is freed.
84 .PP
85 \&\fBBIO_new_socket()\fR returns a socket BIO using \fBsock\fR and \fBclose_flag\fR.
86 .SH NOTES
87 .IX Header "NOTES"
88 Socket BIOs also support any relevant functionality of file descriptor
89 BIOs.
90 .PP
91 The reason for having separate file descriptor and socket BIOs is that on some
92 platforms sockets are not file descriptors and use distinct I/O routines,
93 Windows is one such platform. Any code mixing the two will not work on
94 all platforms.
95 .SH "RETURN VALUES"
96 .IX Header "RETURN VALUES"
97 \&\fBBIO_s_socket()\fR returns the socket BIO method.
98 .PP
99 \&\fBBIO_new_socket()\fR returns the newly allocated BIO or NULL is an error
100 occurred.
101 .SH COPYRIGHT
102 .IX Header "COPYRIGHT"
103 Copyright 2000\-2016 The OpenSSL Project Authors. All Rights Reserved.
104 .PP
105 Licensed under the Apache License 2.0 (the "License"). You may not use
106 this file except in compliance with the License. You can obtain a copy
107 in the file LICENSE in the source distribution or at
108 <https://www.openssl.org/source/license.html>.