bsd/sys/poll.h

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