lib/libc/sys/connect.2

   1 .\"     $NetBSD: connect.2,v 1.28 2010/05/31 12:16:20 njoly Exp $
   2 .\"
   3 .\" Copyright (c) 1983, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)connect.2   8.1 (Berkeley) 6/4/93
  31 .\"
  32 .Dd May 18, 2004
  33 .Dt CONNECT 2
  34 .Os
  35 .Sh NAME
  36 .Nm connect
  37 .Nd initiate a connection on a socket
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/socket.h
  42 .Ft int
  43 .Fn connect "int s" "const struct sockaddr *name" "socklen_t namelen"
  44 .Sh DESCRIPTION
  45 The parameter
  46 .Fa s
  47 is a socket.
  48 If it is of type
  49 .Dv SOCK_DGRAM ,
  50 this call specifies the peer with which the socket is to be associated;
  51 this address is that to which datagrams are to be sent,
  52 and the only address from which datagrams are to be received.
  53 If the socket is of type
  54 .Dv SOCK_STREAM ,
  55 this call attempts to make a connection to
  56 another socket.
  57 The other socket is specified by
  58 .Fa name ,
  59 which is an address in the communications space of the socket.
  60 .Fa namelen
  61 indicates the amount of space pointed to by
  62 .Fa name ,
  63 in bytes.
  64 Each communications space interprets the
  65 .Fa name
  66 parameter in its own way.
  67 Generally, stream sockets may successfully
  68 .Fn connect
  69 only once; datagram sockets may use
  70 .Fn connect
  71 multiple times to change their association.
  72 Datagram sockets may dissolve the association
  73 by connecting to an invalid address, such as a null address.
  74 .Pp
  75 If a
  76 .Fn connect
  77 call is interrupted by a signal, it will return with errno set to
  78 .Er EINTR
  79 and the connection attempt will proceed as if the socket was non-blocking.
  80 Subsequent calls to
  81 .Fn connect
  82 will set errno to
  83 .Er EALREADY .
  84 .Sh RETURN VALUES
  85 If the connection or binding succeeds, 0 is returned.
  86 Otherwise a \-1 is returned, and a more specific error
  87 code is stored in
  88 .Va errno .
  89 .Sh ERRORS
  90 The
  91 .Fn connect
  92 call fails if:
  93 .Bl -tag -width Er
  94 .It Bq Er EBADF
  95 .Fa s
  96 is not a valid descriptor.
  97 .It Bq Er ENOTSOCK
  98 .Fa s
  99 is a descriptor for a file, not a socket.
 100 .It Bq Er EADDRNOTAVAIL
 101 The specified address is not available on this machine.
 102 .It Bq Er EAFNOSUPPORT
 103 Addresses in the specified address family cannot be used with this socket.
 104 .It Bq Er EISCONN
 105 The socket is already connected.
 106 .It Bq Er ETIMEDOUT
 107 Connection establishment timed out without establishing a connection.
 108 .It Bq Er ECONNREFUSED
 109 The attempt to connect was forcefully rejected.
 110 .It Bq Er ENETUNREACH
 111 The network isn't reachable from this host.
 112 .It Bq Er EADDRINUSE
 113 The address is already in use.
 114 .It Bq Er EFAULT
 115 The
 116 .Fa name
 117 parameter specifies an area outside
 118 the process address space.
 119 .It Bq Er EINPROGRESS
 120 The socket is non-blocking and the connection cannot be completed immediately.
 121 It is possible to
 122 .Xr select 2
 123 or
 124 .Xr poll 2
 125 for completion by selecting or polling the socket for writing.
 126 The success or failure of the connect operation may be determined by using
 127 .Xr getsockopt 2
 128 to read the socket error status with the
 129 .Dv SO_ERROR
 130 option at the
 131 .Dv SOL_SOCKET
 132 level.
 133 The returned socket error status is zero on success, or one of the
 134 error codes listed here on failure.
 135 .It Bq Er EALREADY
 136 Either the socket is non-blocking mode or a previous call to
 137 .Fn connect
 138 was interrupted by a signal, and the connection attempt has not yet
 139 been completed.
 140 .It Bq Er EINTR
 141 The connection attempt was interrupted by a signal.
 142 .El
 143 .Pp
 144 The following errors are specific to connecting names in the
 145 .Ux
 146 domain.
 147 These errors may not apply in future versions of the
 148 .Ux
 149 IPC domain.
 150 .Bl -tag -width Er
 151 .It Bq Er ENOTDIR
 152 A component of the path prefix is not a directory.
 153 .It Bq Er ENAMETOOLONG
 154 A component of a pathname exceeded
 155 .Brq Dv NAME_MAX
 156 characters, or an entire path name exceeded
 157 .Brq Dv PATH_MAX
 158 characters.
 159 .It Bq Er ENOENT
 160 The named socket does not exist.
 161 .It Bq Er EACCES
 162 Search permission is denied for a component of the path prefix, or
 163 write access to the named socket is denied.
 164 .It Bq Er ELOOP
 165 Too many symbolic links were encountered in translating the pathname.
 166 .El
 167 .Sh SEE ALSO
 168 .Xr accept 2 ,
 169 .Xr getsockname 2 ,
 170 .Xr getsockopt 2 ,
 171 .Xr poll 2 ,
 172 .Xr select 2 ,
 173 .Xr socket 2
 174 .Sh HISTORY
 175 The
 176 .Fn connect
 177 function call appeared in
 178 .Bx 4.2 .