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.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>
… …
145#define EV_PREPARE 0x00004000 /* event loop about to poll */ 166#define EV_PREPARE 0x00004000 /* event loop about to poll */
146#define EV_CHECK 0x00008000 /* event loop finished poll */ 167#define EV_CHECK 0x00008000 /* event loop finished poll */
147#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ 168#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
148#define EV_FORK 0x00020000 /* event loop resumed in child */ 169#define EV_FORK 0x00020000 /* event loop resumed in child */
149#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 */
150#define EV_ERROR 0x80000000 /* sent when an error occurs */ 172#define EV_ERROR 0x80000000 /* sent when an error occurs */
151 173
152/* 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 */
153#ifndef EV_COMMON 175#ifndef EV_COMMON
154# define EV_COMMON void *data; 176# define EV_COMMON void *data;
… …
156#ifndef EV_PROTOTYPES 178#ifndef EV_PROTOTYPES
157# define EV_PROTOTYPES 1 179# define EV_PROTOTYPES 1
158#endif 180#endif
159 181
160#define EV_VERSION_MAJOR 3 182#define EV_VERSION_MAJOR 3
161#define EV_VERSION_MINOR 0 183#define EV_VERSION_MINOR 9
162 184
163#ifndef EV_CB_DECLARE 185#ifndef EV_CB_DECLARE
164# 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);
165#endif 187#endif
166#ifndef EV_CB_INVOKE 188#ifndef EV_CB_INVOKE
… …
182 * or simply 1 for watchers that aren't in some array. 204 * or simply 1 for watchers that aren't in some array.
183 * pending is either 0, in which case the watcher isn't, 205 * pending is either 0, in which case the watcher isn't,
184 * or the array index + 1 in the pendings array. 206 * or the array index + 1 in the pendings array.
185 */ 207 */
186 208
209#if EV_MINPRI == EV_MAXPRI
210# define EV_DECL_PRIORITY
211#else
212# define EV_DECL_PRIORITY int priority;
213#endif
214
187/* shared by all watchers */ 215/* shared by all watchers */
188#define EV_WATCHER(type) \ 216#define EV_WATCHER(type) \
189 int active; /* private */ \ 217 int active; /* private */ \
190 int pending; /* private */ \ 218 int pending; /* private */ \
191 int priority; /* private */ \ 219 EV_DECL_PRIORITY /* private */ \
192 EV_COMMON /* rw */ \ 220 EV_COMMON /* rw */ \
193 EV_CB_DECLARE (type) /* private */ 221 EV_CB_DECLARE (type) /* private */
194 222
195#define EV_WATCHER_LIST(type) \ 223#define EV_WATCHER_LIST(type) \
196 EV_WATCHER (type) \ 224 EV_WATCHER (type) \
… …
352 EV_WATCHER (ev_async) 380 EV_WATCHER (ev_async)
353 381
354 EV_ATOMIC_T sent; /* private */ 382 EV_ATOMIC_T sent; /* private */
355} ev_async; 383} ev_async;
356 384
357# define ev_async_pending(w) ((w)->sent + 0) 385# define ev_async_pending(w) (+(w)->sent)
358#endif 386#endif
359 387
360/* the presence of this union forces similar struct layout */ 388/* the presence of this union forces similar struct layout */
361union ev_any_watcher 389union ev_any_watcher
362{ 390{
… …
391/* the default */ 419/* the default */
392#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 420#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
393/* flag bits */ 421/* flag bits */
394#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 422#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
395#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 */
396/* method bits to be ored together */ 428/* method bits to be ored together */
397#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 429#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
398#define EVBACKEND_POLL 0x00000002U /* !win */ 430#define EVBACKEND_POLL 0x00000002U /* !win */
399#define EVBACKEND_EPOLL 0x00000004U /* linux */ 431#define EVBACKEND_EPOLL 0x00000004U /* linux */
400#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 432#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
401#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 433#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
402#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 434#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
435#define EVBACKEND_ALL 0x0000003FU
403 436
404#if EV_PROTOTYPES 437#if EV_PROTOTYPES
405int ev_version_major (void); 438int ev_version_major (void);
406int ev_version_minor (void); 439int ev_version_minor (void);
407 440
… …
454 487
455/* create and destroy alternative loops that don't handle signals */ 488/* create and destroy alternative loops that don't handle signals */
456struct ev_loop *ev_loop_new (unsigned int flags); 489struct ev_loop *ev_loop_new (unsigned int flags);
457void ev_loop_destroy (EV_P); 490void ev_loop_destroy (EV_P);
458void ev_loop_fork (EV_P); 491void ev_loop_fork (EV_P);
459void ev_loop_verify (EV_P);
460 492
461ev_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 */
462void ev_now_update (EV_P);
463 494
464#else 495#else
465 496
466int ev_default_loop (unsigned int flags); /* returns true when successful */ 497int ev_default_loop (unsigned int flags); /* returns true when successful */
467 498
… …
491/* 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 */
492/* you can call it in either the parent or the child */ 523/* you can call it in either the parent or the child */
493/* you can actually call it at any time, anywhere :) */ 524/* you can actually call it at any time, anywhere :) */
494void ev_default_fork (void); 525void ev_default_fork (void);
495 526
496#if 0 527unsigned int ev_backend (EV_P); /* backend in use by loop */
528
529void ev_now_update (EV_P); /* update event loop time */
530
531#if EV_WALK_ENABLE
497/* 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 */
498/* callback on every such watcher. The callback might stop the watcher, */ 533/* callback on every such watcher. The callback might stop the watcher, */
499/* but do nothing else with the loop */ 534/* but do nothing else with the loop */
500void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 535void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
501#endif 536#endif
502 537
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 */ 538#endif /* prototypes */
506 539
507#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 540#define EVLOOP_NONBLOCK 1 /* do not block/wait */
508#define EVLOOP_ONESHOT 2 /* block *once* only */ 541#define EVLOOP_ONESHOT 2 /* block *once* only */
509#define EVUNLOOP_CANCEL 0 /* undo unloop */ 542#define EVUNLOOP_CANCEL 0 /* undo unloop */
… …
512 545
513#if EV_PROTOTYPES 546#if EV_PROTOTYPES
514void ev_loop (EV_P_ int flags); 547void 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 */ 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 */
516 549
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/* 550/*
521 * 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
522 * 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
523 * 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.
524 */ 554 */
525void ev_ref (EV_P); 555void ev_ref (EV_P);
526void ev_unref (EV_P); 556void ev_unref (EV_P);
527 557
558/*
528/* 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
529/* if timeout is < 0, do wait indefinitely */ 560 * if timeout is < 0, do wait indefinitely
561 */
530void 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
531#endif 588#endif
532 589
533/* 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 */
534/* 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 */
535#define ev_init(ev,cb_) do { \ 592#define ev_init(ev,cb_) do { \
536 ((ev_watcher *)(void *)(ev))->active = \ 593 ((ev_watcher *)(void *)(ev))->active = \
537 ((ev_watcher *)(void *)(ev))->pending = \ 594 ((ev_watcher *)(void *)(ev))->pending = 0; \
538 ((ev_watcher *)(void *)(ev))->priority = 0; \ 595 ev_set_priority ((ev), 0); \
539 ev_set_cb ((ev), cb_); \ 596 ev_set_cb ((ev), cb_); \
540} while (0) 597} while (0)
541 598
542#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)
543#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)
… …
566#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)
567 624
568#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 */
569#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 */
570 627
571#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
572#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))
573#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
574 637
575#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 638#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
576 639
577#ifndef ev_set_cb 640#ifndef ev_set_cb
578# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 641# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
579#endif 642#endif
580 643
… …
584 647
585/* 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 */
586/* accepts any ev_watcher type */ 649/* accepts any ev_watcher type */
587void ev_feed_event (EV_P_ void *w, int revents); 650void ev_feed_event (EV_P_ void *w, int revents);
588void 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
589void ev_feed_signal_event (EV_P_ int signum); 653void ev_feed_signal_event (EV_P_ int signum);
654#endif
590void ev_invoke (EV_P_ void *w, int revents); 655void ev_invoke (EV_P_ void *w, int revents);
591int ev_clear_pending (EV_P_ void *w); 656int ev_clear_pending (EV_P_ void *w);
592 657
593void ev_io_start (EV_P_ ev_io *w); 658void ev_io_start (EV_P_ ev_io *w);
594void ev_io_stop (EV_P_ ev_io *w); 659void ev_io_stop (EV_P_ ev_io *w);
595 660
596void ev_timer_start (EV_P_ ev_timer *w); 661void ev_timer_start (EV_P_ ev_timer *w);
597void ev_timer_stop (EV_P_ ev_timer *w); 662void 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 */ 663/* 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); 664void ev_timer_again (EV_P_ ev_timer *w);
665/* return remaining time */
666ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
600 667
601#if EV_PERIODIC_ENABLE 668#if EV_PERIODIC_ENABLE
602void ev_periodic_start (EV_P_ ev_periodic *w); 669void ev_periodic_start (EV_P_ ev_periodic *w);
603void ev_periodic_stop (EV_P_ ev_periodic *w); 670void ev_periodic_stop (EV_P_ ev_periodic *w);
604void ev_periodic_again (EV_P_ ev_periodic *w); 671void ev_periodic_again (EV_P_ ev_periodic *w);
605#endif 672#endif
606 673
607/* only supported in the default loop */ 674/* only supported in the default loop */
675#if EV_SIGNAL_ENABLE
608void ev_signal_start (EV_P_ ev_signal *w); 676void ev_signal_start (EV_P_ ev_signal *w);
609void ev_signal_stop (EV_P_ ev_signal *w); 677void ev_signal_stop (EV_P_ ev_signal *w);
678#endif
610 679
611/* only supported in the default loop */ 680/* only supported in the default loop */
681# if EV_CHILD_ENABLE
612void ev_child_start (EV_P_ ev_child *w); 682void ev_child_start (EV_P_ ev_child *w);
613void ev_child_stop (EV_P_ ev_child *w); 683void ev_child_stop (EV_P_ ev_child *w);
684# endif
614 685
615# if EV_STAT_ENABLE 686# if EV_STAT_ENABLE
616void ev_stat_start (EV_P_ ev_stat *w); 687void ev_stat_start (EV_P_ ev_stat *w);
617void ev_stat_stop (EV_P_ ev_stat *w); 688void ev_stat_stop (EV_P_ ev_stat *w);
618void 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