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

Comparing libev/ev.h (file contents):
Revision 1.110 by root, Wed Mar 4 14:33:10 2009 UTC vs.
Revision 1.119 by root, Fri Jul 10 00:36:21 2009 UTC

80 80
81#ifndef EV_ASYNC_ENABLE 81#ifndef EV_ASYNC_ENABLE
82# define EV_ASYNC_ENABLE 1 82# define EV_ASYNC_ENABLE 1
83#endif 83#endif
84 84
85#ifndef EV_WALK_ENABLE
86# define EV_WALK_ENABLE 0 /* not yet */
87#endif
88
85#ifndef EV_ATOMIC_T 89#ifndef EV_ATOMIC_T
86# include <signal.h> 90# include <signal.h>
87# define EV_ATOMIC_T sig_atomic_t volatile 91# define EV_ATOMIC_T sig_atomic_t volatile
88#endif 92#endif
89 93
131/* eventmask, revents, events... */ 135/* eventmask, revents, events... */
132#define EV_UNDEF -1 /* guaranteed to be invalid */ 136#define EV_UNDEF -1 /* guaranteed to be invalid */
133#define EV_NONE 0x00 /* no events */ 137#define EV_NONE 0x00 /* no events */
134#define EV_READ 0x01 /* ev_io detected read will not block */ 138#define EV_READ 0x01 /* ev_io detected read will not block */
135#define EV_WRITE 0x02 /* ev_io detected write will not block */ 139#define EV_WRITE 0x02 /* ev_io detected write will not block */
136#define EV_IOFDSET 0x80 /* internal use only */ 140#define EV__IOFDSET 0x80 /* internal use only */
141#define EV_IO EV_READ /* alias for type-detection */
137#define EV_TIMEOUT 0x00000100 /* timer timed out */ 142#define EV_TIMEOUT 0x00000100 /* timer timed out */
143#define EV_TIMER EV_TIMEOUT /* alias for type-detection */
138#define EV_PERIODIC 0x00000200 /* periodic timer timed out */ 144#define EV_PERIODIC 0x00000200 /* periodic timer timed out */
139#define EV_SIGNAL 0x00000400 /* signal was received */ 145#define EV_SIGNAL 0x00000400 /* signal was received */
140#define EV_CHILD 0x00000800 /* child/pid had status change */ 146#define EV_CHILD 0x00000800 /* child/pid had status change */
141#define EV_STAT 0x00001000 /* stat data changed */ 147#define EV_STAT 0x00001000 /* stat data changed */
142#define EV_IDLE 0x00002000 /* event loop is idling */ 148#define EV_IDLE 0x00002000 /* event loop is idling */
143#define EV_PREPARE 0x00004000 /* event loop about to poll */ 149#define EV_PREPARE 0x00004000 /* event loop about to poll */
144#define EV_CHECK 0x00008000 /* event loop finished poll */ 150#define EV_CHECK 0x00008000 /* event loop finished poll */
145#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ 151#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
146#define EV_FORK 0x00020000 /* event loop resumed in child */ 152#define EV_FORK 0x00020000 /* event loop resumed in child */
147#define EV_ASYNC 0x00040000 /* async intra-loop signal */ 153#define EV_ASYNC 0x00040000 /* async intra-loop signal */
154#define EV_CUSTOM 0x01000000 /* for use by user code */
148#define EV_ERROR 0x80000000 /* sent when an error occurs */ 155#define EV_ERROR 0x80000000 /* sent when an error occurs */
149 156
150/* can be used to add custom fields to all watchers, while losing binary compatibility */ 157/* can be used to add custom fields to all watchers, while losing binary compatibility */
151#ifndef EV_COMMON 158#ifndef EV_COMMON
152# define EV_COMMON void *data; 159# define EV_COMMON void *data;
180 * or simply 1 for watchers that aren't in some array. 187 * or simply 1 for watchers that aren't in some array.
181 * pending is either 0, in which case the watcher isn't, 188 * pending is either 0, in which case the watcher isn't,
182 * or the array index + 1 in the pendings array. 189 * or the array index + 1 in the pendings array.
183 */ 190 */
184 191
192#if EV_MINPRI == EV_MAXPRI
193# define EV_DECL_PRIORITY
194#else
195# define EV_DECL_PRIORITY int priority;
196#endif
197
185/* shared by all watchers */ 198/* shared by all watchers */
186#define EV_WATCHER(type) \ 199#define EV_WATCHER(type) \
187 int active; /* private */ \ 200 int active; /* private */ \
188 int pending; /* private */ \ 201 int pending; /* private */ \
189 int priority; /* private */ \ 202 EV_DECL_PRIORITY /* private */ \
190 EV_COMMON /* rw */ \ 203 EV_COMMON /* rw */ \
191 EV_CB_DECLARE (type) /* private */ 204 EV_CB_DECLARE (type) /* private */
192 205
193#define EV_WATCHER_LIST(type) \ 206#define EV_WATCHER_LIST(type) \
194 EV_WATCHER (type) \ 207 EV_WATCHER (type) \
452 465
453/* create and destroy alternative loops that don't handle signals */ 466/* create and destroy alternative loops that don't handle signals */
454struct ev_loop *ev_loop_new (unsigned int flags); 467struct ev_loop *ev_loop_new (unsigned int flags);
455void ev_loop_destroy (EV_P); 468void ev_loop_destroy (EV_P);
456void ev_loop_fork (EV_P); 469void ev_loop_fork (EV_P);
457void ev_loop_verify (EV_P);
458 470
459ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 471ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
460void ev_now_update (EV_P);
461 472
462#else 473#else
463 474
464int ev_default_loop (unsigned int flags); /* returns true when successful */ 475int ev_default_loop (unsigned int flags); /* returns true when successful */
465 476
489/* if you create alternative loops you have to call ev_loop_fork on them */ 500/* if you create alternative loops you have to call ev_loop_fork on them */
490/* you can call it in either the parent or the child */ 501/* you can call it in either the parent or the child */
491/* you can actually call it at any time, anywhere :) */ 502/* you can actually call it at any time, anywhere :) */
492void ev_default_fork (void); 503void ev_default_fork (void);
493 504
494unsigned int ev_backend (EV_P); /* backend in use by loop */ 505unsigned int ev_backend (EV_P); /* backend in use by loop */
495unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 506
507void ev_now_update (EV_P); /* update event loop time */
508
509#if EV_WALK_ENABLE
510/* walk (almost) all watchers in the loop of a given type, invoking the */
511/* callback on every such watcher. The callback might stop the watcher, */
512/* but do nothing else with the loop */
513void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
514#endif
515
496#endif /* prototypes */ 516#endif /* prototypes */
497 517
498#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 518#define EVLOOP_NONBLOCK 1 /* do not block/wait */
499#define EVLOOP_ONESHOT 2 /* block *once* only */ 519#define EVLOOP_ONESHOT 2 /* block *once* only */
500#define EVUNLOOP_CANCEL 0 /* undo unloop */ 520#define EVUNLOOP_CANCEL 0 /* undo unloop */
503 523
504#if EV_PROTOTYPES 524#if EV_PROTOTYPES
505void ev_loop (EV_P_ int flags); 525void ev_loop (EV_P_ int flags);
506void 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 */ 526void 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 */
507 527
528/*
529 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
530 * keeps one reference. if you have a long-running watcher you never unregister that
531 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
532 */
533void ev_ref (EV_P);
534void ev_unref (EV_P);
535
536/*
537 * convenience function, wait for a single event, without registering an event watcher
538 * if timeout is < 0, do wait indefinitely
539 */
540void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
541
542# if EV_MINIMAL < 2
543unsigned int ev_loop_count (EV_P); /* number of loop iterations */
544unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
545void ev_loop_verify (EV_P); /* abort if loop data corrupted */
546
508void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 547void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
509void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 548void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
510 549
511/* 550/*
512 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 551 * a single void * can be attached to each loop. this is intended
513 * keeps one reference. if you have a long-runing watcher you never unregister that 552 * to aid the invoke_pending/blocking callbacks.
514 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
515 */ 553 */
554void ev_set_userdata (EV_P_ void *data);
555void *ev_userdata (EV_P);
556
557/*
558 * hooks to overide how and when libev invokes callbacks,
559 * and hooks that wrap the actual eventloop blocking call.
560 */
561void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
562void ev_set_blocking_cb (EV_P_ void (*suspend_cb_)(EV_P), void (*resume_cb_)(EV_P));
563
564void ev_invoke_pending (EV_P); /* invoke all pending watchers */
565
566/*
567 * stop/start the timer handling.
568 */
569void ev_suspend (EV_P);
516void ev_ref (EV_P); 570void ev_resume (EV_P);
517void ev_unref (EV_P); 571#endif
518 572
519/* convenience function, wait for a single event, without registering an event watcher */
520/* if timeout is < 0, do wait indefinitely */
521void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
522#endif 573#endif
523 574
524/* these may evaluate ev multiple times, and the other arguments at most once */ 575/* these may evaluate ev multiple times, and the other arguments at most once */
525/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 576/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
526#define ev_init(ev,cb_) do { \ 577#define ev_init(ev,cb_) do { \
527 ((ev_watcher *)(void *)(ev))->active = \ 578 ((ev_watcher *)(void *)(ev))->active = \
528 ((ev_watcher *)(void *)(ev))->pending = \ 579 ((ev_watcher *)(void *)(ev))->pending = 0; \
529 ((ev_watcher *)(void *)(ev))->priority = 0; \ 580 ev_set_priority ((ev), 0); \
530 ev_set_cb ((ev), cb_); \ 581 ev_set_cb ((ev), cb_); \
531} while (0) 582} while (0)
532 583
533#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0) 584#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
534#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0) 585#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
535#define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0) 586#define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0)
536#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 587#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
537#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0) 588#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
538#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0) 589#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
557#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 608#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
558 609
559#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 610#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
560#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 611#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
561 612
562#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
563#define ev_cb(ev) (ev)->cb /* rw */ 613#define ev_cb(ev) (ev)->cb /* rw */
614
615#if EV_MINPRI == EV_MAXPRI
616# define ev_priority(ev) ((ev), EV_MINPRI)
617# define ev_set_priority(ev,pri) ((ev), (pri))
618#else
619# define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
564#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) 620# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
621#endif
565 622
566#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 623#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)
567 624
568#ifndef ev_set_cb 625#ifndef ev_set_cb
569# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 626# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines