bsd/sys/poll.h

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