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

Comparing libev/ev.h (file contents):
Revision 1.139 by root, Tue Mar 16 20:49:47 2010 UTC vs.
Revision 1.145 by root, Fri Oct 22 06:09:26 2010 UTC

… …
44extern "C" { 44extern "C" {
45#endif 45#endif
46 46
47/*****************************************************************************/ 47/*****************************************************************************/
48 48
49/* pre-4.0 compatibility */
50#ifndef EV_COMPAT3
51# define EV_COMPAT3 1
52#endif
53
49#ifndef EV_FEATURES 54#ifndef EV_FEATURES
50# define EV_FEATURES 0x7f 55# define EV_FEATURES 0x7f
51#endif 56#endif
52 57
53#define EV_FEATURE_CODE ((EV_FEATURES) & 1) 58#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
… …
140# include <sys/types.h> 145# include <sys/types.h>
141# endif 146# endif
142# include <sys/stat.h> 147# include <sys/stat.h>
143#endif 148#endif
144 149
150#ifdef __cplusplus
151# define EV_DEFARG(x) = x
152#else
153# define EV_DEFARG(x)
154#endif
155
145/* support multiple event loops? */ 156/* support multiple event loops? */
146#if EV_MULTIPLICITY 157#if EV_MULTIPLICITY
147struct ev_loop; 158struct ev_loop;
148# define EV_P struct ev_loop *loop 159# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
149# define EV_P_ EV_P, 160# define EV_P_ EV_P, /* a loop as first of multiple parameters */
150# define EV_A loop 161# define EV_A loop /* a loop as sole argument to a function call */
151# define EV_A_ EV_A, 162# define EV_A_ EV_A, /* a loop as first of multiple arguments */
152# define EV_DEFAULT_UC ev_default_loop_uc () 163# define EV_DEFAULT_UC ev_default_loop_uc () /* the default loop, if initialised, as sole arg */
153# define EV_DEFAULT_UC_ EV_DEFAULT_UC, 164# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
154# define EV_DEFAULT ev_default_loop (0) 165# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
155# define EV_DEFAULT_ EV_DEFAULT, 166# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
167# define EV_PDEF EV_P EV_DEFARG (EV_DEFAULT_UC) /* EV_P, but with default argument in C++ */
156#else 168#else
157# define EV_P void 169# define EV_P void
158# define EV_P_ 170# define EV_P_
159# define EV_A 171# define EV_A
160# define EV_A_ 172# define EV_A_
161# define EV_DEFAULT 173# define EV_DEFAULT
162# define EV_DEFAULT_ 174# define EV_DEFAULT_
163# define EV_DEFAULT_UC 175# define EV_DEFAULT_UC
164# define EV_DEFAULT_UC_ 176# define EV_DEFAULT_UC_
177# define EV_PDEF EV_P
165# undef EV_EMBED_ENABLE 178# undef EV_EMBED_ENABLE
166#endif 179#endif
167 180
168#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 181#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
169# define EV_INLINE static inline 182# define EV_INLINE static inline
… …
179 192
180#define EV_VERSION_MAJOR 4 193#define EV_VERSION_MAJOR 4
181#define EV_VERSION_MINOR 0 194#define EV_VERSION_MINOR 0
182 195
183/* eventmask, revents, events... */ 196/* eventmask, revents, events... */
197enum {
184#define EV_UNDEF -1 /* guaranteed to be invalid */ 198 EV_UNDEF = -1, /* guaranteed to be invalid */
185#define EV_NONE 0x00 /* no events */ 199 EV_NONE = 0x00, /* no events */
186#define EV_READ 0x01 /* ev_io detected read will not block */ 200 EV_READ = 0x01, /* ev_io detected read will not block */
187#define EV_WRITE 0x02 /* ev_io detected write will not block */ 201 EV_WRITE = 0x02, /* ev_io detected write will not block */
188#define EV__IOFDSET 0x80 /* internal use only */ 202 EV__IOFDSET = 0x80, /* internal use only */
189#define EV_IO EV_READ /* alias for type-detection */ 203 EV_IO = EV_READ, /* alias for type-detection */
190#define EV_TIMER 0x00000100 /* timer timed out */ 204 EV_TIMER = 0x00000100, /* timer timed out */
205#if EV_COMPAT3
191#define EV_TIMEOUT EV_TIMER /* pre 4.0 API compatibility */ 206 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
207#endif
192#define EV_PERIODIC 0x00000200 /* periodic timer timed out */ 208 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
193#define EV_SIGNAL 0x00000400 /* signal was received */ 209 EV_SIGNAL = 0x00000400, /* signal was received */
194#define EV_CHILD 0x00000800 /* child/pid had status change */ 210 EV_CHILD = 0x00000800, /* child/pid had status change */
195#define EV_STAT 0x00001000 /* stat data changed */ 211 EV_STAT = 0x00001000, /* stat data changed */
196#define EV_IDLE 0x00002000 /* event loop is idling */ 212 EV_IDLE = 0x00002000, /* event loop is idling */
197#define EV_PREPARE 0x00004000 /* event loop about to poll */ 213 EV_PREPARE = 0x00004000, /* event loop about to poll */
198#define EV_CHECK 0x00008000 /* event loop finished poll */ 214 EV_CHECK = 0x00008000, /* event loop finished poll */
199#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ 215 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
200#define EV_FORK 0x00020000 /* event loop resumed in child */ 216 EV_FORK = 0x00020000, /* event loop resumed in child */
201#define EV_ASYNC 0x00040000 /* async intra-loop signal */ 217 EV_ASYNC = 0x00040000, /* async intra-loop signal */
202#define EV_CUSTOM 0x01000000 /* for use by user code */ 218 EV_CUSTOM = 0x01000000, /* for use by user code */
203#define EV_ERROR 0x80000000 /* sent when an error occurs */ 219 EV_ERROR = 0x80000000 /* sent when an error occurs */
220};
204 221
205/* can be used to add custom fields to all watchers, while losing binary compatibility */ 222/* can be used to add custom fields to all watchers, while losing binary compatibility */
206#ifndef EV_COMMON 223#ifndef EV_COMMON
207# define EV_COMMON void *data; 224# define EV_COMMON void *data;
208#endif 225#endif
… …
441#if EV_ASYNC_ENABLE 458#if EV_ASYNC_ENABLE
442 struct ev_async async; 459 struct ev_async async;
443#endif 460#endif
444}; 461};
445 462
446/* bits for ev_default_loop and ev_loop_new */ 463/* flag bits for ev_default_loop and ev_loop_new */
464enum {
447/* the default */ 465 /* the default */
448#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 466 EVFLAG_AUTO = 0x00000000U, /* not quite a mask */
449/* flag bits */ 467 /* flag bits */
450#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 468 EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */
451#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ 469 EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */
452/* debugging/feature disable */ 470 /* debugging/feature disable */
453#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */ 471 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
472#if EV_COMPAT3
454#define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */ 473 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
474#endif
455#define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */ 475 EVFLAG_SIGNALFD = 0x00200000U /* attempt to use signalfd */
476};
477
456/* method bits to be ored together */ 478/* method bits to be ored together */
479enum {
457#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 480 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
458#define EVBACKEND_POLL 0x00000002U /* !win */ 481 EVBACKEND_POLL = 0x00000002U, /* !win */
459#define EVBACKEND_EPOLL 0x00000004U /* linux */ 482 EVBACKEND_EPOLL = 0x00000004U, /* linux */
460#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 483 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
461#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 484 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
462#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 485 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
463#define EVBACKEND_ALL 0x0000003FU 486 EVBACKEND_ALL = 0x0000003FU
487};
464 488
465#if EV_PROTOTYPES 489#if EV_PROTOTYPES
466int ev_version_major (void); 490int ev_version_major (void);
467int ev_version_minor (void); 491int ev_version_minor (void);
468 492
… …
497} 521}
498 522
499/* the default loop is the only one that handles signals and child watchers */ 523/* the default loop is the only one that handles signals and child watchers */
500/* you can call this as often as you like */ 524/* you can call this as often as you like */
501EV_INLINE struct ev_loop * 525EV_INLINE struct ev_loop *
502ev_default_loop (unsigned int flags) 526ev_default_loop (unsigned int flags EV_DEFARG (0))
503{ 527{
504 struct ev_loop *loop = ev_default_loop_uc (); 528 struct ev_loop *loop = ev_default_loop_uc ();
505 529
506 if (!loop) 530 if (!loop)
507 { 531 {
… …
512 536
513 return loop; 537 return loop;
514} 538}
515 539
516/* create and destroy alternative loops that don't handle signals */ 540/* create and destroy alternative loops that don't handle signals */
517struct ev_loop *ev_loop_new (unsigned int flags); 541struct ev_loop *ev_loop_new (unsigned int flags EV_DEFARG (0));
518void ev_loop_destroy (EV_P); 542void ev_loop_destroy (EV_PDEF);
519void ev_loop_fork (EV_P); 543void ev_loop_fork (EV_PDEF);
520 544
521ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 545ev_tstamp ev_now (EV_PDEF); /* time w.r.t. timers and the eventloop, updated after each poll */
522 546
523#else 547#else
524 548
525int ev_default_loop (unsigned int flags); /* returns true when successful */ 549int ev_default_loop (unsigned int flags EV_DEFARG (0)); /* returns true when successful */
526 550
527EV_INLINE ev_tstamp 551EV_INLINE ev_tstamp
528ev_now (void) 552ev_now (void)
529{ 553{
530 extern ev_tstamp ev_rt_now; 554 extern ev_tstamp ev_rt_now;
… …
532 return ev_rt_now; 556 return ev_rt_now;
533} 557}
534#endif /* multiplicity */ 558#endif /* multiplicity */
535 559
536EV_INLINE int 560EV_INLINE int
537ev_is_default_loop (EV_P) 561ev_is_default_loop (EV_PDEF)
538{ 562{
539#if EV_MULTIPLICITY 563#if EV_MULTIPLICITY
540 extern struct ev_loop *ev_default_loop_ptr; 564 extern struct ev_loop *ev_default_loop_ptr;
541 565
542 return !!(EV_A == ev_default_loop_ptr); 566 return !!(EV_A == ev_default_loop_ptr);
… …
550/* if you create alternative loops you have to call ev_loop_fork on them */ 574/* 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 */ 575/* you can call it in either the parent or the child */
552/* you can actually call it at any time, anywhere :) */ 576/* you can actually call it at any time, anywhere :) */
553void ev_default_fork (void); 577void ev_default_fork (void);
554 578
555unsigned int ev_backend (EV_P); /* backend in use by loop */ 579unsigned int ev_backend (EV_PDEF); /* backend in use by loop */
556 580
557void ev_now_update (EV_P); /* update event loop time */ 581void ev_now_update (EV_PDEF); /* update event loop time */
558 582
559#if EV_WALK_ENABLE 583#if EV_WALK_ENABLE
560/* walk (almost) all watchers in the loop of a given type, invoking the */ 584/* walk (almost) all watchers in the loop of a given type, invoking the */
561/* callback on every such watcher. The callback might stop the watcher, */ 585/* callback on every such watcher. The callback might stop the watcher, */
562/* but do nothing else with the loop */ 586/* but do nothing else with the loop */
563void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 587void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
564#endif 588#endif
565 589
566#endif /* prototypes */ 590#endif /* prototypes */
567 591
568#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 592/* ev_run flags values */
569#define EVLOOP_ONESHOT 2 /* block *once* only */ 593enum {
570#define EVUNLOOP_CANCEL 0 /* undo unloop */ 594 EVRUN_NOWAIT = 1, /* do not block/wait */
571#define EVUNLOOP_ONE 1 /* unloop once */ 595 EVRUN_ONCE = 2 /* block *once* only */
596};
597
598/* ev_break how values */
599enum {
600 EVBREAK_CANCEL = 0, /* undo unloop */
601 EVBREAK_ONE = 1, /* unloop once */
572#define EVUNLOOP_ALL 2 /* unloop all loops */ 602 EVBREAK_ALL = 2 /* unloop all loops */
603};
573 604
574#if EV_PROTOTYPES 605#if EV_PROTOTYPES
575void ev_loop (EV_P_ int flags); 606void ev_run (EV_P_ int flags EV_DEFARG (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 */ 607void ev_break (EV_P_ int how EV_DEFARG (EVBREAK_ONE)); /* break out of the loop */
577 608
578/* 609/*
579 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 610 * 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 611 * 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. 612 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
582 */ 613 */
583void ev_ref (EV_P); 614void ev_ref (EV_PDEF);
584void ev_unref (EV_P); 615void ev_unref (EV_PDEF);
585 616
586/* 617/*
587 * convenience function, wait for a single event, without registering an event watcher 618 * convenience function, wait for a single event, without registering an event watcher
588 * if timeout is < 0, do wait indefinitely 619 * if timeout is < 0, do wait indefinitely
589 */ 620 */
590void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 621void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
591 622
592# if EV_FEATURE_API 623# if EV_FEATURE_API
593unsigned int ev_iteration (EV_P); /* number of loop iterations */ 624unsigned int ev_iteration (EV_PDEF); /* number of loop iterations */
594unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ 625unsigned int ev_depth (EV_PDEF); /* #ev_loop enters - #ev_loop leaves */
595void ev_verify (EV_P); /* abort if loop data corrupted */ 626void ev_verify (EV_PDEF); /* 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 627
604void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 628void 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 */ 629void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
606 630
607/* advanced stuff for threading etc. support, see docs */ 631/* advanced stuff for threading etc. support, see docs */
608void ev_set_userdata (EV_P_ void *data); 632void ev_set_userdata (EV_P_ void *data);
609void *ev_userdata (EV_P); 633void *ev_userdata (EV_PDEF);
610void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P)); 634void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
611void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P)); 635void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
612 636
613unsigned int ev_pending_count (EV_P); /* number of pending events, if any */ 637unsigned int ev_pending_count (EV_PDEF); /* number of pending events, if any */
614void ev_invoke_pending (EV_P); /* invoke all pending watchers */ 638void ev_invoke_pending (EV_PDEF); /* invoke all pending watchers */
615 639
616/* 640/*
617 * stop/start the timer handling. 641 * stop/start the timer handling.
618 */ 642 */
619void ev_suspend (EV_P); 643void ev_suspend (EV_PDEF);
620void ev_resume (EV_P); 644void ev_resume (EV_PDEF);
621#endif 645#endif
622 646
623#endif 647#endif
624 648
625/* these may evaluate ev multiple times, and the other arguments at most once */ 649/* these may evaluate ev multiple times, and the other arguments at most once */
… …
640#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 664#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
641#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 665#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
642#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 666#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
643#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 667#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
644#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 668#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
645#define ev_async_set(ev) do { (ev)->sent = 0; } while (0) 669#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
646 670
647#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 671#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
648#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 672#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
649#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0) 673#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
650#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 674#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
… …
755void ev_async_start (EV_P_ ev_async *w); 779void ev_async_start (EV_P_ ev_async *w);
756void ev_async_stop (EV_P_ ev_async *w); 780void ev_async_stop (EV_P_ ev_async *w);
757void ev_async_send (EV_P_ ev_async *w); 781void ev_async_send (EV_P_ ev_async *w);
758# endif 782# endif
759 783
784#if EV_COMPAT3
785 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
786 #define EVLOOP_ONESHOT EVRUN_ONCE
787 #define EVUNLOOP_CANCEL EVBREAK_CANCEL
788 #define EVUNLOOP_ONE EVBREAK_ONE
789 #define EVUNLOOP_ALL EVBREAK_ALL
790 #if EV_PROTOTYPES
791 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
792 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
793 #if EV_FEATURE_API
794 EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); }
795 EV_INLINE void ev_loop_depth (EV_P) { ev_depth (EV_A); }
796 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
797 #endif
798 #endif
799#else
800 typedef struct ev_loop ev_loop;
801#endif
802
760#endif 803#endif
761 804
762#ifdef __cplusplus 805#ifdef __cplusplus
763} 806}
764#endif 807#endif

Diff Legend

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