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.132 by root, Wed Mar 10 08:19:39 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
… …
72 72
73#ifndef EV_FORK_ENABLE 73#ifndef EV_FORK_ENABLE
74# define EV_FORK_ENABLE 1 74# define EV_FORK_ENABLE 1
75#endif 75#endif
76 76
77#ifndef EV_SIGNAL_ENABLE
78# define EV_SIGNAL_ENABLE 1
79#endif
80
81#ifndef EV_CHILD_ENABLE
82# ifdef _WIN32
83# define EV_CHILD_ENABLE 0
84# else
85# define EV_CHILD_ENABLE 1
86#endif
87#endif
88
89#ifndef EV_ASYNC_ENABLE
90# define EV_ASYNC_ENABLE 1
91#endif
92
77#ifndef EV_EMBED_ENABLE 93#ifndef EV_EMBED_ENABLE
78# define EV_EMBED_ENABLE 1 94# define EV_EMBED_ENABLE 1
79#endif
80
81#ifndef EV_ASYNC_ENABLE
82# define EV_ASYNC_ENABLE 1
83#endif 95#endif
84 96
85#ifndef EV_WALK_ENABLE 97#ifndef EV_WALK_ENABLE
86# define EV_WALK_ENABLE 0 /* not yet */ 98# define EV_WALK_ENABLE 0 /* not yet */
87#endif 99#endif
… …
90# include <signal.h> 102# include <signal.h>
91# define EV_ATOMIC_T sig_atomic_t volatile 103# define EV_ATOMIC_T sig_atomic_t volatile
92#endif 104#endif
93 105
94/*****************************************************************************/ 106/*****************************************************************************/
107
108#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
109# undef EV_SIGNAL_ENABLE
110# define EV_SIGNAL_ENABLE 1
111#endif
95 112
96#if EV_STAT_ENABLE 113#if EV_STAT_ENABLE
97# ifdef _WIN32 114# ifdef _WIN32
98# include <time.h> 115# include <time.h>
99# include <sys/types.h> 116# include <sys/types.h>
… …
161#ifndef EV_PROTOTYPES 178#ifndef EV_PROTOTYPES
162# define EV_PROTOTYPES 1 179# define EV_PROTOTYPES 1
163#endif 180#endif
164 181
165#define EV_VERSION_MAJOR 3 182#define EV_VERSION_MAJOR 3
166#define EV_VERSION_MINOR 0 183#define EV_VERSION_MINOR 9
167 184
168#ifndef EV_CB_DECLARE 185#ifndef EV_CB_DECLARE
169# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 186# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
170#endif 187#endif
171#ifndef EV_CB_INVOKE 188#ifndef EV_CB_INVOKE
… …
363 EV_WATCHER (ev_async) 380 EV_WATCHER (ev_async)
364 381
365 EV_ATOMIC_T sent; /* private */ 382 EV_ATOMIC_T sent; /* private */
366} ev_async; 383} ev_async;
367 384
368# define ev_async_pending(w) ((w)->sent + 0) 385# define ev_async_pending(w) (+(w)->sent)
369#endif 386#endif
370 387
371/* the presence of this union forces similar struct layout */ 388/* the presence of this union forces similar struct layout */
372union ev_any_watcher 389union ev_any_watcher
373{ 390{
… …
402/* the default */ 419/* the default */
403#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 420#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
404/* flag bits */ 421/* flag bits */
405#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 422#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
406#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ 423#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
424/* debugging/feature disable */
425#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */
426#define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */
427#define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */
407/* method bits to be ored together */ 428/* method bits to be ored together */
408#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 429#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
409#define EVBACKEND_POLL 0x00000002U /* !win */ 430#define EVBACKEND_POLL 0x00000002U /* !win */
410#define EVBACKEND_EPOLL 0x00000004U /* linux */ 431#define EVBACKEND_EPOLL 0x00000004U /* linux */
411#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 432#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
412#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 433#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
413#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 434#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
435#define EVBACKEND_ALL 0x0000003FU
414 436
415#if EV_PROTOTYPES 437#if EV_PROTOTYPES
416int ev_version_major (void); 438int ev_version_major (void);
417int ev_version_minor (void); 439int ev_version_minor (void);
418 440
… …
500/* if you create alternative loops you have to call ev_loop_fork on them */ 522/* 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 */ 523/* you can call it in either the parent or the child */
502/* you can actually call it at any time, anywhere :) */ 524/* you can actually call it at any time, anywhere :) */
503void ev_default_fork (void); 525void ev_default_fork (void);
504 526
505unsigned int ev_backend (EV_P); /* backend in use by loop */ 527unsigned 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 528
510void ev_now_update (EV_P); /* update event loop time */ 529void ev_now_update (EV_P); /* update event loop time */
511void ev_invoke_pending (EV_P); /* invoke all pending watchers */
512 530
513#if EV_WALK_ENABLE 531#if EV_WALK_ENABLE
514/* walk (almost) all watchers in the loop of a given type, invoking the */ 532/* 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, */ 533/* callback on every such watcher. The callback might stop the watcher, */
516/* but do nothing else with the loop */ 534/* but do nothing else with the loop */
… …
527 545
528#if EV_PROTOTYPES 546#if EV_PROTOTYPES
529void ev_loop (EV_P_ int flags); 547void 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 */ 548void 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 549
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/* 550/*
536 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 551 * 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 552 * 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. 553 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
539 */ 554 */
540void ev_ref (EV_P); 555void ev_ref (EV_P);
541void ev_unref (EV_P); 556void ev_unref (EV_P);
557
558/*
559 * convenience function, wait for a single event, without registering an event watcher
560 * if timeout is < 0, do wait indefinitely
561 */
562void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
563
564# if EV_MINIMAL < 2
565unsigned int ev_loop_count (EV_P); /* number of loop iterations */
566unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
567void ev_loop_verify (EV_P); /* abort if loop data corrupted */
568
569void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
570void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
571
572/* advanced stuff for threading etc. support, see docs */
573void ev_set_userdata (EV_P_ void *data);
574void *ev_userdata (EV_P);
575void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
576void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
577
578unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
579void ev_invoke_pending (EV_P); /* invoke all pending watchers */
542 580
543/* 581/*
544 * stop/start the timer handling. 582 * stop/start the timer handling.
545 */ 583 */
546void ev_suspend (EV_P); 584void ev_suspend (EV_P);
547void ev_resume (EV_P); 585void ev_resume (EV_P);
586#endif
548 587
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 588#endif
555 589
556/* these may evaluate ev multiple times, and the other arguments at most once */ 590/* 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 */ 591/* 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 { \ 592#define ev_init(ev,cb_) do { \
… …
595 629
596#if EV_MINPRI == EV_MAXPRI 630#if EV_MINPRI == EV_MAXPRI
597# define ev_priority(ev) ((ev), EV_MINPRI) 631# define ev_priority(ev) ((ev), EV_MINPRI)
598# define ev_set_priority(ev,pri) ((ev), (pri)) 632# define ev_set_priority(ev,pri) ((ev), (pri))
599#else 633#else
600# define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) 634# define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
601# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri) 635# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
602#endif 636#endif
603 637
604#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 638#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
605 639
606#ifndef ev_set_cb 640#ifndef ev_set_cb
607# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 641# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
608#endif 642#endif
609 643
… …
613 647
614/* feeds an event into a watcher as if the event actually occured */ 648/* feeds an event into a watcher as if the event actually occured */
615/* accepts any ev_watcher type */ 649/* accepts any ev_watcher type */
616void ev_feed_event (EV_P_ void *w, int revents); 650void ev_feed_event (EV_P_ void *w, int revents);
617void ev_feed_fd_event (EV_P_ int fd, int revents); 651void ev_feed_fd_event (EV_P_ int fd, int revents);
652#if EV_SIGNAL_ENABLE
618void ev_feed_signal_event (EV_P_ int signum); 653void ev_feed_signal_event (EV_P_ int signum);
654#endif
619void ev_invoke (EV_P_ void *w, int revents); 655void ev_invoke (EV_P_ void *w, int revents);
620int ev_clear_pending (EV_P_ void *w); 656int ev_clear_pending (EV_P_ void *w);
621 657
622void ev_io_start (EV_P_ ev_io *w); 658void ev_io_start (EV_P_ ev_io *w);
623void ev_io_stop (EV_P_ ev_io *w); 659void ev_io_stop (EV_P_ ev_io *w);
624 660
625void ev_timer_start (EV_P_ ev_timer *w); 661void ev_timer_start (EV_P_ ev_timer *w);
626void ev_timer_stop (EV_P_ ev_timer *w); 662void 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 */ 663/* 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); 664void ev_timer_again (EV_P_ ev_timer *w);
665/* return remaining time */
666ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
629 667
630#if EV_PERIODIC_ENABLE 668#if EV_PERIODIC_ENABLE
631void ev_periodic_start (EV_P_ ev_periodic *w); 669void ev_periodic_start (EV_P_ ev_periodic *w);
632void ev_periodic_stop (EV_P_ ev_periodic *w); 670void ev_periodic_stop (EV_P_ ev_periodic *w);
633void ev_periodic_again (EV_P_ ev_periodic *w); 671void ev_periodic_again (EV_P_ ev_periodic *w);
634#endif 672#endif
635 673
636/* only supported in the default loop */ 674/* only supported in the default loop */
675#if EV_SIGNAL_ENABLE
637void ev_signal_start (EV_P_ ev_signal *w); 676void ev_signal_start (EV_P_ ev_signal *w);
638void ev_signal_stop (EV_P_ ev_signal *w); 677void ev_signal_stop (EV_P_ ev_signal *w);
678#endif
639 679
640/* only supported in the default loop */ 680/* only supported in the default loop */
681# if EV_CHILD_ENABLE
641void ev_child_start (EV_P_ ev_child *w); 682void ev_child_start (EV_P_ ev_child *w);
642void ev_child_stop (EV_P_ ev_child *w); 683void ev_child_stop (EV_P_ ev_child *w);
684# endif
643 685
644# if EV_STAT_ENABLE 686# if EV_STAT_ENABLE
645void ev_stat_start (EV_P_ ev_stat *w); 687void ev_stat_start (EV_P_ ev_stat *w);
646void ev_stat_stop (EV_P_ ev_stat *w); 688void ev_stat_stop (EV_P_ ev_stat *w);
647void ev_stat_stat (EV_P_ ev_stat *w); 689void ev_stat_stat (EV_P_ ev_stat *w);

Diff Legend

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