man2/connect.2

   1 .\" Copyright 1993 Rickard E. Faith (faith@cs.unc.edu)
   2 .\" Portions extracted from /usr/include/sys/socket.h, which does not have
   3 .\" any authorship information in it.  It is probably available under the GPL.
   4 .\"
   5 .\" %%%LICENSE_START(VERBATIM)
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\" %%%LICENSE_END
  26 .\"
  27 .\"
  28 .\" Other portions are from the 6.9 (Berkeley) 3/10/91 man page:
  29 .\"
  30 .\" Copyright (c) 1983 The Regents of the University of California.
  31 .\" All rights reserved.
  32 .\"
  33 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
  34 .\" Redistribution and use in source and binary forms, with or without
  35 .\" modification, are permitted provided that the following conditions
  36 .\" are met:
  37 .\" 1. Redistributions of source code must retain the above copyright
  38 .\"    notice, this list of conditions and the following disclaimer.
  39 .\" 2. Redistributions in binary form must reproduce the above copyright
  40 .\"    notice, this list of conditions and the following disclaimer in the
  41 .\"    documentation and/or other materials provided with the distribution.
  42 .\" 3. All advertising materials mentioning features or use of this software
  43 .\"    must display the following acknowledgement:
  44 .\"     This product includes software developed by the University of
  45 .\"     California, Berkeley and its contributors.
  46 .\" 4. Neither the name of the University nor the names of its contributors
  47 .\"    may be used to endorse or promote products derived from this software
  48 .\"    without specific prior written permission.
  49 .\"
  50 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  51 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  52 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  53 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  54 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  55 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  56 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  57 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  58 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  59 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  60 .\" SUCH DAMAGE.
  61 .\" %%%LICENSE_END
  62 .\"
  63 .\" Modified 1997-01-31 by Eric S. Raymond <esr@thyrsus.com>
  64 .\" Modified 1998, 1999 by Andi Kleen
  65 .\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com>
  66 .\"
  67 .TH CONNECT 2 2017-09-15 "Linux" "Linux Programmer's Manual"
  68 .SH NAME
  69 connect \- initiate a connection on a socket
  70 .SH SYNOPSIS
  71 .nf
  72 .BR "#include <sys/types.h>" "          /* See NOTES */"
  73 .br
  74 .B #include <sys/socket.h>
  75 .PP
  76 .BI "int connect(int " sockfd ", const struct sockaddr *" addr ,
  77 .BI "            socklen_t " addrlen );
  78 .fi
  79 .SH DESCRIPTION
  80 The
  81 .BR connect ()
  82 system call connects the socket referred to by the file descriptor
  83 .I sockfd
  84 to the address specified by
  85 .IR addr .
  86 The
  87 .I addrlen
  88 argument specifies the size of
  89 .IR addr .
  90 The format of the address in
  91 .I addr
  92 is determined by the address space of the socket
  93 .IR sockfd ;
  94 see
  95 .BR socket (2)
  96 for further details.
  97 .PP
  98 If the socket
  99 .I sockfd
 100 is of type
 101 .BR SOCK_DGRAM ,
 102 then
 103 .I addr
 104 is the address to which datagrams are sent by default, and the only
 105 address from which datagrams are received.
 106 If the socket is of type
 107 .B SOCK_STREAM
 108 or
 109 .BR SOCK_SEQPACKET ,
 110 this call attempts to make a connection to the socket that is bound
 111 to the address specified by
 112 .IR addr .
 113 .PP
 114 Generally, connection-based protocol sockets may successfully
 115 .BR connect ()
 116 only once; connectionless protocol sockets may use
 117 .BR connect ()
 118 multiple times to change their association.
 119 Connectionless sockets may
 120 dissolve the association by connecting to an address with the
 121 .I sa_family
 122 member of
 123 .I sockaddr
 124 set to
 125 .BR AF_UNSPEC
 126 (supported on Linux since kernel 2.2).
 127 .SH RETURN VALUE
 128 If the connection or binding succeeds, zero is returned.
 129 On error, \-1 is returned, and
 130 .I errno
 131 is set appropriately.
 132 .SH ERRORS
 133 The following are general socket errors only.
 134 There may be other domain-specific error codes.
 135 .TP
 136 .B EACCES
 137 For UNIX domain sockets, which are identified by pathname:
 138 Write permission is denied on the socket file,
 139 or search permission is denied for one of the directories
 140 in the path prefix.
 141 (See also
 142 .BR path_resolution (7).)
 143 .TP
 144 .BR EACCES ", " EPERM
 145 The user tried to connect to a broadcast address without having the socket
 146 broadcast flag enabled or the connection request failed because of a local
 147 firewall rule.
 148 .TP
 149 .B EADDRINUSE
 150 Local address is already in use.
 151 .TP
 152 .B EADDRNOTAVAIL
 153 (Internet domain sockets)
 154 The socket referred to by
 155 .I sockfd
 156 had not previously been bound to an address and,
 157 upon attempting to bind it to an ephemeral port,
 158 it was determined that all port numbers in the ephemeral port range
 159 are currently in use.
 160 See the discussion of
 161 .I /proc/sys/net/ipv4/ip_local_port_range
 162 in
 163 .BR ip (7).
 164 .TP
 165 .B EAFNOSUPPORT
 166 The passed address didn't have the correct address family in its
 167 .I sa_family
 168 field.
 169 .TP
 170 .B EAGAIN
 171 Insufficient entries in the routing cache.
 172 .TP
 173 .B EALREADY
 174 The socket is nonblocking and a previous connection attempt has not yet
 175 been completed.
 176 .TP
 177 .B EBADF
 178 .I sockfd
 179 is not a valid open file descriptor.
 180 .TP
 181 .B ECONNREFUSED
 182 No one listening on the remote address.
 183 .TP
 184 .B EFAULT
 185 The socket structure address is outside the user's address space.
 186 .TP
 187 .B EINPROGRESS
 188 The socket is nonblocking and the connection cannot be completed
 189 immediately.
 190 It is possible to
 191 .BR select (2)
 192 or
 193 .BR poll (2)
 194 for completion by selecting the socket for writing.
 195 After
 196 .BR select (2)
 197 indicates writability, use
 198 .BR getsockopt (2)
 199 to read the
 200 .B SO_ERROR
 201 option at level
 202 .B SOL_SOCKET
 203 to determine whether
 204 .BR connect ()
 205 completed successfully
 206 .RB ( SO_ERROR
 207 is zero) or unsuccessfully
 208 .RB ( SO_ERROR
 209 is one of the usual error codes listed here,
 210 explaining the reason for the failure).
 211 .TP
 212 .B EINTR
 213 The system call was interrupted by a signal that was caught; see
 214 .BR signal (7).
 215 .\" For TCP, the connection will complete asynchronously.
 216 .\" See http://lkml.org/lkml/2005/7/12/254
 217 .TP
 218 .B EISCONN
 219 The socket is already connected.
 220 .TP
 221 .B ENETUNREACH
 222 Network is unreachable.
 223 .TP
 224 .B ENOTSOCK
 225 The file descriptor
 226 .I sockfd
 227 does not refer to a socket.
 228 .TP
 229 .B EPROTOTYPE
 230 The socket type does not support the requested communications protocol.
 231 This error can occur, for example,
 232 on an attempt to connect a UNIX domain datagram socket to a stream socket.
 233 .TP
 234 .B ETIMEDOUT
 235 Timeout while attempting connection.
 236 The server may be too
 237 busy to accept new connections.
 238 Note that for IP sockets the timeout may
 239 be very long when syncookies are enabled on the server.
 240 .SH CONFORMING TO
 241 POSIX.1-2001, POSIX.1-2008, SVr4, 4.4BSD, (the
 242 .BR connect ()
 243 function first appeared in 4.2BSD).
 244 .\" SVr4 documents the additional
 245 .\" general error codes
 246 .\" .BR EADDRNOTAVAIL ,
 247 .\" .BR EINVAL ,
 248 .\" .BR EAFNOSUPPORT ,
 249 .\" .BR EALREADY ,
 250 .\" .BR EINTR ,
 251 .\" .BR EPROTOTYPE ,
 252 .\" and
 253 .\" .BR ENOSR .
 254 .\" It also
 255 .\" documents many additional error conditions not described here.
 256 .SH NOTES
 257 POSIX.1 does not require the inclusion of
 258 .IR <sys/types.h> ,
 259 and this header file is not required on Linux.
 260 However, some historical (BSD) implementations required this header
 261 file, and portable applications are probably wise to include it.
 262 .PP
 263 For background on the
 264 .I socklen_t
 265 type, see
 266 .BR accept (2).
 267 .PP
 268 If
 269 .BR connect ()
 270 fails, consider the state of the socket as unspecified.
 271 Portable applications should close the socket and create a new one for
 272 reconnecting.
 273 .SH EXAMPLE
 274 An example of the use of
 275 .BR connect ()
 276 is shown in
 277 .BR getaddrinfo (3).
 278 .SH SEE ALSO
 279 .BR accept (2),
 280 .BR bind (2),
 281 .BR getsockname (2),
 282 .BR listen (2),
 283 .BR socket (2),
 284 .BR path_resolution (7)