ev.h

   1 /*
   2  * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de>
   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 are
   7  * met:
   8  *
   9  *     * Redistributions of source code must retain the above copyright
  10  *       notice, this list of conditions and the following disclaimer.
  11  *
  12  *     * Redistributions in binary form must reproduce the above
  13  *       copyright notice, this list of conditions and the following
  14  *       disclaimer in the documentation and/or other materials provided
  15  *       with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef EV_H
  31 #define EV_H
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 typedef double ev_tstamp;
  38
  39 /* these priorities are inclusive, higher priorities will be called earlier */
  40 #ifndef EV_MINPRI
  41 # define EV_MINPRI -2
  42 #endif
  43 #ifndef EV_MAXPRI
  44 # define EV_MAXPRI +2
  45 #endif
  46
  47 #ifndef EV_MULTIPLICITY
  48 # define EV_MULTIPLICITY 1
  49 #endif
  50
  51 /* support multiple event loops? */
  52 #if EV_MULTIPLICITY
  53 struct ev_loop;
  54 # define EV_P struct ev_loop *loop
  55 # define EV_P_ EV_P,
  56 # define EV_A loop
  57 # define EV_A_ EV_A,
  58 #else
  59 # define EV_P void
  60 # define EV_P_
  61 # define EV_A
  62 # define EV_A_
  63 #endif
  64
  65 /* eventmask, revents, events... */
  66 #define EV_UNDEF          -1 /* guaranteed to be invalid */
  67 #define EV_NONE         0x00
  68 #define EV_READ         0x01
  69 #define EV_WRITE        0x02
  70 #define EV_TIMEOUT  0x000100
  71 #define EV_PERIODIC 0x000200
  72 #define EV_SIGNAL   0x000400
  73 #define EV_IDLE     0x000800
  74 #define EV_CHECK    0x001000
  75 #define EV_PREPARE  0x002000
  76 #define EV_CHILD    0x004000
  77 #define EV_ERROR    0x800000 /* sent when an error occurs */
  78
  79 /* can be used to add custom fields to all watchers */
  80 #ifndef EV_COMMON
  81 # define EV_COMMON void *data
  82 #endif
  83 #ifndef EV_PROTOTYPES
  84 # define EV_PROTOTYPES 1
  85 #endif
  86
  87 #define EV_VERSION_MAJOR 1
  88 #define EV_VERSION_MINOR 1
  89
  90 /*
  91  * struct member types:
  92  * private: you can look at them, but not change them, and they might not mean anything to you.
  93  * ro: can be read anytime, but only changed when the watcher isn't active
  94  * rw: can be read and modified anytime, even when the watcher is active
  95  */
  96
  97 /* shared by all watchers */
  98 #define EV_WATCHER(type)                        \
  99   int active; /* private */                     \
 100   int pending; /* private */                    \
 101   int priority; /* private */                   \
 102   EV_COMMON; /* rw */                           \
 103   void (*cb)(EV_P_ struct type *, int revents) /* private */ /* gets invoked with an eventmask */
 104
 105 #define EV_WATCHER_LIST(type)                   \
 106   EV_WATCHER (type);                            \
 107   struct ev_watcher_list *next /* private */
 108
 109 #define EV_WATCHER_TIME(type)                   \
 110   EV_WATCHER (type);                            \
 111   ev_tstamp at     /* private */
 112
 113 /* base class, nothing to see here unless you subclass */
 114 struct ev_watcher {
 115   EV_WATCHER (ev_watcher);
 116 };
 117
 118 /* base class, nothing to see here unless you subclass */
 119 struct ev_watcher_list {
 120   EV_WATCHER_LIST (ev_watcher_list);
 121 };
 122
 123 /* base class, nothing to see here unless you subclass */
 124 struct ev_watcher_time {
 125   EV_WATCHER_TIME (ev_watcher_time);
 126 };
 127
 128 /* invoked after a specific time, repeatable (based on monotonic clock) */
 129 /* revent EV_TIMEOUT */
 130 struct ev_timer
 131 {
 132   EV_WATCHER_TIME (ev_timer);
 133
 134   ev_tstamp repeat; /* rw */
 135 };
 136
 137 /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
 138 /* revent EV_PERIODIC */
 139 struct ev_periodic
 140 {
 141   EV_WATCHER_TIME (ev_periodic);
 142
 143   ev_tstamp interval; /* rw */
 144 };
 145
 146 /* invoked when fd is either EV_READable or EV_WRITEable */
 147 /* revent EV_READ, EV_WRITE */
 148 struct ev_io
 149 {
 150   EV_WATCHER_LIST (ev_io);
 151
 152   int fd;     /* ro */
 153   int events; /* ro */
 154 };
 155
 156 /* invoked when the given signal has been received */
 157 /* revent EV_SIGNAL */
 158 struct ev_signal
 159 {
 160   EV_WATCHER_LIST (ev_signal);
 161
 162   int signum; /* ro */
 163 };
 164
 165 /* invoked when the nothing else needs to be done, keeps the process from blocking */
 166 /* revent EV_IDLE */
 167 struct ev_idle
 168 {
 169   EV_WATCHER (ev_idle);
 170 };
 171
 172 /* invoked for each run of the mainloop, just before the blocking call */
 173 /* you can still change events in any way you like */
 174 /* revent EV_PREPARE */
 175 struct ev_prepare
 176 {
 177   EV_WATCHER (ev_prepare);
 178 };
 179
 180 /* invoked for each run of the mainloop, just after the blocking call */
 181 /* revent EV_CHECK */
 182 struct ev_check
 183 {
 184   EV_WATCHER (ev_check);
 185 };
 186
 187 /* invoked when sigchld is received and waitpid indicates the givne pid */
 188 /* revent EV_CHILD */
 189 /* does not support priorities */
 190 struct ev_child
 191 {
 192   EV_WATCHER_LIST (ev_child);
 193
 194   int pid;     /* ro */
 195   int rpid;    /* rw, holds the received pid */
 196   int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
 197 };
 198
 199 union ev_any_watcher
 200 {
 201   struct ev_watcher w;
 202   struct ev_watcher_list wl;
 203   struct ev_io io;
 204   struct ev_timer timer;
 205   struct ev_periodic periodic;
 206   struct ev_signal signal;
 207   struct ev_idle idle;
 208   struct ev_child child;
 209   struct ev_prepare prepare;
 210   struct ev_check check;
 211 };
 212
 213 #define EVMETHOD_AUTO     0 /* consults environment */
 214 #define EVMETHOD_SELECT   1
 215 #define EVMETHOD_POLL     2
 216 #define EVMETHOD_EPOLL    4
 217 #define EVMETHOD_KQUEUE   8
 218 #define EVMETHOD_DEVPOLL 16 /* NYI */
 219 #define EVMETHOD_PORT    32 /* NYI */
 220 #define EVMETHOD_WIN32   64 /* NYI */
 221 #define EVMETHOD_ANY     ~0 /* any method, do not consult env */
 222
 223 #if EV_PROTOTYPES
 224 int ev_version_major (void);
 225 int ev_version_minor (void);
 226
 227 ev_tstamp ev_time (void);
 228
 229 /* Sets the allocation function to use, works like realloc.
 230  * It is used to allocate and free memory.
 231  * If it returns zero when memory needs to be allocated, the library might abort
 232  * or take some potentially destructive action.
 233  * The default is your system realloc function.
 234  */
 235 void ev_set_allocator (void *(*cb)(void *ptr, long size));
 236
 237 /* set the callback function to call on a
 238  * retryable syscall error
 239  * (such as failed select, poll, epoll_wait)
 240  */
 241 void ev_set_syserr_cb (void (*cb)(const char *msg));
 242
 243 # if EV_MULTIPLICITY
 244 /* the default loop is the only one that handles signals and child watchers */
 245 /* you can call this as often as you like */
 246 struct ev_loop *ev_default_loop (int methods); /* returns default loop */
 247
 248 /* create and destroy alternative loops that don't handle signals */
 249 struct ev_loop *ev_loop_new (int methods);
 250 void ev_loop_destroy (EV_P);
 251 void ev_loop_fork (EV_P);
 252 # else
 253 int ev_default_loop (int methods); /* returns true when successful */
 254 # endif
 255
 256 void ev_default_destroy (void); /* destroy the default loop */
 257 /* this needs to be called after fork, to duplicate the default loop */
 258 /* if you create alternative loops you have to call ev_loop_fork on them */
 259 /* you can call it in either the parent or the child */
 260 /* you can actually call it at any time, anywhere :) */
 261 void ev_default_fork (void);
 262
 263 int ev_method (EV_P);
 264 #endif
 265
 266 #define EVLOOP_NONBLOCK 1 /* do not block/wait */
 267 #define EVLOOP_ONESHOT  2 /* block *once* only */
 268 #define EVUNLOOP_ONCE   1 /* unloop once */
 269 #define EVUNLOOP_ALL    2 /* unloop all loops */
 270
 271 #if EV_PROTOTYPES
 272 void ev_loop (EV_P_ int flags);
 273 void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
 274
 275 ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
 276
 277 /*
 278  * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
 279  * keeps one reference. if you have a long-runing watcher you never unregister that
 280  * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
 281  */
 282 void ev_ref   (EV_P);
 283 void ev_unref (EV_P);
 284
 285 /* convinience function, wait for a single event, without registering an event watcher */
 286 /* if timeout is < 0, do wait indefinitely */
 287 void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
 288 #endif
 289
 290 /* these may evaluate ev multiple times, and the other arguments at most once */
 291 /* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
 292 #define ev_watcher_init(ev,cb_) do {            \
 293   ((struct ev_watcher *)(void *)(ev))->active   =       \
 294   ((struct ev_watcher *)(void *)(ev))->pending  =       \
 295   ((struct ev_watcher *)(void *)(ev))->priority = 0;    \
 296   (ev)->cb = (cb_);                             \
 297 } while (0)
 298
 299 #define ev_io_set(ev,fd_,events_)           do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
 300 #define ev_timer_set(ev,after_,repeat_)     do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
 301 #define ev_periodic_set(ev,at_,interval_)   do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
 302 #define ev_signal_set(ev,signum_)           do { (ev)->signum = (signum_); } while (0)
 303 #define ev_idle_set(ev)                     /* nop, yes, this is a serious in-joke */
 304 #define ev_prepare_set(ev)                  /* nop, yes, this is a serious in-joke */
 305 #define ev_check_set(ev)                    /* nop, yes, this is a serious in-joke */
 306 #define ev_child_set(ev,pid_)               do { (ev)->pid = (pid_); } while (0)
 307
 308 #define ev_io_init(ev,cb,fd,events)         do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
 309 #define ev_timer_init(ev,cb,after,repeat)   do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
 310 #define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0)
 311 #define ev_signal_init(ev,cb,signum)        do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
 312 #define ev_idle_init(ev,cb)                 do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
 313 #define ev_prepare_init(ev,cb)              do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
 314 #define ev_check_init(ev,cb)                do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
 315 #define ev_child_init(ev,cb,pid)            do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
 316
 317 #define ev_is_pending(ev)                   (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
 318 #define ev_is_active(ev)                    (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
 319
 320 #define ev_priority(ev)                     ((struct ev_watcher *)(void *)(ev))->priority /* rw */
 321 #define ev_cb(ev)                           (ev)->cb /* rw */
 322 #define ev_set_priority(ev,pri)             ev_priority (ev) = (pri)
 323 #define ev_set_cb(ev,cb_)                   ev_cb (ev) = (cb_)
 324
 325 /* stopping (enabling, adding) a watcher does nothing if it is already running */
 326 /* stopping (disabling, deleting) a watcher does nothing unless its already running */
 327 #if EV_PROTOTYPES
 328 void ev_io_start       (EV_P_ struct ev_io *w);
 329 void ev_io_stop        (EV_P_ struct ev_io *w);
 330
 331 void ev_timer_start    (EV_P_ struct ev_timer *w);
 332 void ev_timer_stop     (EV_P_ struct ev_timer *w);
 333 /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
 334 void ev_timer_again    (EV_P_ struct ev_timer *w);
 335
 336 void ev_periodic_start (EV_P_ struct ev_periodic *w);
 337 void ev_periodic_stop  (EV_P_ struct ev_periodic *w);
 338
 339 void ev_idle_start     (EV_P_ struct ev_idle *w);
 340 void ev_idle_stop      (EV_P_ struct ev_idle *w);
 341
 342 void ev_prepare_start  (EV_P_ struct ev_prepare *w);
 343 void ev_prepare_stop   (EV_P_ struct ev_prepare *w);
 344
 345 void ev_check_start    (EV_P_ struct ev_check *w);
 346 void ev_check_stop     (EV_P_ struct ev_check *w);
 347
 348 /* only supported in the default loop */
 349 void ev_signal_start   (EV_P_ struct ev_signal *w);
 350 void ev_signal_stop    (EV_P_ struct ev_signal *w);
 351
 352 /* only supported in the default loop */
 353 void ev_child_start    (EV_P_ struct ev_child *w);
 354 void ev_child_stop     (EV_P_ struct ev_child *w);
 355 #endif
 356
 357 #ifdef __cplusplus
 358 }
 359 #endif
 360
 361 #endif
 362