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 |
# define EV_DEFAULT_A ev_default_loop (0) |
59 |
# define EV_DEFAULT_A_ EV_DEFAULT_A, |
60 |
#else |
61 |
# define EV_P void |
62 |
# define EV_P_ |
63 |
# define EV_A |
64 |
# define EV_A_ |
65 |
# define EV_DEFAULT_A |
66 |
# define EV_DEFAULT_A_ |
67 |
#endif |
68 |
|
69 |
/* eventmask, revents, events... */ |
70 |
#define EV_UNDEF -1 /* guaranteed to be invalid */ |
71 |
#define EV_NONE 0x00 |
72 |
#define EV_READ 0x01 |
73 |
#define EV_WRITE 0x02 |
74 |
#define EV_TIMEOUT 0x000100 |
75 |
#define EV_PERIODIC 0x000200 |
76 |
#define EV_SIGNAL 0x000400 |
77 |
#define EV_IDLE 0x000800 |
78 |
#define EV_CHECK 0x001000 |
79 |
#define EV_PREPARE 0x002000 |
80 |
#define EV_CHILD 0x004000 |
81 |
#define EV_ERROR 0x800000 /* sent when an error occurs */ |
82 |
|
83 |
/* can be used to add custom fields to all watchers */ |
84 |
#ifndef EV_COMMON |
85 |
# define EV_COMMON void *data |
86 |
#endif |
87 |
#ifndef EV_PROTOTYPES |
88 |
# define EV_PROTOTYPES 1 |
89 |
#endif |
90 |
|
91 |
#define EV_VERSION_MAJOR 1 |
92 |
#define EV_VERSION_MINOR 1 |
93 |
|
94 |
#ifndef EV_CB_DECLARE |
95 |
# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); |
96 |
#endif |
97 |
#ifndef EV_CB_INVOKE |
98 |
# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) |
99 |
#endif |
100 |
|
101 |
/* |
102 |
* struct member types: |
103 |
* private: you can look at them, but not change them, and they might not mean anything to you. |
104 |
* ro: can be read anytime, but only changed when the watcher isn't active |
105 |
* rw: can be read and modified anytime, even when the watcher is active |
106 |
*/ |
107 |
|
108 |
/* shared by all watchers */ |
109 |
#define EV_WATCHER(type) \ |
110 |
int active; /* private */ \ |
111 |
int pending; /* private */ \ |
112 |
int priority; /* private */ \ |
113 |
EV_COMMON; /* rw */ \ |
114 |
EV_CB_DECLARE (type) /* private */ |
115 |
|
116 |
#define EV_WATCHER_LIST(type) \ |
117 |
EV_WATCHER (type); \ |
118 |
struct ev_watcher_list *next /* private */ |
119 |
|
120 |
#define EV_WATCHER_TIME(type) \ |
121 |
EV_WATCHER (type); \ |
122 |
ev_tstamp at /* private */ |
123 |
|
124 |
/* base class, nothing to see here unless you subclass */ |
125 |
struct ev_watcher |
126 |
{ |
127 |
EV_WATCHER (ev_watcher); |
128 |
}; |
129 |
|
130 |
/* base class, nothing to see here unless you subclass */ |
131 |
struct ev_watcher_list |
132 |
{ |
133 |
EV_WATCHER_LIST (ev_watcher_list); |
134 |
}; |
135 |
|
136 |
/* base class, nothing to see here unless you subclass */ |
137 |
struct ev_watcher_time |
138 |
{ |
139 |
EV_WATCHER_TIME (ev_watcher_time); |
140 |
}; |
141 |
|
142 |
/* invoked after a specific time, repeatable (based on monotonic clock) */ |
143 |
/* revent EV_TIMEOUT */ |
144 |
struct ev_timer |
145 |
{ |
146 |
EV_WATCHER_TIME (ev_timer); |
147 |
|
148 |
ev_tstamp repeat; /* rw */ |
149 |
}; |
150 |
|
151 |
/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ |
152 |
/* revent EV_PERIODIC */ |
153 |
struct ev_periodic |
154 |
{ |
155 |
EV_WATCHER_TIME (ev_periodic); |
156 |
|
157 |
ev_tstamp interval; /* rw */ |
158 |
ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ |
159 |
}; |
160 |
|
161 |
/* invoked when fd is either EV_READable or EV_WRITEable */ |
162 |
/* revent EV_READ, EV_WRITE */ |
163 |
struct ev_io |
164 |
{ |
165 |
EV_WATCHER_LIST (ev_io); |
166 |
|
167 |
int fd; /* ro */ |
168 |
int events; /* ro */ |
169 |
}; |
170 |
|
171 |
/* invoked when the given signal has been received */ |
172 |
/* revent EV_SIGNAL */ |
173 |
struct ev_signal |
174 |
{ |
175 |
EV_WATCHER_LIST (ev_signal); |
176 |
|
177 |
int signum; /* ro */ |
178 |
}; |
179 |
|
180 |
/* invoked when the nothing else needs to be done, keeps the process from blocking */ |
181 |
/* revent EV_IDLE */ |
182 |
struct ev_idle |
183 |
{ |
184 |
EV_WATCHER (ev_idle); |
185 |
}; |
186 |
|
187 |
/* invoked for each run of the mainloop, just before the blocking call */ |
188 |
/* you can still change events in any way you like */ |
189 |
/* revent EV_PREPARE */ |
190 |
struct ev_prepare |
191 |
{ |
192 |
EV_WATCHER (ev_prepare); |
193 |
}; |
194 |
|
195 |
/* invoked for each run of the mainloop, just after the blocking call */ |
196 |
/* revent EV_CHECK */ |
197 |
struct ev_check |
198 |
{ |
199 |
EV_WATCHER (ev_check); |
200 |
}; |
201 |
|
202 |
/* invoked when sigchld is received and waitpid indicates the givne pid */ |
203 |
/* revent EV_CHILD */ |
204 |
/* does not support priorities */ |
205 |
struct ev_child |
206 |
{ |
207 |
EV_WATCHER_LIST (ev_child); |
208 |
|
209 |
int pid; /* ro */ |
210 |
int rpid; /* rw, holds the received pid */ |
211 |
int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ |
212 |
}; |
213 |
|
214 |
/* the presence of this union forces similar struct layout */ |
215 |
union ev_any_watcher |
216 |
{ |
217 |
struct ev_watcher w; |
218 |
struct ev_watcher_list wl; |
219 |
|
220 |
struct ev_io io; |
221 |
struct ev_timer timer; |
222 |
struct ev_periodic periodic; |
223 |
struct ev_idle idle; |
224 |
struct ev_prepare prepare; |
225 |
struct ev_check check; |
226 |
struct ev_signal signal; |
227 |
struct ev_child child; |
228 |
}; |
229 |
|
230 |
#define EVMETHOD_AUTO 0 /* consults environment */ |
231 |
#define EVMETHOD_SELECT 1 |
232 |
#define EVMETHOD_POLL 2 |
233 |
#define EVMETHOD_EPOLL 4 |
234 |
#define EVMETHOD_KQUEUE 8 |
235 |
#define EVMETHOD_DEVPOLL 16 /* NYI */ |
236 |
#define EVMETHOD_PORT 32 /* NYI */ |
237 |
#define EVMETHOD_WIN32 64 /* NYI */ |
238 |
#define EVMETHOD_ANY ~0 /* any method, do not consult env */ |
239 |
|
240 |
#if EV_PROTOTYPES |
241 |
int ev_version_major (void); |
242 |
int ev_version_minor (void); |
243 |
|
244 |
ev_tstamp ev_time (void); |
245 |
|
246 |
/* Sets the allocation function to use, works like realloc. |
247 |
* It is used to allocate and free memory. |
248 |
* If it returns zero when memory needs to be allocated, the library might abort |
249 |
* or take some potentially destructive action. |
250 |
* The default is your system realloc function. |
251 |
*/ |
252 |
void ev_set_allocator (void *(*cb)(void *ptr, long size)); |
253 |
|
254 |
/* set the callback function to call on a |
255 |
* retryable syscall error |
256 |
* (such as failed select, poll, epoll_wait) |
257 |
*/ |
258 |
void ev_set_syserr_cb (void (*cb)(const char *msg)); |
259 |
|
260 |
# if EV_MULTIPLICITY |
261 |
/* the default loop is the only one that handles signals and child watchers */ |
262 |
/* you can call this as often as you like */ |
263 |
struct ev_loop *ev_default_loop (int methods); /* returns default loop */ |
264 |
|
265 |
/* create and destroy alternative loops that don't handle signals */ |
266 |
struct ev_loop *ev_loop_new (int methods); |
267 |
void ev_loop_destroy (EV_P); |
268 |
void ev_loop_fork (EV_P); |
269 |
|
270 |
ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ |
271 |
|
272 |
# else |
273 |
|
274 |
int ev_default_loop (int methods); /* returns true when successful */ |
275 |
|
276 |
static ev_tstamp |
277 |
ev_now () |
278 |
{ |
279 |
extern ev_tstamp ev_rt_now; |
280 |
|
281 |
return ev_rt_now; |
282 |
} |
283 |
# endif |
284 |
|
285 |
void ev_default_destroy (void); /* destroy the default loop */ |
286 |
/* this needs to be called after fork, to duplicate the default loop */ |
287 |
/* if you create alternative loops you have to call ev_loop_fork on them */ |
288 |
/* you can call it in either the parent or the child */ |
289 |
/* you can actually call it at any time, anywhere :) */ |
290 |
void ev_default_fork (void); |
291 |
|
292 |
int ev_method (EV_P); |
293 |
#endif |
294 |
|
295 |
#define EVLOOP_NONBLOCK 1 /* do not block/wait */ |
296 |
#define EVLOOP_ONESHOT 2 /* block *once* only */ |
297 |
#define EVUNLOOP_ONCE 1 /* unloop once */ |
298 |
#define EVUNLOOP_ALL 2 /* unloop all loops */ |
299 |
|
300 |
#if EV_PROTOTYPES |
301 |
void ev_loop (EV_P_ int flags); |
302 |
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 */ |
303 |
|
304 |
/* |
305 |
* ref/unref can be used to add or remove a refcount on the mainloop. every watcher |
306 |
* keeps one reference. if you have a long-runing watcher you never unregister that |
307 |
* should not keep ev_loop from running, unref() after starting, and ref() before stopping. |
308 |
*/ |
309 |
void ev_ref (EV_P); |
310 |
void ev_unref (EV_P); |
311 |
|
312 |
/* convinience function, wait for a single event, without registering an event watcher */ |
313 |
/* if timeout is < 0, do wait indefinitely */ |
314 |
void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); |
315 |
#endif |
316 |
|
317 |
/* these may evaluate ev multiple times, and the other arguments at most once */ |
318 |
/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ |
319 |
#define ev_init(ev,cb_) do { \ |
320 |
((struct ev_watcher *)(void *)(ev))->active = \ |
321 |
((struct ev_watcher *)(void *)(ev))->pending = \ |
322 |
((struct ev_watcher *)(void *)(ev))->priority = 0; \ |
323 |
ev_set_cb ((ev), cb_); \ |
324 |
} while (0) |
325 |
|
326 |
#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) |
327 |
#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) |
328 |
#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) |
329 |
#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) |
330 |
#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ |
331 |
#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ |
332 |
#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ |
333 |
#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) |
334 |
|
335 |
#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) |
336 |
#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) |
337 |
#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) |
338 |
#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) |
339 |
#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) |
340 |
#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) |
341 |
#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) |
342 |
#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) |
343 |
|
344 |
#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ |
345 |
#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ |
346 |
|
347 |
#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */ |
348 |
#define ev_cb(ev) (ev)->cb /* rw */ |
349 |
#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) |
350 |
|
351 |
#ifndef ev_set_cb |
352 |
# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) |
353 |
#endif |
354 |
|
355 |
/* stopping (enabling, adding) a watcher does nothing if it is already running */ |
356 |
/* stopping (disabling, deleting) a watcher does nothing unless its already running */ |
357 |
#if EV_PROTOTYPES |
358 |
|
359 |
/* feeds an event into a watcher as if the event actually occured */ |
360 |
/* accepts any ev_watcher type */ |
361 |
void ev_feed_event (EV_P_ void *w, int revents); |
362 |
void ev_feed_fd_event (EV_P_ int fd, int revents); |
363 |
void ev_feed_signal_event (EV_P_ int signum); |
364 |
|
365 |
void ev_io_start (EV_P_ struct ev_io *w); |
366 |
void ev_io_stop (EV_P_ struct ev_io *w); |
367 |
|
368 |
void ev_timer_start (EV_P_ struct ev_timer *w); |
369 |
void ev_timer_stop (EV_P_ struct ev_timer *w); |
370 |
/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ |
371 |
void ev_timer_again (EV_P_ struct ev_timer *w); |
372 |
|
373 |
void ev_periodic_start (EV_P_ struct ev_periodic *w); |
374 |
void ev_periodic_stop (EV_P_ struct ev_periodic *w); |
375 |
void ev_periodic_again (EV_P_ struct ev_periodic *w); |
376 |
|
377 |
void ev_idle_start (EV_P_ struct ev_idle *w); |
378 |
void ev_idle_stop (EV_P_ struct ev_idle *w); |
379 |
|
380 |
void ev_prepare_start (EV_P_ struct ev_prepare *w); |
381 |
void ev_prepare_stop (EV_P_ struct ev_prepare *w); |
382 |
|
383 |
void ev_check_start (EV_P_ struct ev_check *w); |
384 |
void ev_check_stop (EV_P_ struct ev_check *w); |
385 |
|
386 |
/* only supported in the default loop */ |
387 |
void ev_signal_start (EV_P_ struct ev_signal *w); |
388 |
void ev_signal_stop (EV_P_ struct ev_signal *w); |
389 |
|
390 |
/* only supported in the default loop */ |
391 |
void ev_child_start (EV_P_ struct ev_child *w); |
392 |
void ev_child_stop (EV_P_ struct ev_child *w); |
393 |
#endif |
394 |
|
395 |
#ifdef __cplusplus |
396 |
} |
397 |
#endif |
398 |
|
399 |
#endif |
400 |
|