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

Comparing libev/ev.h (file contents):
Revision 1.143 by root, Fri Oct 22 05:57:55 2010 UTC vs.
Revision 1.155 by root, Thu Nov 4 18:40:09 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
… …
97 101
98#ifndef EV_FORK_ENABLE 102#ifndef EV_FORK_ENABLE
99# define EV_FORK_ENABLE EV_FEATURE_WATCHERS 103# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
100#endif 104#endif
101 105
106#ifndef EV_CLEANUP_ENABLE
107# define EV_CLEANUP_ENABLE EV_FEATURE_WATCHERS
108#endif
109
102#ifndef EV_SIGNAL_ENABLE 110#ifndef EV_SIGNAL_ENABLE
103# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS 111# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
104#endif 112#endif
105 113
106#ifndef EV_CHILD_ENABLE 114#ifndef EV_CHILD_ENABLE
… …
145# include <sys/types.h> 153# include <sys/types.h>
146# endif 154# endif
147# include <sys/stat.h> 155# include <sys/stat.h>
148#endif 156#endif
149 157
150#ifdef __cplusplus
151# define EV_DEFARG(x) = x
152#else
153# define EV_DEFARG(x)
154#endif
155
156/* support multiple event loops? */ 158/* support multiple event loops? */
157#if EV_MULTIPLICITY 159#if EV_MULTIPLICITY
158struct ev_loop; 160struct ev_loop;
159# define EV_P struct ev_loop *loop 161# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
160# define EV_P_ EV_P, 162# define EV_P_ EV_P, /* a loop as first of multiple parameters */
161# define EV_A loop 163# define EV_A loop /* a loop as sole argument to a function call */
162# define EV_A_ EV_A, 164# define EV_A_ EV_A, /* a loop as first of multiple arguments */
163# define EV_DEFAULT_UC ev_default_loop_uc () 165# define EV_DEFAULT_UC ev_default_loop_uc_ () /* the default loop, if initialised, as sole arg */
164# define EV_DEFAULT_UC_ EV_DEFAULT_UC, 166# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
165# define EV_DEFAULT ev_default_loop (0) 167# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
166# define EV_DEFAULT_ EV_DEFAULT, 168# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
167#else 169#else
168# define EV_P void 170# define EV_P void
169# define EV_P_ 171# define EV_P_
170# define EV_A 172# define EV_A
171# define EV_A_ 173# define EV_A_
… …
174# define EV_DEFAULT_UC 176# define EV_DEFAULT_UC
175# define EV_DEFAULT_UC_ 177# define EV_DEFAULT_UC_
176# undef EV_EMBED_ENABLE 178# undef EV_EMBED_ENABLE
177#endif 179#endif
178 180
181/* EV_INLINE is used for functions in header files */
179#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 182#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
180# define EV_INLINE static inline 183# define EV_INLINE static inline
181#else 184#else
182# define EV_INLINE static 185# define EV_INLINE static
183#endif 186#endif
184 187
188/* EV_PROTOTYPES can be sued to switch of prototype declarations */
185#ifndef EV_PROTOTYPES 189#ifndef EV_PROTOTYPES
186# define EV_PROTOTYPES 1 190# define EV_PROTOTYPES 1
187#endif 191#endif
188 192
189/*****************************************************************************/ 193/*****************************************************************************/
… …
191#define EV_VERSION_MAJOR 4 195#define EV_VERSION_MAJOR 4
192#define EV_VERSION_MINOR 0 196#define EV_VERSION_MINOR 0
193 197
194/* eventmask, revents, events... */ 198/* eventmask, revents, events... */
195enum { 199enum {
196 EV_UNDEF = -1, /* guaranteed to be invalid */ 200 EV_UNDEF = 0xFFFFFFFF, /* guaranteed to be invalid */
197 EV_NONE = 0x00, /* no events */ 201 EV_NONE = 0x00, /* no events */
198 EV_READ = 0x01, /* ev_io detected read will not block */ 202 EV_READ = 0x01, /* ev_io detected read will not block */
199 EV_WRITE = 0x02, /* ev_io detected write will not block */ 203 EV_WRITE = 0x02, /* ev_io detected write will not block */
200 EV__IOFDSET = 0x80, /* internal use only */ 204 EV__IOFDSET = 0x80, /* internal use only */
201 EV_IO = EV_READ, /* alias for type-detection */ 205 EV_IO = EV_READ, /* alias for type-detection */
… …
210 EV_IDLE = 0x00002000, /* event loop is idling */ 214 EV_IDLE = 0x00002000, /* event loop is idling */
211 EV_PREPARE = 0x00004000, /* event loop about to poll */ 215 EV_PREPARE = 0x00004000, /* event loop about to poll */
212 EV_CHECK = 0x00008000, /* event loop finished poll */ 216 EV_CHECK = 0x00008000, /* event loop finished poll */
213 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */ 217 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
214 EV_FORK = 0x00020000, /* event loop resumed in child */ 218 EV_FORK = 0x00020000, /* event loop resumed in child */
219 EV_CLEANUP = 0x00040000, /* event loop resumed in child */
215 EV_ASYNC = 0x00040000, /* async intra-loop signal */ 220 EV_ASYNC = 0x00080000, /* async intra-loop signal */
216 EV_CUSTOM = 0x01000000, /* for use by user code */ 221 EV_CUSTOM = 0x01000000, /* for use by user code */
217 EV_ERROR = 0x80000000 /* sent when an error occurs */ 222 EV_ERROR = 0x80000000 /* sent when an error occurs */
218}; 223};
219 224
220/* can be used to add custom fields to all watchers, while losing binary compatibility */ 225/* can be used to add custom fields to all watchers, while losing binary compatibility */
… …
389 EV_WATCHER (ev_check) 394 EV_WATCHER (ev_check)
390} ev_check; 395} ev_check;
391 396
392#if EV_FORK_ENABLE 397#if EV_FORK_ENABLE
393/* the callback gets invoked before check in the child process when a fork was detected */ 398/* the callback gets invoked before check in the child process when a fork was detected */
399/* revent EV_FORK */
394typedef struct ev_fork 400typedef struct ev_fork
395{ 401{
396 EV_WATCHER (ev_fork) 402 EV_WATCHER (ev_fork)
397} ev_fork; 403} ev_fork;
404#endif
405
406#if EV_CLEANUP_ENABLE
407/* is invoked just before the loop gets destroyed */
408/* revent EV_CLEANUP */
409typedef struct ev_cleanup
410{
411 EV_WATCHER (ev_cleanup)
412} ev_cleanup;
398#endif 413#endif
399 414
400#if EV_EMBED_ENABLE 415#if EV_EMBED_ENABLE
401/* used to embed an event loop inside another */ 416/* used to embed an event loop inside another */
402/* the callback gets invoked when the event loop has handled events, and can be 0 */ 417/* the callback gets invoked when the event loop has handled events, and can be 0 */
… …
410 ev_check check; /* unused */ 425 ev_check check; /* unused */
411 ev_timer timer; /* unused */ 426 ev_timer timer; /* unused */
412 ev_periodic periodic; /* unused */ 427 ev_periodic periodic; /* unused */
413 ev_idle idle; /* unused */ 428 ev_idle idle; /* unused */
414 ev_fork fork; /* private */ 429 ev_fork fork; /* private */
430#if EV_CLEANUP_ENABLE
431 ev_cleanup cleanup; /* unused */
432#endif
415} ev_embed; 433} ev_embed;
416#endif 434#endif
417 435
418#if EV_ASYNC_ENABLE 436#if EV_ASYNC_ENABLE
419/* invoked when somebody calls ev_async_send on the watcher */ 437/* invoked when somebody calls ev_async_send on the watcher */
… …
447#endif 465#endif
448 struct ev_prepare prepare; 466 struct ev_prepare prepare;
449 struct ev_check check; 467 struct ev_check check;
450#if EV_FORK_ENABLE 468#if EV_FORK_ENABLE
451 struct ev_fork fork; 469 struct ev_fork fork;
470#endif
471#if EV_CLEANUP_ENABLE
472 struct ev_cleanup cleanup;
452#endif 473#endif
453#if EV_EMBED_ENABLE 474#if EV_EMBED_ENABLE
454 struct ev_embed embed; 475 struct ev_embed embed;
455#endif 476#endif
456#if EV_ASYNC_ENABLE 477#if EV_ASYNC_ENABLE
… …
508 * (such as failed select, poll, epoll_wait) 529 * (such as failed select, poll, epoll_wait)
509 */ 530 */
510void ev_set_syserr_cb (void (*cb)(const char *msg)); 531void ev_set_syserr_cb (void (*cb)(const char *msg));
511 532
512#if EV_MULTIPLICITY 533#if EV_MULTIPLICITY
534
535/* the default loop is the only one that handles signals and child watchers */
536/* you can call this as often as you like */
537struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0));
538
513EV_INLINE struct ev_loop * 539EV_INLINE struct ev_loop *
514ev_default_loop_uc (void) 540ev_default_loop_uc_ (void)
515{ 541{
516 extern struct ev_loop *ev_default_loop_ptr; 542 extern struct ev_loop *ev_default_loop_ptr;
517 543
518 return ev_default_loop_ptr; 544 return ev_default_loop_ptr;
519} 545}
520 546
521/* the default loop is the only one that handles signals and child watchers */ 547EV_INLINE int
522/* you can call this as often as you like */ 548ev_is_default_loop (EV_P)
523EV_INLINE struct ev_loop *
524ev_default_loop (unsigned int flags EV_DEFARG (0))
525{ 549{
526 struct ev_loop *loop = ev_default_loop_uc (); 550 return EV_A == EV_DEFAULT_UC;
527
528 if (!loop)
529 {
530 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
531
532 loop = ev_default_loop_init (flags);
533 }
534
535 return loop;
536} 551}
537 552
538/* create and destroy alternative loops that don't handle signals */ 553/* create and destroy alternative loops that don't handle signals */
539struct ev_loop *ev_loop_new (unsigned int flags EV_DEFARG (0)); 554struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
540void ev_loop_destroy (EV_P);
541void ev_loop_fork (EV_P);
542 555
543ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 556ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
544 557
545#else 558#else
546 559
547int ev_default_loop (unsigned int flags EV_DEFARG (0)); /* returns true when successful */ 560int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */
548 561
549EV_INLINE ev_tstamp 562EV_INLINE ev_tstamp
550ev_now (void) 563ev_now (void)
551{ 564{
552 extern ev_tstamp ev_rt_now; 565 extern ev_tstamp ev_rt_now;
553 566
554 return ev_rt_now; 567 return ev_rt_now;
555} 568}
569
570/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
571EV_INLINE int
572ev_is_default_loop (void)
573{
574 return 1;
575}
576
556#endif /* multiplicity */ 577#endif /* multiplicity */
557 578
558EV_INLINE int 579/* destroy event loops, also works for the default loop */
559ev_is_default_loop (EV_P) 580void ev_loop_destroy (EV_P);
560{
561#if EV_MULTIPLICITY
562 extern struct ev_loop *ev_default_loop_ptr;
563 581
564 return !!(EV_A == ev_default_loop_ptr);
565#else
566 return 1;
567#endif
568}
569
570void ev_default_destroy (void); /* destroy the default loop */
571/* this needs to be called after fork, to duplicate the default loop */ 582/* this needs to be called after fork, to duplicate the loop */
572/* if you create alternative loops you have to call ev_loop_fork on them */ 583/* when you want to re-use it in the child */
573/* you can call it in either the parent or the child */ 584/* you can call it in either the parent or the child */
574/* you can actually call it at any time, anywhere :) */ 585/* you can actually call it at any time, anywhere :) */
575void ev_default_fork (void); 586void ev_loop_fork (EV_P);
576 587
577unsigned int ev_backend (EV_P); /* backend in use by loop */ 588unsigned int ev_backend (EV_P); /* backend in use by loop */
578 589
579void ev_now_update (EV_P); /* update event loop time */ 590void ev_now_update (EV_P); /* update event loop time */
580 591
… …
599 EVBREAK_ONE = 1, /* unloop once */ 610 EVBREAK_ONE = 1, /* unloop once */
600 EVBREAK_ALL = 2 /* unloop all loops */ 611 EVBREAK_ALL = 2 /* unloop all loops */
601}; 612};
602 613
603#if EV_PROTOTYPES 614#if EV_PROTOTYPES
604void ev_run (EV_P_ int flags EV_DEFARG (0)); 615void ev_run (EV_P_ int flags EV_CPP (= 0));
605void ev_break (EV_P_ int how EV_DEFARG (EVBREAK_ONE)); /* break out of the loop */ 616void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */
606 617
607/* 618/*
608 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 619 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
609 * keeps one reference. if you have a long-running watcher you never unregister that 620 * keeps one reference. if you have a long-running watcher you never unregister that
610 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 621 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
… …
662#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 673#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
663#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 674#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
664#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 675#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
665#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 676#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
666#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 677#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
678#define ev_cleanup_set(ev) /* nop, yes, this is a serious in-joke */
667#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */ 679#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
668 680
669#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 681#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
670#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 682#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
671#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0) 683#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
… …
675#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 687#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
676#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 688#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
677#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 689#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
678#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) 690#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
679#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 691#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
692#define ev_cleanup_init(ev,cb) do { ev_init ((ev), (cb)); ev_cleanup_set ((ev)); } while (0)
680#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 693#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
681 694
682#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 695#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
683#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 696#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
684 697
… …
762#endif 775#endif
763 776
764# if EV_FORK_ENABLE 777# if EV_FORK_ENABLE
765void ev_fork_start (EV_P_ ev_fork *w); 778void ev_fork_start (EV_P_ ev_fork *w);
766void ev_fork_stop (EV_P_ ev_fork *w); 779void ev_fork_stop (EV_P_ ev_fork *w);
780# endif
781
782# if EV_CLEANUP_ENABLE
783void ev_cleanup_start (EV_P_ ev_cleanup *w);
784void ev_cleanup_stop (EV_P_ ev_cleanup *w);
767# endif 785# endif
768 786
769# if EV_EMBED_ENABLE 787# if EV_EMBED_ENABLE
770/* only supported when loop to be embedded is in fact embeddable */ 788/* only supported when loop to be embedded is in fact embeddable */
771void ev_embed_start (EV_P_ ev_embed *w); 789void ev_embed_start (EV_P_ ev_embed *w);
… …
786 #define EVUNLOOP_ONE EVBREAK_ONE 804 #define EVUNLOOP_ONE EVBREAK_ONE
787 #define EVUNLOOP_ALL EVBREAK_ALL 805 #define EVUNLOOP_ALL EVBREAK_ALL
788 #if EV_PROTOTYPES 806 #if EV_PROTOTYPES
789 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); } 807 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
790 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); } 808 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
809 EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); }
810 EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); }
791 #if EV_FEATURE_API 811 #if EV_FEATURE_API
792 EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); } 812 EV_INLINE unsigned int ev_loop_count (EV_P) { return ev_iteration (EV_A); }
793 EV_INLINE void ev_loop_depth (EV_P) { ev_depth (EV_A); } 813 EV_INLINE unsigned int ev_loop_depth (EV_P) { return ev_depth (EV_A); }
794 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); } 814 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
795 #endif 815 #endif
796 #endif 816 #endif
797#else 817#else
798 typedef struct ev_loop ev_loop; 818 typedef struct ev_loop ev_loop;
799#endif 819#endif
800 820
801#endif 821#endif
802 822
803#ifdef __cplusplus 823EV_CPP(})
804}
805#endif
806 824
807#endif 825#endif
808 826

Diff Legend

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