xnu-1228.9.59.tar.gz

[apple/xnu.git] / bsd / man / man2 / poll.2

diff --git a/bsd/man/man2/poll.2 b/bsd/man/man2/poll.2
index 7bae4dda400e3fbb15d8a91c62e276c391a9d607..c0da7211029fb3cfc54ffd52e22bca4d68491791 100644 (file)
--- a/bsd/man/man2/poll.2
+++ b/bsd/man/man2/poll.2
@@ -1,7 +1,7 @@
 .\"
 .\" Copyright (c) 2005 Apple Computer, Inc. All rights reserved.
 .\"
 .\"
 .\" Copyright (c) 2005 Apple Computer, Inc. All rights reserved.
 .\"

-.\" @APPLE_OSREFERENCE_LICENSE_HEADER_START@
+.\" @APPLE_LICENSE_HEADER_START@

 .\"
 .\" This file contains Original Code and/or Modifications of Original Code
 .\" as defined in and that are subject to the Apple Public Source License
 .\"
 .\" This file contains Original Code and/or Modifications of Original Code
 .\" as defined in and that are subject to the Apple Public Source License


@@ -18,7 +18,7 @@
 .\" Please see the License for the specific language governing rights and
 .\" limitations under the License.
 .\"
 .\" Please see the License for the specific language governing rights and
 .\" limitations under the License.
 .\"

-.\" @APPLE_OSREFERENCE_LICENSE_HEADER_END@
+.\" @APPLE_LICENSE_HEADER_END@

 .\"
 .\"
 .\" Copyright (c) 1996 Charles M. Hannum.  All rights reserved.
 .\"
 .\"
 .\" Copyright (c) 1996 Charles M. Hannum.  All rights reserved.


@@ -57,18 +57,24 @@
 .Sh SYNOPSIS
 .In poll.h
 .Ft int
 .Sh SYNOPSIS
 .In poll.h
 .Ft int

-.Fn poll "struct pollfd *fds" "nfds_t nfds" "int timeout"
+.Fo poll
+.Fa "struct pollfd fds[]"
+.Fa "nfds_t nfds"
+.Fa "int timeout"
+.Fc

 .Sh DESCRIPTION
 .Fn Poll
 .Sh DESCRIPTION
 .Fn Poll

-examines a set of file descriptors to see if some of them are ready for
-I/O or if certain events have occurred on them.
+examines a set of file descriptors
+to see if some of them are ready for I/O
+or if certain events have occurred on them.

 The
 .Fa fds
 The
 .Fa fds

-argument is a pointer to an array of pollfd structures as defined in
+argument is a pointer to an array of pollfd structures,
+as defined in

 .Aq Pa poll.h
 (shown below).  The
 .Fa nfds
 .Aq Pa poll.h
 (shown below).  The
 .Fa nfds

-argument determines the size of the
+argument specifies the size of the

 .Fa fds
 array.
 .Bd -literal
 .Fa fds
 array.
 .Bd -literal


@@ -82,7 +88,7 @@ struct pollfd {
 The fields of
 .Fa struct pollfd
 are as follows:
 The fields of
 .Fa struct pollfd
 are as follows:

-.Bl -tag -width XXXrevents
+.Bl -tag -width XXXPOLLWRNORM

 .It fd
 File descriptor to poll.
 .It events
 .It fd
 File descriptor to poll.
 .It events


@@ -97,49 +103,63 @@ and
 .Fa revents
 have the following bits:
 .Bl -tag -width XXXPOLLWRNORM
 .Fa revents
 have the following bits:
 .Bl -tag -width XXXPOLLWRNORM

-.It POLLIN
-Data other than high priority data may be read without blocking.
-This is equivalent to ( POLLRDNORM | POLLRDBAND ).
-.It POLLRDNORM
-Normal data may be read without blocking.
-.It POLLRDBAND
-Priority data may be read without blocking.
-.It POLLPRI
-High priority data may be read without blocking.
-.It POLLOUT
-.It POLLWRNORM
-Normal data may be written without blocking.
-.It POLLWRBAND
-Priority data may be written without blocking.
+.\" ===========

 .It POLLERR
 .It POLLERR

-An exceptional condition has occurred on the device or socket.  This
-flag is output only, and ignored if present in the input
+An exceptional condition has occurred on the device or socket.
+This flag is output only, and ignored if present in the input

 .Fa events
 bitmask.
 .Fa events
 bitmask.

+.\" ===========

 .It POLLHUP
 .It POLLHUP

-The device or socket has been disconnected.  This flag is output only,
+The device or socket has been disconnected.
+This flag is output only,

 and ignored if present in the input
 .Fa events
 and ignored if present in the input
 .Fa events

-bitmask.  Note that
-POLLHUP
-and
-POLLOUT
+bitmask.
+Note that POLLHUP and POLLOUT

 are mutually exclusive and should never be present in the
 .Fa revents
 bitmask at the same time.
 are mutually exclusive and should never be present in the
 .Fa revents
 bitmask at the same time.

+.\" ===========
+.It POLLIN
+Data other than high priority data may be read without blocking.
+This is equivalent to ( POLLRDNORM | POLLRDBAND ).
+.\" ===========

 .It POLLNVAL
 .It POLLNVAL

-The file descriptor is not open.  This flag is output only, and ignored if present in the input
+The file descriptor is not open.
+This flag is output only, and ignored if present in the input

 .Fa events
 bitmask.
 .Fa events
 bitmask.

+.\" ===========
+.It POLLOUT
+Normal data may be written without blocking.
+This is equivalent to POLLWRNORM.
+.\" ===========
+.It POLLPRI
+High priority data may be read without blocking.
+.\" ===========
+.It POLLRDBAND
+Priority data may be read without blocking.
+.\" ===========
+.It POLLRDNORM
+Normal data may be read without blocking.
+.\" ===========
+.It POLLWRBAND
+Priority data may be written without blocking.
+.\" ===========
+.It POLLWRNORM
+Normal data may be written without blocking.

 .El
 .Pp
 .El
 .Pp

-The distinction between normal, priority, and high-priority data is file type
-or device specific.
+The distinction between normal, priority, and high-priority data
+is specific to particular file types or devices.

 .Pp
 If
 .Fa timeout
 .Pp
 If
 .Fa timeout

-is greater than zero, it specifies a maximum interval to
-wait for any file descriptor to become ready, in milliseconds.  If
+is greater than zero,
+it specifies a maximum interval (in milliseconds)
+to wait for any file descriptor to become ready.
+If

 .Fa timeout
 is zero, then
 .Fn poll
 .Fa timeout
 is zero, then
 .Fn poll


@@ -148,8 +168,9 @@ will return without blocking. If the value of
 is -1, the poll blocks indefinitely.
 .Sh RETURN VALUES
 .Fn Poll
 is -1, the poll blocks indefinitely.
 .Sh RETURN VALUES
 .Fn Poll

-returns the number of descriptors that are ready for I/O, or -1 if an
-error occured.  If the time limit expires,
+returns the number of descriptors that are ready for I/O,
+or -1 if an error occurred.
+If the time limit expires,

 .Fn poll
 returns 0.
 If
 .Fn poll
 returns 0.
 If


@@ -158,22 +179,30 @@ returns with an error,
 including one due to an interrupted call,
 the
 .Fa fds
 including one due to an interrupted call,
 the
 .Fa fds

-array will be unmodified.
+array will be unmodified and the global variable
+.Va errno
+will be set to indicate the error.

 .Sh ERRORS
 .Sh ERRORS

-An error return from
-.Fn poll
-indicates:
+.Fn Poll
+will fail if:

 .Bl -tag -width Er
 .Bl -tag -width Er

+.\" ===========
+.It Bq Er EAGAIN
+Allocation of internal data structures fails.
+A subsequent request may succeed.
+.\" ===========

 .It Bq Er EFAULT
 .Fa Fds
 points outside the process's allocated address space.
 .It Bq Er EFAULT
 .Fa Fds
 points outside the process's allocated address space.

+.\" ===========

 .It Bq Er EINTR
 .It Bq Er EINTR

-A signal was delivered before the time limit expired and
-before any of the selected events occurred.
+A signal is delivered before the time limit expires
+and before any of the selected events occurs.
+.\" ===========

 .It Bq Er EINVAL
 The
 .Fa nfds
 .It Bq Er EINVAL
 The
 .Fa nfds

-argument is greater than OPEN_MAX, or the
+argument is greater than OPEN_MAX or the

 .Fa timeout
 argument is less than -1.
 .El
 .Fa timeout
 argument is less than -1.
 .El


@@ -195,4 +224,3 @@ The
 .Fn poll
 function call appeared in
 .At V .
 .Fn poll
 function call appeared in
 .At V .

-