ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
(Generate patch)

Comparing libev/ev.h (file contents):
Revision 1.75 by root, Wed Nov 28 17:32:24 2007 UTC vs.
Revision 1.88 by root, Sat Dec 22 05:48:00 2007 UTC

… …
54 54
55#ifndef EV_STAT_ENABLE 55#ifndef EV_STAT_ENABLE
56# define EV_STAT_ENABLE 1 56# define EV_STAT_ENABLE 1
57#endif 57#endif
58 58
59#ifndef EV_IDLE_ENABLE
60# define EV_IDLE_ENABLE 1
61#endif
62
59#ifndef EV_FORK_ENABLE 63#ifndef EV_FORK_ENABLE
60# define EV_FORK_ENABLE 1 64# define EV_FORK_ENABLE 1
61#endif 65#endif
62 66
63#ifndef EV_EMBED_ENABLE 67#ifndef EV_EMBED_ENABLE
… …
93/* eventmask, revents, events... */ 97/* eventmask, revents, events... */
94#define EV_UNDEF -1L /* guaranteed to be invalid */ 98#define EV_UNDEF -1L /* guaranteed to be invalid */
95#define EV_NONE 0x00L /* no events */ 99#define EV_NONE 0x00L /* no events */
96#define EV_READ 0x01L /* ev_io detected read will not block */ 100#define EV_READ 0x01L /* ev_io detected read will not block */
97#define EV_WRITE 0x02L /* ev_io detected write will not block */ 101#define EV_WRITE 0x02L /* ev_io detected write will not block */
102#define EV_IOFDSET 0x80L /* internal use only */
98#define EV_TIMEOUT 0x00000100L /* timer timed out */ 103#define EV_TIMEOUT 0x00000100L /* timer timed out */
99#define EV_PERIODIC 0x00000200L /* periodic timer timed out */ 104#define EV_PERIODIC 0x00000200L /* periodic timer timed out */
100#define EV_SIGNAL 0x00000400L /* signal was received */ 105#define EV_SIGNAL 0x00000400L /* signal was received */
101#define EV_CHILD 0x00000800L /* child/pid had status change */ 106#define EV_CHILD 0x00000800L /* child/pid had status change */
102#define EV_STAT 0x00001000L /* stat data changed */ 107#define EV_STAT 0x00001000L /* stat data changed */
… …
113#endif 118#endif
114#ifndef EV_PROTOTYPES 119#ifndef EV_PROTOTYPES
115# define EV_PROTOTYPES 1 120# define EV_PROTOTYPES 1
116#endif 121#endif
117 122
118#define EV_VERSION_MAJOR 1 123#define EV_VERSION_MAJOR 2
119#define EV_VERSION_MINOR 1 124#define EV_VERSION_MINOR 0
120 125
121#ifndef EV_CB_DECLARE 126#ifndef EV_CB_DECLARE
122# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 127# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
123#endif 128#endif
124#ifndef EV_CB_INVOKE 129#ifndef EV_CB_INVOKE
… …
189/* revent EV_PERIODIC */ 194/* revent EV_PERIODIC */
190typedef struct ev_periodic 195typedef struct ev_periodic
191{ 196{
192 EV_WATCHER_TIME (ev_periodic) 197 EV_WATCHER_TIME (ev_periodic)
193 198
199 ev_tstamp offset; /* rw */
194 ev_tstamp interval; /* rw */ 200 ev_tstamp interval; /* rw */
195 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 201 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
196} ev_periodic; 202} ev_periodic;
197 203
198/* invoked when the given signal has been received */ 204/* invoked when the given signal has been received */
… …
238 244
239 int wd; /* wd for inotify, fd for kqueue */ 245 int wd; /* wd for inotify, fd for kqueue */
240} ev_stat; 246} ev_stat;
241#endif 247#endif
242 248
249#if EV_IDLE_ENABLE
243/* invoked when the nothing else needs to be done, keeps the process from blocking */ 250/* invoked when the nothing else needs to be done, keeps the process from blocking */
244/* revent EV_IDLE */ 251/* revent EV_IDLE */
245typedef struct ev_idle 252typedef struct ev_idle
246{ 253{
247 EV_WATCHER (ev_idle) 254 EV_WATCHER (ev_idle)
248} ev_idle; 255} ev_idle;
256#endif
249 257
250/* invoked for each run of the mainloop, just before the blocking call */ 258/* invoked for each run of the mainloop, just before the blocking call */
251/* you can still change events in any way you like */ 259/* you can still change events in any way you like */
252/* revent EV_PREPARE */ 260/* revent EV_PREPARE */
253typedef struct ev_prepare 261typedef struct ev_prepare
… …
275/* the callback gets invoked when the event loop has handled events, and can be 0 */ 283/* the callback gets invoked when the event loop has handled events, and can be 0 */
276typedef struct ev_embed 284typedef struct ev_embed
277{ 285{
278 EV_WATCHER (ev_embed) 286 EV_WATCHER (ev_embed)
279 287
280 ev_io io; /* private */
281 struct ev_loop *loop; /* ro */ 288 struct ev_loop *other; /* ro */
289 ev_io io; /* private */
290 ev_prepare prepare; /* private */
291 ev_check check; /* unused */
292 ev_timer timer; /* unused */
293 ev_periodic periodic; /* unused */
294 ev_idle idle; /* unused */
295 ev_fork fork; /* unused */
282} ev_embed; 296} ev_embed;
283#endif 297#endif
284 298
285/* the presence of this union forces similar struct layout */ 299/* the presence of this union forces similar struct layout */
286union ev_any_watcher 300union ev_any_watcher
… …
294 struct ev_signal signal; 308 struct ev_signal signal;
295 struct ev_child child; 309 struct ev_child child;
296#if EV_STAT_ENABLE 310#if EV_STAT_ENABLE
297 struct ev_stat stat; 311 struct ev_stat stat;
298#endif 312#endif
313#if EV_IDLE_ENABLE
299 struct ev_idle idle; 314 struct ev_idle idle;
315#endif
300 struct ev_prepare prepare; 316 struct ev_prepare prepare;
301 struct ev_check check; 317 struct ev_check check;
302#if EV_FORK_ENABLE 318#if EV_FORK_ENABLE
303 struct ev_fork fork; 319 struct ev_fork fork;
304#endif 320#endif
… …
310/* bits for ev_default_loop and ev_loop_new */ 326/* bits for ev_default_loop and ev_loop_new */
311/* the default */ 327/* the default */
312#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */ 328#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */
313/* flag bits */ 329/* flag bits */
314#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */ 330#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */
331#define EVFLAG_FORKCHECK 0x02000000UL /* check for a fork in each iteration */
315/* method bits to be ored together */ 332/* method bits to be ored together */
316#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */ 333#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */
317#define EVBACKEND_POLL 0x00000002UL /* !win */ 334#define EVBACKEND_POLL 0x00000002UL /* !win */
318#define EVBACKEND_EPOLL 0x00000004UL /* linux */ 335#define EVBACKEND_EPOLL 0x00000004UL /* linux */
319#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */ 336#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */
… …
327unsigned int ev_supported_backends (void); 344unsigned int ev_supported_backends (void);
328unsigned int ev_recommended_backends (void); 345unsigned int ev_recommended_backends (void);
329unsigned int ev_embeddable_backends (void); 346unsigned int ev_embeddable_backends (void);
330 347
331ev_tstamp ev_time (void); 348ev_tstamp ev_time (void);
349void ev_sleep (ev_tstamp delay); /* sleep for a while */
332 350
333/* Sets the allocation function to use, works like realloc. 351/* Sets the allocation function to use, works like realloc.
334 * It is used to allocate and free memory. 352 * It is used to allocate and free memory.
335 * If it returns zero when memory needs to be allocated, the library might abort 353 * If it returns zero when memory needs to be allocated, the library might abort
336 * or take some potentially destructive action. 354 * or take some potentially destructive action.
… …
384/* if you create alternative loops you have to call ev_loop_fork on them */ 402/* if you create alternative loops you have to call ev_loop_fork on them */
385/* you can call it in either the parent or the child */ 403/* you can call it in either the parent or the child */
386/* you can actually call it at any time, anywhere :) */ 404/* you can actually call it at any time, anywhere :) */
387void ev_default_fork (void); 405void ev_default_fork (void);
388 406
389unsigned int ev_backend (EV_P); 407unsigned int ev_backend (EV_P); /* backend in use by loop */
408unsigned int ev_loop_count (EV_P); /* number of loop iterations */
390#endif 409#endif
391 410
392#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 411#define EVLOOP_NONBLOCK 1 /* do not block/wait */
393#define EVLOOP_ONESHOT 2 /* block *once* only */ 412#define EVLOOP_ONESHOT 2 /* block *once* only */
394#define EVUNLOOP_CANCEL 0 /* undo unloop */ 413#define EVUNLOOP_CANCEL 0 /* undo unloop */
… …
396#define EVUNLOOP_ALL 2 /* unloop all loops */ 415#define EVUNLOOP_ALL 2 /* unloop all loops */
397 416
398#if EV_PROTOTYPES 417#if EV_PROTOTYPES
399void ev_loop (EV_P_ int flags); 418void ev_loop (EV_P_ int flags);
400void 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 */ 419void 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 */
420
421void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
422void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
401 423
402/* 424/*
403 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 425 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
404 * keeps one reference. if you have a long-runing watcher you never unregister that 426 * keeps one reference. if you have a long-runing watcher you never unregister that
405 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 427 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
… …
412void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 434void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
413#endif 435#endif
414 436
415/* these may evaluate ev multiple times, and the other arguments at most once */ 437/* these may evaluate ev multiple times, and the other arguments at most once */
416/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 438/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
417#define ev_init(ev,cb_) do { \ 439#define ev_init(ev,cb_) do { \
418 ((ev_watcher *)(void *)(ev))->active = \ 440 ((ev_watcher *)(void *)(ev))->active = \
419 ((ev_watcher *)(void *)(ev))->pending = \ 441 ((ev_watcher *)(void *)(ev))->pending = \
420 ((ev_watcher *)(void *)(ev))->priority = 0; \ 442 ((ev_watcher *)(void *)(ev))->priority = 0; \
421 ev_set_cb ((ev), cb_); \ 443 ev_set_cb ((ev), cb_); \
422} while (0) 444} while (0)
423 445
424#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 446#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0)
425#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 447#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
426#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 448#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
427#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 449#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
428#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 450#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
429#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0) 451#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
430#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 452#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
431#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 453#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
432#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 454#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
433#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0) 455#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
434#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 456#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
435 457
436#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 458#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
437#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 459#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
438#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 460#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
… …
440#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 462#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
441#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0) 463#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0)
442#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 464#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
443#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 465#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
444#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 466#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
445#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0) 467#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
446#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 468#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
447 469
448#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 470#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
449#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 471#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
450 472
451#define ev_priority(ev) ((ev_watcher *)(void *)(ev))->priority /* rw */ 473#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
452#define ev_cb(ev) (ev)->cb /* rw */ 474#define ev_cb(ev) (ev)->cb /* rw */
453#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) 475#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri)
454 476
455#ifndef ev_set_cb 477#ifndef ev_set_cb
456# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 478# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
457#endif 479#endif
458 480
… …
463/* feeds an event into a watcher as if the event actually occured */ 485/* feeds an event into a watcher as if the event actually occured */
464/* accepts any ev_watcher type */ 486/* accepts any ev_watcher type */
465void ev_feed_event (EV_P_ void *w, int revents); 487void ev_feed_event (EV_P_ void *w, int revents);
466void ev_feed_fd_event (EV_P_ int fd, int revents); 488void ev_feed_fd_event (EV_P_ int fd, int revents);
467void ev_feed_signal_event (EV_P_ int signum); 489void ev_feed_signal_event (EV_P_ int signum);
490void ev_invoke (EV_P_ void *w, int revents);
491int ev_clear_pending (EV_P_ void *w);
468 492
469void ev_io_start (EV_P_ ev_io *w); 493void ev_io_start (EV_P_ ev_io *w);
470void ev_io_stop (EV_P_ ev_io *w); 494void ev_io_stop (EV_P_ ev_io *w);
471 495
472void ev_timer_start (EV_P_ ev_timer *w); 496void ev_timer_start (EV_P_ ev_timer *w);
… …
492void ev_stat_start (EV_P_ ev_stat *w); 516void ev_stat_start (EV_P_ ev_stat *w);
493void ev_stat_stop (EV_P_ ev_stat *w); 517void ev_stat_stop (EV_P_ ev_stat *w);
494void ev_stat_stat (EV_P_ ev_stat *w); 518void ev_stat_stat (EV_P_ ev_stat *w);
495# endif 519# endif
496 520
521# if EV_IDLE_ENABLE
497void ev_idle_start (EV_P_ ev_idle *w); 522void ev_idle_start (EV_P_ ev_idle *w);
498void ev_idle_stop (EV_P_ ev_idle *w); 523void ev_idle_stop (EV_P_ ev_idle *w);
524# endif
499 525
500void ev_prepare_start (EV_P_ ev_prepare *w); 526void ev_prepare_start (EV_P_ ev_prepare *w);
501void ev_prepare_stop (EV_P_ ev_prepare *w); 527void ev_prepare_stop (EV_P_ ev_prepare *w);
502 528
503void ev_check_start (EV_P_ ev_check *w); 529void ev_check_start (EV_P_ ev_check *w);

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines