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

Comparing libev/ev.h (file contents):
Revision 1.140 by root, Thu Oct 21 02:33:08 2010 UTC vs.
Revision 1.148 by root, Sun Oct 24 14:44:40 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/*****************************************************************************/
52
53/* pre-4.0 compatibility */
54#ifndef EV_COMPAT3
55# define EV_COMPAT3 1
56#endif
48 57
49#ifndef EV_FEATURES 58#ifndef EV_FEATURES
50# define EV_FEATURES 0x7f 59# define EV_FEATURES 0x7f
51#endif 60#endif
52 61
… …
143#endif 152#endif
144 153
145/* support multiple event loops? */ 154/* support multiple event loops? */
146#if EV_MULTIPLICITY 155#if EV_MULTIPLICITY
147struct ev_loop; 156struct ev_loop;
148# define EV_P struct ev_loop *loop 157# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
149# define EV_P_ EV_P, 158# define EV_P_ EV_P, /* a loop as first of multiple parameters */
150# define EV_A loop 159# define EV_A loop /* a loop as sole argument to a function call */
151# define EV_A_ EV_A, 160# define EV_A_ EV_A, /* a loop as first of multiple arguments */
152# define EV_DEFAULT_UC ev_default_loop_uc () 161# define EV_DEFAULT_UC ev_default_loop_uc () /* the default loop, if initialised, as sole arg */
153# define EV_DEFAULT_UC_ EV_DEFAULT_UC, 162# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
154# define EV_DEFAULT ev_default_loop (0) 163# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
155# define EV_DEFAULT_ EV_DEFAULT, 164# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
156#else 165#else
157# define EV_P void 166# define EV_P void
158# define EV_P_ 167# define EV_P_
159# define EV_A 168# define EV_A
160# define EV_A_ 169# define EV_A_
… …
163# define EV_DEFAULT_UC 172# define EV_DEFAULT_UC
164# define EV_DEFAULT_UC_ 173# define EV_DEFAULT_UC_
165# undef EV_EMBED_ENABLE 174# undef EV_EMBED_ENABLE
166#endif 175#endif
167 176
177/* EV_INLINE is used for functions in header files */
168#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 178#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
169# define EV_INLINE static inline 179# define EV_INLINE static inline
170#else 180#else
171# define EV_INLINE static 181# define EV_INLINE static
172#endif 182#endif
173 183
184/* EV_PROTOTYPES can be sued to switch of prototype declarations */
174#ifndef EV_PROTOTYPES 185#ifndef EV_PROTOTYPES
175# define EV_PROTOTYPES 1 186# define EV_PROTOTYPES 1
176#endif 187#endif
177 188
178/*****************************************************************************/ 189/*****************************************************************************/
179 190
180#define EV_VERSION_MAJOR 4 191#define EV_VERSION_MAJOR 4
181#define EV_VERSION_MINOR 0 192#define EV_VERSION_MINOR 0
182 193
183/* eventmask, revents, events... */ 194/* eventmask, revents, events... */
195enum {
184#define EV_UNDEF -1 /* guaranteed to be invalid */ 196 EV_UNDEF = -1, /* guaranteed to be invalid */
185#define EV_NONE 0x00 /* no events */ 197 EV_NONE = 0x00, /* no events */
186#define EV_READ 0x01 /* ev_io detected read will not block */ 198 EV_READ = 0x01, /* ev_io detected read will not block */
187#define EV_WRITE 0x02 /* ev_io detected write will not block */ 199 EV_WRITE = 0x02, /* ev_io detected write will not block */
188#define EV__IOFDSET 0x80 /* internal use only */ 200 EV__IOFDSET = 0x80, /* internal use only */
189#define EV_IO EV_READ /* alias for type-detection */ 201 EV_IO = EV_READ, /* alias for type-detection */
190#define EV_TIMER 0x00000100 /* timer timed out */ 202 EV_TIMER = 0x00000100, /* timer timed out */
203#if EV_COMPAT3
191#define EV_TIMEOUT EV_TIMER /* pre 4.0 API compatibility */ 204 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
205#endif
192#define EV_PERIODIC 0x00000200 /* periodic timer timed out */ 206 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
193#define EV_SIGNAL 0x00000400 /* signal was received */ 207 EV_SIGNAL = 0x00000400, /* signal was received */
194#define EV_CHILD 0x00000800 /* child/pid had status change */ 208 EV_CHILD = 0x00000800, /* child/pid had status change */
195#define EV_STAT 0x00001000 /* stat data changed */ 209 EV_STAT = 0x00001000, /* stat data changed */
196#define EV_IDLE 0x00002000 /* event loop is idling */ 210 EV_IDLE = 0x00002000, /* event loop is idling */
197#define EV_PREPARE 0x00004000 /* event loop about to poll */ 211 EV_PREPARE = 0x00004000, /* event loop about to poll */
198#define EV_CHECK 0x00008000 /* event loop finished poll */ 212 EV_CHECK = 0x00008000, /* event loop finished poll */
199#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ 213 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
200#define EV_FORK 0x00020000 /* event loop resumed in child */ 214 EV_FORK = 0x00020000, /* event loop resumed in child */
201#define EV_ASYNC 0x00040000 /* async intra-loop signal */ 215 EV_ASYNC = 0x00040000, /* async intra-loop signal */
202#define EV_CUSTOM 0x01000000 /* for use by user code */ 216 EV_CUSTOM = 0x01000000, /* for use by user code */
203#define EV_ERROR 0x80000000 /* sent when an error occurs */ 217 EV_ERROR = 0x80000000 /* sent when an error occurs */
218};
204 219
205/* can be used to add custom fields to all watchers, while losing binary compatibility */ 220/* can be used to add custom fields to all watchers, while losing binary compatibility */
206#ifndef EV_COMMON 221#ifndef EV_COMMON
207# define EV_COMMON void *data; 222# define EV_COMMON void *data;
208#endif 223#endif
… …
441#if EV_ASYNC_ENABLE 456#if EV_ASYNC_ENABLE
442 struct ev_async async; 457 struct ev_async async;
443#endif 458#endif
444}; 459};
445 460
446/* bits for ev_default_loop and ev_loop_new */ 461/* flag bits for ev_default_loop and ev_loop_new */
462enum {
447/* the default */ 463 /* the default */
448#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 464 EVFLAG_AUTO = 0x00000000U, /* not quite a mask */
449/* flag bits */ 465 /* flag bits */
450#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 466 EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */
451#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ 467 EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */
452/* debugging/feature disable */ 468 /* debugging/feature disable */
453#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */ 469 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
470#if EV_COMPAT3
454#define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */ 471 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
472#endif
455#define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */ 473 EVFLAG_SIGNALFD = 0x00200000U /* attempt to use signalfd */
474};
475
456/* method bits to be ored together */ 476/* method bits to be ored together */
477enum {
457#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 478 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
458#define EVBACKEND_POLL 0x00000002U /* !win */ 479 EVBACKEND_POLL = 0x00000002U, /* !win */
459#define EVBACKEND_EPOLL 0x00000004U /* linux */ 480 EVBACKEND_EPOLL = 0x00000004U, /* linux */
460#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 481 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
461#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 482 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
462#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 483 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
463#define EVBACKEND_ALL 0x0000003FU 484 EVBACKEND_ALL = 0x0000003FU
485};
464 486
465#if EV_PROTOTYPES 487#if EV_PROTOTYPES
466int ev_version_major (void); 488int ev_version_major (void);
467int ev_version_minor (void); 489int ev_version_minor (void);
468 490
… …
486 * (such as failed select, poll, epoll_wait) 508 * (such as failed select, poll, epoll_wait)
487 */ 509 */
488void ev_set_syserr_cb (void (*cb)(const char *msg)); 510void ev_set_syserr_cb (void (*cb)(const char *msg));
489 511
490#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
491EV_INLINE struct ev_loop * 518EV_INLINE struct ev_loop *
492ev_default_loop_uc (void) 519ev_default_loop_uc (void)
493{ 520{
494 extern struct ev_loop *ev_default_loop_ptr; 521 extern struct ev_loop *ev_default_loop_ptr;
495 522
496 return ev_default_loop_ptr; 523 return ev_default_loop_ptr;
497} 524}
498 525
499/* the default loop is the only one that handles signals and child watchers */ 526EV_INLINE int
500/* you can call this as often as you like */ 527ev_is_default_loop (EV_P)
501EV_INLINE struct ev_loop *
502ev_default_loop (unsigned int flags)
503{ 528{
504 struct ev_loop *loop = ev_default_loop_uc (); 529 return EV_A == ev_default_loop_uc ();
505
506 if (!loop)
507 {
508 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
509
510 loop = ev_default_loop_init (flags);
511 }
512
513 return loop;
514} 530}
515 531
516/* create and destroy alternative loops that don't handle signals */ 532/* create and destroy alternative loops that don't handle signals */
517struct ev_loop *ev_loop_new (unsigned int flags); 533struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
518void ev_loop_destroy (EV_P); 534void ev_loop_destroy (EV_P);
519void ev_loop_fork (EV_P); 535void ev_loop_fork (EV_P);
520 536
521ev_tstamp ev_now (EV_P); /* 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 */
522 538
523#else 539#else
524 540
525int ev_default_loop (unsigned int flags); /* returns true when successful */ 541int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */
526 542
527EV_INLINE ev_tstamp 543EV_INLINE ev_tstamp
528ev_now (void) 544ev_now (void)
529{ 545{
530 extern ev_tstamp ev_rt_now; 546 extern ev_tstamp ev_rt_now;
531 547
532 return ev_rt_now; 548 return ev_rt_now;
533} 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
534#endif /* multiplicity */ 558#endif /* multiplicity */
535
536EV_INLINE int
537ev_is_default_loop (EV_P)
538{
539#if EV_MULTIPLICITY
540 extern struct ev_loop *ev_default_loop_ptr;
541
542 return !!(EV_A == ev_default_loop_ptr);
543#else
544 return 1;
545#endif
546}
547 559
548void ev_default_destroy (void); /* destroy the default loop */ 560void ev_default_destroy (void); /* destroy the default loop */
549/* this needs to be called after fork, to duplicate the default loop */ 561/* this needs to be called after fork, to duplicate the default loop */
550/* if you create alternative loops you have to call ev_loop_fork on them */ 562/* if you create alternative loops you have to call ev_loop_fork on them */
551/* you can call it in either the parent or the child */ 563/* you can call it in either the parent or the child */
… …
563void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 575void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
564#endif 576#endif
565 577
566#endif /* prototypes */ 578#endif /* prototypes */
567 579
568#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 580/* ev_run flags values */
569#define EVLOOP_ONESHOT 2 /* block *once* only */ 581enum {
570#define EVUNLOOP_CANCEL 0 /* undo unloop */ 582 EVRUN_NOWAIT = 1, /* do not block/wait */
571#define EVUNLOOP_ONE 1 /* unloop once */ 583 EVRUN_ONCE = 2 /* block *once* only */
584};
585
586/* ev_break how values */
587enum {
588 EVBREAK_CANCEL = 0, /* undo unloop */
589 EVBREAK_ONE = 1, /* unloop once */
572#define EVUNLOOP_ALL 2 /* unloop all loops */ 590 EVBREAK_ALL = 2 /* unloop all loops */
591};
573 592
574#if EV_PROTOTYPES 593#if EV_PROTOTYPES
575void ev_loop (EV_P_ int flags); 594void ev_run (EV_P_ int flags EV_CPP (= 0));
576void 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 */ 595void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */
577 596
578/* 597/*
579 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 598 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
580 * keeps one reference. if you have a long-running watcher you never unregister that 599 * keeps one reference. if you have a long-running watcher you never unregister that
581 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 600 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
… …
591 610
592# if EV_FEATURE_API 611# if EV_FEATURE_API
593unsigned int ev_iteration (EV_P); /* number of loop iterations */ 612unsigned int ev_iteration (EV_P); /* number of loop iterations */
594unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ 613unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
595void ev_verify (EV_P); /* abort if loop data corrupted */ 614void ev_verify (EV_P); /* abort if loop data corrupted */
596
597/* pre 4.0 API compatibility */
598# if EV_MULTIPLICITY
599# define ev_loop_count(l) ev_iteration (l)
600# define ev_loop_depth(l) ev_depth (l)
601# define ev_loop_verify(l) ev_verify (l)
602# endif
603 615
604void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 616void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
605void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 617void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
606 618
607/* advanced stuff for threading etc. support, see docs */ 619/* advanced stuff for threading etc. support, see docs */
… …
755void ev_async_start (EV_P_ ev_async *w); 767void ev_async_start (EV_P_ ev_async *w);
756void ev_async_stop (EV_P_ ev_async *w); 768void ev_async_stop (EV_P_ ev_async *w);
757void ev_async_send (EV_P_ ev_async *w); 769void ev_async_send (EV_P_ ev_async *w);
758# endif 770# endif
759 771
772#if EV_COMPAT3
773 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
774 #define EVLOOP_ONESHOT EVRUN_ONCE
775 #define EVUNLOOP_CANCEL EVBREAK_CANCEL
776 #define EVUNLOOP_ONE EVBREAK_ONE
777 #define EVUNLOOP_ALL EVBREAK_ALL
778 #if EV_PROTOTYPES
779 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
780 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
781 #if EV_FEATURE_API
782 EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); }
783 EV_INLINE void ev_loop_depth (EV_P) { ev_depth (EV_A); }
784 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
785 #endif
760#endif 786 #endif
761 787#else
762#ifdef __cplusplus 788 typedef struct ev_loop ev_loop;
763}
764#endif 789#endif
765 790
766#endif 791#endif
767 792
793EV_CPP(})
794
795#endif
796

Diff Legend

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