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

Comparing libev/ev.h (file contents):
Revision 1.112 by root, Sat Mar 28 22:17:17 2009 UTC vs.
Revision 1.133 by root, Wed Mar 10 09:23:07 2010 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
… …
64 64
65#ifndef EV_STAT_ENABLE 65#ifndef EV_STAT_ENABLE
66# define EV_STAT_ENABLE 1 66# define EV_STAT_ENABLE 1
67#endif 67#endif
68 68
69#ifndef EV_PREPARE_ENABLE
70# define EV_PREPARE_ENABLE 1
71#endif
72
73#ifndef EV_CHECK_ENABLE
74# define EV_CHECK_ENABLE 1
75#endif
76
69#ifndef EV_IDLE_ENABLE 77#ifndef EV_IDLE_ENABLE
70# define EV_IDLE_ENABLE 1 78# define EV_IDLE_ENABLE 1
71#endif 79#endif
72 80
73#ifndef EV_FORK_ENABLE 81#ifndef EV_FORK_ENABLE
74# define EV_FORK_ENABLE 1 82# define EV_FORK_ENABLE 1
75#endif 83#endif
76 84
85#ifndef EV_SIGNAL_ENABLE
86# define EV_SIGNAL_ENABLE 1
87#endif
88
89#ifndef EV_CHILD_ENABLE
90# ifdef _WIN32
91# define EV_CHILD_ENABLE 0
92# else
93# define EV_CHILD_ENABLE 1
94#endif
95#endif
96
97#ifndef EV_ASYNC_ENABLE
98# define EV_ASYNC_ENABLE 1
99#endif
100
77#ifndef EV_EMBED_ENABLE 101#ifndef EV_EMBED_ENABLE
78# define EV_EMBED_ENABLE 1 102# define EV_EMBED_ENABLE 1
79#endif 103#endif
80 104
81#ifndef EV_ASYNC_ENABLE 105#ifndef EV_WALK_ENABLE
82# define EV_ASYNC_ENABLE 1 106# define EV_WALK_ENABLE 0 /* not yet */
83#endif 107#endif
84 108
85#ifndef EV_ATOMIC_T 109#ifndef EV_ATOMIC_T
86# include <signal.h> 110# include <signal.h>
87# define EV_ATOMIC_T sig_atomic_t volatile 111# define EV_ATOMIC_T sig_atomic_t volatile
88#endif 112#endif
89 113
90/*****************************************************************************/ 114/*****************************************************************************/
115
116#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
117# undef EV_SIGNAL_ENABLE
118# define EV_SIGNAL_ENABLE 1
119#endif
91 120
92#if EV_STAT_ENABLE 121#if EV_STAT_ENABLE
93# ifdef _WIN32 122# ifdef _WIN32
94# include <time.h> 123# include <time.h>
95# include <sys/types.h> 124# include <sys/types.h>
… …
145#define EV_PREPARE 0x00004000 /* event loop about to poll */ 174#define EV_PREPARE 0x00004000 /* event loop about to poll */
146#define EV_CHECK 0x00008000 /* event loop finished poll */ 175#define EV_CHECK 0x00008000 /* event loop finished poll */
147#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ 176#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
148#define EV_FORK 0x00020000 /* event loop resumed in child */ 177#define EV_FORK 0x00020000 /* event loop resumed in child */
149#define EV_ASYNC 0x00040000 /* async intra-loop signal */ 178#define EV_ASYNC 0x00040000 /* async intra-loop signal */
179#define EV_CUSTOM 0x01000000 /* for use by user code */
150#define EV_ERROR 0x80000000 /* sent when an error occurs */ 180#define EV_ERROR 0x80000000 /* sent when an error occurs */
151 181
152/* can be used to add custom fields to all watchers, while losing binary compatibility */ 182/* can be used to add custom fields to all watchers, while losing binary compatibility */
153#ifndef EV_COMMON 183#ifndef EV_COMMON
154# define EV_COMMON void *data; 184# define EV_COMMON void *data;
… …
156#ifndef EV_PROTOTYPES 186#ifndef EV_PROTOTYPES
157# define EV_PROTOTYPES 1 187# define EV_PROTOTYPES 1
158#endif 188#endif
159 189
160#define EV_VERSION_MAJOR 3 190#define EV_VERSION_MAJOR 3
161#define EV_VERSION_MINOR 0 191#define EV_VERSION_MINOR 9
162 192
163#ifndef EV_CB_DECLARE 193#ifndef EV_CB_DECLARE
164# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 194# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
165#endif 195#endif
166#ifndef EV_CB_INVOKE 196#ifndef EV_CB_INVOKE
… …
182 * or simply 1 for watchers that aren't in some array. 212 * or simply 1 for watchers that aren't in some array.
183 * pending is either 0, in which case the watcher isn't, 213 * pending is either 0, in which case the watcher isn't,
184 * or the array index + 1 in the pendings array. 214 * or the array index + 1 in the pendings array.
185 */ 215 */
186 216
217#if EV_MINPRI == EV_MAXPRI
218# define EV_DECL_PRIORITY
219#else
220# define EV_DECL_PRIORITY int priority;
221#endif
222
187/* shared by all watchers */ 223/* shared by all watchers */
188#define EV_WATCHER(type) \ 224#define EV_WATCHER(type) \
189 int active; /* private */ \ 225 int active; /* private */ \
190 int pending; /* private */ \ 226 int pending; /* private */ \
191 int priority; /* private */ \ 227 EV_DECL_PRIORITY /* private */ \
192 EV_COMMON /* rw */ \ 228 EV_COMMON /* rw */ \
193 EV_CB_DECLARE (type) /* private */ 229 EV_CB_DECLARE (type) /* private */
194 230
195#define EV_WATCHER_LIST(type) \ 231#define EV_WATCHER_LIST(type) \
196 EV_WATCHER (type) \ 232 EV_WATCHER (type) \
… …
352 EV_WATCHER (ev_async) 388 EV_WATCHER (ev_async)
353 389
354 EV_ATOMIC_T sent; /* private */ 390 EV_ATOMIC_T sent; /* private */
355} ev_async; 391} ev_async;
356 392
357# define ev_async_pending(w) ((w)->sent + 0) 393# define ev_async_pending(w) (+(w)->sent)
358#endif 394#endif
359 395
360/* the presence of this union forces similar struct layout */ 396/* the presence of this union forces similar struct layout */
361union ev_any_watcher 397union ev_any_watcher
362{ 398{
… …
391/* the default */ 427/* the default */
392#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 428#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
393/* flag bits */ 429/* flag bits */
394#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 430#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
395#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ 431#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
432/* debugging/feature disable */
433#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */
434#define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */
435#define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */
396/* method bits to be ored together */ 436/* method bits to be ored together */
397#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 437#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
398#define EVBACKEND_POLL 0x00000002U /* !win */ 438#define EVBACKEND_POLL 0x00000002U /* !win */
399#define EVBACKEND_EPOLL 0x00000004U /* linux */ 439#define EVBACKEND_EPOLL 0x00000004U /* linux */
400#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 440#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
401#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 441#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
402#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 442#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
443#define EVBACKEND_ALL 0x0000003FU
403 444
404#if EV_PROTOTYPES 445#if EV_PROTOTYPES
405int ev_version_major (void); 446int ev_version_major (void);
406int ev_version_minor (void); 447int ev_version_minor (void);
407 448
… …
454 495
455/* create and destroy alternative loops that don't handle signals */ 496/* create and destroy alternative loops that don't handle signals */
456struct ev_loop *ev_loop_new (unsigned int flags); 497struct ev_loop *ev_loop_new (unsigned int flags);
457void ev_loop_destroy (EV_P); 498void ev_loop_destroy (EV_P);
458void ev_loop_fork (EV_P); 499void ev_loop_fork (EV_P);
459void ev_loop_verify (EV_P);
460 500
461ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 501ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
462void ev_now_update (EV_P);
463 502
464#else 503#else
465 504
466int ev_default_loop (unsigned int flags); /* returns true when successful */ 505int ev_default_loop (unsigned int flags); /* returns true when successful */
467 506
… …
491/* if you create alternative loops you have to call ev_loop_fork on them */ 530/* if you create alternative loops you have to call ev_loop_fork on them */
492/* you can call it in either the parent or the child */ 531/* you can call it in either the parent or the child */
493/* you can actually call it at any time, anywhere :) */ 532/* you can actually call it at any time, anywhere :) */
494void ev_default_fork (void); 533void ev_default_fork (void);
495 534
496#if 0 535unsigned int ev_backend (EV_P); /* backend in use by loop */
536
537void ev_now_update (EV_P); /* update event loop time */
538
539#if EV_WALK_ENABLE
497/* walk (almost) all watchers in the loop of a given type, invoking the */ 540/* walk (almost) all watchers in the loop of a given type, invoking the */
498/* callback on every such watcher. The callback might stop the watcher, */ 541/* callback on every such watcher. The callback might stop the watcher, */
499/* but do nothing else with the loop */ 542/* but do nothing else with the loop */
500void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 543void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
501#endif 544#endif
502 545
503unsigned int ev_backend (EV_P); /* backend in use by loop */
504unsigned int ev_loop_count (EV_P); /* number of loop iterations */
505#endif /* prototypes */ 546#endif /* prototypes */
506 547
507#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 548#define EVLOOP_NONBLOCK 1 /* do not block/wait */
508#define EVLOOP_ONESHOT 2 /* block *once* only */ 549#define EVLOOP_ONESHOT 2 /* block *once* only */
509#define EVUNLOOP_CANCEL 0 /* undo unloop */ 550#define EVUNLOOP_CANCEL 0 /* undo unloop */
… …
512 553
513#if EV_PROTOTYPES 554#if EV_PROTOTYPES
514void ev_loop (EV_P_ int flags); 555void ev_loop (EV_P_ int flags);
515void 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 */ 556void 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 */
516 557
517void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
518void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
519
520/* 558/*
521 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 559 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
522 * keeps one reference. if you have a long-runing watcher you never unregister that 560 * keeps one reference. if you have a long-running watcher you never unregister that
523 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 561 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
524 */ 562 */
525void ev_ref (EV_P); 563void ev_ref (EV_P);
526void ev_unref (EV_P); 564void ev_unref (EV_P);
527 565
566/*
528/* convenience function, wait for a single event, without registering an event watcher */ 567 * convenience function, wait for a single event, without registering an event watcher
529/* if timeout is < 0, do wait indefinitely */ 568 * if timeout is < 0, do wait indefinitely
569 */
530void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 570void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
571
572# if EV_MINIMAL < 2
573unsigned int ev_loop_count (EV_P); /* number of loop iterations */
574unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
575void ev_loop_verify (EV_P); /* abort if loop data corrupted */
576
577void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
578void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
579
580/* advanced stuff for threading etc. support, see docs */
581void ev_set_userdata (EV_P_ void *data);
582void *ev_userdata (EV_P);
583void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
584void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
585
586unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
587void ev_invoke_pending (EV_P); /* invoke all pending watchers */
588
589/*
590 * stop/start the timer handling.
591 */
592void ev_suspend (EV_P);
593void ev_resume (EV_P);
594#endif
595
531#endif 596#endif
532 597
533/* these may evaluate ev multiple times, and the other arguments at most once */ 598/* these may evaluate ev multiple times, and the other arguments at most once */
534/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 599/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
535#define ev_init(ev,cb_) do { \ 600#define ev_init(ev,cb_) do { \
536 ((ev_watcher *)(void *)(ev))->active = \ 601 ((ev_watcher *)(void *)(ev))->active = \
537 ((ev_watcher *)(void *)(ev))->pending = \ 602 ((ev_watcher *)(void *)(ev))->pending = 0; \
538 ((ev_watcher *)(void *)(ev))->priority = 0; \ 603 ev_set_priority ((ev), 0); \
539 ev_set_cb ((ev), cb_); \ 604 ev_set_cb ((ev), cb_); \
540} while (0) 605} while (0)
541 606
542#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0) 607#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
543#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0) 608#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
… …
566#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 631#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
567 632
568#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 633#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
569#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 634#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
570 635
571#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
572#define ev_cb(ev) (ev)->cb /* rw */ 636#define ev_cb(ev) (ev)->cb /* rw */
637
638#if EV_MINPRI == EV_MAXPRI
639# define ev_priority(ev) ((ev), EV_MINPRI)
640# define ev_set_priority(ev,pri) ((ev), (pri))
641#else
642# define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
573#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) 643# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
644#endif
574 645
575#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 646#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
576 647
577#ifndef ev_set_cb 648#ifndef ev_set_cb
578# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 649# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
579#endif 650#endif
580 651
… …
584 655
585/* feeds an event into a watcher as if the event actually occured */ 656/* feeds an event into a watcher as if the event actually occured */
586/* accepts any ev_watcher type */ 657/* accepts any ev_watcher type */
587void ev_feed_event (EV_P_ void *w, int revents); 658void ev_feed_event (EV_P_ void *w, int revents);
588void ev_feed_fd_event (EV_P_ int fd, int revents); 659void ev_feed_fd_event (EV_P_ int fd, int revents);
660#if EV_SIGNAL_ENABLE
589void ev_feed_signal_event (EV_P_ int signum); 661void ev_feed_signal_event (EV_P_ int signum);
662#endif
590void ev_invoke (EV_P_ void *w, int revents); 663void ev_invoke (EV_P_ void *w, int revents);
591int ev_clear_pending (EV_P_ void *w); 664int ev_clear_pending (EV_P_ void *w);
592 665
593void ev_io_start (EV_P_ ev_io *w); 666void ev_io_start (EV_P_ ev_io *w);
594void ev_io_stop (EV_P_ ev_io *w); 667void ev_io_stop (EV_P_ ev_io *w);
595 668
596void ev_timer_start (EV_P_ ev_timer *w); 669void ev_timer_start (EV_P_ ev_timer *w);
597void ev_timer_stop (EV_P_ ev_timer *w); 670void ev_timer_stop (EV_P_ ev_timer *w);
598/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 671/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
599void ev_timer_again (EV_P_ ev_timer *w); 672void ev_timer_again (EV_P_ ev_timer *w);
673/* return remaining time */
674ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
600 675
601#if EV_PERIODIC_ENABLE 676#if EV_PERIODIC_ENABLE
602void ev_periodic_start (EV_P_ ev_periodic *w); 677void ev_periodic_start (EV_P_ ev_periodic *w);
603void ev_periodic_stop (EV_P_ ev_periodic *w); 678void ev_periodic_stop (EV_P_ ev_periodic *w);
604void ev_periodic_again (EV_P_ ev_periodic *w); 679void ev_periodic_again (EV_P_ ev_periodic *w);
605#endif 680#endif
606 681
607/* only supported in the default loop */ 682/* only supported in the default loop */
683#if EV_SIGNAL_ENABLE
608void ev_signal_start (EV_P_ ev_signal *w); 684void ev_signal_start (EV_P_ ev_signal *w);
609void ev_signal_stop (EV_P_ ev_signal *w); 685void ev_signal_stop (EV_P_ ev_signal *w);
686#endif
610 687
611/* only supported in the default loop */ 688/* only supported in the default loop */
689# if EV_CHILD_ENABLE
612void ev_child_start (EV_P_ ev_child *w); 690void ev_child_start (EV_P_ ev_child *w);
613void ev_child_stop (EV_P_ ev_child *w); 691void ev_child_stop (EV_P_ ev_child *w);
692# endif
614 693
615# if EV_STAT_ENABLE 694# if EV_STAT_ENABLE
616void ev_stat_start (EV_P_ ev_stat *w); 695void ev_stat_start (EV_P_ ev_stat *w);
617void ev_stat_stop (EV_P_ ev_stat *w); 696void ev_stat_stop (EV_P_ ev_stat *w);
618void ev_stat_stat (EV_P_ ev_stat *w); 697void ev_stat_stat (EV_P_ ev_stat *w);
… …
621# if EV_IDLE_ENABLE 700# if EV_IDLE_ENABLE
622void ev_idle_start (EV_P_ ev_idle *w); 701void ev_idle_start (EV_P_ ev_idle *w);
623void ev_idle_stop (EV_P_ ev_idle *w); 702void ev_idle_stop (EV_P_ ev_idle *w);
624# endif 703# endif
625 704
705#if EV_PREPARE_ENABLE
626void ev_prepare_start (EV_P_ ev_prepare *w); 706void ev_prepare_start (EV_P_ ev_prepare *w);
627void ev_prepare_stop (EV_P_ ev_prepare *w); 707void ev_prepare_stop (EV_P_ ev_prepare *w);
708#endif
628 709
710#if EV_CHECK_ENABLE
629void ev_check_start (EV_P_ ev_check *w); 711void ev_check_start (EV_P_ ev_check *w);
630void ev_check_stop (EV_P_ ev_check *w); 712void ev_check_stop (EV_P_ ev_check *w);
713#endif
631 714
632# if EV_FORK_ENABLE 715# if EV_FORK_ENABLE
633void ev_fork_start (EV_P_ ev_fork *w); 716void ev_fork_start (EV_P_ ev_fork *w);
634void ev_fork_stop (EV_P_ ev_fork *w); 717void ev_fork_stop (EV_P_ ev_fork *w);
635# endif 718# endif

Diff Legend

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