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

Comparing libev/ev.h (file contents):
Revision 1.142 by root, Thu Oct 21 14:50:58 2010 UTC vs.
Revision 1.150 by root, Sun Oct 24 18:05:53 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
… …
94#ifndef EV_IDLE_ENABLE 98#ifndef EV_IDLE_ENABLE
95# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS 99# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
96#endif 100#endif
97 101
98#ifndef EV_FORK_ENABLE 102#ifndef EV_FORK_ENABLE
103# define EV_FORK_ENABLE 0 /* not implemented */
104#endif
105
106#ifndef EV_CLEANUP_ENABLE
99# define EV_FORK_ENABLE EV_FEATURE_WATCHERS 107# define EV_CLEANUP_ENABLE EV_FEATURE_WATCHERS
100#endif 108#endif
101 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
… …
148#endif 156#endif
149 157
150/* support multiple event loops? */ 158/* support multiple event loops? */
151#if EV_MULTIPLICITY 159#if EV_MULTIPLICITY
152struct ev_loop; 160struct ev_loop;
153# define EV_P struct ev_loop *loop 161# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
154# define EV_P_ EV_P, 162# define EV_P_ EV_P, /* a loop as first of multiple parameters */
155# define EV_A loop 163# define EV_A loop /* a loop as sole argument to a function call */
156# define EV_A_ EV_A, 164# define EV_A_ EV_A, /* a loop as first of multiple arguments */
157# 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 */
158# define EV_DEFAULT_UC_ EV_DEFAULT_UC, 166# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
159# define EV_DEFAULT ev_default_loop (0) 167# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
160# define EV_DEFAULT_ EV_DEFAULT, 168# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
161#else 169#else
162# define EV_P void 170# define EV_P void
163# define EV_P_ 171# define EV_P_
164# define EV_A 172# define EV_A
165# define EV_A_ 173# define EV_A_
… …
168# define EV_DEFAULT_UC 176# define EV_DEFAULT_UC
169# define EV_DEFAULT_UC_ 177# define EV_DEFAULT_UC_
170# undef EV_EMBED_ENABLE 178# undef EV_EMBED_ENABLE
171#endif 179#endif
172 180
181/* EV_INLINE is used for functions in header files */
173#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 182#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
174# define EV_INLINE static inline 183# define EV_INLINE static inline
175#else 184#else
176# define EV_INLINE static 185# define EV_INLINE static
177#endif 186#endif
178 187
188/* EV_PROTOTYPES can be sued to switch of prototype declarations */
179#ifndef EV_PROTOTYPES 189#ifndef EV_PROTOTYPES
180# define EV_PROTOTYPES 1 190# define EV_PROTOTYPES 1
181#endif 191#endif
182 192
183/*****************************************************************************/ 193/*****************************************************************************/
… …
192 EV_READ = 0x01, /* ev_io detected read will not block */ 202 EV_READ = 0x01, /* ev_io detected read will not block */
193 EV_WRITE = 0x02, /* ev_io detected write will not block */ 203 EV_WRITE = 0x02, /* ev_io detected write will not block */
194 EV__IOFDSET = 0x80, /* internal use only */ 204 EV__IOFDSET = 0x80, /* internal use only */
195 EV_IO = EV_READ, /* alias for type-detection */ 205 EV_IO = EV_READ, /* alias for type-detection */
196 EV_TIMER = 0x00000100, /* timer timed out */ 206 EV_TIMER = 0x00000100, /* timer timed out */
207#if EV_COMPAT3
197 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */ 208 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
209#endif
198 EV_PERIODIC = 0x00000200, /* periodic timer timed out */ 210 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
199 EV_SIGNAL = 0x00000400, /* signal was received */ 211 EV_SIGNAL = 0x00000400, /* signal was received */
200 EV_CHILD = 0x00000800, /* child/pid had status change */ 212 EV_CHILD = 0x00000800, /* child/pid had status change */
201 EV_STAT = 0x00001000, /* stat data changed */ 213 EV_STAT = 0x00001000, /* stat data changed */
202 EV_IDLE = 0x00002000, /* event loop is idling */ 214 EV_IDLE = 0x00002000, /* event loop is idling */
203 EV_PREPARE = 0x00004000, /* event loop about to poll */ 215 EV_PREPARE = 0x00004000, /* event loop about to poll */
204 EV_CHECK = 0x00008000, /* event loop finished poll */ 216 EV_CHECK = 0x00008000, /* event loop finished poll */
205 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */ 217 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
206 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 */
207 EV_ASYNC = 0x00040000, /* async intra-loop signal */ 220 EV_ASYNC = 0x00080000, /* async intra-loop signal */
208 EV_CUSTOM = 0x01000000, /* for use by user code */ 221 EV_CUSTOM = 0x01000000, /* for use by user code */
209 EV_ERROR = 0x80000000 /* sent when an error occurs */ 222 EV_ERROR = 0x80000000 /* sent when an error occurs */
210}; 223};
211 224
212/* 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 */
… …
381 EV_WATCHER (ev_check) 394 EV_WATCHER (ev_check)
382} ev_check; 395} ev_check;
383 396
384#if EV_FORK_ENABLE 397#if EV_FORK_ENABLE
385/* 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 */
386typedef struct ev_fork 400typedef struct ev_fork
387{ 401{
388 EV_WATCHER (ev_fork) 402 EV_WATCHER (ev_fork)
389} 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;
390#endif 413#endif
391 414
392#if EV_EMBED_ENABLE 415#if EV_EMBED_ENABLE
393/* used to embed an event loop inside another */ 416/* used to embed an event loop inside another */
394/* 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 */
… …
402 ev_check check; /* unused */ 425 ev_check check; /* unused */
403 ev_timer timer; /* unused */ 426 ev_timer timer; /* unused */
404 ev_periodic periodic; /* unused */ 427 ev_periodic periodic; /* unused */
405 ev_idle idle; /* unused */ 428 ev_idle idle; /* unused */
406 ev_fork fork; /* private */ 429 ev_fork fork; /* private */
430 ev_cleanup cleanup; /* unused */
407} ev_embed; 431} ev_embed;
408#endif 432#endif
409 433
410#if EV_ASYNC_ENABLE 434#if EV_ASYNC_ENABLE
411/* invoked when somebody calls ev_async_send on the watcher */ 435/* invoked when somebody calls ev_async_send on the watcher */
… …
439#endif 463#endif
440 struct ev_prepare prepare; 464 struct ev_prepare prepare;
441 struct ev_check check; 465 struct ev_check check;
442#if EV_FORK_ENABLE 466#if EV_FORK_ENABLE
443 struct ev_fork fork; 467 struct ev_fork fork;
468#endif
469#if EV_CLEANUP_ENABLE
470 struct ev_cleanup cleanup;
444#endif 471#endif
445#if EV_EMBED_ENABLE 472#if EV_EMBED_ENABLE
446 struct ev_embed embed; 473 struct ev_embed embed;
447#endif 474#endif
448#if EV_ASYNC_ENABLE 475#if EV_ASYNC_ENABLE
… …
500 * (such as failed select, poll, epoll_wait) 527 * (such as failed select, poll, epoll_wait)
501 */ 528 */
502void ev_set_syserr_cb (void (*cb)(const char *msg)); 529void ev_set_syserr_cb (void (*cb)(const char *msg));
503 530
504#if EV_MULTIPLICITY 531#if EV_MULTIPLICITY
532
533/* the default loop is the only one that handles signals and child watchers */
534/* you can call this as often as you like */
535struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0));
536
505EV_INLINE struct ev_loop * 537EV_INLINE struct ev_loop *
506ev_default_loop_uc (void) 538ev_default_loop_uc_ (void)
507{ 539{
508 extern struct ev_loop *ev_default_loop_ptr; 540 extern struct ev_loop *ev_default_loop_ptr;
509 541
510 return ev_default_loop_ptr; 542 return ev_default_loop_ptr;
511} 543}
512 544
513/* the default loop is the only one that handles signals and child watchers */ 545EV_INLINE int
514/* you can call this as often as you like */ 546ev_is_default_loop (EV_P)
515EV_INLINE struct ev_loop *
516ev_default_loop (unsigned int flags)
517{ 547{
518 struct ev_loop *loop = ev_default_loop_uc (); 548 return EV_A == EV_DEFAULT_UC;
519
520 if (!loop)
521 {
522 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
523
524 loop = ev_default_loop_init (flags);
525 }
526
527 return loop;
528} 549}
529 550
530/* create and destroy alternative loops that don't handle signals */ 551/* create and destroy alternative loops that don't handle signals */
531struct ev_loop *ev_loop_new (unsigned int flags); 552struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
553/* destroy event loops, also works for the default loop */
532void ev_loop_destroy (EV_P); 554void ev_loop_destroy (EV_P);
533void ev_loop_fork (EV_P);
534 555
535ev_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 */
536 557
537#else 558#else
538 559
539int ev_default_loop (unsigned int flags); /* returns true when successful */ 560int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */
540 561
541EV_INLINE ev_tstamp 562EV_INLINE ev_tstamp
542ev_now (void) 563ev_now (void)
543{ 564{
544 extern ev_tstamp ev_rt_now; 565 extern ev_tstamp ev_rt_now;
545 566
546 return ev_rt_now; 567 return ev_rt_now;
547} 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
548#endif /* multiplicity */ 577#endif /* multiplicity */
549 578
550EV_INLINE int
551ev_is_default_loop (EV_P)
552{
553#if EV_MULTIPLICITY
554 extern struct ev_loop *ev_default_loop_ptr;
555
556 return !!(EV_A == ev_default_loop_ptr);
557#else
558 return 1;
559#endif
560}
561
562void ev_default_destroy (void); /* destroy the default loop */
563/* this needs to be called after fork, to duplicate the default loop */ 579/* this needs to be called after fork, to duplicate the loop */
564/* if you create alternative loops you have to call ev_loop_fork on them */ 580/* when you want to re-use it in the child */
565/* you can call it in either the parent or the child */ 581/* you can call it in either the parent or the child */
566/* you can actually call it at any time, anywhere :) */ 582/* you can actually call it at any time, anywhere :) */
567void ev_default_fork (void); 583void ev_loop_fork (EV_P);
568 584
569unsigned int ev_backend (EV_P); /* backend in use by loop */ 585unsigned int ev_backend (EV_P); /* backend in use by loop */
570 586
571void ev_now_update (EV_P); /* update event loop time */ 587void ev_now_update (EV_P); /* update event loop time */
572 588
… …
591 EVBREAK_ONE = 1, /* unloop once */ 607 EVBREAK_ONE = 1, /* unloop once */
592 EVBREAK_ALL = 2 /* unloop all loops */ 608 EVBREAK_ALL = 2 /* unloop all loops */
593}; 609};
594 610
595#if EV_PROTOTYPES 611#if EV_PROTOTYPES
596void ev_run (EV_P_ int flags); 612void ev_run (EV_P_ int flags EV_CPP (= 0));
597void ev_break (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ 613void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */
598 614
599/* 615/*
600 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 616 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
601 * keeps one reference. if you have a long-running watcher you never unregister that 617 * keeps one reference. if you have a long-running watcher you never unregister that
602 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 618 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
… …
654#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 670#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
655#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 671#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
656#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 672#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
657#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 673#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
658#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 674#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
675#define ev_cleanup_set(ev) /* nop, yes, this is a serious in-joke */
659#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */ 676#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
660 677
661#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 678#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
662#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 679#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
663#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0) 680#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
… …
667#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 684#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
668#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 685#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
669#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 686#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
670#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) 687#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
671#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 688#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
689#define ev_cleanup_init(ev,cb) do { ev_init ((ev), (cb)); ev_cleanup_set ((ev)); } while (0)
672#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 690#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
673 691
674#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 692#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
675#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 693#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
676 694
… …
754#endif 772#endif
755 773
756# if EV_FORK_ENABLE 774# if EV_FORK_ENABLE
757void ev_fork_start (EV_P_ ev_fork *w); 775void ev_fork_start (EV_P_ ev_fork *w);
758void ev_fork_stop (EV_P_ ev_fork *w); 776void ev_fork_stop (EV_P_ ev_fork *w);
777# endif
778
779# if EV_CLEANUP_ENABLE
780void ev_cleanup_start (EV_P_ ev_cleanup *w);
781void ev_cleanup_stop (EV_P_ ev_cleanup *w);
759# endif 782# endif
760 783
761# if EV_EMBED_ENABLE 784# if EV_EMBED_ENABLE
762/* only supported when loop to be embedded is in fact embeddable */ 785/* only supported when loop to be embedded is in fact embeddable */
763void ev_embed_start (EV_P_ ev_embed *w); 786void ev_embed_start (EV_P_ ev_embed *w);
… …
778 #define EVUNLOOP_ONE EVBREAK_ONE 801 #define EVUNLOOP_ONE EVBREAK_ONE
779 #define EVUNLOOP_ALL EVBREAK_ALL 802 #define EVUNLOOP_ALL EVBREAK_ALL
780 #if EV_PROTOTYPES 803 #if EV_PROTOTYPES
781 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); } 804 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
782 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); } 805 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
806 EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); }
807 EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); }
783 #if EV_FEATURE_API 808 #if EV_FEATURE_API
784 EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); } 809 EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); }
785 EV_INLINE void ev_loop_depth (EV_P) { ev_depth (EV_A); } 810 EV_INLINE void ev_loop_depth (EV_P) { ev_depth (EV_A); }
786 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); } 811 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
787 #endif 812 #endif
… …
790 typedef struct ev_loop ev_loop; 815 typedef struct ev_loop ev_loop;
791#endif 816#endif
792 817
793#endif 818#endif
794 819
795#ifdef __cplusplus 820EV_CPP(})
796}
797#endif
798 821
799#endif 822#endif
800 823

Diff Legend

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