secure/lib/libcrypto/man/man3/BIO_connect.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "BIO_CONNECT 3"
 136 .TH BIO_CONNECT 3 "2020-09-22" "1.1.1h" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 BIO_socket, BIO_bind, BIO_connect, BIO_listen, BIO_accept_ex, BIO_closesocket \- BIO socket communication setup routines
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/bio.h>
 147 \&
 148 \& int BIO_socket(int domain, int socktype, int protocol, int options);
 149 \& int BIO_bind(int sock, const BIO_ADDR *addr, int options);
 150 \& int BIO_connect(int sock, const BIO_ADDR *addr, int options);
 151 \& int BIO_listen(int sock, const BIO_ADDR *addr, int options);
 152 \& int BIO_accept_ex(int accept_sock, BIO_ADDR *peer, int options);
 153 \& int BIO_closesocket(int sock);
 154 .Ve
 155 .SH "DESCRIPTION"
 156 .IX Header "DESCRIPTION"
 157 \&\fBBIO_socket()\fR creates a socket in the domain \fBdomain\fR, of type
 158 \&\fBsocktype\fR and \fBprotocol\fR.  Socket \fBoptions\fR are currently unused,
 159 but is present for future use.
 160 .PP
 161 \&\fBBIO_bind()\fR binds the source address and service to a socket and
 162 may be useful before calling \fBBIO_connect()\fR.  The options may include
 163 \&\fB\s-1BIO_SOCK_REUSEADDR\s0\fR, which is described in \*(L"\s-1FLAGS\*(R"\s0 below.
 164 .PP
 165 \&\fBBIO_connect()\fR connects \fBsock\fR to the address and service given by
 166 \&\fBaddr\fR.  Connection \fBoptions\fR may be zero or any combination of
 167 \&\fB\s-1BIO_SOCK_KEEPALIVE\s0\fR, \fB\s-1BIO_SOCK_NONBLOCK\s0\fR and \fB\s-1BIO_SOCK_NODELAY\s0\fR.
 168 The flags are described in \*(L"\s-1FLAGS\*(R"\s0 below.
 169 .PP
 170 \&\fBBIO_listen()\fR has \fBsock\fR start listening on the address and service
 171 given by \fBaddr\fR.  Connection \fBoptions\fR may be zero or any
 172 combination of \fB\s-1BIO_SOCK_KEEPALIVE\s0\fR, \fB\s-1BIO_SOCK_NONBLOCK\s0\fR,
 173 \&\fB\s-1BIO_SOCK_NODELAY\s0\fR, \fB\s-1BIO_SOCK_REUSEADDR\s0\fR and \fB\s-1BIO_SOCK_V6_ONLY\s0\fR.
 174 The flags are described in \*(L"\s-1FLAGS\*(R"\s0 below.
 175 .PP
 176 \&\fBBIO_accept_ex()\fR waits for an incoming connections on the given
 177 socket \fBaccept_sock\fR.  When it gets a connection, the address and
 178 port of the peer gets stored in \fBpeer\fR if that one is non-NULL.
 179 Accept \fBoptions\fR may be zero or \fB\s-1BIO_SOCK_NONBLOCK\s0\fR, and is applied
 180 on the accepted socket.  The flags are described in \*(L"\s-1FLAGS\*(R"\s0 below.
 181 .PP
 182 \&\fBBIO_closesocket()\fR closes \fBsock\fR.
 183 .SH "FLAGS"
 184 .IX Header "FLAGS"
 185 .IP "\s-1BIO_SOCK_KEEPALIVE\s0" 4
 186 .IX Item "BIO_SOCK_KEEPALIVE"
 187 Enables regular sending of keep-alive messages.
 188 .IP "\s-1BIO_SOCK_NONBLOCK\s0" 4
 189 .IX Item "BIO_SOCK_NONBLOCK"
 190 Sets the socket to nonblocking mode.
 191 .IP "\s-1BIO_SOCK_NODELAY\s0" 4
 192 .IX Item "BIO_SOCK_NODELAY"
 193 Corresponds to \fB\s-1TCP_NODELAY\s0\fR, and disables the Nagle algorithm.  With
 194 this set, any data will be sent as soon as possible instead of being
 195 buffered until there's enough for the socket to send out in one go.
 196 .IP "\s-1BIO_SOCK_REUSEADDR\s0" 4
 197 .IX Item "BIO_SOCK_REUSEADDR"
 198 Try to reuse the address and port combination for a recently closed
 199 port.
 200 .IP "\s-1BIO_SOCK_V6_ONLY\s0" 4
 201 .IX Item "BIO_SOCK_V6_ONLY"
 202 When creating an IPv6 socket, make it only listen for IPv6 addresses
 203 and not IPv4 addresses mapped to IPv6.
 204 .PP
 205 These flags are bit flags, so they are to be combined with the
 206 \&\f(CW\*(C`|\*(C'\fR operator, for example:
 207 .PP
 208 .Vb 1
 209 \& BIO_connect(sock, addr, BIO_SOCK_KEEPALIVE | BIO_SOCK_NONBLOCK);
 210 .Ve
 211 .SH "RETURN VALUES"
 212 .IX Header "RETURN VALUES"
 213 \&\fBBIO_socket()\fR returns the socket number on success or \fB\s-1INVALID_SOCKET\s0\fR
 214 (\-1) on error.  When an error has occurred, the OpenSSL error stack
 215 will hold the error data and errno has the system error.
 216 .PP
 217 \&\fBBIO_bind()\fR, \fBBIO_connect()\fR and \fBBIO_listen()\fR return 1 on success or 0 on error.
 218 When an error has occurred, the OpenSSL error stack will hold the error
 219 data and errno has the system error.
 220 .PP
 221 \&\fBBIO_accept_ex()\fR returns the accepted socket on success or
 222 \&\fB\s-1INVALID_SOCKET\s0\fR (\-1) on error.  When an error has occurred, the
 223 OpenSSL error stack will hold the error data and errno has the system
 224 error.
 225 .SH "SEE ALSO"
 226 .IX Header "SEE ALSO"
 227 \&\s-1\fBBIO_ADDR\s0\fR\|(3)
 228 .SH "HISTORY"
 229 .IX Header "HISTORY"
 230 \&\fBBIO_gethostname()\fR, \fBBIO_get_port()\fR, \fBBIO_get_host_ip()\fR,
 231 \&\fBBIO_get_accept_socket()\fR and \fBBIO_accept()\fR were deprecated in OpenSSL 1.1.0.
 232 Use the functions described above instead.
 233 .SH "COPYRIGHT"
 234 .IX Header "COPYRIGHT"
 235 Copyright 2016\-2020 The OpenSSL Project Authors. All Rights Reserved.
 236 .PP
 237 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 238 this file except in compliance with the License.  You can obtain a copy
 239 in the file \s-1LICENSE\s0 in the source distribution or at
 240 <https://www.openssl.org/source/license.html>.