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