bsd/sys/poll.h

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