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

Comparing libev/ev.h (file contents):
Revision 1.134 by root, Tue Mar 16 00:20:17 2010 UTC vs.
Revision 1.147 by root, Fri Oct 22 09:24:11 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
53/* pre-4.0 compatibility */
54#ifndef EV_COMPAT3
55# define EV_COMPAT3 1
56#endif
57
49#ifndef EV_FEATURES 58#ifndef EV_FEATURES
50# define EV_FEATURES 0x3f 59# define EV_FEATURES 0x7f
51#endif 60#endif
52 61
53#define EV_FEATURE_CODE ((EV_FEATURES) & 1) 62#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
54#define EV_FEATURE_DATA ((EV_FEATURES) & 2) 63#define EV_FEATURE_DATA ((EV_FEATURES) & 2)
64#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4)
55#define EV_FEATURE_API ((EV_FEATURES) & 4) 65#define EV_FEATURE_API ((EV_FEATURES) & 8)
56#define EV_FEATURE_WATCHERS ((EV_FEATURES) & 8) 66#define EV_FEATURE_WATCHERS ((EV_FEATURES) & 16)
57#define EV_FEATURE_BACKENDS ((EV_FEATURES) & 16) 67#define EV_FEATURE_BACKENDS ((EV_FEATURES) & 32)
58#define EV_FEATURE_OS ((EV_FEATURES) & 32) 68#define EV_FEATURE_OS ((EV_FEATURES) & 64)
59 69
60/* these priorities are inclusive, higher priorities will be called earlier */ 70/* these priorities are inclusive, higher priorities will be invoked earlier */
61#ifndef EV_MINPRI 71#ifndef EV_MINPRI
62# define EV_MINPRI (EV_FEATURE_API ? -2 : 0) 72# define EV_MINPRI (EV_FEATURE_CONFIG ? -2 : 0)
63#endif 73#endif
64#ifndef EV_MAXPRI 74#ifndef EV_MAXPRI
65# define EV_MAXPRI (EV_FEATURE_API ? +2 : 0) 75# define EV_MAXPRI (EV_FEATURE_CONFIG ? +2 : 0)
66#endif 76#endif
67 77
68#ifndef EV_MULTIPLICITY 78#ifndef EV_MULTIPLICITY
69# define EV_MULTIPLICITY EV_FEATURE_API 79# define EV_MULTIPLICITY EV_FEATURE_CONFIG
70#endif 80#endif
71 81
72#ifndef EV_PERIODIC_ENABLE 82#ifndef EV_PERIODIC_ENABLE
73# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS 83# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
74#endif 84#endif
… …
123# undef EV_SIGNAL_ENABLE 133# undef EV_SIGNAL_ENABLE
124# define EV_SIGNAL_ENABLE 1 134# define EV_SIGNAL_ENABLE 1
125#endif 135#endif
126 136
127/*****************************************************************************/ 137/*****************************************************************************/
128
129#if !EV_FEATURE_CODE && !defined (NDEBUG)
130# define NDEBUG 1
131# include <assert.h>
132#endif
133 138
134typedef double ev_tstamp; 139typedef double ev_tstamp;
135 140
136#ifndef EV_ATOMIC_T 141#ifndef EV_ATOMIC_T
137# include <signal.h> 142# include <signal.h>
… …
147#endif 152#endif
148 153
149/* support multiple event loops? */ 154/* support multiple event loops? */
150#if EV_MULTIPLICITY 155#if EV_MULTIPLICITY
151struct ev_loop; 156struct ev_loop;
152# define EV_P struct ev_loop *loop 157# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
153# define EV_P_ EV_P, 158# define EV_P_ EV_P, /* a loop as first of multiple parameters */
154# define EV_A loop 159# define EV_A loop /* a loop as sole argument to a function call */
155# define EV_A_ EV_A, 160# define EV_A_ EV_A, /* a loop as first of multiple arguments */
156# 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 */
157# define EV_DEFAULT_UC_ EV_DEFAULT_UC, 162# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
158# define EV_DEFAULT ev_default_loop (0) 163# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
159# define EV_DEFAULT_ EV_DEFAULT, 164# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
160#else 165#else
161# define EV_P void 166# define EV_P void
162# define EV_P_ 167# define EV_P_
163# define EV_A 168# define EV_A
164# define EV_A_ 169# define EV_A_
… …
167# define EV_DEFAULT_UC 172# define EV_DEFAULT_UC
168# define EV_DEFAULT_UC_ 173# define EV_DEFAULT_UC_
169# undef EV_EMBED_ENABLE 174# undef EV_EMBED_ENABLE
170#endif 175#endif
171 176
177/* EV_INLINE is used for functions in header files */
172#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 178#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
173# define EV_INLINE static inline 179# define EV_INLINE static inline
174#else 180#else
175# define EV_INLINE static 181# define EV_INLINE static
176#endif 182#endif
177 183
184/* EV_PROTOTYPES can be sued to switch of prototype declarations */
185#ifndef EV_PROTOTYPES
186# define EV_PROTOTYPES 1
187#endif
188
178/*****************************************************************************/ 189/*****************************************************************************/
179 190
191#define EV_VERSION_MAJOR 4
192#define EV_VERSION_MINOR 0
193
180/* eventmask, revents, events... */ 194/* eventmask, revents, events... */
195enum {
181#define EV_UNDEF -1 /* guaranteed to be invalid */ 196 EV_UNDEF = -1, /* guaranteed to be invalid */
182#define EV_NONE 0x00 /* no events */ 197 EV_NONE = 0x00, /* no events */
183#define EV_READ 0x01 /* ev_io detected read will not block */ 198 EV_READ = 0x01, /* ev_io detected read will not block */
184#define EV_WRITE 0x02 /* ev_io detected write will not block */ 199 EV_WRITE = 0x02, /* ev_io detected write will not block */
185#define EV__IOFDSET 0x80 /* internal use only */ 200 EV__IOFDSET = 0x80, /* internal use only */
186#define EV_IO EV_READ /* alias for type-detection */ 201 EV_IO = EV_READ, /* alias for type-detection */
187#define EV_TIMEOUT 0x00000100 /* timer timed out */ 202 EV_TIMER = 0x00000100, /* timer timed out */
188#define EV_TIMER EV_TIMEOUT /* alias for type-detection */ 203#if EV_COMPAT3
204 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
205#endif
189#define EV_PERIODIC 0x00000200 /* periodic timer timed out */ 206 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
190#define EV_SIGNAL 0x00000400 /* signal was received */ 207 EV_SIGNAL = 0x00000400, /* signal was received */
191#define EV_CHILD 0x00000800 /* child/pid had status change */ 208 EV_CHILD = 0x00000800, /* child/pid had status change */
192#define EV_STAT 0x00001000 /* stat data changed */ 209 EV_STAT = 0x00001000, /* stat data changed */
193#define EV_IDLE 0x00002000 /* event loop is idling */ 210 EV_IDLE = 0x00002000, /* event loop is idling */
194#define EV_PREPARE 0x00004000 /* event loop about to poll */ 211 EV_PREPARE = 0x00004000, /* event loop about to poll */
195#define EV_CHECK 0x00008000 /* event loop finished poll */ 212 EV_CHECK = 0x00008000, /* event loop finished poll */
196#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ 213 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
197#define EV_FORK 0x00020000 /* event loop resumed in child */ 214 EV_FORK = 0x00020000, /* event loop resumed in child */
198#define EV_ASYNC 0x00040000 /* async intra-loop signal */ 215 EV_ASYNC = 0x00040000, /* async intra-loop signal */
199#define EV_CUSTOM 0x01000000 /* for use by user code */ 216 EV_CUSTOM = 0x01000000, /* for use by user code */
200#define EV_ERROR 0x80000000 /* sent when an error occurs */ 217 EV_ERROR = 0x80000000 /* sent when an error occurs */
218};
201 219
202/* 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 */
203#ifndef EV_COMMON 221#ifndef EV_COMMON
204# define EV_COMMON void *data; 222# define EV_COMMON void *data;
205#endif 223#endif
206#ifndef EV_PROTOTYPES
207# define EV_PROTOTYPES 1
208#endif
209
210#define EV_VERSION_MAJOR 3
211#define EV_VERSION_MINOR 9
212 224
213#ifndef EV_CB_DECLARE 225#ifndef EV_CB_DECLARE
214# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 226# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
215#endif 227#endif
216#ifndef EV_CB_INVOKE 228#ifndef EV_CB_INVOKE
217# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) 229# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
218#endif 230#endif
231
232/* not official, do not use */
233#define EV_CB(type,name) void name (EV_P_ struct ev_ ## type *w, int revents)
219 234
220/* 235/*
221 * struct member types: 236 * struct member types:
222 * private: you may look at them, but not change them, 237 * private: you may look at them, but not change them,
223 * and they might not mean anything to you. 238 * and they might not mean anything to you.
… …
234 * or the array index + 1 in the pendings array. 249 * or the array index + 1 in the pendings array.
235 */ 250 */
236 251
237#if EV_MINPRI == EV_MAXPRI 252#if EV_MINPRI == EV_MAXPRI
238# define EV_DECL_PRIORITY 253# define EV_DECL_PRIORITY
239#else 254#elif !defined (EV_DECL_PRIORITY)
240# define EV_DECL_PRIORITY int priority; 255# define EV_DECL_PRIORITY int priority;
241#endif 256#endif
242 257
243/* shared by all watchers */ 258/* shared by all watchers */
244#define EV_WATCHER(type) \ 259#define EV_WATCHER(type) \
… …
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
… …
497} 519}
498 520
499/* the default loop is the only one that handles signals and child watchers */ 521/* the default loop is the only one that handles signals and child watchers */
500/* you can call this as often as you like */ 522/* you can call this as often as you like */
501EV_INLINE struct ev_loop * 523EV_INLINE struct ev_loop *
502ev_default_loop (unsigned int flags) 524ev_default_loop (unsigned int flags EV_CPP (= 0))
503{ 525{
504 struct ev_loop *loop = ev_default_loop_uc (); 526 struct ev_loop *loop = ev_default_loop_uc ();
505 527
506 if (!loop) 528 if (!loop)
507 { 529 {
… …
512 534
513 return loop; 535 return loop;
514} 536}
515 537
516/* create and destroy alternative loops that don't handle signals */ 538/* create and destroy alternative loops that don't handle signals */
517struct ev_loop *ev_loop_new (unsigned int flags); 539struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
518void ev_loop_destroy (EV_P); 540void ev_loop_destroy (EV_P);
519void ev_loop_fork (EV_P); 541void ev_loop_fork (EV_P);
520 542
521ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 543ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
522 544
523#else 545#else
524 546
525int ev_default_loop (unsigned int flags); /* returns true when successful */ 547int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */
526 548
527EV_INLINE ev_tstamp 549EV_INLINE ev_tstamp
528ev_now (void) 550ev_now (void)
529{ 551{
530 extern ev_tstamp ev_rt_now; 552 extern ev_tstamp ev_rt_now;
… …
563void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 585void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
564#endif 586#endif
565 587
566#endif /* prototypes */ 588#endif /* prototypes */
567 589
568#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 590/* ev_run flags values */
569#define EVLOOP_ONESHOT 2 /* block *once* only */ 591enum {
570#define EVUNLOOP_CANCEL 0 /* undo unloop */ 592 EVRUN_NOWAIT = 1, /* do not block/wait */
571#define EVUNLOOP_ONE 1 /* unloop once */ 593 EVRUN_ONCE = 2 /* block *once* only */
594};
595
596/* ev_break how values */
597enum {
598 EVBREAK_CANCEL = 0, /* undo unloop */
599 EVBREAK_ONE = 1, /* unloop once */
572#define EVUNLOOP_ALL 2 /* unloop all loops */ 600 EVBREAK_ALL = 2 /* unloop all loops */
601};
573 602
574#if EV_PROTOTYPES 603#if EV_PROTOTYPES
575void ev_loop (EV_P_ int flags); 604void 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 */ 605void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */
577 606
578/* 607/*
579 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 608 * 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 609 * 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. 610 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
… …
588 * if timeout is < 0, do wait indefinitely 617 * if timeout is < 0, do wait indefinitely
589 */ 618 */
590void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 619void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
591 620
592# if EV_FEATURE_API 621# if EV_FEATURE_API
593unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 622unsigned int ev_iteration (EV_P); /* number of loop iterations */
594unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ 623unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
595void ev_loop_verify (EV_P); /* abort if loop data corrupted */ 624void ev_verify (EV_P); /* abort if loop data corrupted */
596 625
597void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 626void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
598void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 627void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
599 628
600/* advanced stuff for threading etc. support, see docs */ 629/* advanced stuff for threading etc. support, see docs */
… …
633#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 662#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
634#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 663#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
635#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 664#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
636#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 665#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
637#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 666#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
638#define ev_async_set(ev) do { (ev)->sent = 0; } while (0) 667#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
639 668
640#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 669#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
641#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 670#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
642#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } 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)
643#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 672#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
… …
748void ev_async_start (EV_P_ ev_async *w); 777void ev_async_start (EV_P_ ev_async *w);
749void ev_async_stop (EV_P_ ev_async *w); 778void ev_async_stop (EV_P_ ev_async *w);
750void ev_async_send (EV_P_ ev_async *w); 779void ev_async_send (EV_P_ ev_async *w);
751# endif 780# endif
752 781
782#if EV_COMPAT3
783 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
784 #define EVLOOP_ONESHOT EVRUN_ONCE
785 #define EVUNLOOP_CANCEL EVBREAK_CANCEL
786 #define EVUNLOOP_ONE EVBREAK_ONE
787 #define EVUNLOOP_ALL EVBREAK_ALL
788 #if EV_PROTOTYPES
789 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 ); }
791 #if EV_FEATURE_API
792 EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); }
793 EV_INLINE void ev_loop_depth (EV_P) { ev_depth (EV_A); }
794 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
795 #endif
753#endif 796 #endif
754 797#else
755#ifdef __cplusplus 798 typedef struct ev_loop ev_loop;
756}
757#endif 799#endif
758 800
759#endif 801#endif
760 802
803EV_CPP(})
804
805#endif
806

Diff Legend

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