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 typedef double ev_tstamp;
  34
  35 /* eventmask, revents, events... */
  36 #define EV_UNDEF   -1 /* guaranteed to be invalid */
  37 #define EV_NONE    0x000000
  38 #define EV_READ    0x000001
  39 #define EV_WRITE   0x000002
  40 #define EV_TIMEOUT 0x000004
  41 #define EV_SIGNAL  0x000008
  42 #define EV_IDLE    0x000010
  43 #define EV_CHECK   0x000020
  44 #define EV_PREPARE 0x000040
  45 #define EV_CHILD   0x000080
  46 #define EV_ERROR   0x800000
  47
  48 /* can be used to add custom fields to all watchers */
  49 #ifndef EV_COMMON
  50 # define EV_COMMON void *data
  51 #endif
  52 #ifndef EV_PROTOTYPES
  53 # define EV_PROTOTYPES 1
  54 #endif
  55
  56 #define EV_VERSION_MAJOR 1
  57 #define EV_VERSION_MINOR 1
  58
  59 /*
  60  * struct member types:
  61  * private: you can look at them, but not change them, and they might not mean anything to you.
  62  * ro: can be read anytime, but only changed when the watcher isn't active
  63  * rw: can be read and modified anytime, even when the watcher is active
  64  */
  65
  66 /* shared by all watchers */
  67 #define EV_WATCHER(type)                        \
  68   int active; /* private */                     \
  69   int pending; /* private */                    \
  70   EV_COMMON; /* rw */                           \
  71   void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */
  72
  73 #define EV_WATCHER_LIST(type)                   \
  74   EV_WATCHER (type);                            \
  75   struct type *next /* private */
  76
  77 #define EV_WATCHER_TIME(type)                   \
  78   EV_WATCHER (type);                            \
  79   ev_tstamp at     /* private */
  80
  81 /* base class, nothing to see here unless you subclass */
  82 struct ev_watcher {
  83   EV_WATCHER (ev_watcher);
  84 };
  85
  86 /* base class, nothing to see here unless you subclass */
  87 struct ev_watcher_list {
  88   EV_WATCHER_LIST (ev_watcher_list);
  89 };
  90
  91 /* base class, nothing to see here unless you subclass */
  92 struct ev_watcher_time {
  93   EV_WATCHER_TIME (ev_watcher_time);
  94 };
  95
  96 /* invoked after a specific time, repeatable (based on monotonic clock) */
  97 struct ev_timer
  98 {
  99   EV_WATCHER_TIME (ev_timer);
 100
 101   ev_tstamp repeat; /* rw */
 102 };
 103
 104 /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
 105 struct ev_periodic
 106 {
 107   EV_WATCHER_TIME (ev_periodic);
 108
 109   ev_tstamp interval; /* rw */
 110 };
 111
 112 /* invoked when fd is either EV_READable or EV_WRITEable */
 113 struct ev_io
 114 {
 115   EV_WATCHER_LIST (ev_io);
 116
 117   int fd;     /* ro */
 118   int events; /* ro */
 119 };
 120
 121 /* invoked when the given signal has been received */
 122 struct ev_signal
 123 {
 124   EV_WATCHER_LIST (ev_signal);
 125
 126   int signum; /* ro */
 127 };
 128
 129 /* invoked when the nothing else needs to be done, keeps the process from blocking */
 130 struct ev_idle
 131 {
 132   EV_WATCHER (ev_idle);
 133 };
 134
 135 /* invoked for each run of the mainloop, just before the blocking call */
 136 /* you can still change events in any way you like */
 137 struct ev_prepare
 138 {
 139   EV_WATCHER (ev_prepare);
 140 };
 141
 142 /* invoked for each run of the mainloop, just after the blocking call */
 143 struct ev_check
 144 {
 145   EV_WATCHER (ev_check);
 146 };
 147
 148 /* invoked when sigchld is received and waitpid indicates the givne pid */
 149 struct ev_child
 150 {
 151   EV_WATCHER_LIST (ev_child);
 152
 153   int pid;    /* ro */
 154   int status; /* rw, holds the exit status, use the macros from sys/wait.h */
 155 };
 156
 157 #define EVMETHOD_NONE   0
 158 #define EVMETHOD_SELECT 1
 159 #define EVMETHOD_EPOLL  2
 160 #if EV_PROTOTYPES
 161 extern int ev_method;
 162 int ev_init (int flags); /* returns ev_method */
 163 int ev_version_major (void);
 164 int ev_version_minor (void);
 165
 166 /* these three calls are suitable for plugging into pthread_atfork */
 167 void ev_prefork (void);
 168 void ev_postfork_parent (void);
 169 void ev_postfork_child (void);
 170
 171 extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
 172 ev_tstamp ev_time (void);
 173 #endif
 174
 175 #define EVLOOP_NONBLOCK 1 /* do not block/wait */
 176 #define EVLOOP_ONESHOT  2 /* block *once* only */
 177 #if EV_PROTOTYPES
 178 void ev_loop (int flags);
 179 extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
 180
 181 /* convinience function, wait for a single event, without registering an event watcher */
 182 /* if timeout is < 0, do wait indefinitely */
 183 void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
 184 #endif
 185
 186 /* these may evaluate ev multiple times, and the other arguments at most once */
 187 /* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */
 188 #define evw_init(ev,cb_)                   do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0)
 189
 190 #define evio_set(ev,fd_,events_)           do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
 191 #define evtimer_set(ev,after_,repeat_)     do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
 192 #define evperiodic_set(ev,at_,interval_)   do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
 193 #define evsignal_set(ev,signum_)           do { (ev)->signum = (signum_); } while (0)
 194 #define evidle_set(ev)                     /* nop, yes, this is a serious in-joke */
 195 #define evprepare_set(ev)                  /* nop, yes, this is a serious in-joke */
 196 #define evcheck_set(ev)                    /* nop, yes, this is a serious in-joke */
 197 #define evchild_set(ev,pid_)               do { (ev)->pid = (pid_); } while (0)
 198
 199 #define evio_init(ev,cb,fd,events)         do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0)
 200 #define evtimer_init(ev,cb,after,repeat)   do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0)
 201 #define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0)
 202 #define evsignal_init(ev,cb,signum)        do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0)
 203 #define evidle_init(ev,cb)                 do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0)
 204 #define evprepare_init(ev,cb)              do { evw_init ((ev), (cb)); evprepare_set ((ev)); } while (0)
 205 #define evcheck_init(ev,cb)                do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0)
 206 #define evchild_init(ev,cb,pid)            do { evw_init ((ev), (cb)); evchild_set ((ev),(pid)); } while (0)
 207
 208 #define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
 209
 210 /* stopping (enabling, adding) a watcher does nothing if it is already running */
 211 /* stopping (disabling, deleting) a watcher does nothing unless its already running */
 212 #if EV_PROTOTYPES
 213 void evio_start       (struct ev_io *w);
 214 void evio_stop        (struct ev_io *w);
 215
 216 void evtimer_start    (struct ev_timer *w);
 217 void evtimer_stop     (struct ev_timer *w);
 218 void evtimer_again    (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
 219
 220 void evperiodic_start (struct ev_periodic *w);
 221 void evperiodic_stop  (struct ev_periodic *w);
 222
 223 void evsignal_start   (struct ev_signal *w);
 224 void evsignal_stop    (struct ev_signal *w);
 225
 226 void evidle_start     (struct ev_idle *w);
 227 void evidle_stop      (struct ev_idle *w);
 228
 229 void evprepare_start  (struct ev_prepare *w);
 230 void evprepare_stop   (struct ev_prepare *w);
 231
 232 void evcheck_start    (struct ev_check *w);
 233 void evcheck_stop     (struct ev_check *w);
 234
 235 void evchild_start    (struct ev_child *w);
 236 void evchild_stop     (struct ev_child *w);
 237 #endif
 238
 239 #endif
 240