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.125 by root, Mon Aug 3 12:12:40 2009 UTC

35 * and other provisions required by the GPL. If you do not delete the 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 36 * provisions above, a recipient may use your version of this file under
37 * either the BSD or the GPL. 37 * either the BSD or the GPL.
38 */ 38 */
39 39
40#ifndef EV_H__ 40#ifndef EV_H_
41#define EV_H__ 41#define EV_H_
42 42
43#ifdef __cplusplus 43#ifdef __cplusplus
44extern "C" { 44extern "C" {
45#endif 45#endif
46 46
78# define EV_EMBED_ENABLE 1 78# define EV_EMBED_ENABLE 1
79#endif 79#endif
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
84
85#ifndef EV_WALK_ENABLE
86# define EV_WALK_ENABLE 0 /* not yet */
83#endif 87#endif
84 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
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;
154#ifndef EV_PROTOTYPES 161#ifndef EV_PROTOTYPES
155# define EV_PROTOTYPES 1 162# define EV_PROTOTYPES 1
156#endif 163#endif
157 164
158#define EV_VERSION_MAJOR 3 165#define EV_VERSION_MAJOR 3
159#define EV_VERSION_MINOR 0 166#define EV_VERSION_MINOR 7
160 167
161#ifndef EV_CB_DECLARE 168#ifndef EV_CB_DECLARE
162# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 169# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
163#endif 170#endif
164#ifndef EV_CB_INVOKE 171#ifndef EV_CB_INVOKE
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) \
389/* the default */ 402/* the default */
390#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 403#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
391/* flag bits */ 404/* flag bits */
392#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 405#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
393#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ 406#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
407/* debugging/feature disable */
408#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */
409#define EVFLAG_NOSIGFD 0x00200000U /* do not attempt to use signalfd */
394/* method bits to be ored together */ 410/* method bits to be ored together */
395#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 411#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
396#define EVBACKEND_POLL 0x00000002U /* !win */ 412#define EVBACKEND_POLL 0x00000002U /* !win */
397#define EVBACKEND_EPOLL 0x00000004U /* linux */ 413#define EVBACKEND_EPOLL 0x00000004U /* linux */
398#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 414#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
452 468
453/* create and destroy alternative loops that don't handle signals */ 469/* create and destroy alternative loops that don't handle signals */
454struct ev_loop *ev_loop_new (unsigned int flags); 470struct ev_loop *ev_loop_new (unsigned int flags);
455void ev_loop_destroy (EV_P); 471void ev_loop_destroy (EV_P);
456void ev_loop_fork (EV_P); 472void ev_loop_fork (EV_P);
457void ev_loop_verify (EV_P);
458 473
459ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 474ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
460void ev_now_update (EV_P);
461 475
462#else 476#else
463 477
464int ev_default_loop (unsigned int flags); /* returns true when successful */ 478int ev_default_loop (unsigned int flags); /* returns true when successful */
465 479
489/* if you create alternative loops you have to call ev_loop_fork on them */ 503/* 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 */ 504/* you can call it in either the parent or the child */
491/* you can actually call it at any time, anywhere :) */ 505/* you can actually call it at any time, anywhere :) */
492void ev_default_fork (void); 506void ev_default_fork (void);
493 507
494unsigned int ev_backend (EV_P); /* backend in use by loop */ 508unsigned int ev_backend (EV_P); /* backend in use by loop */
495unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 509
510void ev_now_update (EV_P); /* update event loop time */
511
512#if EV_WALK_ENABLE
513/* walk (almost) all watchers in the loop of a given type, invoking the */
514/* callback on every such watcher. The callback might stop the watcher, */
515/* but do nothing else with the loop */
516void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
517#endif
518
496#endif /* prototypes */ 519#endif /* prototypes */
497 520
498#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 521#define EVLOOP_NONBLOCK 1 /* do not block/wait */
499#define EVLOOP_ONESHOT 2 /* block *once* only */ 522#define EVLOOP_ONESHOT 2 /* block *once* only */
500#define EVUNLOOP_CANCEL 0 /* undo unloop */ 523#define EVUNLOOP_CANCEL 0 /* undo unloop */
503 526
504#if EV_PROTOTYPES 527#if EV_PROTOTYPES
505void ev_loop (EV_P_ int flags); 528void 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 */ 529void 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 530
508void 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 */
510
511/* 531/*
512 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 532 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
513 * keeps one reference. if you have a long-runing watcher you never unregister that 533 * keeps one reference. if you have a long-running watcher you never unregister that
514 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 534 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
515 */ 535 */
516void ev_ref (EV_P); 536void ev_ref (EV_P);
517void ev_unref (EV_P); 537void ev_unref (EV_P);
518 538
539/*
519/* convenience function, wait for a single event, without registering an event watcher */ 540 * convenience function, wait for a single event, without registering an event watcher
520/* if timeout is < 0, do wait indefinitely */ 541 * if timeout is < 0, do wait indefinitely
542 */
521void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 543void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
544
545# if EV_MINIMAL < 2
546unsigned int ev_loop_count (EV_P); /* number of loop iterations */
547unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
548void ev_loop_verify (EV_P); /* abort if loop data corrupted */
549
550void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
551void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
552
553/* advanced stuff for threading etc. support, see docs */
554void ev_set_userdata (EV_P_ void *data);
555void *ev_userdata (EV_P);
556void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
557void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
558
559unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
560void ev_invoke_pending (EV_P); /* invoke all pending watchers */
561
562/*
563 * stop/start the timer handling.
564 */
565void ev_suspend (EV_P);
566void ev_resume (EV_P);
567#endif
568
522#endif 569#endif
523 570
524/* these may evaluate ev multiple times, and the other arguments at most once */ 571/* 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 */ 572/* 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 { \ 573#define ev_init(ev,cb_) do { \
527 ((ev_watcher *)(void *)(ev))->active = \ 574 ((ev_watcher *)(void *)(ev))->active = \
528 ((ev_watcher *)(void *)(ev))->pending = \ 575 ((ev_watcher *)(void *)(ev))->pending = 0; \
529 ((ev_watcher *)(void *)(ev))->priority = 0; \ 576 ev_set_priority ((ev), 0); \
530 ev_set_cb ((ev), cb_); \ 577 ev_set_cb ((ev), cb_); \
531} while (0) 578} while (0)
532 579
533#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0) 580#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) 581#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) 582#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) 583#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) 584#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) 585#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) 604#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
558 605
559#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 606#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 */ 607#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
561 608
562#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
563#define ev_cb(ev) (ev)->cb /* rw */ 609#define ev_cb(ev) (ev)->cb /* rw */
610
611#if EV_MINPRI == EV_MAXPRI
612# define ev_priority(ev) ((ev), EV_MINPRI)
613# define ev_set_priority(ev,pri) ((ev), (pri))
614#else
615# define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
564#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) 616# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
617#endif
565 618
566#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 619#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)
567 620
568#ifndef ev_set_cb 621#ifndef ev_set_cb
569# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 622# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
586 639
587void ev_timer_start (EV_P_ ev_timer *w); 640void ev_timer_start (EV_P_ ev_timer *w);
588void ev_timer_stop (EV_P_ ev_timer *w); 641void ev_timer_stop (EV_P_ ev_timer *w);
589/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 642/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
590void ev_timer_again (EV_P_ ev_timer *w); 643void ev_timer_again (EV_P_ ev_timer *w);
644/* return remaining time */
645ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
591 646
592#if EV_PERIODIC_ENABLE 647#if EV_PERIODIC_ENABLE
593void ev_periodic_start (EV_P_ ev_periodic *w); 648void ev_periodic_start (EV_P_ ev_periodic *w);
594void ev_periodic_stop (EV_P_ ev_periodic *w); 649void ev_periodic_stop (EV_P_ ev_periodic *w);
595void ev_periodic_again (EV_P_ ev_periodic *w); 650void ev_periodic_again (EV_P_ ev_periodic *w);

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines