ev.h

   1 #ifndef EV_H
   2 #define EV_H
   3
   4 typedef double ev_tstamp;
   5
   6 /* eventmask, revents, events... */
   7 #define EV_UNDEF   -1 /* guaranteed to be invalid */
   8 #define EV_NONE    0x00
   9 #define EV_READ    0x01
  10 #define EV_WRITE   0x02
  11 #define EV_TIMEOUT 0x04
  12 #define EV_SIGNAL  0x08
  13 #define EV_IDLE    0x10
  14 #define EV_CHECK   0x20
  15 #define EV_ERROR   (0x3f|0x80)
  16
  17 /* can be used to add custom fields to all watchers */
  18 #ifndef EV_COMMON
  19 # define EV_COMMON void *data
  20 #endif
  21 #ifndef EV_PROTOTYPES
  22 # define EV_PROTOTYPES 1
  23 #endif
  24
  25 /*
  26  * struct member types:
  27  * private: you can look at them, but not change them, and they might not mean anything to you.
  28  * ro: can be read anytime, but only changed when the watcher isn't active
  29  * rw: can be read and modified anytime, even when the watcher is active
  30  */
  31
  32 /* shared by all watchers */
  33 #define EV_WATCHER(type)                        \
  34   int active; /* private */                     \
  35   int pending; /* private */                    \
  36   EV_COMMON; /* rw */                           \
  37   void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */
  38
  39 #define EV_WATCHER_LIST(type)                   \
  40   EV_WATCHER (type);                            \
  41   struct type *next /* private */
  42
  43 #define EV_WATCHER_TIME(type)                   \
  44   EV_WATCHER (type);                            \
  45   ev_tstamp at     /* private */
  46
  47 /* base class, nothing to see here unless you subclass */
  48 struct ev_watcher {
  49   EV_WATCHER (ev_watcher);
  50 };
  51
  52 /* base class, nothing to see here unless you subclass */
  53 struct ev_watcher_list {
  54   EV_WATCHER_LIST (ev_watcher_list);
  55 };
  56
  57 /* base class, nothing to see here unless you subclass */
  58 struct ev_watcher_time {
  59   EV_WATCHER_TIME (ev_watcher_time);
  60 };
  61
  62 /* invoked after a specific time, repeatable (based on monotonic clock) */
  63 struct ev_timer
  64 {
  65   EV_WATCHER_TIME (ev_timer);
  66
  67   ev_tstamp repeat; /* rw */
  68 };
  69
  70 /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
  71 struct ev_periodic
  72 {
  73   EV_WATCHER_TIME (ev_periodic);
  74
  75   ev_tstamp interval; /* rw */
  76 };
  77
  78 /* invoked when fd is either EV_READable or EV_WRITEable */
  79 struct ev_io
  80 {
  81   EV_WATCHER_LIST (ev_io);
  82
  83   int fd;     /* ro */
  84   int events; /* ro */
  85 };
  86
  87 /* invoked when the given signal has been received */
  88 struct ev_signal
  89 {
  90   EV_WATCHER_LIST (ev_signal);
  91
  92   int signum; /* ro */
  93 };
  94
  95 /* invoked when the nothing else needs to be done, keeps the process from blocking */
  96 struct ev_idle
  97 {
  98   EV_WATCHER (ev_idle);
  99 };
 100
 101 /* invoked for each run of the mainloop, just before the next blocking vall is initiated */
 102 struct ev_check
 103 {
 104   EV_WATCHER (ev_check);
 105 };
 106
 107 #define EVMETHOD_NONE   0
 108 #define EVMETHOD_SELECT 1
 109 #define EVMETHOD_EPOLL  2
 110 #if EV_PROTOTYPES
 111 extern int ev_method;
 112 int ev_init (int flags); /* returns ev_method */
 113
 114 /* these three calls are suitable for plugging into pthread_atfork */
 115 void ev_prefork (void);
 116 void ev_postfork_parent (void);
 117 void ev_postfork_child (void);
 118
 119 extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
 120 ev_tstamp ev_time (void);
 121 #endif
 122
 123 #define EVLOOP_NONBLOCK 1 /* do not block/wait */
 124 #define EVLOOP_ONESHOT  2 /* block *once* only */
 125 #if EV_PROTOTYPES
 126 void ev_loop (int flags);
 127 extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
 128
 129 /* convinience function, wait for a single event, without registering an event watcher */
 130 /* if timeout is < 0, do wait indefinitely */
 131 void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
 132 #endif
 133
 134 /* these may evaluate ev multiple times, and the other arguments at most once */
 135 /* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */
 136 #define evw_init(ev,cb_)                   do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0)
 137
 138 #define evio_set(ev,fd_,events_)           do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
 139 #define evtimer_set(ev,after_,repeat_)     do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
 140 #define evperiodic_set(ev,at_,interval_)   do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
 141 #define evsignal_set(ev,signum_)           do { (ev)->signum = (signum_); } while (0)
 142 #define evcheck_set(ev)                    /* nop, yes, this is a serious in-joke */
 143 #define evidle_set(ev)                     /* nop, yes, this is a serious in-joke */
 144
 145 #define evio_init(ev,cb,fd,events)         do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0)
 146 #define evtimer_init(ev,cb,after,repeat)   do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0)
 147 #define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0)
 148 #define evsignal_init(ev,cb,signum)        do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0)
 149 #define evcheck_init(ev,cb)                do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0)
 150 #define evidle_init(ev,cb)                 do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0)
 151
 152 #define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
 153
 154 /* stopping (enabling, adding) a watcher does nothing if it is already running */
 155 /* stopping (disabling, deleting) a watcher does nothing unless its already running */
 156 #if EV_PROTOTYPES
 157 void evio_start       (struct ev_io *w);
 158 void evio_stop        (struct ev_io *w);
 159
 160 void evtimer_start    (struct ev_timer *w);
 161 void evtimer_stop     (struct ev_timer *w);
 162 void evtimer_again    (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
 163
 164 void evperiodic_start (struct ev_periodic *w);
 165 void evperiodic_stop  (struct ev_periodic *w);
 166
 167 void evsignal_start   (struct ev_signal *w);
 168 void evsignal_stop    (struct ev_signal *w);
 169
 170 void evidle_start     (struct ev_idle *w);
 171 void evidle_stop      (struct ev_idle *w);
 172
 173 void evcheck_start    (struct ev_check *w);
 174 void evcheck_stop     (struct ev_check *w);
 175 #endif
 176
 177 #endif
 178