xref: /illumos-gate/usr/src/man/man3head/poll.h.3head (revision 4c28a617e3922d92a58e813a5b955eb526b9c386)

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.

POLL.H 3HEAD "Sep 9, 2004"
NAME
poll.h, poll - definitions for the poll() function
SYNOPSIS

#include <poll.h>
DESCRIPTION

The <poll.h> header defines the pollfd structure, which includes the following members: int fd

the following descriptor being polled

short events

the input event flags (see below)

short revents

the output event flags (see below)

The <poll.h> header defines the following type through typedef: nfds_t

an unsigned integer type used for the number of file descriptors

The implementation supports one or more programming environments in which the width of nfds_t is no greater than the width of type long. The names of these programming environments can be obtained using the confstr() function or the getconf utility. See confstr(3C) and getconf(1).

The following symbolic constants are defined, zero or more of which can be OR'ed together to form the events or revents members in the pollfd structure: POLLIN

Data other than high-priority data can be read without blocking.

POLLRDNORM

Normal data can be read without blocking.

POLLRDBAND

Priority data can be read without blocking.

POLLPRI

High priority data can be read without blocking.

POLLOUT

Normal data can be written without blocking.

POLLWRNORM

Equivalent to POLLOUT.

POLLWRBAND

Priority data can be written.

POLLERR

An error has occurred (revents only).

POLLHUP

Device has been disconnected (revents only).

POLLNVAL

Invalid fd member (revents only).

The significance and semantics of normal, priority, and high-priority data are file and device-specific.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
SEE ALSO

getconf(1), poll(2), confstr(3C), attributes(5), standards(5)