1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)select.2 8.2 (Berkeley) 3/25/94
33 .\" $FreeBSD: src/lib/libc/sys/select.2,v 1.14.2.5 2001/12/14 18:34:01 ru Exp $
34 .\" $DragonFly: src/lib/libc/sys/select.2,v 1.7 2006/05/26 19:39:37 swildner Exp $
41 .Nd synchronous I/O multiplexing
49 .Fn select "int nfds" "fd_set *readfds" "fd_set *writefds" "fd_set *exceptfds" "struct timeval *timeout"
52 .Fn FD_ISSET fd &fdset
56 examines the I/O descriptor sets whose addresses are passed in
61 to see if some of their descriptors
62 are ready for reading, are ready for writing, or have an exceptional
63 condition pending, respectively.
64 The only exceptional condition detectable is out-of-band
65 data received on a socket.
68 descriptors are checked in each set;
69 i.e., the descriptors from 0 through
71 in the descriptor sets are examined.
74 replaces the given descriptor sets
75 with subsets consisting of those descriptors that are ready
76 for the requested operation.
78 returns the total number of ready descriptors in all the sets.
80 The descriptor sets are stored as bit fields in arrays of integers.
81 The following macros are provided for manipulating such descriptor sets:
83 initializes a descriptor set
87 includes a particular descriptor
96 .Fn FD_ISSET fd &fdset
102 The behavior of these macros is undefined if
103 a descriptor value is less than zero or greater than or equal to
105 which is normally at least equal
106 to the maximum number of descriptors supported by the system.
110 is a non-nil pointer, it specifies the maximum interval to wait for the
111 selection to complete. System activity can lengthen the interval by
112 an indeterminate amount.
116 is a nil pointer, the select blocks indefinitely.
118 To effect a poll, the
120 argument should be non-nil, pointing to a zero-valued timeval structure.
127 may be given as nil pointers if no descriptors are of interest.
129 Even if no descriptors are of interest, the timeout works as described,
130 effectively putting the process into an interruptible sleep for the
134 is nil, the process will block until a signal is received.
137 returns the number of ready descriptors that are contained in
139 or -1 if an error occurred.
140 If the time limit expires,
145 returns with an error,
146 including one due to an interrupted call,
147 the descriptor sets will be unmodified.
154 One of the descriptor sets specified an invalid descriptor.
156 A signal was delivered before the time limit expired and
157 before any of the selected events occurred.
159 The specified time limit is invalid. One of its components is
160 negative or too large.
168 .Xr getdtablesize 2 ,
179 In order to accommodate programs which might potentially
180 use a larger number of open files with
183 to increase this size by having the program define
185 before the inclusion of any header which includes
190 is greater than the number of open files,
192 is not guaranteed to examine the unused file descriptors. For historical
195 will always examine the first 256 descriptors.
199 function call appeared in
203 allows systems to modify the original timeout in place.
204 Thus, it is unwise to assume that the timeout value will be unmodified