1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
.\"
.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
.\" permission to reproduce portions of its copyrighted documentation.
.\" Original documentation from The Open Group can be obtained online at
.\" http://www.opengroup.org/bookstore/.
.\"
.\" The Institute of Electrical and Electronics Engineers and The Open
.\" Group, have given us permission to reprint portions of their
.\" documentation.
.\"
.\" In the following statement, the phrase ``this text'' refers to portions
.\" of the system documentation.
.\"
.\" Portions of this text are reprinted and reproduced in electronic form
.\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
.\" Standard for Information Technology -- Portable Operating System
.\" Interface (POSIX), The Open Group Base Specifications Issue 6,
.\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
.\" Engineers, Inc and The Open Group. In the event of any discrepancy
.\" between these versions and the original IEEE and The Open Group
.\" Standard, the original IEEE and The Open Group Standard is the referee
.\" document. The original Standard can be obtained online at
.\" http://www.opengroup.org/unix/online.html.
.\"
.\" This notice shall appear on any product containing this material.
.\"
.\" The contents of this file are subject to the terms of the
.\" Common Development and Distribution License (the "License").
.\" You may not use this file except in compliance with the License.
.\"
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
.\" or http://www.opensolaris.org/os/licensing.
.\" See the License for the specific language governing permissions
.\" and limitations under the License.
.\"
.\" When distributing Covered Code, include this CDDL HEADER in each
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
.\" If applicable, add the following below this CDDL HEADER, with the
.\" fields enclosed by brackets "[]" replaced with your own identifying
.\" information: Portions Copyright [yyyy] [name of copyright owner]
.\"
.\"
.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
.\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
.\"
.TH POLL.H 3HEAD "Sep 9, 2004"
.SH NAME
poll.h, poll \- definitions for the \fBpoll()\fR function
.SH SYNOPSIS
.LP
.nf
#include <\fBpoll.h\fR>
.fi
.SH DESCRIPTION
.sp
.LP
The <\fBpoll.h\fR> header defines the \fBpollfd\fR structure, which includes
the following members:
.sp
.ne 2
.na
\fB\fBint fd\fR\fR
.ad
.RS 17n
the following descriptor being polled
.RE
.sp
.ne 2
.na
\fB\fBshort events\fR\fR
.ad
.RS 17n
the input event flags (see below)
.RE
.sp
.ne 2
.na
\fB\fBshort revents\fR\fR
.ad
.RS 17n
the output event flags (see below)
.RE
.sp
.LP
The <\fBpoll.h\fR> header defines the following type through \fBtypedef\fR:
.sp
.ne 2
.na
\fB\fBnfds_t\fR\fR
.ad
.RS 10n
an unsigned integer type used for the number of file descriptors
.RE
.sp
.LP
The implementation supports one or more programming environments in which the
width of \fBnfds_t\fR is no greater than the width of type long. The names of
these programming environments can be obtained using the \fBconfstr()\fR
function or the \fBgetconf\fR utility. See \fBconfstr\fR(3C) and
\fBgetconf\fR(1).
.sp
.LP
The following symbolic constants are defined, zero or more of which can be
OR'ed together to form the \fBevents\fR or \fBrevents\fR members in the
\fBpollfd\fR structure:
.sp
.ne 2
.na
\fB\fBPOLLIN\fR\fR
.ad
.RS 14n
Data other than high-priority data can be read without blocking.
.RE
.sp
.ne 2
.na
\fB\fBPOLLRDNORM\fR\fR
.ad
.RS 14n
Normal data can be read without blocking.
.RE
.sp
.ne 2
.na
\fB\fBPOLLRDBAND\fR\fR
.ad
.RS 14n
Priority data can be read without blocking.
.RE
.sp
.ne 2
.na
\fB\fBPOLLPRI\fR\fR
.ad
.RS 14n
High priority data can be read without blocking.
.RE
.sp
.ne 2
.na
\fB\fBPOLLOUT\fR\fR
.ad
.RS 14n
Normal data can be written without blocking.
.RE
.sp
.ne 2
.na
\fB\fBPOLLWRNORM\fR\fR
.ad
.RS 14n
Equivalent to \fBPOLLOUT\fR.
.RE
.sp
.ne 2
.na
\fB\fBPOLLWRBAND\fR\fR
.ad
.RS 14n
Priority data can be written.
.RE
.sp
.ne 2
.na
\fB\fBPOLLERR\fR\fR
.ad
.RS 14n
An error has occurred (\fBrevents\fR only).
.RE
.sp
.ne 2
.na
\fB\fBPOLLHUP\fR\fR
.ad
.RS 14n
Device has been disconnected (\fBrevents\fR only).
.RE
.sp
.ne 2
.na
\fB\fBPOLLNVAL\fR\fR
.ad
.RS 14n
Invalid \fBfd\fR member (\fBrevents\fR only).
.RE
.sp
.LP
The significance and semantics of normal, priority, and high-priority data are
file and device-specific.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE ATTRIBUTE VALUE
_
Interface Stability Standard
.TE
.SH SEE ALSO
.sp
.LP
\fBgetconf\fR(1), \fBpoll\fR(2), \fBconfstr\fR(3C), \fBattributes\fR(5),
\fBstandards\fR(5)
|
