bsd/sys/poll.h

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