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

Comparing libev/ev.h (file contents):
Revision 1.118 by root, Thu Jul 9 09:11:20 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
80
81#ifndef EV_ASYNC_ENABLE
82# define EV_ASYNC_ENABLE 1
83#endif 103#endif
84 104
85#ifndef EV_WALK_ENABLE 105#ifndef EV_WALK_ENABLE
86# define EV_WALK_ENABLE 0 /* not yet */ 106# define EV_WALK_ENABLE 0 /* not yet */
87#endif 107#endif
… …
90# include <signal.h> 110# include <signal.h>
91# define EV_ATOMIC_T sig_atomic_t volatile 111# define EV_ATOMIC_T sig_atomic_t volatile
92#endif 112#endif
93 113
94/*****************************************************************************/ 114/*****************************************************************************/
115
116#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
117# undef EV_SIGNAL_ENABLE
118# define EV_SIGNAL_ENABLE 1
119#endif
95 120
96#if EV_STAT_ENABLE 121#if EV_STAT_ENABLE
97# ifdef _WIN32 122# ifdef _WIN32
98# include <time.h> 123# include <time.h>
99# include <sys/types.h> 124# include <sys/types.h>
… …
161#ifndef EV_PROTOTYPES 186#ifndef EV_PROTOTYPES
162# define EV_PROTOTYPES 1 187# define EV_PROTOTYPES 1
163#endif 188#endif
164 189
165#define EV_VERSION_MAJOR 3 190#define EV_VERSION_MAJOR 3
166#define EV_VERSION_MINOR 0 191#define EV_VERSION_MINOR 9
167 192
168#ifndef EV_CB_DECLARE 193#ifndef EV_CB_DECLARE
169# 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);
170#endif 195#endif
171#ifndef EV_CB_INVOKE 196#ifndef EV_CB_INVOKE
… …
363 EV_WATCHER (ev_async) 388 EV_WATCHER (ev_async)
364 389
365 EV_ATOMIC_T sent; /* private */ 390 EV_ATOMIC_T sent; /* private */
366} ev_async; 391} ev_async;
367 392
368# define ev_async_pending(w) ((w)->sent + 0) 393# define ev_async_pending(w) (+(w)->sent)
369#endif 394#endif
370 395
371/* the presence of this union forces similar struct layout */ 396/* the presence of this union forces similar struct layout */
372union ev_any_watcher 397union ev_any_watcher
373{ 398{
… …
402/* the default */ 427/* the default */
403#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 428#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
404/* flag bits */ 429/* flag bits */
405#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 430#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
406#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 */
407/* method bits to be ored together */ 436/* method bits to be ored together */
408#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 437#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
409#define EVBACKEND_POLL 0x00000002U /* !win */ 438#define EVBACKEND_POLL 0x00000002U /* !win */
410#define EVBACKEND_EPOLL 0x00000004U /* linux */ 439#define EVBACKEND_EPOLL 0x00000004U /* linux */
411#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 440#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
412#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 441#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
413#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 442#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
443#define EVBACKEND_ALL 0x0000003FU
414 444
415#if EV_PROTOTYPES 445#if EV_PROTOTYPES
416int ev_version_major (void); 446int ev_version_major (void);
417int ev_version_minor (void); 447int ev_version_minor (void);
418 448
… …
500/* 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 */
501/* you can call it in either the parent or the child */ 531/* you can call it in either the parent or the child */
502/* you can actually call it at any time, anywhere :) */ 532/* you can actually call it at any time, anywhere :) */
503void ev_default_fork (void); 533void ev_default_fork (void);
504 534
505unsigned int ev_backend (EV_P); /* backend in use by loop */ 535unsigned int ev_backend (EV_P); /* backend in use by loop */
506unsigned int ev_loop_count (EV_P); /* number of loop iterations */
507unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
508void ev_loop_verify (EV_P); /* abort if loop data corrupted */
509 536
510void ev_now_update (EV_P); /* update event loop time */ 537void ev_now_update (EV_P); /* update event loop time */
511void ev_invoke_pending (EV_P); /* invoke all pending watchers */
512 538
513#if EV_WALK_ENABLE 539#if EV_WALK_ENABLE
514/* 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 */
515/* callback on every such watcher. The callback might stop the watcher, */ 541/* callback on every such watcher. The callback might stop the watcher, */
516/* but do nothing else with the loop */ 542/* but do nothing else with the loop */
… …
527 553
528#if EV_PROTOTYPES 554#if EV_PROTOTYPES
529void ev_loop (EV_P_ int flags); 555void ev_loop (EV_P_ int flags);
530void 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 */
531 557
532void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
533void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
534
535/* 558/*
536 * 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
537 * 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
538 * 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.
539 */ 562 */
540void ev_ref (EV_P); 563void ev_ref (EV_P);
541void ev_unref (EV_P); 564void ev_unref (EV_P);
565
566/*
567 * convenience function, wait for a single event, without registering an event watcher
568 * if timeout is < 0, do wait indefinitely
569 */
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 */
542 588
543/* 589/*
544 * stop/start the timer handling. 590 * stop/start the timer handling.
545 */ 591 */
546void ev_suspend (EV_P); 592void ev_suspend (EV_P);
547void ev_resume (EV_P); 593void ev_resume (EV_P);
594#endif
548 595
549/*
550 * convenience function, wait for a single event, without registering an event watcher
551 * if timeout is < 0, do wait indefinitely
552 */
553void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
554#endif 596#endif
555 597
556/* 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 */
557/* 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 */
558#define ev_init(ev,cb_) do { \ 600#define ev_init(ev,cb_) do { \
… …
595 637
596#if EV_MINPRI == EV_MAXPRI 638#if EV_MINPRI == EV_MAXPRI
597# define ev_priority(ev) ((ev), EV_MINPRI) 639# define ev_priority(ev) ((ev), EV_MINPRI)
598# define ev_set_priority(ev,pri) ((ev), (pri)) 640# define ev_set_priority(ev,pri) ((ev), (pri))
599#else 641#else
600# define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) 642# define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
601# 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)
602#endif 644#endif
603 645
604#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 646#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
605 647
606#ifndef ev_set_cb 648#ifndef ev_set_cb
607# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 649# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
608#endif 650#endif
609 651
… …
613 655
614/* 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 */
615/* accepts any ev_watcher type */ 657/* accepts any ev_watcher type */
616void ev_feed_event (EV_P_ void *w, int revents); 658void ev_feed_event (EV_P_ void *w, int revents);
617void 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
618void ev_feed_signal_event (EV_P_ int signum); 661void ev_feed_signal_event (EV_P_ int signum);
662#endif
619void ev_invoke (EV_P_ void *w, int revents); 663void ev_invoke (EV_P_ void *w, int revents);
620int ev_clear_pending (EV_P_ void *w); 664int ev_clear_pending (EV_P_ void *w);
621 665
622void ev_io_start (EV_P_ ev_io *w); 666void ev_io_start (EV_P_ ev_io *w);
623void ev_io_stop (EV_P_ ev_io *w); 667void ev_io_stop (EV_P_ ev_io *w);
624 668
625void ev_timer_start (EV_P_ ev_timer *w); 669void ev_timer_start (EV_P_ ev_timer *w);
626void ev_timer_stop (EV_P_ ev_timer *w); 670void ev_timer_stop (EV_P_ ev_timer *w);
627/* 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 */
628void 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);
629 675
630#if EV_PERIODIC_ENABLE 676#if EV_PERIODIC_ENABLE
631void ev_periodic_start (EV_P_ ev_periodic *w); 677void ev_periodic_start (EV_P_ ev_periodic *w);
632void ev_periodic_stop (EV_P_ ev_periodic *w); 678void ev_periodic_stop (EV_P_ ev_periodic *w);
633void ev_periodic_again (EV_P_ ev_periodic *w); 679void ev_periodic_again (EV_P_ ev_periodic *w);
634#endif 680#endif
635 681
636/* only supported in the default loop */ 682/* only supported in the default loop */
683#if EV_SIGNAL_ENABLE
637void ev_signal_start (EV_P_ ev_signal *w); 684void ev_signal_start (EV_P_ ev_signal *w);
638void ev_signal_stop (EV_P_ ev_signal *w); 685void ev_signal_stop (EV_P_ ev_signal *w);
686#endif
639 687
640/* only supported in the default loop */ 688/* only supported in the default loop */
689# if EV_CHILD_ENABLE
641void ev_child_start (EV_P_ ev_child *w); 690void ev_child_start (EV_P_ ev_child *w);
642void ev_child_stop (EV_P_ ev_child *w); 691void ev_child_stop (EV_P_ ev_child *w);
692# endif
643 693
644# if EV_STAT_ENABLE 694# if EV_STAT_ENABLE
645void ev_stat_start (EV_P_ ev_stat *w); 695void ev_stat_start (EV_P_ ev_stat *w);
646void ev_stat_stop (EV_P_ ev_stat *w); 696void ev_stat_stop (EV_P_ ev_stat *w);
647void ev_stat_stat (EV_P_ ev_stat *w); 697void ev_stat_stat (EV_P_ ev_stat *w);
… …
650# if EV_IDLE_ENABLE 700# if EV_IDLE_ENABLE
651void ev_idle_start (EV_P_ ev_idle *w); 701void ev_idle_start (EV_P_ ev_idle *w);
652void ev_idle_stop (EV_P_ ev_idle *w); 702void ev_idle_stop (EV_P_ ev_idle *w);
653# endif 703# endif
654 704
705#if EV_PREPARE_ENABLE
655void ev_prepare_start (EV_P_ ev_prepare *w); 706void ev_prepare_start (EV_P_ ev_prepare *w);
656void ev_prepare_stop (EV_P_ ev_prepare *w); 707void ev_prepare_stop (EV_P_ ev_prepare *w);
708#endif
657 709
710#if EV_CHECK_ENABLE
658void ev_check_start (EV_P_ ev_check *w); 711void ev_check_start (EV_P_ ev_check *w);
659void ev_check_stop (EV_P_ ev_check *w); 712void ev_check_stop (EV_P_ ev_check *w);
713#endif
660 714
661# if EV_FORK_ENABLE 715# if EV_FORK_ENABLE
662void ev_fork_start (EV_P_ ev_fork *w); 716void ev_fork_start (EV_P_ ev_fork *w);
663void ev_fork_stop (EV_P_ ev_fork *w); 717void ev_fork_stop (EV_P_ ev_fork *w);
664# endif 718# endif

Diff Legend

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