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

Comparing libev/ev.h (file contents):
Revision 1.111 by root, Mon Mar 16 21:15:06 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 95#endif
80 96
81#ifndef EV_ASYNC_ENABLE 97#ifndef EV_WALK_ENABLE
82# define EV_ASYNC_ENABLE 1 98# define EV_WALK_ENABLE 0 /* not yet */
83#endif 99#endif
84 100
85#ifndef EV_ATOMIC_T 101#ifndef EV_ATOMIC_T
86# include <signal.h> 102# include <signal.h>
87# define EV_ATOMIC_T sig_atomic_t volatile 103# define EV_ATOMIC_T sig_atomic_t volatile
88#endif 104#endif
89 105
90/*****************************************************************************/ 106/*****************************************************************************/
107
108#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
109# undef EV_SIGNAL_ENABLE
110# define EV_SIGNAL_ENABLE 1
111#endif
91 112
92#if EV_STAT_ENABLE 113#if EV_STAT_ENABLE
93# ifdef _WIN32 114# ifdef _WIN32
94# include <time.h> 115# include <time.h>
95# include <sys/types.h> 116# include <sys/types.h>
134#define EV_READ 0x01 /* ev_io detected read will not block */ 155#define EV_READ 0x01 /* ev_io detected read will not block */
135#define EV_WRITE 0x02 /* ev_io detected write will not block */ 156#define EV_WRITE 0x02 /* ev_io detected write will not block */
136#define EV__IOFDSET 0x80 /* internal use only */ 157#define EV__IOFDSET 0x80 /* internal use only */
137#define EV_IO EV_READ /* alias for type-detection */ 158#define EV_IO EV_READ /* alias for type-detection */
138#define EV_TIMEOUT 0x00000100 /* timer timed out */ 159#define EV_TIMEOUT 0x00000100 /* timer timed out */
160#define EV_TIMER EV_TIMEOUT /* alias for type-detection */
139#define EV_PERIODIC 0x00000200 /* periodic timer timed out */ 161#define EV_PERIODIC 0x00000200 /* periodic timer timed out */
140#define EV_SIGNAL 0x00000400 /* signal was received */ 162#define EV_SIGNAL 0x00000400 /* signal was received */
141#define EV_CHILD 0x00000800 /* child/pid had status change */ 163#define EV_CHILD 0x00000800 /* child/pid had status change */
142#define EV_STAT 0x00001000 /* stat data changed */ 164#define EV_STAT 0x00001000 /* stat data changed */
143#define EV_IDLE 0x00002000 /* event loop is idling */ 165#define EV_IDLE 0x00002000 /* event loop is idling */
144#define EV_PREPARE 0x00004000 /* event loop about to poll */ 166#define EV_PREPARE 0x00004000 /* event loop about to poll */
145#define EV_CHECK 0x00008000 /* event loop finished poll */ 167#define EV_CHECK 0x00008000 /* event loop finished poll */
146#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ 168#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
147#define EV_FORK 0x00020000 /* event loop resumed in child */ 169#define EV_FORK 0x00020000 /* event loop resumed in child */
148#define EV_ASYNC 0x00040000 /* async intra-loop signal */ 170#define EV_ASYNC 0x00040000 /* async intra-loop signal */
171#define EV_CUSTOM 0x01000000 /* for use by user code */
149#define EV_ERROR 0x80000000 /* sent when an error occurs */ 172#define EV_ERROR 0x80000000 /* sent when an error occurs */
150 173
151/* can be used to add custom fields to all watchers, while losing binary compatibility */ 174/* can be used to add custom fields to all watchers, while losing binary compatibility */
152#ifndef EV_COMMON 175#ifndef EV_COMMON
153# define EV_COMMON void *data; 176# define EV_COMMON void *data;
155#ifndef EV_PROTOTYPES 178#ifndef EV_PROTOTYPES
156# define EV_PROTOTYPES 1 179# define EV_PROTOTYPES 1
157#endif 180#endif
158 181
159#define EV_VERSION_MAJOR 3 182#define EV_VERSION_MAJOR 3
160#define EV_VERSION_MINOR 0 183#define EV_VERSION_MINOR 9
161 184
162#ifndef EV_CB_DECLARE 185#ifndef EV_CB_DECLARE
163# 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);
164#endif 187#endif
165#ifndef EV_CB_INVOKE 188#ifndef EV_CB_INVOKE
181 * or simply 1 for watchers that aren't in some array. 204 * or simply 1 for watchers that aren't in some array.
182 * pending is either 0, in which case the watcher isn't, 205 * pending is either 0, in which case the watcher isn't,
183 * or the array index + 1 in the pendings array. 206 * or the array index + 1 in the pendings array.
184 */ 207 */
185 208
209#if EV_MINPRI == EV_MAXPRI
210# define EV_DECL_PRIORITY
211#else
212# define EV_DECL_PRIORITY int priority;
213#endif
214
186/* shared by all watchers */ 215/* shared by all watchers */
187#define EV_WATCHER(type) \ 216#define EV_WATCHER(type) \
188 int active; /* private */ \ 217 int active; /* private */ \
189 int pending; /* private */ \ 218 int pending; /* private */ \
190 int priority; /* private */ \ 219 EV_DECL_PRIORITY /* private */ \
191 EV_COMMON /* rw */ \ 220 EV_COMMON /* rw */ \
192 EV_CB_DECLARE (type) /* private */ 221 EV_CB_DECLARE (type) /* private */
193 222
194#define EV_WATCHER_LIST(type) \ 223#define EV_WATCHER_LIST(type) \
195 EV_WATCHER (type) \ 224 EV_WATCHER (type) \
351 EV_WATCHER (ev_async) 380 EV_WATCHER (ev_async)
352 381
353 EV_ATOMIC_T sent; /* private */ 382 EV_ATOMIC_T sent; /* private */
354} ev_async; 383} ev_async;
355 384
356# define ev_async_pending(w) ((w)->sent + 0) 385# define ev_async_pending(w) (+(w)->sent)
357#endif 386#endif
358 387
359/* the presence of this union forces similar struct layout */ 388/* the presence of this union forces similar struct layout */
360union ev_any_watcher 389union ev_any_watcher
361{ 390{
390/* the default */ 419/* the default */
391#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 420#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
392/* flag bits */ 421/* flag bits */
393#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 422#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
394#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 */
395/* method bits to be ored together */ 428/* method bits to be ored together */
396#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 429#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
397#define EVBACKEND_POLL 0x00000002U /* !win */ 430#define EVBACKEND_POLL 0x00000002U /* !win */
398#define EVBACKEND_EPOLL 0x00000004U /* linux */ 431#define EVBACKEND_EPOLL 0x00000004U /* linux */
399#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 432#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
400#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 433#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
401#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 434#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
435#define EVBACKEND_ALL 0x0000003FU
402 436
403#if EV_PROTOTYPES 437#if EV_PROTOTYPES
404int ev_version_major (void); 438int ev_version_major (void);
405int ev_version_minor (void); 439int ev_version_minor (void);
406 440
453 487
454/* create and destroy alternative loops that don't handle signals */ 488/* create and destroy alternative loops that don't handle signals */
455struct ev_loop *ev_loop_new (unsigned int flags); 489struct ev_loop *ev_loop_new (unsigned int flags);
456void ev_loop_destroy (EV_P); 490void ev_loop_destroy (EV_P);
457void ev_loop_fork (EV_P); 491void ev_loop_fork (EV_P);
458void ev_loop_verify (EV_P);
459 492
460ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 493ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
461void ev_now_update (EV_P);
462 494
463#else 495#else
464 496
465int ev_default_loop (unsigned int flags); /* returns true when successful */ 497int ev_default_loop (unsigned int flags); /* returns true when successful */
466 498
490/* 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 */
491/* you can call it in either the parent or the child */ 523/* you can call it in either the parent or the child */
492/* you can actually call it at any time, anywhere :) */ 524/* you can actually call it at any time, anywhere :) */
493void ev_default_fork (void); 525void ev_default_fork (void);
494 526
495unsigned int ev_backend (EV_P); /* backend in use by loop */ 527unsigned int ev_backend (EV_P); /* backend in use by loop */
496unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 528
529void ev_now_update (EV_P); /* update event loop time */
530
531#if EV_WALK_ENABLE
532/* walk (almost) all watchers in the loop of a given type, invoking the */
533/* callback on every such watcher. The callback might stop the watcher, */
534/* but do nothing else with the loop */
535void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
536#endif
537
497#endif /* prototypes */ 538#endif /* prototypes */
498 539
499#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 540#define EVLOOP_NONBLOCK 1 /* do not block/wait */
500#define EVLOOP_ONESHOT 2 /* block *once* only */ 541#define EVLOOP_ONESHOT 2 /* block *once* only */
501#define EVUNLOOP_CANCEL 0 /* undo unloop */ 542#define EVUNLOOP_CANCEL 0 /* undo unloop */
504 545
505#if EV_PROTOTYPES 546#if EV_PROTOTYPES
506void ev_loop (EV_P_ int flags); 547void ev_loop (EV_P_ int flags);
507void 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 */
508 549
509void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
510void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
511
512/* 550/*
513 * 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
514 * 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
515 * 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.
516 */ 554 */
517void ev_ref (EV_P); 555void ev_ref (EV_P);
518void ev_unref (EV_P); 556void ev_unref (EV_P);
519 557
558/*
520/* convenience function, wait for a single event, without registering an event watcher */ 559 * convenience function, wait for a single event, without registering an event watcher
521/* if timeout is < 0, do wait indefinitely */ 560 * if timeout is < 0, do wait indefinitely
561 */
522void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 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 */
580
581/*
582 * stop/start the timer handling.
583 */
584void ev_suspend (EV_P);
585void ev_resume (EV_P);
586#endif
587
523#endif 588#endif
524 589
525/* 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 */
526/* 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 */
527#define ev_init(ev,cb_) do { \ 592#define ev_init(ev,cb_) do { \
528 ((ev_watcher *)(void *)(ev))->active = \ 593 ((ev_watcher *)(void *)(ev))->active = \
529 ((ev_watcher *)(void *)(ev))->pending = \ 594 ((ev_watcher *)(void *)(ev))->pending = 0; \
530 ((ev_watcher *)(void *)(ev))->priority = 0; \ 595 ev_set_priority ((ev), 0); \
531 ev_set_cb ((ev), cb_); \ 596 ev_set_cb ((ev), cb_); \
532} while (0) 597} while (0)
533 598
534#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0) 599#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
535#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0) 600#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
558#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 623#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
559 624
560#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 625#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
561#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 626#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
562 627
563#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
564#define ev_cb(ev) (ev)->cb /* rw */ 628#define ev_cb(ev) (ev)->cb /* rw */
629
630#if EV_MINPRI == EV_MAXPRI
631# define ev_priority(ev) ((ev), EV_MINPRI)
632# define ev_set_priority(ev,pri) ((ev), (pri))
633#else
634# define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
565#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)
636#endif
566 637
567#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 638#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
568 639
569#ifndef ev_set_cb 640#ifndef ev_set_cb
570# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 641# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
571#endif 642#endif
572 643
576 647
577/* 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 */
578/* accepts any ev_watcher type */ 649/* accepts any ev_watcher type */
579void ev_feed_event (EV_P_ void *w, int revents); 650void ev_feed_event (EV_P_ void *w, int revents);
580void 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
581void ev_feed_signal_event (EV_P_ int signum); 653void ev_feed_signal_event (EV_P_ int signum);
654#endif
582void ev_invoke (EV_P_ void *w, int revents); 655void ev_invoke (EV_P_ void *w, int revents);
583int ev_clear_pending (EV_P_ void *w); 656int ev_clear_pending (EV_P_ void *w);
584 657
585void ev_io_start (EV_P_ ev_io *w); 658void ev_io_start (EV_P_ ev_io *w);
586void ev_io_stop (EV_P_ ev_io *w); 659void ev_io_stop (EV_P_ ev_io *w);
587 660
588void ev_timer_start (EV_P_ ev_timer *w); 661void ev_timer_start (EV_P_ ev_timer *w);
589void ev_timer_stop (EV_P_ ev_timer *w); 662void ev_timer_stop (EV_P_ ev_timer *w);
590/* 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 */
591void 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);
592 667
593#if EV_PERIODIC_ENABLE 668#if EV_PERIODIC_ENABLE
594void ev_periodic_start (EV_P_ ev_periodic *w); 669void ev_periodic_start (EV_P_ ev_periodic *w);
595void ev_periodic_stop (EV_P_ ev_periodic *w); 670void ev_periodic_stop (EV_P_ ev_periodic *w);
596void ev_periodic_again (EV_P_ ev_periodic *w); 671void ev_periodic_again (EV_P_ ev_periodic *w);
597#endif 672#endif
598 673
599/* only supported in the default loop */ 674/* only supported in the default loop */
675#if EV_SIGNAL_ENABLE
600void ev_signal_start (EV_P_ ev_signal *w); 676void ev_signal_start (EV_P_ ev_signal *w);
601void ev_signal_stop (EV_P_ ev_signal *w); 677void ev_signal_stop (EV_P_ ev_signal *w);
678#endif
602 679
603/* only supported in the default loop */ 680/* only supported in the default loop */
681# if EV_CHILD_ENABLE
604void ev_child_start (EV_P_ ev_child *w); 682void ev_child_start (EV_P_ ev_child *w);
605void ev_child_stop (EV_P_ ev_child *w); 683void ev_child_stop (EV_P_ ev_child *w);
684# endif
606 685
607# if EV_STAT_ENABLE 686# if EV_STAT_ENABLE
608void ev_stat_start (EV_P_ ev_stat *w); 687void ev_stat_start (EV_P_ ev_stat *w);
609void ev_stat_stop (EV_P_ ev_stat *w); 688void ev_stat_stop (EV_P_ ev_stat *w);
610void 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