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

Comparing libev/ev.h (file contents):
Revision 1.79 by root, Sat Dec 8 03:53:36 2007 UTC vs.
Revision 1.89 by root, Mon Dec 24 03:41:38 2007 UTC

97/* eventmask, revents, events... */ 97/* eventmask, revents, events... */
98#define EV_UNDEF -1L /* guaranteed to be invalid */ 98#define EV_UNDEF -1L /* guaranteed to be invalid */
99#define EV_NONE 0x00L /* no events */ 99#define EV_NONE 0x00L /* no events */
100#define EV_READ 0x01L /* ev_io detected read will not block */ 100#define EV_READ 0x01L /* ev_io detected read will not block */
101#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 */
102#define EV_TIMEOUT 0x00000100L /* timer timed out */ 103#define EV_TIMEOUT 0x00000100L /* timer timed out */
103#define EV_PERIODIC 0x00000200L /* periodic timer timed out */ 104#define EV_PERIODIC 0x00000200L /* periodic timer timed out */
104#define EV_SIGNAL 0x00000400L /* signal was received */ 105#define EV_SIGNAL 0x00000400L /* signal was received */
105#define EV_CHILD 0x00000800L /* child/pid had status change */ 106#define EV_CHILD 0x00000800L /* child/pid had status change */
106#define EV_STAT 0x00001000L /* stat data changed */ 107#define EV_STAT 0x00001000L /* stat data changed */
117#endif 118#endif
118#ifndef EV_PROTOTYPES 119#ifndef EV_PROTOTYPES
119# define EV_PROTOTYPES 1 120# define EV_PROTOTYPES 1
120#endif 121#endif
121 122
122#define EV_VERSION_MAJOR 1 123#define EV_VERSION_MAJOR 2
123#define EV_VERSION_MINOR 1 124#define EV_VERSION_MINOR 0
124 125
125#ifndef EV_CB_DECLARE 126#ifndef EV_CB_DECLARE
126# 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);
127#endif 128#endif
128#ifndef EV_CB_INVOKE 129#ifndef EV_CB_INVOKE
193/* revent EV_PERIODIC */ 194/* revent EV_PERIODIC */
194typedef struct ev_periodic 195typedef struct ev_periodic
195{ 196{
196 EV_WATCHER_TIME (ev_periodic) 197 EV_WATCHER_TIME (ev_periodic)
197 198
199 ev_tstamp offset; /* rw */
198 ev_tstamp interval; /* rw */ 200 ev_tstamp interval; /* rw */
199 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 */
200} ev_periodic; 202} ev_periodic;
201 203
202/* invoked when the given signal has been received */ 204/* invoked when the given signal has been received */
281/* 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 */
282typedef struct ev_embed 284typedef struct ev_embed
283{ 285{
284 EV_WATCHER (ev_embed) 286 EV_WATCHER (ev_embed)
285 287
286 ev_io io; /* private */
287 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 */
288} ev_embed; 296} ev_embed;
289#endif 297#endif
290 298
291/* the presence of this union forces similar struct layout */ 299/* the presence of this union forces similar struct layout */
292union ev_any_watcher 300union ev_any_watcher
336unsigned int ev_supported_backends (void); 344unsigned int ev_supported_backends (void);
337unsigned int ev_recommended_backends (void); 345unsigned int ev_recommended_backends (void);
338unsigned int ev_embeddable_backends (void); 346unsigned int ev_embeddable_backends (void);
339 347
340ev_tstamp ev_time (void); 348ev_tstamp ev_time (void);
349void ev_sleep (ev_tstamp delay); /* sleep for a while */
341 350
342/* Sets the allocation function to use, works like realloc. 351/* Sets the allocation function to use, works like realloc.
343 * It is used to allocate and free memory. 352 * It is used to allocate and free memory.
344 * 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
345 * or take some potentially destructive action. 354 * or take some potentially destructive action.
393/* 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 */
394/* you can call it in either the parent or the child */ 403/* you can call it in either the parent or the child */
395/* you can actually call it at any time, anywhere :) */ 404/* you can actually call it at any time, anywhere :) */
396void ev_default_fork (void); 405void ev_default_fork (void);
397 406
398unsigned int ev_backend (EV_P); 407unsigned int ev_backend (EV_P); /* backend in use by loop */
399unsigned int ev_loop_count (EV_P); 408unsigned int ev_loop_count (EV_P); /* number of loop iterations */
400#endif 409#endif
401 410
402#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 411#define EVLOOP_NONBLOCK 1 /* do not block/wait */
403#define EVLOOP_ONESHOT 2 /* block *once* only */ 412#define EVLOOP_ONESHOT 2 /* block *once* only */
404#define EVUNLOOP_CANCEL 0 /* undo unloop */ 413#define EVUNLOOP_CANCEL 0 /* undo unloop */
406#define EVUNLOOP_ALL 2 /* unloop all loops */ 415#define EVUNLOOP_ALL 2 /* unloop all loops */
407 416
408#if EV_PROTOTYPES 417#if EV_PROTOTYPES
409void ev_loop (EV_P_ int flags); 418void ev_loop (EV_P_ int flags);
410void 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 */
411 423
412/* 424/*
413 * 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
414 * 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
415 * 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.
429 ((ev_watcher *)(void *)(ev))->pending = \ 441 ((ev_watcher *)(void *)(ev))->pending = \
430 ((ev_watcher *)(void *)(ev))->priority = 0; \ 442 ((ev_watcher *)(void *)(ev))->priority = 0; \
431 ev_set_cb ((ev), cb_); \ 443 ev_set_cb ((ev), cb_); \
432} while (0) 444} while (0)
433 445
434#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)
435#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)
436#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)
437#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)
438#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)
439#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)
440#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 */
441#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 */
442#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 */
443#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)
444#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 */
445 457
446#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)
447#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)
448#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)
449#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 461#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
450#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)
451#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_stat_set ((ev),(path),(interval)); } while (0)
452#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)
453#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)
454#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)
455#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)
456#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)
457 469
458#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 */
459#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 */
460 472
473/* 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 */
474/* accepts any ev_watcher type */ 486/* accepts any ev_watcher type */
475void ev_feed_event (EV_P_ void *w, int revents); 487void ev_feed_event (EV_P_ void *w, int revents);
476void ev_feed_fd_event (EV_P_ int fd, int revents); 488void ev_feed_fd_event (EV_P_ int fd, int revents);
477void 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);
478void ev_clear_pending (EV_P_ void *w, int invoke); 491int ev_clear_pending (EV_P_ void *w);
479 492
480void ev_io_start (EV_P_ ev_io *w); 493void ev_io_start (EV_P_ ev_io *w);
481void ev_io_stop (EV_P_ ev_io *w); 494void ev_io_stop (EV_P_ ev_io *w);
482 495
483void ev_timer_start (EV_P_ ev_timer *w); 496void ev_timer_start (EV_P_ ev_timer *w);

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines