ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
Revision: 1.91
Committed: Fri Jan 25 15:45:09 2008 UTC (16 years, 5 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-3_0
Changes since 1.90: +4 -3 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 /*
2 * libev native API header
3 *
4 * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de>
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without modifica-
8 * tion, are permitted provided that the following conditions are met:
9 *
10 * 1. Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
12 *
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
18 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
19 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
20 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
21 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
23 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
25 * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
26 * OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Alternatively, the contents of this file may be used under the terms of
29 * the GNU General Public License ("GPL") version 2 or any later version,
30 * in which case the provisions of the GPL are applicable instead of
31 * the above. If you wish to allow the use of your version of this file
32 * only under the terms of the GPL and not to allow others to use your
33 * version of this file under the BSD license, indicate your decision
34 * by deleting the provisions above and replace them with the notice
35 * and other provisions required by the GPL. If you do not delete the
36 * provisions above, a recipient may use your version of this file under
37 * either the BSD or the GPL.
38 */
39
40 #ifndef EV_H__
41 #define EV_H__
42
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46
47 typedef double ev_tstamp;
48
49 /* these priorities are inclusive, higher priorities will be called earlier */
50 #ifndef EV_MINPRI
51 # define EV_MINPRI -2
52 #endif
53 #ifndef EV_MAXPRI
54 # define EV_MAXPRI +2
55 #endif
56
57 #ifndef EV_MULTIPLICITY
58 # define EV_MULTIPLICITY 1
59 #endif
60
61 #ifndef EV_PERIODIC_ENABLE
62 # define EV_PERIODIC_ENABLE 1
63 #endif
64
65 #ifndef EV_STAT_ENABLE
66 # define EV_STAT_ENABLE 1
67 #endif
68
69 #ifndef EV_IDLE_ENABLE
70 # define EV_IDLE_ENABLE 1
71 #endif
72
73 #ifndef EV_FORK_ENABLE
74 # define EV_FORK_ENABLE 1
75 #endif
76
77 #ifndef EV_EMBED_ENABLE
78 # define EV_EMBED_ENABLE 1
79 #endif
80
81 /*****************************************************************************/
82
83 #if EV_STAT_ENABLE
84 # include <sys/stat.h>
85 #endif
86
87 /* support multiple event loops? */
88 #if EV_MULTIPLICITY
89 struct ev_loop;
90 # define EV_P struct ev_loop *loop
91 # define EV_P_ EV_P,
92 # define EV_A loop
93 # define EV_A_ EV_A,
94 # define EV_DEFAULT ev_default_loop (0)
95 # define EV_DEFAULT_ EV_DEFAULT,
96 #else
97 # define EV_P void
98 # define EV_P_
99 # define EV_A
100 # define EV_A_
101 # define EV_DEFAULT
102 # define EV_DEFAULT_
103
104 # undef EV_EMBED_ENABLE
105 #endif
106
107 /* eventmask, revents, events... */
108 #define EV_UNDEF -1L /* guaranteed to be invalid */
109 #define EV_NONE 0x00L /* no events */
110 #define EV_READ 0x01L /* ev_io detected read will not block */
111 #define EV_WRITE 0x02L /* ev_io detected write will not block */
112 #define EV_IOFDSET 0x80L /* internal use only */
113 #define EV_TIMEOUT 0x00000100L /* timer timed out */
114 #define EV_PERIODIC 0x00000200L /* periodic timer timed out */
115 #define EV_SIGNAL 0x00000400L /* signal was received */
116 #define EV_CHILD 0x00000800L /* child/pid had status change */
117 #define EV_STAT 0x00001000L /* stat data changed */
118 #define EV_IDLE 0x00002000L /* event loop is idling */
119 #define EV_PREPARE 0x00004000L /* event loop about to poll */
120 #define EV_CHECK 0x00008000L /* event loop finished poll */
121 #define EV_EMBED 0x00010000L /* embedded event loop needs sweep */
122 #define EV_FORK 0x00020000L /* event loop resumed in child */
123 #define EV_ERROR 0x80000000L /* sent when an error occurs */
124
125 /* can be used to add custom fields to all watchers, while losing binary compatibility */
126 #ifndef EV_COMMON
127 # define EV_COMMON void *data;
128 #endif
129 #ifndef EV_PROTOTYPES
130 # define EV_PROTOTYPES 1
131 #endif
132
133 #define EV_VERSION_MAJOR 3
134 #define EV_VERSION_MINOR 0
135
136 #ifndef EV_CB_DECLARE
137 # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
138 #endif
139 #ifndef EV_CB_INVOKE
140 # define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
141 #endif
142
143 /*
144 * struct member types:
145 * private: you can look at them, but not change them, and they might not mean anything to you.
146 * ro: can be read anytime, but only changed when the watcher isn't active
147 * rw: can be read and modified anytime, even when the watcher is active
148 */
149
150 /* shared by all watchers */
151 #define EV_WATCHER(type) \
152 int active; /* private */ \
153 int pending; /* private */ \
154 int priority; /* private */ \
155 EV_COMMON /* rw */ \
156 EV_CB_DECLARE (type) /* private */
157
158 #define EV_WATCHER_LIST(type) \
159 EV_WATCHER (type) \
160 struct ev_watcher_list *next; /* private */
161
162 #define EV_WATCHER_TIME(type) \
163 EV_WATCHER (type) \
164 ev_tstamp at; /* private */
165
166 /* base class, nothing to see here unless you subclass */
167 typedef struct ev_watcher
168 {
169 EV_WATCHER (ev_watcher)
170 } ev_watcher;
171
172 /* base class, nothing to see here unless you subclass */
173 typedef struct ev_watcher_list
174 {
175 EV_WATCHER_LIST (ev_watcher_list)
176 } ev_watcher_list;
177
178 /* base class, nothing to see here unless you subclass */
179 typedef struct ev_watcher_time
180 {
181 EV_WATCHER_TIME (ev_watcher_time)
182 } ev_watcher_time;
183
184 /* invoked when fd is either EV_READable or EV_WRITEable */
185 /* revent EV_READ, EV_WRITE */
186 typedef struct ev_io
187 {
188 EV_WATCHER_LIST (ev_io)
189
190 int fd; /* ro */
191 int events; /* ro */
192 } ev_io;
193
194 /* invoked after a specific time, repeatable (based on monotonic clock) */
195 /* revent EV_TIMEOUT */
196 typedef struct ev_timer
197 {
198 EV_WATCHER_TIME (ev_timer)
199
200 ev_tstamp repeat; /* rw */
201 } ev_timer;
202
203 /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
204 /* revent EV_PERIODIC */
205 typedef struct ev_periodic
206 {
207 EV_WATCHER_TIME (ev_periodic)
208
209 ev_tstamp offset; /* rw */
210 ev_tstamp interval; /* rw */
211 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
212 } ev_periodic;
213
214 /* invoked when the given signal has been received */
215 /* revent EV_SIGNAL */
216 typedef struct ev_signal
217 {
218 EV_WATCHER_LIST (ev_signal)
219
220 int signum; /* ro */
221 } ev_signal;
222
223 /* invoked when sigchld is received and waitpid indicates the given pid */
224 /* revent EV_CHILD */
225 /* does not support priorities */
226 typedef struct ev_child
227 {
228 EV_WATCHER_LIST (ev_child)
229
230 int flags; /* private */
231 int pid; /* ro */
232 int rpid; /* rw, holds the received pid */
233 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
234 } ev_child;
235
236 #if EV_STAT_ENABLE
237 /* st_nlink = 0 means missing file or other error */
238 # ifdef _WIN32
239 typedef struct _stati64 ev_statdata;
240 # else
241 typedef struct stat ev_statdata;
242 # endif
243
244 /* invoked each time the stat data changes for a given path */
245 /* revent EV_STAT */
246 typedef struct ev_stat
247 {
248 EV_WATCHER_LIST (ev_stat)
249
250 ev_timer timer; /* private */
251 ev_tstamp interval; /* ro */
252 const char *path; /* ro */
253 ev_statdata prev; /* ro */
254 ev_statdata attr; /* ro */
255
256 int wd; /* wd for inotify, fd for kqueue */
257 } ev_stat;
258 #endif
259
260 #if EV_IDLE_ENABLE
261 /* invoked when the nothing else needs to be done, keeps the process from blocking */
262 /* revent EV_IDLE */
263 typedef struct ev_idle
264 {
265 EV_WATCHER (ev_idle)
266 } ev_idle;
267 #endif
268
269 /* invoked for each run of the mainloop, just before the blocking call */
270 /* you can still change events in any way you like */
271 /* revent EV_PREPARE */
272 typedef struct ev_prepare
273 {
274 EV_WATCHER (ev_prepare)
275 } ev_prepare;
276
277 /* invoked for each run of the mainloop, just after the blocking call */
278 /* revent EV_CHECK */
279 typedef struct ev_check
280 {
281 EV_WATCHER (ev_check)
282 } ev_check;
283
284 #if EV_FORK_ENABLE
285 /* the callback gets invoked before check in the child process when a fork was detected */
286 typedef struct ev_fork
287 {
288 EV_WATCHER (ev_fork)
289 } ev_fork;
290 #endif
291
292 #if EV_EMBED_ENABLE
293 /* used to embed an event loop inside another */
294 /* the callback gets invoked when the event loop has handled events, and can be 0 */
295 typedef struct ev_embed
296 {
297 EV_WATCHER (ev_embed)
298
299 struct ev_loop *other; /* ro */
300 ev_io io; /* private */
301 ev_prepare prepare; /* private */
302 ev_check check; /* unused */
303 ev_timer timer; /* unused */
304 ev_periodic periodic; /* unused */
305 ev_idle idle; /* unused */
306 ev_fork fork; /* unused */
307 } ev_embed;
308 #endif
309
310 /* the presence of this union forces similar struct layout */
311 union ev_any_watcher
312 {
313 struct ev_watcher w;
314 struct ev_watcher_list wl;
315
316 struct ev_io io;
317 struct ev_timer timer;
318 struct ev_periodic periodic;
319 struct ev_signal signal;
320 struct ev_child child;
321 #if EV_STAT_ENABLE
322 struct ev_stat stat;
323 #endif
324 #if EV_IDLE_ENABLE
325 struct ev_idle idle;
326 #endif
327 struct ev_prepare prepare;
328 struct ev_check check;
329 #if EV_FORK_ENABLE
330 struct ev_fork fork;
331 #endif
332 #if EV_EMBED_ENABLE
333 struct ev_embed embed;
334 #endif
335 };
336
337 /* bits for ev_default_loop and ev_loop_new */
338 /* the default */
339 #define EVFLAG_AUTO 0x00000000UL /* not quite a mask */
340 /* flag bits */
341 #define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */
342 #define EVFLAG_FORKCHECK 0x02000000UL /* check for a fork in each iteration */
343 /* method bits to be ored together */
344 #define EVBACKEND_SELECT 0x00000001UL /* about anywhere */
345 #define EVBACKEND_POLL 0x00000002UL /* !win */
346 #define EVBACKEND_EPOLL 0x00000004UL /* linux */
347 #define EVBACKEND_KQUEUE 0x00000008UL /* bsd */
348 #define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */
349 #define EVBACKEND_PORT 0x00000020UL /* solaris 10 */
350
351 #if EV_PROTOTYPES
352 int ev_version_major (void);
353 int ev_version_minor (void);
354
355 unsigned int ev_supported_backends (void);
356 unsigned int ev_recommended_backends (void);
357 unsigned int ev_embeddable_backends (void);
358
359 ev_tstamp ev_time (void);
360 void ev_sleep (ev_tstamp delay); /* sleep for a while */
361
362 /* Sets the allocation function to use, works like realloc.
363 * It is used to allocate and free memory.
364 * If it returns zero when memory needs to be allocated, the library might abort
365 * or take some potentially destructive action.
366 * The default is your system realloc function.
367 */
368 void ev_set_allocator (void *(*cb)(void *ptr, long size));
369
370 /* set the callback function to call on a
371 * retryable syscall error
372 * (such as failed select, poll, epoll_wait)
373 */
374 void ev_set_syserr_cb (void (*cb)(const char *msg));
375
376 # if EV_MULTIPLICITY
377 /* the default loop is the only one that handles signals and child watchers */
378 /* you can call this as often as you like */
379 static struct ev_loop *
380 ev_default_loop (unsigned int flags)
381 {
382 extern struct ev_loop *ev_default_loop_ptr;
383 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
384
385 if (!ev_default_loop_ptr)
386 ev_default_loop_init (flags);
387
388 return ev_default_loop_ptr;
389 }
390
391 /* create and destroy alternative loops that don't handle signals */
392 struct ev_loop *ev_loop_new (unsigned int flags);
393 void ev_loop_destroy (EV_P);
394 void ev_loop_fork (EV_P);
395
396 ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
397
398 # else
399
400 int ev_default_loop (unsigned int flags); /* returns true when successful */
401
402 static ev_tstamp
403 ev_now (void)
404 {
405 extern ev_tstamp ev_rt_now;
406
407 return ev_rt_now;
408 }
409 # endif
410
411 void ev_default_destroy (void); /* destroy the default loop */
412 /* this needs to be called after fork, to duplicate the default loop */
413 /* if you create alternative loops you have to call ev_loop_fork on them */
414 /* you can call it in either the parent or the child */
415 /* you can actually call it at any time, anywhere :) */
416 void ev_default_fork (void);
417
418 unsigned int ev_backend (EV_P); /* backend in use by loop */
419 unsigned int ev_loop_count (EV_P); /* number of loop iterations */
420 #endif
421
422 #define EVLOOP_NONBLOCK 1 /* do not block/wait */
423 #define EVLOOP_ONESHOT 2 /* block *once* only */
424 #define EVUNLOOP_CANCEL 0 /* undo unloop */
425 #define EVUNLOOP_ONE 1 /* unloop once */
426 #define EVUNLOOP_ALL 2 /* unloop all loops */
427
428 #if EV_PROTOTYPES
429 void ev_loop (EV_P_ int flags);
430 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 */
431
432 void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
433 void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
434
435 /*
436 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
437 * keeps one reference. if you have a long-runing watcher you never unregister that
438 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
439 */
440 void ev_ref (EV_P);
441 void ev_unref (EV_P);
442
443 /* convinience function, wait for a single event, without registering an event watcher */
444 /* if timeout is < 0, do wait indefinitely */
445 void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
446 #endif
447
448 /* these may evaluate ev multiple times, and the other arguments at most once */
449 /* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
450 #define ev_init(ev,cb_) do { \
451 ((ev_watcher *)(void *)(ev))->active = \
452 ((ev_watcher *)(void *)(ev))->pending = \
453 ((ev_watcher *)(void *)(ev))->priority = 0; \
454 ev_set_cb ((ev), cb_); \
455 } while (0)
456
457 #define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0)
458 #define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
459 #define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
460 #define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
461 #define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
462 #define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
463 #define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
464 #define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
465 #define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
466 #define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
467 #define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
468
469 #define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
470 #define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
471 #define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
472 #define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
473 #define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
474 #define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
475 #define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
476 #define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
477 #define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
478 #define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
479 #define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
480
481 #define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
482 #define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
483
484 #define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
485 #define ev_cb(ev) (ev)->cb /* rw */
486 #define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri)
487
488 #ifndef ev_set_cb
489 # define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
490 #endif
491
492 /* stopping (enabling, adding) a watcher does nothing if it is already running */
493 /* stopping (disabling, deleting) a watcher does nothing unless its already running */
494 #if EV_PROTOTYPES
495
496 /* feeds an event into a watcher as if the event actually occured */
497 /* accepts any ev_watcher type */
498 void ev_feed_event (EV_P_ void *w, int revents);
499 void ev_feed_fd_event (EV_P_ int fd, int revents);
500 void ev_feed_signal_event (EV_P_ int signum);
501 void ev_invoke (EV_P_ void *w, int revents);
502 int ev_clear_pending (EV_P_ void *w);
503
504 void ev_io_start (EV_P_ ev_io *w);
505 void ev_io_stop (EV_P_ ev_io *w);
506
507 void ev_timer_start (EV_P_ ev_timer *w);
508 void ev_timer_stop (EV_P_ ev_timer *w);
509 /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
510 void ev_timer_again (EV_P_ ev_timer *w);
511
512 #if EV_PERIODIC_ENABLE
513 void ev_periodic_start (EV_P_ ev_periodic *w);
514 void ev_periodic_stop (EV_P_ ev_periodic *w);
515 void ev_periodic_again (EV_P_ ev_periodic *w);
516 #endif
517
518 /* only supported in the default loop */
519 void ev_signal_start (EV_P_ ev_signal *w);
520 void ev_signal_stop (EV_P_ ev_signal *w);
521
522 /* only supported in the default loop */
523 void ev_child_start (EV_P_ ev_child *w);
524 void ev_child_stop (EV_P_ ev_child *w);
525
526 # if EV_STAT_ENABLE
527 void ev_stat_start (EV_P_ ev_stat *w);
528 void ev_stat_stop (EV_P_ ev_stat *w);
529 void ev_stat_stat (EV_P_ ev_stat *w);
530 # endif
531
532 # if EV_IDLE_ENABLE
533 void ev_idle_start (EV_P_ ev_idle *w);
534 void ev_idle_stop (EV_P_ ev_idle *w);
535 # endif
536
537 void ev_prepare_start (EV_P_ ev_prepare *w);
538 void ev_prepare_stop (EV_P_ ev_prepare *w);
539
540 void ev_check_start (EV_P_ ev_check *w);
541 void ev_check_stop (EV_P_ ev_check *w);
542
543 # if EV_FORK_ENABLE
544 void ev_fork_start (EV_P_ ev_fork *w);
545 void ev_fork_stop (EV_P_ ev_fork *w);
546 # endif
547
548 # if EV_EMBED_ENABLE
549 /* only supported when loop to be embedded is in fact embeddable */
550 void ev_embed_start (EV_P_ ev_embed *w);
551 void ev_embed_stop (EV_P_ ev_embed *w);
552 void ev_embed_sweep (EV_P_ ev_embed *w);
553 # endif
554
555 #endif
556
557 #ifdef __cplusplus
558 }
559 #endif
560
561 #endif
562