sys/sys/poll.h

   1 /*-
   2  * Copyright (c) 1997 Peter Wemm <peter@freebsd.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. The name of the author may not be used to endorse or promote products
  14  *    derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD: src/sys/sys/poll.h,v 1.6.2.1 2000/08/21 12:25:58 sheldonh Exp $
  29  */
  30
  31 #ifndef _SYS_POLL_H_
  32 #define _SYS_POLL_H_
  33
  34 /*
  35  * This file is intended to be compatible with the traditional poll.h.
  36  */
  37
  38 typedef unsigned int    nfds_t;
  39
  40 /*
  41  * This structure is passed as an array to poll(2).
  42  */
  43 struct pollfd {
  44         int     fd;             /* which file descriptor to poll */
  45         short   events;         /* events we are interested in */
  46         short   revents;        /* events found on return */
  47 };
  48
  49 /*
  50  * Requestable events.  If poll(2) finds any of these set, they are
  51  * copied to revents on return.
  52  * XXX Note that FreeBSD doesn't make much distinction between POLLPRI
  53  * and POLLRDBAND since none of the file types have distinct priority
  54  * bands - and only some have an urgent "mode".
  55  * XXX Note POLLIN isn't really supported in true SVSV terms.  Under SYSV
  56  * POLLIN includes all of normal, band and urgent data.  Most poll handlers
  57  * on FreeBSD only treat it as "normal" data.
  58  */
  59 #define POLLIN          0x0001          /* any readable data available */
  60 #define POLLPRI         0x0002          /* OOB/Urgent readable data */
  61 #define POLLOUT         0x0004          /* file descriptor is writeable */
  62 #define POLLRDNORM      0x0040          /* non-OOB/URG data available */
  63 #define POLLWRNORM      POLLOUT         /* no write type differentiation */
  64 #define POLLRDBAND      0x0080          /* OOB/Urgent readable data */
  65 #define POLLWRBAND      0x0100          /* OOB/Urgent data can be written */
  66
  67 /*
  68  * These events are set if they occur regardless of whether they were
  69  * requested.
  70  */
  71 #define POLLERR         0x0008          /* some poll error occurred */
  72 #define POLLHUP         0x0010          /* file descriptor was "hung up" */
  73 #define POLLNVAL        0x0020          /* requested events "invalid" */
  74
  75 #define POLLSTANDARD    (POLLIN|POLLPRI|POLLOUT|POLLRDNORM|POLLRDBAND|\
  76                          POLLWRBAND|POLLERR|POLLHUP|POLLNVAL)
  77
  78 /*
  79  * Request that poll() wait forever.
  80  * XXX in SYSV, this is defined in stropts.h, which is not included
  81  * by poll.h.
  82  */
  83 #define INFTIM          (-1)
  84
  85 #ifndef _KERNEL
  86
  87 #include <sys/cdefs.h>
  88
  89 #if __BSD_VISIBLE
  90 #ifndef _SYS_SIGNAL_H_
  91 #include <sys/signal.h>
  92 #endif
  93 #ifndef _SYS_TIME_H_
  94 #include <sys/time.h>
  95 #endif
  96 #endif
  97
  98 __BEGIN_DECLS
  99 /*
 100  * XXX logically, poll() should be declared in <poll.h>, but SVR4 at
 101  * least has it here in <sys/poll.h>.
 102  */
 103 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE
 104 int     poll(struct pollfd *, nfds_t, int);
 105 #endif
 106 #if __BSD_VISIBLE
 107 int     ppoll(struct pollfd *, nfds_t, const struct timespec *,
 108             const sigset_t *);
 109 #endif
 110 __END_DECLS
 111
 112 #endif /* !_KERNEL */
 113
 114 #endif /* !_SYS_POLL_H_ */