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

Comparing libev/ev.h (file contents):
Revision 1.116 by root, Wed Jul 8 02:46:05 2009 UTC vs.
Revision 1.148 by root, Sun Oct 24 14:44:40 2010 UTC

1/* 1/*
2 * libev native API header 2 * libev native API header
3 * 3 *
4 * Copyright (c) 2007,2008,2009 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008,2009,2010 Marc Alexander Lehmann <libev@schmorp.de>
5 * All rights reserved. 5 * All rights reserved.
6 * 6 *
7 * Redistribution and use in source and binary forms, with or without modifica- 7 * Redistribution and use in source and binary forms, with or without modifica-
8 * tion, are permitted provided that the following conditions are met: 8 * tion, are permitted provided that the following conditions are met:
9 * 9 *
… …
35 * and other provisions required by the GPL. If you do not delete the 35 * and other provisions required by the GPL. If you do not delete the
36 * provisions above, a recipient may use your version of this file under 36 * provisions above, a recipient may use your version of this file under
37 * either the BSD or the GPL. 37 * either the BSD or the GPL.
38 */ 38 */
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
47typedef double ev_tstamp; 51/*****************************************************************************/
48 52
53/* pre-4.0 compatibility */
54#ifndef EV_COMPAT3
55# define EV_COMPAT3 1
56#endif
57
58#ifndef EV_FEATURES
59# define EV_FEATURES 0x7f
60#endif
61
62#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
63#define EV_FEATURE_DATA ((EV_FEATURES) & 2)
64#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4)
65#define EV_FEATURE_API ((EV_FEATURES) & 8)
66#define EV_FEATURE_WATCHERS ((EV_FEATURES) & 16)
67#define EV_FEATURE_BACKENDS ((EV_FEATURES) & 32)
68#define EV_FEATURE_OS ((EV_FEATURES) & 64)
69
49/* these priorities are inclusive, higher priorities will be called earlier */ 70/* these priorities are inclusive, higher priorities will be invoked earlier */
50#ifndef EV_MINPRI 71#ifndef EV_MINPRI
51# define EV_MINPRI -2 72# define EV_MINPRI (EV_FEATURE_CONFIG ? -2 : 0)
52#endif 73#endif
53#ifndef EV_MAXPRI 74#ifndef EV_MAXPRI
54# define EV_MAXPRI +2 75# define EV_MAXPRI (EV_FEATURE_CONFIG ? +2 : 0)
55#endif 76#endif
56 77
57#ifndef EV_MULTIPLICITY 78#ifndef EV_MULTIPLICITY
58# define EV_MULTIPLICITY 1 79# define EV_MULTIPLICITY EV_FEATURE_CONFIG
59#endif 80#endif
60 81
61#ifndef EV_PERIODIC_ENABLE 82#ifndef EV_PERIODIC_ENABLE
62# define EV_PERIODIC_ENABLE 1 83# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
63#endif 84#endif
64 85
65#ifndef EV_STAT_ENABLE 86#ifndef EV_STAT_ENABLE
66# define EV_STAT_ENABLE 1 87# define EV_STAT_ENABLE EV_FEATURE_WATCHERS
88#endif
89
90#ifndef EV_PREPARE_ENABLE
91# define EV_PREPARE_ENABLE EV_FEATURE_WATCHERS
92#endif
93
94#ifndef EV_CHECK_ENABLE
95# define EV_CHECK_ENABLE EV_FEATURE_WATCHERS
67#endif 96#endif
68 97
69#ifndef EV_IDLE_ENABLE 98#ifndef EV_IDLE_ENABLE
70# define EV_IDLE_ENABLE 1 99# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
71#endif 100#endif
72 101
73#ifndef EV_FORK_ENABLE 102#ifndef EV_FORK_ENABLE
103# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
104#endif
105
106#ifndef EV_SIGNAL_ENABLE
107# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
108#endif
109
110#ifndef EV_CHILD_ENABLE
111# ifdef _WIN32
74# define EV_FORK_ENABLE 1 112# define EV_CHILD_ENABLE 0
113# else
114# define EV_CHILD_ENABLE EV_FEATURE_WATCHERS
115#endif
116#endif
117
118#ifndef EV_ASYNC_ENABLE
119# define EV_ASYNC_ENABLE EV_FEATURE_WATCHERS
75#endif 120#endif
76 121
77#ifndef EV_EMBED_ENABLE 122#ifndef EV_EMBED_ENABLE
78# define EV_EMBED_ENABLE 1 123# define EV_EMBED_ENABLE EV_FEATURE_WATCHERS
79#endif
80
81#ifndef EV_ASYNC_ENABLE
82# define EV_ASYNC_ENABLE 1
83#endif 124#endif
84 125
85#ifndef EV_WALK_ENABLE 126#ifndef EV_WALK_ENABLE
86# define EV_WALK_ENABLE 0 /* not yet */ 127# define EV_WALK_ENABLE 0 /* not yet */
87#endif 128#endif
129
130/*****************************************************************************/
131
132#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
133# undef EV_SIGNAL_ENABLE
134# define EV_SIGNAL_ENABLE 1
135#endif
136
137/*****************************************************************************/
138
139typedef double ev_tstamp;
88 140
89#ifndef EV_ATOMIC_T 141#ifndef EV_ATOMIC_T
90# include <signal.h> 142# include <signal.h>
91# define EV_ATOMIC_T sig_atomic_t volatile 143# define EV_ATOMIC_T sig_atomic_t volatile
92#endif 144#endif
93
94/*****************************************************************************/
95 145
96#if EV_STAT_ENABLE 146#if EV_STAT_ENABLE
97# ifdef _WIN32 147# ifdef _WIN32
98# include <time.h> 148# include <time.h>
99# include <sys/types.h> 149# include <sys/types.h>
… …
102#endif 152#endif
103 153
104/* support multiple event loops? */ 154/* support multiple event loops? */
105#if EV_MULTIPLICITY 155#if EV_MULTIPLICITY
106struct ev_loop; 156struct ev_loop;
107# define EV_P struct ev_loop *loop 157# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
108# define EV_P_ EV_P, 158# define EV_P_ EV_P, /* a loop as first of multiple parameters */
109# define EV_A loop 159# define EV_A loop /* a loop as sole argument to a function call */
110# define EV_A_ EV_A, 160# define EV_A_ EV_A, /* a loop as first of multiple arguments */
111# 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 */
112# define EV_DEFAULT_UC_ EV_DEFAULT_UC, 162# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
113# define EV_DEFAULT ev_default_loop (0) 163# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
114# define EV_DEFAULT_ EV_DEFAULT, 164# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
115#else 165#else
116# define EV_P void 166# define EV_P void
117# define EV_P_ 167# define EV_P_
118# define EV_A 168# define EV_A
119# define EV_A_ 169# define EV_A_
… …
122# define EV_DEFAULT_UC 172# define EV_DEFAULT_UC
123# define EV_DEFAULT_UC_ 173# define EV_DEFAULT_UC_
124# undef EV_EMBED_ENABLE 174# undef EV_EMBED_ENABLE
125#endif 175#endif
126 176
177/* EV_INLINE is used for functions in header files */
127#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 178#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
128# define EV_INLINE static inline 179# define EV_INLINE static inline
129#else 180#else
130# define EV_INLINE static 181# define EV_INLINE static
131#endif 182#endif
132 183
184/* EV_PROTOTYPES can be sued to switch of prototype declarations */
185#ifndef EV_PROTOTYPES
186# define EV_PROTOTYPES 1
187#endif
188
133/*****************************************************************************/ 189/*****************************************************************************/
134 190
191#define EV_VERSION_MAJOR 4
192#define EV_VERSION_MINOR 0
193
135/* eventmask, revents, events... */ 194/* eventmask, revents, events... */
195enum {
136#define EV_UNDEF -1 /* guaranteed to be invalid */ 196 EV_UNDEF = -1, /* guaranteed to be invalid */
137#define EV_NONE 0x00 /* no events */ 197 EV_NONE = 0x00, /* no events */
138#define EV_READ 0x01 /* ev_io detected read will not block */ 198 EV_READ = 0x01, /* ev_io detected read will not block */
139#define EV_WRITE 0x02 /* ev_io detected write will not block */ 199 EV_WRITE = 0x02, /* ev_io detected write will not block */
140#define EV__IOFDSET 0x80 /* internal use only */ 200 EV__IOFDSET = 0x80, /* internal use only */
141#define EV_IO EV_READ /* alias for type-detection */ 201 EV_IO = EV_READ, /* alias for type-detection */
142#define EV_TIMEOUT 0x00000100 /* timer timed out */ 202 EV_TIMER = 0x00000100, /* timer timed out */
143#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
144#define EV_PERIODIC 0x00000200 /* periodic timer timed out */ 206 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
145#define EV_SIGNAL 0x00000400 /* signal was received */ 207 EV_SIGNAL = 0x00000400, /* signal was received */
146#define EV_CHILD 0x00000800 /* child/pid had status change */ 208 EV_CHILD = 0x00000800, /* child/pid had status change */
147#define EV_STAT 0x00001000 /* stat data changed */ 209 EV_STAT = 0x00001000, /* stat data changed */
148#define EV_IDLE 0x00002000 /* event loop is idling */ 210 EV_IDLE = 0x00002000, /* event loop is idling */
149#define EV_PREPARE 0x00004000 /* event loop about to poll */ 211 EV_PREPARE = 0x00004000, /* event loop about to poll */
150#define EV_CHECK 0x00008000 /* event loop finished poll */ 212 EV_CHECK = 0x00008000, /* event loop finished poll */
151#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ 213 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
152#define EV_FORK 0x00020000 /* event loop resumed in child */ 214 EV_FORK = 0x00020000, /* event loop resumed in child */
153#define EV_ASYNC 0x00040000 /* async intra-loop signal */ 215 EV_ASYNC = 0x00040000, /* async intra-loop signal */
154#define EV_CUSTOM 0x01000000 /* for use by user code */ 216 EV_CUSTOM = 0x01000000, /* for use by user code */
155#define EV_ERROR 0x80000000 /* sent when an error occurs */ 217 EV_ERROR = 0x80000000 /* sent when an error occurs */
218};
156 219
157/* 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 */
158#ifndef EV_COMMON 221#ifndef EV_COMMON
159# define EV_COMMON void *data; 222# define EV_COMMON void *data;
160#endif 223#endif
161#ifndef EV_PROTOTYPES
162# define EV_PROTOTYPES 1
163#endif
164
165#define EV_VERSION_MAJOR 3
166#define EV_VERSION_MINOR 0
167 224
168#ifndef EV_CB_DECLARE 225#ifndef EV_CB_DECLARE
169# 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);
170#endif 227#endif
171#ifndef EV_CB_INVOKE 228#ifndef EV_CB_INVOKE
172# 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))
173#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)
174 234
175/* 235/*
176 * struct member types: 236 * struct member types:
177 * private: you may look at them, but not change them, 237 * private: you may look at them, but not change them,
178 * and they might not mean anything to you. 238 * and they might not mean anything to you.
… …
187 * or simply 1 for watchers that aren't in some array. 247 * or simply 1 for watchers that aren't in some array.
188 * pending is either 0, in which case the watcher isn't, 248 * pending is either 0, in which case the watcher isn't,
189 * or the array index + 1 in the pendings array. 249 * or the array index + 1 in the pendings array.
190 */ 250 */
191 251
252#if EV_MINPRI == EV_MAXPRI
253# define EV_DECL_PRIORITY
254#elif !defined (EV_DECL_PRIORITY)
255# define EV_DECL_PRIORITY int priority;
256#endif
257
192/* shared by all watchers */ 258/* shared by all watchers */
193#define EV_WATCHER(type) \ 259#define EV_WATCHER(type) \
194 int active; /* private */ \ 260 int active; /* private */ \
195 int pending; /* private */ \ 261 int pending; /* private */ \
196 int priority; /* private */ \ 262 EV_DECL_PRIORITY /* private */ \
197 EV_COMMON /* rw */ \ 263 EV_COMMON /* rw */ \
198 EV_CB_DECLARE (type) /* private */ 264 EV_CB_DECLARE (type) /* private */
199 265
200#define EV_WATCHER_LIST(type) \ 266#define EV_WATCHER_LIST(type) \
201 EV_WATCHER (type) \ 267 EV_WATCHER (type) \
… …
357 EV_WATCHER (ev_async) 423 EV_WATCHER (ev_async)
358 424
359 EV_ATOMIC_T sent; /* private */ 425 EV_ATOMIC_T sent; /* private */
360} ev_async; 426} ev_async;
361 427
362# define ev_async_pending(w) ((w)->sent + 0) 428# define ev_async_pending(w) (+(w)->sent)
363#endif 429#endif
364 430
365/* the presence of this union forces similar struct layout */ 431/* the presence of this union forces similar struct layout */
366union ev_any_watcher 432union ev_any_watcher
367{ 433{
… …
390#if EV_ASYNC_ENABLE 456#if EV_ASYNC_ENABLE
391 struct ev_async async; 457 struct ev_async async;
392#endif 458#endif
393}; 459};
394 460
395/* bits for ev_default_loop and ev_loop_new */ 461/* flag bits for ev_default_loop and ev_loop_new */
462enum {
396/* the default */ 463 /* the default */
397#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 464 EVFLAG_AUTO = 0x00000000U, /* not quite a mask */
398/* flag bits */ 465 /* flag bits */
399#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 466 EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */
400#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ 467 EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */
468 /* debugging/feature disable */
469 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
470#if EV_COMPAT3
471 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
472#endif
473 EVFLAG_SIGNALFD = 0x00200000U /* attempt to use signalfd */
474};
475
401/* method bits to be ored together */ 476/* method bits to be ored together */
477enum {
402#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 478 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
403#define EVBACKEND_POLL 0x00000002U /* !win */ 479 EVBACKEND_POLL = 0x00000002U, /* !win */
404#define EVBACKEND_EPOLL 0x00000004U /* linux */ 480 EVBACKEND_EPOLL = 0x00000004U, /* linux */
405#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 481 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
406#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 482 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
407#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 483 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
484 EVBACKEND_ALL = 0x0000003FU
485};
408 486
409#if EV_PROTOTYPES 487#if EV_PROTOTYPES
410int ev_version_major (void); 488int ev_version_major (void);
411int ev_version_minor (void); 489int ev_version_minor (void);
412 490
… …
430 * (such as failed select, poll, epoll_wait) 508 * (such as failed select, poll, epoll_wait)
431 */ 509 */
432void ev_set_syserr_cb (void (*cb)(const char *msg)); 510void ev_set_syserr_cb (void (*cb)(const char *msg));
433 511
434#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
435EV_INLINE struct ev_loop * 518EV_INLINE struct ev_loop *
436ev_default_loop_uc (void) 519ev_default_loop_uc (void)
437{ 520{
438 extern struct ev_loop *ev_default_loop_ptr; 521 extern struct ev_loop *ev_default_loop_ptr;
439 522
440 return ev_default_loop_ptr; 523 return ev_default_loop_ptr;
441} 524}
442 525
443/* the default loop is the only one that handles signals and child watchers */ 526EV_INLINE int
444/* you can call this as often as you like */ 527ev_is_default_loop (EV_P)
445EV_INLINE struct ev_loop *
446ev_default_loop (unsigned int flags)
447{ 528{
448 struct ev_loop *loop = ev_default_loop_uc (); 529 return EV_A == ev_default_loop_uc ();
449
450 if (!loop)
451 {
452 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
453
454 loop = ev_default_loop_init (flags);
455 }
456
457 return loop;
458} 530}
459 531
460/* create and destroy alternative loops that don't handle signals */ 532/* create and destroy alternative loops that don't handle signals */
461struct ev_loop *ev_loop_new (unsigned int flags); 533struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
462void ev_loop_destroy (EV_P); 534void ev_loop_destroy (EV_P);
463void ev_loop_fork (EV_P); 535void ev_loop_fork (EV_P);
464 536
465ev_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 */
466void ev_now_update (EV_P);
467 538
468#else 539#else
469 540
470int ev_default_loop (unsigned int flags); /* returns true when successful */ 541int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */
471 542
472EV_INLINE ev_tstamp 543EV_INLINE ev_tstamp
473ev_now (void) 544ev_now (void)
474{ 545{
475 extern ev_tstamp ev_rt_now; 546 extern ev_tstamp ev_rt_now;
476 547
477 return ev_rt_now; 548 return ev_rt_now;
478} 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
479#endif /* multiplicity */ 558#endif /* multiplicity */
480
481EV_INLINE int
482ev_is_default_loop (EV_P)
483{
484#if EV_MULTIPLICITY
485 extern struct ev_loop *ev_default_loop_ptr;
486
487 return !!(EV_A == ev_default_loop_ptr);
488#else
489 return 1;
490#endif
491}
492 559
493void ev_default_destroy (void); /* destroy the default loop */ 560void ev_default_destroy (void); /* destroy the default loop */
494/* 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 */
495/* 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 */
496/* you can call it in either the parent or the child */ 563/* you can call it in either the parent or the child */
497/* you can actually call it at any time, anywhere :) */ 564/* you can actually call it at any time, anywhere :) */
498void ev_default_fork (void); 565void ev_default_fork (void);
499 566
500unsigned int ev_backend (EV_P); /* backend in use by loop */ 567unsigned int ev_backend (EV_P); /* backend in use by loop */
501unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 568
502unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ 569void ev_now_update (EV_P); /* update event loop time */
503void ev_loop_verify (EV_P); /* abort if loop data corrupted */
504 570
505#if EV_WALK_ENABLE 571#if EV_WALK_ENABLE
506/* walk (almost) all watchers in the loop of a given type, invoking the */ 572/* walk (almost) all watchers in the loop of a given type, invoking the */
507/* callback on every such watcher. The callback might stop the watcher, */ 573/* callback on every such watcher. The callback might stop the watcher, */
508/* but do nothing else with the loop */ 574/* but do nothing else with the loop */
509void 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));
510#endif 576#endif
511 577
512#endif /* prototypes */ 578#endif /* prototypes */
513 579
514#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 580/* ev_run flags values */
515#define EVLOOP_ONESHOT 2 /* block *once* only */ 581enum {
516#define EVUNLOOP_CANCEL 0 /* undo unloop */ 582 EVRUN_NOWAIT = 1, /* do not block/wait */
517#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 */
518#define EVUNLOOP_ALL 2 /* unloop all loops */ 590 EVBREAK_ALL = 2 /* unloop all loops */
591};
519 592
520#if EV_PROTOTYPES 593#if EV_PROTOTYPES
521void ev_loop (EV_P_ int flags); 594void ev_run (EV_P_ int flags EV_CPP (= 0));
522void 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 */
523
524void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
525void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
526 596
527/* 597/*
528 * 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
529 * keeps one reference. if you have a long-runing watcher you never unregister that 599 * keeps one reference. if you have a long-running watcher you never unregister that
530 * 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.
531 */ 601 */
532void ev_ref (EV_P); 602void ev_ref (EV_P);
533void ev_unref (EV_P); 603void ev_unref (EV_P);
604
605/*
606 * convenience function, wait for a single event, without registering an event watcher
607 * if timeout is < 0, do wait indefinitely
608 */
609void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
610
611# if EV_FEATURE_API
612unsigned int ev_iteration (EV_P); /* number of loop iterations */
613unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
614void ev_verify (EV_P); /* abort if loop data corrupted */
615
616void ev_set_io_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 */
618
619/* advanced stuff for threading etc. support, see docs */
620void ev_set_userdata (EV_P_ void *data);
621void *ev_userdata (EV_P);
622void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
623void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
624
625unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
626void ev_invoke_pending (EV_P); /* invoke all pending watchers */
534 627
535/* 628/*
536 * stop/start the timer handling. 629 * stop/start the timer handling.
537 */ 630 */
538void ev_suspend (EV_P); 631void ev_suspend (EV_P);
539void ev_resume (EV_P); 632void ev_resume (EV_P);
633#endif
540 634
541/*
542 * convenience function, wait for a single event, without registering an event watcher
543 * if timeout is < 0, do wait indefinitely
544 */
545void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
546#endif 635#endif
547 636
548/* these may evaluate ev multiple times, and the other arguments at most once */ 637/* these may evaluate ev multiple times, and the other arguments at most once */
549/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 638/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
550#define ev_init(ev,cb_) do { \ 639#define ev_init(ev,cb_) do { \
551 ((ev_watcher *)(void *)(ev))->active = \ 640 ((ev_watcher *)(void *)(ev))->active = \
552 ((ev_watcher *)(void *)(ev))->pending = \ 641 ((ev_watcher *)(void *)(ev))->pending = 0; \
553 ((ev_watcher *)(void *)(ev))->priority = 0; \ 642 ev_set_priority ((ev), 0); \
554 ev_set_cb ((ev), cb_); \ 643 ev_set_cb ((ev), cb_); \
555} while (0) 644} while (0)
556 645
557#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0) 646#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
558#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0) 647#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
… …
563#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 652#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
564#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 653#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
565#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 654#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
566#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 655#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
567#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 656#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
568#define ev_async_set(ev) do { (ev)->sent = 0; } while (0) 657#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
569 658
570#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 659#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
571#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 660#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
572#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0) 661#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
573#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 662#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
… …
581#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 670#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
582 671
583#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 672#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
584#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 673#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
585 674
586#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
587#define ev_cb(ev) (ev)->cb /* rw */ 675#define ev_cb(ev) (ev)->cb /* rw */
676
677#if EV_MINPRI == EV_MAXPRI
678# define ev_priority(ev) ((ev), EV_MINPRI)
679# define ev_set_priority(ev,pri) ((ev), (pri))
680#else
681# define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
588#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) 682# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
683#endif
589 684
590#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 685#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
591 686
592#ifndef ev_set_cb 687#ifndef ev_set_cb
593# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 688# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
594#endif 689#endif
595 690
… …
599 694
600/* feeds an event into a watcher as if the event actually occured */ 695/* feeds an event into a watcher as if the event actually occured */
601/* accepts any ev_watcher type */ 696/* accepts any ev_watcher type */
602void ev_feed_event (EV_P_ void *w, int revents); 697void ev_feed_event (EV_P_ void *w, int revents);
603void ev_feed_fd_event (EV_P_ int fd, int revents); 698void ev_feed_fd_event (EV_P_ int fd, int revents);
699#if EV_SIGNAL_ENABLE
604void ev_feed_signal_event (EV_P_ int signum); 700void ev_feed_signal_event (EV_P_ int signum);
701#endif
605void ev_invoke (EV_P_ void *w, int revents); 702void ev_invoke (EV_P_ void *w, int revents);
606int ev_clear_pending (EV_P_ void *w); 703int ev_clear_pending (EV_P_ void *w);
607 704
608void ev_io_start (EV_P_ ev_io *w); 705void ev_io_start (EV_P_ ev_io *w);
609void ev_io_stop (EV_P_ ev_io *w); 706void ev_io_stop (EV_P_ ev_io *w);
610 707
611void ev_timer_start (EV_P_ ev_timer *w); 708void ev_timer_start (EV_P_ ev_timer *w);
612void ev_timer_stop (EV_P_ ev_timer *w); 709void ev_timer_stop (EV_P_ ev_timer *w);
613/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 710/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
614void ev_timer_again (EV_P_ ev_timer *w); 711void ev_timer_again (EV_P_ ev_timer *w);
712/* return remaining time */
713ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
615 714
616#if EV_PERIODIC_ENABLE 715#if EV_PERIODIC_ENABLE
617void ev_periodic_start (EV_P_ ev_periodic *w); 716void ev_periodic_start (EV_P_ ev_periodic *w);
618void ev_periodic_stop (EV_P_ ev_periodic *w); 717void ev_periodic_stop (EV_P_ ev_periodic *w);
619void ev_periodic_again (EV_P_ ev_periodic *w); 718void ev_periodic_again (EV_P_ ev_periodic *w);
620#endif 719#endif
621 720
622/* only supported in the default loop */ 721/* only supported in the default loop */
722#if EV_SIGNAL_ENABLE
623void ev_signal_start (EV_P_ ev_signal *w); 723void ev_signal_start (EV_P_ ev_signal *w);
624void ev_signal_stop (EV_P_ ev_signal *w); 724void ev_signal_stop (EV_P_ ev_signal *w);
725#endif
625 726
626/* only supported in the default loop */ 727/* only supported in the default loop */
728# if EV_CHILD_ENABLE
627void ev_child_start (EV_P_ ev_child *w); 729void ev_child_start (EV_P_ ev_child *w);
628void ev_child_stop (EV_P_ ev_child *w); 730void ev_child_stop (EV_P_ ev_child *w);
731# endif
629 732
630# if EV_STAT_ENABLE 733# if EV_STAT_ENABLE
631void ev_stat_start (EV_P_ ev_stat *w); 734void ev_stat_start (EV_P_ ev_stat *w);
632void ev_stat_stop (EV_P_ ev_stat *w); 735void ev_stat_stop (EV_P_ ev_stat *w);
633void ev_stat_stat (EV_P_ ev_stat *w); 736void ev_stat_stat (EV_P_ ev_stat *w);
… …
636# if EV_IDLE_ENABLE 739# if EV_IDLE_ENABLE
637void ev_idle_start (EV_P_ ev_idle *w); 740void ev_idle_start (EV_P_ ev_idle *w);
638void ev_idle_stop (EV_P_ ev_idle *w); 741void ev_idle_stop (EV_P_ ev_idle *w);
639# endif 742# endif
640 743
744#if EV_PREPARE_ENABLE
641void ev_prepare_start (EV_P_ ev_prepare *w); 745void ev_prepare_start (EV_P_ ev_prepare *w);
642void ev_prepare_stop (EV_P_ ev_prepare *w); 746void ev_prepare_stop (EV_P_ ev_prepare *w);
747#endif
643 748
749#if EV_CHECK_ENABLE
644void ev_check_start (EV_P_ ev_check *w); 750void ev_check_start (EV_P_ ev_check *w);
645void ev_check_stop (EV_P_ ev_check *w); 751void ev_check_stop (EV_P_ ev_check *w);
752#endif
646 753
647# if EV_FORK_ENABLE 754# if EV_FORK_ENABLE
648void ev_fork_start (EV_P_ ev_fork *w); 755void ev_fork_start (EV_P_ ev_fork *w);
649void ev_fork_stop (EV_P_ ev_fork *w); 756void ev_fork_stop (EV_P_ ev_fork *w);
650# endif 757# endif
… …
660void ev_async_start (EV_P_ ev_async *w); 767void ev_async_start (EV_P_ ev_async *w);
661void ev_async_stop (EV_P_ ev_async *w); 768void ev_async_stop (EV_P_ ev_async *w);
662void ev_async_send (EV_P_ ev_async *w); 769void ev_async_send (EV_P_ ev_async *w);
663# endif 770# endif
664 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
665#endif 786 #endif
666 787#else
667#ifdef __cplusplus 788 typedef struct ev_loop ev_loop;
668}
669#endif 789#endif
670 790
671#endif 791#endif
672 792
793EV_CPP(})
794
795#endif
796

Diff Legend

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