other-licenses/android/eventlib.h

   1 /*      $NetBSD: eventlib.h,v 1.1.1.3 2005/12/21 23:15:22 christos Exp $        */
   2
   3 /*
   4  * Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
   5  * Copyright (c) 1995-1999 by Internet Software Consortium
   6  *
   7  * Permission to use, copy, modify, and distribute this software for any
   8  * purpose with or without fee is hereby granted, provided that the above
   9  * copyright notice and this permission notice appear in all copies.
  10  *
  11  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES
  12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  13  * MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR
  14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
  17  * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  18  */
  19
  20 /* eventlib.h - exported interfaces for eventlib
  21  * vix 09sep95 [initial]
  22  *
  23  * Id: eventlib.h,v 1.1.2.1.4.2 2005/07/28 07:43:18 marka Exp
  24  */
  25
  26 /*
  27  * This version of this file is derived from Android 2.3 "Gingerbread",
  28  * which contains uncredited changes by Android/Google developers.  It has
  29  * been modified in 2011 for use in the Android build of Mozilla Firefox by
  30  * Mozilla contributors (including Michael Edwards <m.k.edwards@gmail.com>,
  31  * and Steve Workman <sjhworkman@gmail.com>).
  32  * These changes are offered under the same license as the original NetBSD
  33  * file, whose copyright and license are unchanged above.
  34  */
  35
  36 #ifndef _EVENTLIB_H
  37 #define _EVENTLIB_H
  38
  39 #include <sys/types.h>
  40 #include <sys/uio.h>
  41 #include <sys/time.h>
  42 #include <stdio.h>
  43
  44 #ifndef __P
  45 # define __EVENTLIB_P_DEFINED
  46 # ifdef __STDC__
  47 #  define __P(x) x
  48 # else
  49 #  define __P(x) ()
  50 # endif
  51 #endif
  52
  53 /* In the absence of branded types... */
  54 typedef struct { void *opaque; } evConnID;
  55 typedef struct { void *opaque; } evFileID;
  56 typedef struct { void *opaque; } evStreamID;
  57 typedef struct { void *opaque; } evTimerID;
  58 typedef struct { void *opaque; } evWaitID;
  59 typedef struct { void *opaque; } evContext;
  60 typedef struct { void *opaque; } evEvent;
  61
  62 #define evInitID(id) ((id)->opaque = NULL)
  63 #define evTestID(id) ((id).opaque != NULL)
  64
  65 typedef void (*evConnFunc)__P((evContext, void *, int, const void *, int,
  66                                const void *, int));
  67 typedef void (*evFileFunc)__P((evContext, void *, int, int));
  68 typedef void (*evStreamFunc)__P((evContext, void *, int, int));
  69 typedef void (*evTimerFunc)__P((evContext, void *,
  70                                 struct timespec, struct timespec));
  71 typedef void (*evWaitFunc)__P((evContext, void *, const void *));
  72
  73 typedef struct { unsigned char mask[256/8]; } evByteMask;
  74 #define EV_BYTEMASK_BYTE(b) ((b) / 8)
  75 #define EV_BYTEMASK_MASK(b) (1 << ((b) % 8))
  76 #define EV_BYTEMASK_SET(bm, b) \
  77         ((bm).mask[EV_BYTEMASK_BYTE(b)] |= EV_BYTEMASK_MASK(b))
  78 #define EV_BYTEMASK_CLR(bm, b) \
  79         ((bm).mask[EV_BYTEMASK_BYTE(b)] &= ~EV_BYTEMASK_MASK(b))
  80 #define EV_BYTEMASK_TST(bm, b) \
  81         ((bm).mask[EV_BYTEMASK_BYTE(b)] & EV_BYTEMASK_MASK(b))
  82
  83 #define EV_POLL         1
  84 #define EV_WAIT         2
  85 #define EV_NULL         4
  86
  87 #define EV_READ         1
  88 #define EV_WRITE        2
  89 #define EV_EXCEPT       4
  90
  91 #define EV_WASNONBLOCKING 8     /* Internal library use. */
  92
  93 /* eventlib.c */
  94 #define evCreate        __evCreate
  95 #define evSetDebug      __evSetDebug
  96 #define evDestroy       __evDestroy
  97 #define evGetNext       __evGetNext
  98 #define evDispatch      __evDispatch
  99 #define evDrop          __evDrop
 100 #define evMainLoop      __evMainLoop
 101 #define evHighestFD     __evHighestFD
 102 #define evGetOption     __evGetOption
 103 #define evSetOption     __evSetOption
 104
 105 int  evCreate __P((evContext *));
 106 void evSetDebug __P((evContext, int, FILE *));
 107 int  evDestroy __P((evContext));
 108 int  evGetNext __P((evContext, evEvent *, int));
 109 int  evDispatch __P((evContext, evEvent));
 110 void evDrop __P((evContext, evEvent));
 111 int  evMainLoop __P((evContext));
 112 int  evHighestFD __P((evContext));
 113 int  evGetOption __P((evContext *, const char *, int *));
 114 int  evSetOption __P((evContext *, const char *, int));
 115
 116 /* ev_connects.c */
 117 #define evListen        __evListen
 118 #define evConnect       __evConnect
 119 #define evCancelConn    __evCancelConn
 120 #define evHold          __evHold
 121 #define evUnhold        __evUnhold
 122 #define evTryAccept     __evTryAccept
 123
 124 int evListen __P((evContext, int, int, evConnFunc, void *, evConnID *));
 125 int evConnect __P((evContext, int, const void *, int,
 126                    evConnFunc, void *, evConnID *));
 127 int evCancelConn __P((evContext, evConnID));
 128 int evHold __P((evContext, evConnID));
 129 int evUnhold __P((evContext, evConnID));
 130 int evTryAccept __P((evContext, evConnID, int *));
 131
 132 /* ev_files.c */
 133 #define evSelectFD      __evSelectFD
 134 #define evDeselectFD    __evDeselectFD
 135
 136 int evSelectFD __P((evContext, int, int, evFileFunc, void *, evFileID *));
 137 int evDeselectFD __P((evContext, evFileID));
 138
 139 /* ev_streams.c */
 140 #define evConsIovec     __evConsIovec
 141 #define evWrite         __evWrite
 142 #define evRead          __evRead
 143 #define evTimeRW        __evTimeRW
 144 #define evUntimeRW      __evUntimeRW
 145 #define evCancelRW      __evCancelRW
 146
 147 struct iovec evConsIovec __P((void *, size_t));
 148 int evWrite __P((evContext, int, const struct iovec *, int,
 149                  evStreamFunc func, void *, evStreamID *));
 150 int evRead __P((evContext, int, const struct iovec *, int,
 151                 evStreamFunc func, void *, evStreamID *));
 152 int evTimeRW __P((evContext, evStreamID, evTimerID timer));
 153 int evUntimeRW __P((evContext, evStreamID));
 154 int evCancelRW __P((evContext, evStreamID));
 155
 156 /* ev_timers.c */
 157 #define evConsTime      __evConsTime
 158 #define evAddTime       __evAddTime
 159 #define evSubTime       __evSubTime
 160 #define evCmpTime       __evCmpTime
 161 #define evTimeSpec      __evTimeSpec
 162 #define evTimeVal       __evTimeVal
 163
 164 #define evNowTime               __evNowTime
 165 #define evUTCTime               __evUTCTime
 166 #define evLastEventTime         __evLastEventTime
 167 #define evSetTimer              __evSetTimer
 168 #define evClearTimer            __evClearTimer
 169 #define evConfigTimer           __evConfigTimer
 170 #define evResetTimer            __evResetTimer
 171 #define evSetIdleTimer          __evSetIdleTimer
 172 #define evClearIdleTimer        __evClearIdleTimer
 173 #define evResetIdleTimer        __evResetIdleTimer
 174 #define evTouchIdleTimer        __evTouchIdleTimer
 175
 176 struct timespec evConsTime __P((time_t sec, long nsec));
 177 struct timespec evAddTime __P((struct timespec, struct timespec));
 178 struct timespec evSubTime __P((struct timespec, struct timespec));
 179 struct timespec evNowTime __P((void));
 180 struct timespec evUTCTime __P((void));
 181 struct timespec evLastEventTime __P((evContext));
 182 struct timespec evTimeSpec __P((struct timeval));
 183 struct timeval evTimeVal __P((struct timespec));
 184 int evCmpTime __P((struct timespec, struct timespec));
 185 int evSetTimer __P((evContext, evTimerFunc, void *, struct timespec,
 186                     struct timespec, evTimerID *));
 187 int evClearTimer __P((evContext, evTimerID));
 188 int evConfigTimer __P((evContext, evTimerID, const char *param,
 189                       int value));
 190 int evResetTimer __P((evContext, evTimerID, evTimerFunc, void *,
 191                       struct timespec, struct timespec));
 192 int evSetIdleTimer __P((evContext, evTimerFunc, void *, struct timespec,
 193                         evTimerID *));
 194 int evClearIdleTimer __P((evContext, evTimerID));
 195 int evResetIdleTimer __P((evContext, evTimerID, evTimerFunc, void *,
 196                           struct timespec));
 197 int evTouchIdleTimer __P((evContext, evTimerID));
 198
 199 /* ev_waits.c */
 200 #define evWaitFor       __evWaitFor
 201 #define evDo            __evDo
 202 #define evUnwait        __evUnwait
 203 #define evDefer         __evDefer
 204
 205 int evWaitFor __P((evContext, const void *, evWaitFunc, void *, evWaitID *));
 206 int evDo __P((evContext, const void *));
 207 int evUnwait __P((evContext, evWaitID));
 208 int evDefer __P((evContext, evWaitFunc, void *));
 209
 210 #ifdef __EVENTLIB_P_DEFINED
 211 # undef __P
 212 #endif
 213
 214 #endif /*_EVENTLIB_H*/