BSD 4_3_Net_2 release

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

diff --git a/usr/src/lib/libc/sys/listen.2 b/usr/src/lib/libc/sys/listen.2
index 18ca15e..dd126b4 100644 (file)
--- a/usr/src/lib/libc/sys/listen.2
+++ b/usr/src/lib/libc/sys/listen.2
@@ -1,74 +1,100 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" 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.

 .\"
 .\"

-.\"    @(#)listen.2    6.4 (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 LISTEN 2 "June 23, 1990"
-.UC 5
-.SH NAME
-listen \- listen for connections on a socket
-.SH SYNOPSIS
-.nf
-.ft B
-listen(s, backlog)
-int s, backlog;
-.fi
-.SH DESCRIPTION
+.\"     @(#)listen.2   6.5 (Berkeley) 3/10/91
+.\"
+.Dd March 10, 1991
+.Dt LISTEN 2
+.Os BSD 4.2
+.Sh NAME
+.Nm listen
+.Nd listen for connections on a socket
+.Sh SYNOPSIS
+.Fd #include <sys/socket.h>
+.Ft int
+.Fn listen "int s" "int backlog"
+.Sh DESCRIPTION

 To accept connections, a socket
 is first created with
 To accept connections, a socket
 is first created with

-.IR socket (2),
+.Xr socket 2 ,

 a willingness to accept incoming connections and
 a queue limit for incoming connections are specified with
 a willingness to accept incoming connections and
 a queue limit for incoming connections are specified with

-.IR listen (2),
+.Fn listen ,

 and then the connections are
 accepted with
 and then the connections are
 accepted with

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

 The
 The

-.I listen
+.Fn listen

 call applies only to sockets of type
 call applies only to sockets of type

-SOCK_STREAM
+.Dv SOCK_STREAM

 or
 or

-SOCK_SEQPACKET.
-.PP
+.Dv SOCK_SEQPACKET.
+.Pp

 The
 The

-.I backlog
+.Fa backlog

 parameter defines the maximum length the queue of
 pending connections may grow to.
 If a connection
 request arrives with the queue full the client may
 parameter defines the maximum length the queue of
 pending connections may grow to.
 If a connection
 request arrives with the queue full the client may

-receive an error with an indication of ECONNREFUSED,
+receive an error with an indication of
+.Er ECONNREFUSED ,

 or, if the underlying protocol supports retransmission,
 the request may be ignored so that retries may succeed.
 or, if the underlying protocol supports retransmission,
 the request may be ignored so that retries may succeed.

-.SH "RETURN VALUE
-A 0 return value indicates success; \-1 indicates an error.
-.SH "ERRORS
-The call fails if:
-.TP 20
-[EBADF]
-The argument \fIs\fP is not a valid descriptor.
-.TP 20
-[ENOTSOCK]
-The argument \fIs\fP is not a socket.
-.TP 20
-[EOPNOTSUPP]
-The socket is not of a type that supports the operation \fIlisten\fP.
-.SH "SEE ALSO"
-accept(2), connect(2), socket(2)
-.SH BUGS
+.Sh RETURN VALUES
+A 0 return value indicates success; -1 indicates an error.
+.Sh ERRORS
+.Fn Listen will fail if:
+.Bl -tag -width [EOPNOTSUPP]
+.It Bq Er EBADF
+The argument
+.Fa s
+is not a valid descriptor.
+.It Bq Er ENOTSOCK
+The argument
+.Fa s
+is not a socket.
+.It Bq Er EOPNOTSUPP
+The socket is not of a type that supports the operation
+.Fn listen .
+.El
+.Sh SEE ALSO
+.Xr accept 2 ,
+.Xr connect 2 ,
+.Xr socket 2
+.Sh BUGS

 The
 The

-.I backlog
+.Fa backlog

 is currently limited (silently) to 5.
 is currently limited (silently) to 5.

+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.2 .