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