secure/lib/libcrypto/man/BIO_connect.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "BIO_CONNECT 3"
 132 .TH BIO_CONNECT 3 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 BIO_socket, BIO_bind, BIO_connect, BIO_listen, BIO_accept_ex, BIO_closesocket \- BIO socket communication setup routines
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/bio.h>
 143 \&
 144 \& int BIO_socket(int domain, int socktype, int protocol, int options);
 145 \& int BIO_bind(int sock, const BIO_ADDR *addr, int options);
 146 \& int BIO_connect(int sock, const BIO_ADDR *addr, int options);
 147 \& int BIO_listen(int sock, const BIO_ADDR *addr, int options);
 148 \& int BIO_accept_ex(int accept_sock, BIO_ADDR *peer, int options);
 149 \& int BIO_closesocket(int sock);
 150 .Ve
 151 .SH "DESCRIPTION"
 152 .IX Header "DESCRIPTION"
 153 \&\fIBIO_socket()\fR creates a socket in the domain \fBdomain\fR, of type
 154 \&\fBsocktype\fR and \fBprotocol\fR.  Socket \fBoptions\fR are currently unused,
 155 but is present for future use.
 156 .PP
 157 \&\fIBIO_bind()\fR binds the source address and service to a socket and
 158 may be useful before calling \fIBIO_connect()\fR.  The options may include
 159 \&\fB\s-1BIO_SOCK_REUSADDR\s0\fR, which is described in \*(L"\s-1FLAGS\*(R"\s0 below.
 160 .PP
 161 \&\fIBIO_connect()\fR connects \fBsock\fR to the address and service given by
 162 \&\fBaddr\fR.  Connection \fBoptions\fR may be zero or any combination of
 163 \&\fB\s-1BIO_SOCK_KEEPALIVE\s0\fR, \fB\s-1BIO_SOCK_NONBLOCK\s0\fR and \fB\s-1BIO_SOCK_NODELAY\s0\fR.
 164 The flags are described in \*(L"\s-1FLAGS\*(R"\s0 below.
 165 .PP
 166 \&\fIBIO_listen()\fR has \fBsock\fR start listening on the address and service
 167 given by \fBaddr\fR.  Connection \fBoptions\fR may be zero or any
 168 combination of \fB\s-1BIO_SOCK_KEEPALIVE\s0\fR, \fB\s-1BIO_SOCK_NONBLOCK\s0\fR,
 169 \&\fB\s-1BIO_SOCK_NODELAY\s0\fR, \fB\s-1BIO_SOCK_REUSEADDR\s0\fR and \fB\s-1BIO_SOCK_V6_ONLY\s0\fR.
 170 The flags are described in \*(L"\s-1FLAGS\*(R"\s0 below.
 171 .PP
 172 \&\fIBIO_accept_ex()\fR waits for an incoming connections on the given
 173 socket \fBaccept_sock\fR.  When it gets a connection, the address and
 174 port of the peer gets stored in \fBpeer\fR if that one is non-NULL.
 175 Accept \fBoptions\fR may be zero or \fB\s-1BIO_SOCK_NONBLOCK\s0\fR, and is applied
 176 on the accepted socket.  The flags are described in \*(L"\s-1FLAGS\*(R"\s0 below.
 177 .PP
 178 \&\fIBIO_closesocket()\fR closes \fBsock\fR.
 179 .SH "FLAGS"
 180 .IX Header "FLAGS"
 181 .IP "\s-1BIO_SOCK_KEEPALIVE\s0" 4
 182 .IX Item "BIO_SOCK_KEEPALIVE"
 183 Enables regular sending of keep-alive messages.
 184 .IP "\s-1BIO_SOCK_NONBLOCK\s0" 4
 185 .IX Item "BIO_SOCK_NONBLOCK"
 186 Sets the socket to non-blocking mode.
 187 .IP "\s-1BIO_SOCK_NODELAY\s0" 4
 188 .IX Item "BIO_SOCK_NODELAY"
 189 Corresponds to \fB\s-1TCP_NODELAY\s0\fR, and disables the Nagle algorithm.  With
 190 this set, any data will be sent as soon as possible instead of being
 191 buffered until there's enough for the socket to send out in one go.
 192 .IP "\s-1BIO_SOCK_REUSEADDR\s0" 4
 193 .IX Item "BIO_SOCK_REUSEADDR"
 194 Try to reuse the address and port combination for a recently closed
 195 port.
 196 .IP "\s-1BIO_SOCK_V6_ONLY\s0" 4
 197 .IX Item "BIO_SOCK_V6_ONLY"
 198 When creating an IPv6 socket, make it only listen for IPv6 addresses
 199 and not IPv4 addresses mapped to IPv6.
 200 .PP
 201 These flags are bit flags, so they are to be combined with the
 202 \&\f(CW\*(C`|\*(C'\fR operator, for example:
 203 .PP
 204 .Vb 1
 205 \& BIO_connect(sock, addr, BIO_SOCK_KEEPALIVE | BIO_SOCK_NONBLOCK);
 206 .Ve
 207 .SH "RETURN VALUES"
 208 .IX Header "RETURN VALUES"
 209 \&\fIBIO_socket()\fR returns the socket number on success or \fB\s-1INVALID_SOCKET\s0\fR
 210 (\-1) on error.  When an error has occurred, the OpenSSL error stack
 211 will hold the error data and errno has the system error.
 212 .PP
 213 \&\fIBIO_bind()\fR, \fIBIO_connect()\fR and \fIBIO_listen()\fR return 1 on success or 0 on error.
 214 When an error has occurred, the OpenSSL error stack will hold the error
 215 data and errno has the system error.
 216 .PP
 217 \&\fIBIO_accept_ex()\fR returns the accepted socket on success or
 218 \&\fB\s-1INVALID_SOCKET\s0\fR (\-1) on error.  When an error has occurred, the
 219 OpenSSL error stack will hold the error data and errno has the system
 220 error.
 221 .SH "HISTORY"
 222 .IX Header "HISTORY"
 223 \&\fIBIO_gethostname()\fR, \fIBIO_get_port()\fR, \fIBIO_get_host_ip()\fR,
 224 \&\fIBIO_get_accept_socket()\fR and \fIBIO_accept()\fR were deprecated in
 225 OpenSSL 1.1.0.  Use the functions described above instead.
 226 .SH "SEE ALSO"
 227 .IX Header "SEE ALSO"
 228 \&\s-1\fIBIO_ADDR\s0\fR\|(3)
 229 .SH "COPYRIGHT"
 230 .IX Header "COPYRIGHT"
 231 Copyright 2016\-2018 The OpenSSL Project Authors. All Rights Reserved.
 232 .PP
 233 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 234 this file except in compliance with the License.  You can obtain a copy
 235 in the file \s-1LICENSE\s0 in the source distribution or at
 236 <https://www.openssl.org/source/license.html>.