usr/src/man/man3head/poll.h.3head

   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) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH POLL.H 3HEAD "Sep 9, 2004"
  47 .SH NAME
  48 poll.h, poll \- definitions for the \fBpoll()\fR function
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <\fBpoll.h\fR>
  53 .fi
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The <\fBpoll.h\fR> header defines the \fBpollfd\fR structure, which includes
  59 the following members:
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBint fd\fR\fR
  64 .ad
  65 .RS 17n
  66 the following descriptor being polled
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBshort events\fR\fR
  73 .ad
  74 .RS 17n
  75 the input event flags (see below)
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBshort revents\fR\fR
  82 .ad
  83 .RS 17n
  84 the output event flags (see below)
  85 .RE
  86
  87 .sp
  88 .LP
  89 The <\fBpoll.h\fR> header defines the following type through \fBtypedef\fR:
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBnfds_t\fR\fR
  94 .ad
  95 .RS 10n
  96 an unsigned integer type used for the number of file descriptors
  97 .RE
  98
  99 .sp
 100 .LP
 101 The implementation supports one or more programming environments in which the
 102 width of \fBnfds_t\fR is no greater than the width of type long. The names of
 103 these programming environments can be obtained using the \fBconfstr()\fR
 104 function or the \fBgetconf\fR utility. See \fBconfstr\fR(3C) and
 105 \fBgetconf\fR(1).
 106 .sp
 107 .LP
 108 The following symbolic constants are defined, zero or more of which can be
 109 OR'ed together to form the \fBevents\fR or \fBrevents\fR members  in the
 110 \fBpollfd\fR structure:
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBPOLLIN\fR\fR
 115 .ad
 116 .RS 14n
 117 Data other than high-priority data can be read without blocking.
 118 .RE
 119
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fBPOLLRDNORM\fR\fR
 124 .ad
 125 .RS 14n
 126 Normal data can be read without blocking.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fBPOLLRDBAND\fR\fR
 133 .ad
 134 .RS 14n
 135 Priority data can be read without blocking.
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fBPOLLPRI\fR\fR
 142 .ad
 143 .RS 14n
 144 High priority data can be read without blocking.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fBPOLLOUT\fR\fR
 151 .ad
 152 .RS 14n
 153 Normal data can be written without blocking.
 154 .RE
 155
 156 .sp
 157 .ne 2
 158 .na
 159 \fB\fBPOLLWRNORM\fR\fR
 160 .ad
 161 .RS 14n
 162 Equivalent to \fBPOLLOUT\fR.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fBPOLLWRBAND\fR\fR
 169 .ad
 170 .RS 14n
 171 Priority data can be written.
 172 .RE
 173
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fBPOLLERR\fR\fR
 178 .ad
 179 .RS 14n
 180 An error has occurred (\fBrevents\fR only).
 181 .RE
 182
 183 .sp
 184 .ne 2
 185 .na
 186 \fB\fBPOLLHUP\fR\fR
 187 .ad
 188 .RS 14n
 189 Device has been disconnected (\fBrevents\fR only).
 190 .RE
 191
 192 .sp
 193 .ne 2
 194 .na
 195 \fB\fBPOLLNVAL\fR\fR
 196 .ad
 197 .RS 14n
 198 Invalid \fBfd\fR member (\fBrevents\fR only).
 199 .RE
 200
 201 .sp
 202 .LP
 203 The significance and semantics of normal, priority, and high-priority data are
 204 file and device-specific.
 205 .SH ATTRIBUTES
 206 .sp
 207 .LP
 208 See \fBattributes\fR(5) for descriptions of the following attributes:
 209 .sp
 210
 211 .sp
 212 .TS
 213 box;
 214 c | c
 215 l | l .
 216 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 217 _
 218 Interface Stability     Standard
 219 .TE
 220
 221 .SH SEE ALSO
 222 .sp
 223 .LP
 224 \fBgetconf\fR(1), \fBpoll\fR(2), \fBconfstr\fR(3C), \fBattributes\fR(5),
 225 \fBstandards\fR(5)