usr/src/man/man3xnet/listen.3xnet

   1 .\"
   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/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  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.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  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.
  30 .\"
  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.
  35 .\"
  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]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Portions Copyright (c) 1998, Sun Microsystems, Inc.  All Rights Reserved.
  45 .\"
  46 .TH LISTEN 3XNET "Jun 10, 2002"
  47 .SH NAME
  48 listen \- listen for socket connections and limit the queue of incoming
  49 connections
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lxnet\fR [ \fIlibrary\fR ... ]
  54 #include <sys/socket.h>
  55
  56 \fBint\fR \fBlisten\fR(\fBint\fR \fIsocket\fR, \fBint\fR \fIbacklog\fR);
  57 .fi
  58
  59 .SH DESCRIPTION
  60 .sp
  61 .LP
  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.
  66 .sp
  67 .LP
  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.
  70 .sp
  71 .LP
  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
  75 this limit.
  76 .sp
  77 .LP
  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.
  81 .sp
  82 .LP
  83 The socket in use may require the process to have appropriate privileges to use
  84 the \fBlisten()\fR function.
  85 .SH RETURN VALUES
  86 .sp
  87 .LP
  88 Upon successful completions, \fBlisten()\fR returns 0.  Otherwise, \(mi1 is
  89 returned and \fBerrno\fR is set to indicate the error.
  90 .SH ERRORS
  91 .sp
  92 .LP
  93 The \fBlisten()\fR function will fail if:
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBEBADF\fR\fR
  98 .ad
  99 .RS 16n
 100 The \fIsocket\fR argument is not a valid file descriptor.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBEDESTADDRREQ\fR\fR
 107 .ad
 108 .RS 16n
 109 The socket is not bound to a local address, and the protocol does not support
 110 listening on an unbound socket.
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fBEINVAL\fR\fR
 117 .ad
 118 .RS 16n
 119 The \fIsocket\fR is already connected.
 120 .RE
 121
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fBENOTSOCK\fR\fR
 126 .ad
 127 .RS 16n
 128 The \fIsocket\fR argument does not refer to a socket.
 129 .RE
 130
 131 .sp
 132 .ne 2
 133 .na
 134 \fB\fBEOPNOTSUPP\fR\fR
 135 .ad
 136 .RS 16n
 137 The socket protocol does not support \fBlisten()\fR.
 138 .RE
 139
 140 .sp
 141 .LP
 142 The \fBlisten()\fR function may fail if:
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fBEACCES\fR\fR
 147 .ad
 148 .RS 11n
 149 The calling process does not have the appropriate privileges.
 150 .RE
 151
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fBEINVAL\fR\fR
 156 .ad
 157 .RS 11n
 158 The \fIsocket\fR has been shut down.
 159 .RE
 160
 161 .sp
 162 .ne 2
 163 .na
 164 \fB\fBENOBUFS\fR\fR
 165 .ad
 166 .RS 11n
 167 Insufficient resources are available in the system to complete the call.
 168 .RE
 169
 170 .SH ATTRIBUTES
 171 .sp
 172 .LP
 173 See \fBattributes\fR(5) for descriptions of the following attributes:
 174 .sp
 175
 176 .sp
 177 .TS
 178 box;
 179 c | c
 180 l | l .
 181 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 182 _
 183 Interface Stability     Standard
 184 _
 185 MT-Level        MT-Safe
 186 .TE
 187
 188 .SH SEE ALSO
 189 .sp
 190 .LP
 191 \fBaccept\fR(3XNET), \fBconnect\fR(3XNET), \fBsocket\fR(3XNET),
 192 \fBattributes\fR(5), \fBstandards\fR(5)