BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / sys / connect.2

diff --git a/usr/src/lib/libc/sys/connect.2 b/usr/src/lib/libc/sys/connect.2
index 12c719a..db2738b 100644 (file)
--- a/usr/src/lib/libc/sys/connect.2
+++ b/usr/src/lib/libc/sys/connect.2
@@ -1,138 +1,147 @@
 .\" Copyright (c) 1983 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1983 The Regents of the University of California.
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)connect.2   6.8 (Berkeley) 6/23/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH CONNECT 2 "June 23, 1990"
-.UC 5
-.SH NAME
-connect \- initiate a connection on a socket
-.SH SYNOPSIS
-.nf
-.ft B
-#include <sys/types.h>
-#include <sys/socket.h>
-.PP
-.ft B
-connect(s, name, namelen)
-int s;
-struct sockaddr *name;
-int namelen;
-.fi
-.SH DESCRIPTION
+.\"     @(#)connect.2  6.9 (Berkeley) 3/10/91
+.\"
+.Dd March 10, 1991
+.Dt CONNECT 2
+.Os BSD 4.2
+.Sh NAME
+.Nm connect
+.Nd initiate a connection on a socket
+.Sh SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <sys/socket.h>
+.Ft int
+.Fn connect "int s" "struct sockaddr *name" "int namelen"
+.Sh DESCRIPTION

 The parameter
 The parameter

-.I s
+.Fa s

 is a socket.
 is a socket.

-If it is of type SOCK_DGRAM,
-then this call specifies the peer with which the socket is to be associated;
+If it is of type
+.Dv SOCK_DGRAM ,
+this call specifies the peer with which the socket is to be associated;

 this address is that to which datagrams are to be sent,
 and the only address from which datagrams are to be received.
 this address is that to which datagrams are to be sent,
 and the only address from which datagrams are to be received.

-If the socket is of type SOCK_STREAM,
-then this call attempts to make a connection to
+If the socket is of type
+.Dv SOCK_STREAM ,
+this call attempts to make a connection to

 another socket.
 The other socket is specified by
 another socket.
 The other socket is specified by

-.I name,
+.Fa name ,

 which is an address in the communications space of the socket.
 Each communications space interprets the
 which is an address in the communications space of the socket.
 Each communications space interprets the

-.I name
+.Fa name

 parameter in its own way.
 Generally, stream sockets may successfully
 parameter in its own way.
 Generally, stream sockets may successfully

-.I connect
+.Fn connect

 only once; datagram sockets may use
 only once; datagram sockets may use

-.I connect
+.Fn connect

 multiple times to change their association.
 Datagram sockets may dissolve the association
 by connecting to an invalid address, such as a null address.
 multiple times to change their association.
 Datagram sockets may dissolve the association
 by connecting to an invalid address, such as a null address.

-.SH "RETURN VALUE
-If the connection or binding succeeds, then 0 is returned.
-Otherwise a \-1 is returned, and a more specific error
-code is stored in \fIerrno\fP.
-.SH "ERRORS
-The call fails if:
-.TP 20
-[EBADF]
-.I S
+.Sh RETURN VALUES
+If the connection or binding succeeds, 0 is returned.
+Otherwise a -1 is returned, and a more specific error
+code is stored in
+.Va errno .
+.Sh ERRORS
+The
+.Fn connect
+call fails if:
+.Bl -tag -width EADDRNOTAVAILABB
+.It Bq Er EBADF
+.Fa S

 is not a valid descriptor.
 is not a valid descriptor.

-.TP 20
-[ENOTSOCK]
-.I S
+.It Bq Er ENOTSOCK
+.Fa S

 is a descriptor for a file, not a socket.
 is a descriptor for a file, not a socket.

-.TP 20
-[EADDRNOTAVAIL]
+.It Bq Er EADDRNOTAVAIL

 The specified address is not available on this machine.
 The specified address is not available on this machine.

-.TP 20
-[EAFNOSUPPORT]
+.It Bq Er EAFNOSUPPORT

 Addresses in the specified address family cannot be used with this socket.
 Addresses in the specified address family cannot be used with this socket.

-.TP 20
-[EISCONN]
+.It Bq Er EISCONN

 The socket is already connected.
 The socket is already connected.

-.TP 20
-[ETIMEDOUT]
+.It Bq Er ETIMEDOUT

 Connection establishment timed out without establishing a connection.
 Connection establishment timed out without establishing a connection.

-.TP 20
-[ECONNREFUSED]
+.It Bq Er ECONNREFUSED

 The attempt to connect was forcefully rejected.
 The attempt to connect was forcefully rejected.

-.TP 20
-[ENETUNREACH]
+.It Bq Er ENETUNREACH

 The network isn't reachable from this host.
 The network isn't reachable from this host.

-.TP 20
-[EADDRINUSE]
+.It Bq Er EADDRINUSE

 The address is already in use.
 The address is already in use.

-.TP 20
-[EFAULT]
-The \fIname\fP parameter specifies an area outside
+.It Bq Er EFAULT
+The
+.Fa name
+parameter specifies an area outside

 the process address space.
 the process address space.

-.TP 20
-[EINPROGRESS]
+.It Bq Er EINPROGRESS

 The socket is non-blocking 
 and the connection cannot
 be completed immediately.
 It is possible to
 The socket is non-blocking 
 and the connection cannot
 be completed immediately.
 It is possible to

-.IR select (2)
+.Xr select 2

 for completion by selecting the socket for writing.
 for completion by selecting the socket for writing.

-.TP 20
-[EALREADY]
+.It Bq Er EALREADY

 The socket is non-blocking
 and a previous connection attempt
 has not yet been completed.
 The socket is non-blocking
 and a previous connection attempt
 has not yet been completed.

-.PP
+.El
+.Pp

 The following errors are specific to connecting names in the UNIX domain.
 These errors may not apply in future versions of the UNIX IPC domain.
 The following errors are specific to connecting names in the UNIX domain.
 These errors may not apply in future versions of the UNIX IPC domain.

-.TP 15
-[ENOTDIR]
+.Bl -tag -width EADDRNOTAVAILABB
+.It Bq Er ENOTDIR

 A component of the path prefix is not a directory.
 A component of the path prefix is not a directory.

-.TP 15
-[EINVAL]
+.It Bq Er EINVAL

 The pathname contains a character with the high-order bit set.
 The pathname contains a character with the high-order bit set.

-.TP 15
-[ENAMETOOLONG]
+.It Bq Er ENAMETOOLONG

 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.
 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.

-.TP 15
-[ENOENT]
+.It Bq Er ENOENT

 The named socket does not exist.
 The named socket does not exist.

-.TP 15
-[EACCES]
+.It Bq Er EACCES

 Search permission is denied for a component of the path prefix.
 Search permission is denied for a component of the path prefix.

-.TP 15
-[EACCES]
+.It Bq Er EACCES

 Write access to the named socket is denied.
 Write access to the named socket is denied.

-.TP 15
-[ELOOP]
+.It Bq Er ELOOP

 Too many symbolic links were encountered in translating the pathname.
 Too many symbolic links were encountered in translating the pathname.

-.SH SEE ALSO
-accept(2), select(2), socket(2), getsockname(2)
+.El
+.Sh SEE ALSO
+.Xr accept 2 ,
+.Xr select 2 ,
+.Xr socket 2 ,
+.Xr getsockname 2
+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.2 .