2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 .\" permission to reproduce portions of its copyrighted documentation.
4 .\" Original documentation from The Open Group can be obtained online at
5 .\" http://www.opengroup.org/bookstore/.
7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 .\" Group, have given us permission to reprint portions of their
11 .\" In the following statement, the phrase ``this text'' refers to portions
12 .\" of the system documentation.
14 .\" Portions of this text are reprinted and reproduced in electronic form
15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 .\" Standard for Information Technology -- Portable Operating System
17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 .\" Engineers, Inc and The Open Group. In the event of any discrepancy
20 .\" between these versions and the original IEEE and The Open Group
21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 .\" document. The original Standard can be obtained online at
23 .\" http://www.opengroup.org/unix/online.html.
25 .\" This notice shall appear on any product containing this material.
27 .\" The contents of this file are subject to the terms of the
28 .\" Common Development and Distribution License (the "License").
29 .\" You may not use this file except in compliance with the License.
31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 .\" or http://www.opensolaris.org/os/licensing.
33 .\" See the License for the specific language governing permissions
34 .\" and limitations under the License.
36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 .\" If applicable, add the following below this CDDL HEADER, with the
39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
43 .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
44 .\" Portions Copyright (c) 1998, Sun Microsystems, Inc. All Rights Reserved.
46 .TH LISTEN 3XNET "Jun 10, 2002"
48 listen \- listen for socket connections and limit the queue of incoming
53 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lxnet\fR [ \fIlibrary\fR ... ]
54 #include <sys/socket.h>
56 \fBint\fR \fBlisten\fR(\fBint\fR \fIsocket\fR, \fBint\fR \fIbacklog\fR);
62 The \fBlisten()\fR function marks a connection-mode socket, specified by the
63 \fIsocket\fR argument, as accepting connections, and limits the number of
64 outstanding connections in the socket's listen queue to the value specified by
65 the \fIbacklog\fR argument.
68 If \fBlisten()\fR is called with a \fIbacklog\fR argument value that is less
69 than 0, the function sets the length of the socket's listen queue to 0.
72 The implementation may include incomplete connections in the queue subject to
73 the queue limit. The implementation may also increase the specified queue limit
74 internally if it includes such incomplete connections in the queue subject to
78 Implementations may limit the length of the socket's listen queue. If
79 \fIbacklog\fR exceeds the implementation-dependent maximum queue length, the
80 length of the socket's listen queue will be set to the maximum supported value.
83 The socket in use may require the process to have appropriate privileges to use
84 the \fBlisten()\fR function.
88 Upon successful completions, \fBlisten()\fR returns 0. Otherwise, \(mi1 is
89 returned and \fBerrno\fR is set to indicate the error.
93 The \fBlisten()\fR function will fail if:
100 The \fIsocket\fR argument is not a valid file descriptor.
106 \fB\fBEDESTADDRREQ\fR\fR
109 The socket is not bound to a local address, and the protocol does not support
110 listening on an unbound socket.
119 The \fIsocket\fR is already connected.
128 The \fIsocket\fR argument does not refer to a socket.
134 \fB\fBEOPNOTSUPP\fR\fR
137 The socket protocol does not support \fBlisten()\fR.
142 The \fBlisten()\fR function may fail if:
149 The calling process does not have the appropriate privileges.
158 The \fIsocket\fR has been shut down.
167 Insufficient resources are available in the system to complete the call.
173 See \fBattributes\fR(5) for descriptions of the following attributes:
181 ATTRIBUTE TYPE ATTRIBUTE VALUE
183 Interface Stability Standard
191 \fBaccept\fR(3XNET), \fBconnect\fR(3XNET), \fBsocket\fR(3XNET),
192 \fBattributes\fR(5), \fBstandards\fR(5)