bsd/sys/poll.h

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