xref: /xnu-11417.140.69/bsd/sys/poll.h (revision 43a90889846e00bfb5cf1d255cdc0a701a1e05a4)
1*43a90889SApple OSS Distributions /*
2*43a90889SApple OSS Distributions  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
3*43a90889SApple OSS Distributions  *
4*43a90889SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*43a90889SApple OSS Distributions  *
6*43a90889SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*43a90889SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*43a90889SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*43a90889SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*43a90889SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*43a90889SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*43a90889SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*43a90889SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*43a90889SApple OSS Distributions  *
15*43a90889SApple OSS Distributions  * Please obtain a copy of the License at
16*43a90889SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*43a90889SApple OSS Distributions  *
18*43a90889SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*43a90889SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*43a90889SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*43a90889SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*43a90889SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*43a90889SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*43a90889SApple OSS Distributions  * limitations under the License.
25*43a90889SApple OSS Distributions  *
26*43a90889SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*43a90889SApple OSS Distributions  */
28*43a90889SApple OSS Distributions /*-
29*43a90889SApple OSS Distributions  * Copyright (c) 1997 Peter Wemm <[email protected]>
30*43a90889SApple OSS Distributions  * All rights reserved.
31*43a90889SApple OSS Distributions  *
32*43a90889SApple OSS Distributions  * Redistribution and use in source and binary forms, with or without
33*43a90889SApple OSS Distributions  * modification, are permitted provided that the following conditions
34*43a90889SApple OSS Distributions  * are met:
35*43a90889SApple OSS Distributions  * 1. Redistributions of source code must retain the above copyright
36*43a90889SApple OSS Distributions  *    notice, this list of conditions and the following disclaimer.
37*43a90889SApple OSS Distributions  * 2. Redistributions in binary form must reproduce the above copyright
38*43a90889SApple OSS Distributions  *    notice, this list of conditions and the following disclaimer in the
39*43a90889SApple OSS Distributions  *    documentation and/or other materials provided with the distribution.
40*43a90889SApple OSS Distributions  * 3. The name of the author may not be used to endorse or promote products
41*43a90889SApple OSS Distributions  *    derived from this software without specific prior written permission.
42*43a90889SApple OSS Distributions  *
43*43a90889SApple OSS Distributions  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
44*43a90889SApple OSS Distributions  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45*43a90889SApple OSS Distributions  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
46*43a90889SApple OSS Distributions  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
47*43a90889SApple OSS Distributions  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
48*43a90889SApple OSS Distributions  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
49*43a90889SApple OSS Distributions  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
50*43a90889SApple OSS Distributions  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
51*43a90889SApple OSS Distributions  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
52*43a90889SApple OSS Distributions  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53*43a90889SApple OSS Distributions  * SUCH DAMAGE.
54*43a90889SApple OSS Distributions  *
55*43a90889SApple OSS Distributions  */
56*43a90889SApple OSS Distributions 
57*43a90889SApple OSS Distributions #ifndef _SYS_POLL_H_
58*43a90889SApple OSS Distributions #define _SYS_POLL_H_
59*43a90889SApple OSS Distributions 
60*43a90889SApple OSS Distributions /*
61*43a90889SApple OSS Distributions  * This file is intended to be compatible with the traditional poll.h.
62*43a90889SApple OSS Distributions  */
63*43a90889SApple OSS Distributions 
64*43a90889SApple OSS Distributions /*
65*43a90889SApple OSS Distributions  * Requestable events.  If poll(2) finds any of these set, they are
66*43a90889SApple OSS Distributions  * copied to revents on return.
67*43a90889SApple OSS Distributions  */
68*43a90889SApple OSS Distributions #define POLLIN          0x0001          /* any readable data available */
69*43a90889SApple OSS Distributions #define POLLPRI         0x0002          /* OOB/Urgent readable data */
70*43a90889SApple OSS Distributions #define POLLOUT         0x0004          /* file descriptor is writeable */
71*43a90889SApple OSS Distributions #define POLLRDNORM      0x0040          /* non-OOB/URG data available */
72*43a90889SApple OSS Distributions #define POLLWRNORM      POLLOUT         /* no write type differentiation */
73*43a90889SApple OSS Distributions #define POLLRDBAND      0x0080          /* OOB/Urgent readable data */
74*43a90889SApple OSS Distributions #define POLLWRBAND      0x0100          /* OOB/Urgent data can be written */
75*43a90889SApple OSS Distributions 
76*43a90889SApple OSS Distributions /*
77*43a90889SApple OSS Distributions  * FreeBSD extensions: polling on a regular file might return one
78*43a90889SApple OSS Distributions  * of these events (currently only supported on local filesystems).
79*43a90889SApple OSS Distributions  */
80*43a90889SApple OSS Distributions #define POLLEXTEND      0x0200          /* file may have been extended */
81*43a90889SApple OSS Distributions #define POLLATTRIB      0x0400          /* file attributes may have changed */
82*43a90889SApple OSS Distributions #define POLLNLINK       0x0800          /* (un)link/rename may have happened */
83*43a90889SApple OSS Distributions #define POLLWRITE       0x1000          /* file's contents may have changed */
84*43a90889SApple OSS Distributions 
85*43a90889SApple OSS Distributions /*
86*43a90889SApple OSS Distributions  * These events are set if they occur regardless of whether they were
87*43a90889SApple OSS Distributions  * requested.
88*43a90889SApple OSS Distributions  */
89*43a90889SApple OSS Distributions #define POLLERR         0x0008          /* some poll error occurred */
90*43a90889SApple OSS Distributions #define POLLHUP         0x0010          /* file descriptor was "hung up" */
91*43a90889SApple OSS Distributions #define POLLNVAL        0x0020          /* requested events "invalid" */
92*43a90889SApple OSS Distributions 
93*43a90889SApple OSS Distributions #define POLLSTANDARD    (POLLIN|POLLPRI|POLLOUT|POLLRDNORM|POLLRDBAND|\
94*43a90889SApple OSS Distributions 	                 POLLWRBAND|POLLERR|POLLHUP|POLLNVAL)
95*43a90889SApple OSS Distributions 
96*43a90889SApple OSS Distributions struct pollfd {
97*43a90889SApple OSS Distributions 	int     fd;
98*43a90889SApple OSS Distributions 	short   events;
99*43a90889SApple OSS Distributions 	short   revents;
100*43a90889SApple OSS Distributions };
101*43a90889SApple OSS Distributions 
102*43a90889SApple OSS Distributions typedef unsigned int nfds_t;
103*43a90889SApple OSS Distributions 
104*43a90889SApple OSS Distributions #if !defined(KERNEL)
105*43a90889SApple OSS Distributions 
106*43a90889SApple OSS Distributions #include <sys/cdefs.h>
107*43a90889SApple OSS Distributions 
108*43a90889SApple OSS Distributions __BEGIN_DECLS
109*43a90889SApple OSS Distributions 
110*43a90889SApple OSS Distributions /*
111*43a90889SApple OSS Distributions  * This is defined here (instead of <poll.h>) because this is where
112*43a90889SApple OSS Distributions  * traditional SVR4 code will look to find it.
113*43a90889SApple OSS Distributions  */
114*43a90889SApple OSS Distributions extern int poll(struct pollfd *, nfds_t, int) __DARWIN_ALIAS_C(poll);
115*43a90889SApple OSS Distributions 
116*43a90889SApple OSS Distributions __END_DECLS
117*43a90889SApple OSS Distributions 
118*43a90889SApple OSS Distributions #endif /* !KERNEL */
119*43a90889SApple OSS Distributions 
120*43a90889SApple OSS Distributions #endif /* !_SYS_POLL_H_ */
121