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