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

Comparing libev/ev.h (file contents):
Revision 1.146 by root, Fri Oct 22 06:14:28 2010 UTC vs.
Revision 1.149 by root, Sun Oct 24 17:58:41 2010 UTC

… …
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
44# define EV_CPP(x) x
45#else
46# define EV_CPP(x)
47#endif
48
44extern "C" { 49EV_CPP(extern "C" {)
45#endif
46 50
47/*****************************************************************************/ 51/*****************************************************************************/
48 52
49/* pre-4.0 compatibility */ 53/* pre-4.0 compatibility */
50#ifndef EV_COMPAT3 54#ifndef EV_COMPAT3
… …
145# include <sys/types.h> 149# include <sys/types.h>
146# endif 150# endif
147# include <sys/stat.h> 151# include <sys/stat.h>
148#endif 152#endif
149 153
150/* in C++ we can use this to provide default arguments */
151#ifdef __cplusplus
152# define EV_DEFARG(x) = x
153#else
154# define EV_DEFARG(x)
155#endif
156
157/* support multiple event loops? */ 154/* support multiple event loops? */
158#if EV_MULTIPLICITY 155#if EV_MULTIPLICITY
159struct ev_loop; 156struct ev_loop;
160# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */ 157# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
161# define EV_P_ EV_P, /* a loop as first of multiple parameters */ 158# define EV_P_ EV_P, /* a loop as first of multiple parameters */
162# define EV_A loop /* a loop as sole argument to a function call */ 159# define EV_A loop /* a loop as sole argument to a function call */
163# define EV_A_ EV_A, /* a loop as first of multiple arguments */ 160# define EV_A_ EV_A, /* a loop as first of multiple arguments */
164# define EV_DEFAULT_UC ev_default_loop_uc () /* the default loop, if initialised, as sole arg */ 161# define EV_DEFAULT_UC ev_default_loop_uc_ () /* the default loop, if initialised, as sole arg */
165# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */ 162# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
166# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */ 163# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
167# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */ 164# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
168# define EV_PDEF EV_P EV_DEFARG (EV_DEFAULT_UC) /* EV_P, but with default argument in C++ */
169# define EV_PDEF_ EV_P EV_DEFARG (EV_DEFAULT_UC), /* EV_P_, but with default argument in C++ */
170#else 165#else
171# define EV_P void 166# define EV_P void
172# define EV_P_ 167# define EV_P_
173# define EV_A 168# define EV_A
174# define EV_A_ 169# define EV_A_
175# define EV_DEFAULT 170# define EV_DEFAULT
176# define EV_DEFAULT_ 171# define EV_DEFAULT_
177# define EV_DEFAULT_UC 172# define EV_DEFAULT_UC
178# define EV_DEFAULT_UC_ 173# define EV_DEFAULT_UC_
179# define EV_PDEF EV_P
180# define EV_PDEF_ EV_P_
181# undef EV_EMBED_ENABLE 174# undef EV_EMBED_ENABLE
182#endif 175#endif
183 176
184/* EV_INLINE is used for functions in header files */ 177/* EV_INLINE is used for functions in header files */
185#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 178#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
… …
515 * (such as failed select, poll, epoll_wait) 508 * (such as failed select, poll, epoll_wait)
516 */ 509 */
517void ev_set_syserr_cb (void (*cb)(const char *msg)); 510void ev_set_syserr_cb (void (*cb)(const char *msg));
518 511
519#if EV_MULTIPLICITY 512#if EV_MULTIPLICITY
513
514/* the default loop is the only one that handles signals and child watchers */
515/* you can call this as often as you like */
516struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0));
517
520EV_INLINE struct ev_loop * 518EV_INLINE struct ev_loop *
521ev_default_loop_uc (void) 519ev_default_loop_uc_ (void)
522{ 520{
523 extern struct ev_loop *ev_default_loop_ptr; 521 extern struct ev_loop *ev_default_loop_ptr;
524 522
525 return ev_default_loop_ptr; 523 return ev_default_loop_ptr;
526} 524}
527 525
528/* the default loop is the only one that handles signals and child watchers */ 526EV_INLINE int
529/* you can call this as often as you like */ 527ev_is_default_loop (EV_P)
530EV_INLINE struct ev_loop *
531ev_default_loop (unsigned int flags EV_DEFARG (0))
532{ 528{
533 struct ev_loop *loop = ev_default_loop_uc (); 529 return EV_A == EV_DEFAULT_UC;
534
535 if (!loop)
536 {
537 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
538
539 loop = ev_default_loop_init (flags);
540 }
541
542 return loop;
543} 530}
544 531
545/* create and destroy alternative loops that don't handle signals */ 532/* create and destroy alternative loops that don't handle signals */
546struct ev_loop *ev_loop_new (unsigned int flags EV_DEFARG (0)); 533struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
534/* destroy event loops, also works for the default loop */
547void ev_loop_destroy (EV_PDEF); 535void ev_loop_destroy (EV_P);
548void ev_loop_fork (EV_PDEF);
549 536
550ev_tstamp ev_now (EV_PDEF); /* time w.r.t. timers and the eventloop, updated after each poll */ 537ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
551 538
552#else 539#else
553 540
554int ev_default_loop (unsigned int flags EV_DEFARG (0)); /* returns true when successful */ 541int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */
555 542
556EV_INLINE ev_tstamp 543EV_INLINE ev_tstamp
557ev_now (void) 544ev_now (void)
558{ 545{
559 extern ev_tstamp ev_rt_now; 546 extern ev_tstamp ev_rt_now;
560 547
561 return ev_rt_now; 548 return ev_rt_now;
562} 549}
550
551/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
552EV_INLINE int
553ev_is_default_loop (void)
554{
555 return 1;
556}
557
563#endif /* multiplicity */ 558#endif /* multiplicity */
564 559
565EV_INLINE int
566ev_is_default_loop (EV_PDEF)
567{
568#if EV_MULTIPLICITY
569 extern struct ev_loop *ev_default_loop_ptr;
570
571 return !!(EV_A == ev_default_loop_ptr);
572#else
573 return 1;
574#endif
575}
576
577void ev_default_destroy (void); /* destroy the default loop */
578/* this needs to be called after fork, to duplicate the default loop */ 560/* this needs to be called after fork, to duplicate the loop */
579/* if you create alternative loops you have to call ev_loop_fork on them */ 561/* when you want to re-use it in the child */
580/* you can call it in either the parent or the child */ 562/* you can call it in either the parent or the child */
581/* you can actually call it at any time, anywhere :) */ 563/* you can actually call it at any time, anywhere :) */
582void ev_default_fork (void); 564void ev_loop_fork (EV_P);
583 565
584unsigned int ev_backend (EV_PDEF); /* backend in use by loop */ 566unsigned int ev_backend (EV_P); /* backend in use by loop */
585 567
586void ev_now_update (EV_PDEF); /* update event loop time */ 568void ev_now_update (EV_P); /* update event loop time */
587 569
588#if EV_WALK_ENABLE 570#if EV_WALK_ENABLE
589/* walk (almost) all watchers in the loop of a given type, invoking the */ 571/* walk (almost) all watchers in the loop of a given type, invoking the */
590/* callback on every such watcher. The callback might stop the watcher, */ 572/* callback on every such watcher. The callback might stop the watcher, */
591/* but do nothing else with the loop */ 573/* but do nothing else with the loop */
… …
606 EVBREAK_ONE = 1, /* unloop once */ 588 EVBREAK_ONE = 1, /* unloop once */
607 EVBREAK_ALL = 2 /* unloop all loops */ 589 EVBREAK_ALL = 2 /* unloop all loops */
608}; 590};
609 591
610#if EV_PROTOTYPES 592#if EV_PROTOTYPES
611void ev_run (EV_PDEF_ int flags EV_DEFARG (0)); 593void ev_run (EV_P_ int flags EV_CPP (= 0));
612void ev_break (EV_PDEF_ int how EV_DEFARG (EVBREAK_ONE)); /* break out of the loop */ 594void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */
613 595
614/* 596/*
615 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 597 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
616 * keeps one reference. if you have a long-running watcher you never unregister that 598 * keeps one reference. if you have a long-running watcher you never unregister that
617 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 599 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
618 */ 600 */
619void ev_ref (EV_PDEF); 601void ev_ref (EV_P);
620void ev_unref (EV_PDEF); 602void ev_unref (EV_P);
621 603
622/* 604/*
623 * convenience function, wait for a single event, without registering an event watcher 605 * convenience function, wait for a single event, without registering an event watcher
624 * if timeout is < 0, do wait indefinitely 606 * if timeout is < 0, do wait indefinitely
625 */ 607 */
626void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 608void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
627 609
628# if EV_FEATURE_API 610# if EV_FEATURE_API
629unsigned int ev_iteration (EV_PDEF); /* number of loop iterations */ 611unsigned int ev_iteration (EV_P); /* number of loop iterations */
630unsigned int ev_depth (EV_PDEF); /* #ev_loop enters - #ev_loop leaves */ 612unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
631void ev_verify (EV_PDEF); /* abort if loop data corrupted */ 613void ev_verify (EV_P); /* abort if loop data corrupted */
632 614
633void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 615void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
634void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 616void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
635 617
636/* advanced stuff for threading etc. support, see docs */ 618/* advanced stuff for threading etc. support, see docs */
637void ev_set_userdata (EV_P_ void *data); 619void ev_set_userdata (EV_P_ void *data);
638void *ev_userdata (EV_PDEF); 620void *ev_userdata (EV_P);
639void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P)); 621void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
640void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P)); 622void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
641 623
642unsigned int ev_pending_count (EV_PDEF); /* number of pending events, if any */ 624unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
643void ev_invoke_pending (EV_PDEF); /* invoke all pending watchers */ 625void ev_invoke_pending (EV_P); /* invoke all pending watchers */
644 626
645/* 627/*
646 * stop/start the timer handling. 628 * stop/start the timer handling.
647 */ 629 */
648void ev_suspend (EV_PDEF); 630void ev_suspend (EV_P);
649void ev_resume (EV_PDEF); 631void ev_resume (EV_P);
650#endif 632#endif
651 633
652#endif 634#endif
653 635
654/* these may evaluate ev multiple times, and the other arguments at most once */ 636/* these may evaluate ev multiple times, and the other arguments at most once */
… …
793 #define EVUNLOOP_ONE EVBREAK_ONE 775 #define EVUNLOOP_ONE EVBREAK_ONE
794 #define EVUNLOOP_ALL EVBREAK_ALL 776 #define EVUNLOOP_ALL EVBREAK_ALL
795 #if EV_PROTOTYPES 777 #if EV_PROTOTYPES
796 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); } 778 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
797 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); } 779 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
780 EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); }
781 EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); }
798 #if EV_FEATURE_API 782 #if EV_FEATURE_API
799 EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); } 783 EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); }
800 EV_INLINE void ev_loop_depth (EV_P) { ev_depth (EV_A); } 784 EV_INLINE void ev_loop_depth (EV_P) { ev_depth (EV_A); }
801 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); } 785 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
802 #endif 786 #endif
… …
805 typedef struct ev_loop ev_loop; 789 typedef struct ev_loop ev_loop;
806#endif 790#endif
807 791
808#endif 792#endif
809 793
810#ifdef __cplusplus 794EV_CPP(})
811}
812#endif
813 795
814#endif 796#endif
815 797

Diff Legend

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