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

Comparing libev/ev.h (file contents):
Revision 1.112 by root, Sat Mar 28 22:17:17 2009 UTC vs.
Revision 1.158 by root, Tue Jan 11 13:45:28 2011 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,2011 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" {)
50
51/*****************************************************************************/
52
53/* pre-4.0 compatibility */
54#ifndef EV_COMPAT3
55# define EV_COMPAT3 1
45#endif 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
70/* these priorities are inclusive, higher priorities will be invoked earlier */
71#ifndef EV_MINPRI
72# define EV_MINPRI (EV_FEATURE_CONFIG ? -2 : 0)
73#endif
74#ifndef EV_MAXPRI
75# define EV_MAXPRI (EV_FEATURE_CONFIG ? +2 : 0)
76#endif
77
78#ifndef EV_MULTIPLICITY
79# define EV_MULTIPLICITY EV_FEATURE_CONFIG
80#endif
81
82#ifndef EV_PERIODIC_ENABLE
83# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
84#endif
85
86#ifndef EV_STAT_ENABLE
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
96#endif
97
98#ifndef EV_IDLE_ENABLE
99# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
100#endif
101
102#ifndef EV_FORK_ENABLE
103# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
104#endif
105
106#ifndef EV_CLEANUP_ENABLE
107# define EV_CLEANUP_ENABLE EV_FEATURE_WATCHERS
108#endif
109
110#ifndef EV_SIGNAL_ENABLE
111# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
112#endif
113
114#ifndef EV_CHILD_ENABLE
115# ifdef _WIN32
116# define EV_CHILD_ENABLE 0
117# else
118# define EV_CHILD_ENABLE EV_FEATURE_WATCHERS
119#endif
120#endif
121
122#ifndef EV_ASYNC_ENABLE
123# define EV_ASYNC_ENABLE EV_FEATURE_WATCHERS
124#endif
125
126#ifndef EV_EMBED_ENABLE
127# define EV_EMBED_ENABLE EV_FEATURE_WATCHERS
128#endif
129
130#ifndef EV_WALK_ENABLE
131# define EV_WALK_ENABLE 0 /* not yet */
132#endif
133
134/*****************************************************************************/
135
136#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
137# undef EV_SIGNAL_ENABLE
138# define EV_SIGNAL_ENABLE 1
139#endif
140
141/*****************************************************************************/
46 142
47typedef double ev_tstamp; 143typedef double ev_tstamp;
48
49/* these priorities are inclusive, higher priorities will be called earlier */
50#ifndef EV_MINPRI
51# define EV_MINPRI -2
52#endif
53#ifndef EV_MAXPRI
54# define EV_MAXPRI +2
55#endif
56
57#ifndef EV_MULTIPLICITY
58# define EV_MULTIPLICITY 1
59#endif
60
61#ifndef EV_PERIODIC_ENABLE
62# define EV_PERIODIC_ENABLE 1
63#endif
64
65#ifndef EV_STAT_ENABLE
66# define EV_STAT_ENABLE 1
67#endif
68
69#ifndef EV_IDLE_ENABLE
70# define EV_IDLE_ENABLE 1
71#endif
72
73#ifndef EV_FORK_ENABLE
74# define EV_FORK_ENABLE 1
75#endif
76
77#ifndef EV_EMBED_ENABLE
78# define EV_EMBED_ENABLE 1
79#endif
80
81#ifndef EV_ASYNC_ENABLE
82# define EV_ASYNC_ENABLE 1
83#endif
84 144
85#ifndef EV_ATOMIC_T 145#ifndef EV_ATOMIC_T
86# include <signal.h> 146# include <signal.h>
87# define EV_ATOMIC_T sig_atomic_t volatile 147# define EV_ATOMIC_T sig_atomic_t volatile
88#endif 148#endif
89
90/*****************************************************************************/
91 149
92#if EV_STAT_ENABLE 150#if EV_STAT_ENABLE
93# ifdef _WIN32 151# ifdef _WIN32
94# include <time.h> 152# include <time.h>
95# include <sys/types.h> 153# include <sys/types.h>
… …
98#endif 156#endif
99 157
100/* support multiple event loops? */ 158/* support multiple event loops? */
101#if EV_MULTIPLICITY 159#if EV_MULTIPLICITY
102struct ev_loop; 160struct ev_loop;
103# define EV_P struct ev_loop *loop 161# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
104# define EV_P_ EV_P, 162# define EV_P_ EV_P, /* a loop as first of multiple parameters */
105# define EV_A loop 163# define EV_A loop /* a loop as sole argument to a function call */
106# define EV_A_ EV_A, 164# define EV_A_ EV_A, /* a loop as first of multiple arguments */
107# 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 */
108# define EV_DEFAULT_UC_ EV_DEFAULT_UC, 166# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
109# define EV_DEFAULT ev_default_loop (0) 167# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
110# define EV_DEFAULT_ EV_DEFAULT, 168# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
111#else 169#else
112# define EV_P void 170# define EV_P void
113# define EV_P_ 171# define EV_P_
114# define EV_A 172# define EV_A
115# define EV_A_ 173# define EV_A_
… …
118# define EV_DEFAULT_UC 176# define EV_DEFAULT_UC
119# define EV_DEFAULT_UC_ 177# define EV_DEFAULT_UC_
120# undef EV_EMBED_ENABLE 178# undef EV_EMBED_ENABLE
121#endif 179#endif
122 180
181/* EV_INLINE is used for functions in header files */
123#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 182#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
124# define EV_INLINE static inline 183# define EV_INLINE static inline
125#else 184#else
126# define EV_INLINE static 185# define EV_INLINE static
127#endif 186#endif
128 187
188/* EV_PROTOTYPES can be sued to switch of prototype declarations */
189#ifndef EV_PROTOTYPES
190# define EV_PROTOTYPES 1
191#endif
192
129/*****************************************************************************/ 193/*****************************************************************************/
130 194
195#define EV_VERSION_MAJOR 4
196#define EV_VERSION_MINOR 3
197
131/* eventmask, revents, events... */ 198/* eventmask, revents, events... */
132#define EV_UNDEF -1 /* guaranteed to be invalid */ 199enum {
200 EV_UNDEF = 0xFFFFFFFF, /* guaranteed to be invalid */
133#define EV_NONE 0x00 /* no events */ 201 EV_NONE = 0x00, /* no events */
134#define EV_READ 0x01 /* ev_io detected read will not block */ 202 EV_READ = 0x01, /* ev_io detected read will not block */
135#define EV_WRITE 0x02 /* ev_io detected write will not block */ 203 EV_WRITE = 0x02, /* ev_io detected write will not block */
136#define EV__IOFDSET 0x80 /* internal use only */ 204 EV__IOFDSET = 0x80, /* internal use only */
137#define EV_IO EV_READ /* alias for type-detection */ 205 EV_IO = EV_READ, /* alias for type-detection */
138#define EV_TIMEOUT 0x00000100 /* timer timed out */ 206 EV_TIMER = 0x00000100, /* timer timed out */
139#define EV_TIMER EV_TIMEOUT /* alias for type-detection */ 207#if EV_COMPAT3
208 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
209#endif
140#define EV_PERIODIC 0x00000200 /* periodic timer timed out */ 210 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
141#define EV_SIGNAL 0x00000400 /* signal was received */ 211 EV_SIGNAL = 0x00000400, /* signal was received */
142#define EV_CHILD 0x00000800 /* child/pid had status change */ 212 EV_CHILD = 0x00000800, /* child/pid had status change */
143#define EV_STAT 0x00001000 /* stat data changed */ 213 EV_STAT = 0x00001000, /* stat data changed */
144#define EV_IDLE 0x00002000 /* event loop is idling */ 214 EV_IDLE = 0x00002000, /* event loop is idling */
145#define EV_PREPARE 0x00004000 /* event loop about to poll */ 215 EV_PREPARE = 0x00004000, /* event loop about to poll */
146#define EV_CHECK 0x00008000 /* event loop finished poll */ 216 EV_CHECK = 0x00008000, /* event loop finished poll */
147#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ 217 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
148#define 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 */
149#define EV_ASYNC 0x00040000 /* async intra-loop signal */ 220 EV_ASYNC = 0x00080000, /* async intra-loop signal */
221 EV_CUSTOM = 0x01000000, /* for use by user code */
150#define EV_ERROR 0x80000000 /* sent when an error occurs */ 222 EV_ERROR = 0x80000000 /* sent when an error occurs */
223};
151 224
152/* 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 */
153#ifndef EV_COMMON 226#ifndef EV_COMMON
154# define EV_COMMON void *data; 227# define EV_COMMON void *data;
155#endif 228#endif
156#ifndef EV_PROTOTYPES
157# define EV_PROTOTYPES 1
158#endif
159
160#define EV_VERSION_MAJOR 3
161#define EV_VERSION_MINOR 0
162 229
163#ifndef EV_CB_DECLARE 230#ifndef EV_CB_DECLARE
164# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 231# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
165#endif 232#endif
166#ifndef EV_CB_INVOKE 233#ifndef EV_CB_INVOKE
167# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) 234# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
168#endif 235#endif
236
237/* not official, do not use */
238#define EV_CB(type,name) void name (EV_P_ struct ev_ ## type *w, int revents)
169 239
170/* 240/*
171 * struct member types: 241 * struct member types:
172 * private: you may look at them, but not change them, 242 * private: you may look at them, but not change them,
173 * and they might not mean anything to you. 243 * and they might not mean anything to you.
… …
182 * or simply 1 for watchers that aren't in some array. 252 * or simply 1 for watchers that aren't in some array.
183 * pending is either 0, in which case the watcher isn't, 253 * pending is either 0, in which case the watcher isn't,
184 * or the array index + 1 in the pendings array. 254 * or the array index + 1 in the pendings array.
185 */ 255 */
186 256
257#if EV_MINPRI == EV_MAXPRI
258# define EV_DECL_PRIORITY
259#elif !defined (EV_DECL_PRIORITY)
260# define EV_DECL_PRIORITY int priority;
261#endif
262
187/* shared by all watchers */ 263/* shared by all watchers */
188#define EV_WATCHER(type) \ 264#define EV_WATCHER(type) \
189 int active; /* private */ \ 265 int active; /* private */ \
190 int pending; /* private */ \ 266 int pending; /* private */ \
191 int priority; /* private */ \ 267 EV_DECL_PRIORITY /* private */ \
192 EV_COMMON /* rw */ \ 268 EV_COMMON /* rw */ \
193 EV_CB_DECLARE (type) /* private */ 269 EV_CB_DECLARE (type) /* private */
194 270
195#define EV_WATCHER_LIST(type) \ 271#define EV_WATCHER_LIST(type) \
196 EV_WATCHER (type) \ 272 EV_WATCHER (type) \
… …
318 EV_WATCHER (ev_check) 394 EV_WATCHER (ev_check)
319} ev_check; 395} ev_check;
320 396
321#if EV_FORK_ENABLE 397#if EV_FORK_ENABLE
322/* 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 */
323typedef struct ev_fork 400typedef struct ev_fork
324{ 401{
325 EV_WATCHER (ev_fork) 402 EV_WATCHER (ev_fork)
326} 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;
327#endif 413#endif
328 414
329#if EV_EMBED_ENABLE 415#if EV_EMBED_ENABLE
330/* used to embed an event loop inside another */ 416/* used to embed an event loop inside another */
331/* 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 */
… …
339 ev_check check; /* unused */ 425 ev_check check; /* unused */
340 ev_timer timer; /* unused */ 426 ev_timer timer; /* unused */
341 ev_periodic periodic; /* unused */ 427 ev_periodic periodic; /* unused */
342 ev_idle idle; /* unused */ 428 ev_idle idle; /* unused */
343 ev_fork fork; /* private */ 429 ev_fork fork; /* private */
430#if EV_CLEANUP_ENABLE
431 ev_cleanup cleanup; /* unused */
432#endif
344} ev_embed; 433} ev_embed;
345#endif 434#endif
346 435
347#if EV_ASYNC_ENABLE 436#if EV_ASYNC_ENABLE
348/* invoked when somebody calls ev_async_send on the watcher */ 437/* invoked when somebody calls ev_async_send on the watcher */
… …
352 EV_WATCHER (ev_async) 441 EV_WATCHER (ev_async)
353 442
354 EV_ATOMIC_T sent; /* private */ 443 EV_ATOMIC_T sent; /* private */
355} ev_async; 444} ev_async;
356 445
357# define ev_async_pending(w) ((w)->sent + 0) 446# define ev_async_pending(w) (+(w)->sent)
358#endif 447#endif
359 448
360/* the presence of this union forces similar struct layout */ 449/* the presence of this union forces similar struct layout */
361union ev_any_watcher 450union ev_any_watcher
362{ 451{
… …
377 struct ev_prepare prepare; 466 struct ev_prepare prepare;
378 struct ev_check check; 467 struct ev_check check;
379#if EV_FORK_ENABLE 468#if EV_FORK_ENABLE
380 struct ev_fork fork; 469 struct ev_fork fork;
381#endif 470#endif
471#if EV_CLEANUP_ENABLE
472 struct ev_cleanup cleanup;
473#endif
382#if EV_EMBED_ENABLE 474#if EV_EMBED_ENABLE
383 struct ev_embed embed; 475 struct ev_embed embed;
384#endif 476#endif
385#if EV_ASYNC_ENABLE 477#if EV_ASYNC_ENABLE
386 struct ev_async async; 478 struct ev_async async;
387#endif 479#endif
388}; 480};
389 481
390/* bits for ev_default_loop and ev_loop_new */ 482/* flag bits for ev_default_loop and ev_loop_new */
483enum {
391/* the default */ 484 /* the default */
392#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 485 EVFLAG_AUTO = 0x00000000U, /* not quite a mask */
393/* flag bits */ 486 /* flag bits */
394#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 487 EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */
395#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ 488 EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */
489 /* debugging/feature disable */
490 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
491#if EV_COMPAT3
492 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
493#endif
494 EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */
495 EVFLAG_NOSIGMASK = 0x00400000U /* avoid modifying the signal mask */
496};
497
396/* method bits to be ored together */ 498/* method bits to be ored together */
499enum {
397#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 500 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
398#define EVBACKEND_POLL 0x00000002U /* !win */ 501 EVBACKEND_POLL = 0x00000002U, /* !win */
399#define EVBACKEND_EPOLL 0x00000004U /* linux */ 502 EVBACKEND_EPOLL = 0x00000004U, /* linux */
400#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 503 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
401#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 504 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
402#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 505 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
506 EVBACKEND_ALL = 0x0000003FU, /* all known backends */
507 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
508};
403 509
404#if EV_PROTOTYPES 510#if EV_PROTOTYPES
405int ev_version_major (void); 511int ev_version_major (void);
406int ev_version_minor (void); 512int ev_version_minor (void);
407 513
… …
425 * (such as failed select, poll, epoll_wait) 531 * (such as failed select, poll, epoll_wait)
426 */ 532 */
427void ev_set_syserr_cb (void (*cb)(const char *msg)); 533void ev_set_syserr_cb (void (*cb)(const char *msg));
428 534
429#if EV_MULTIPLICITY 535#if EV_MULTIPLICITY
536
537/* the default loop is the only one that handles signals and child watchers */
538/* you can call this as often as you like */
539struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0));
540
430EV_INLINE struct ev_loop * 541EV_INLINE struct ev_loop *
431ev_default_loop_uc (void) 542ev_default_loop_uc_ (void)
432{ 543{
433 extern struct ev_loop *ev_default_loop_ptr; 544 extern struct ev_loop *ev_default_loop_ptr;
434 545
435 return ev_default_loop_ptr; 546 return ev_default_loop_ptr;
436} 547}
437 548
438/* the default loop is the only one that handles signals and child watchers */ 549EV_INLINE int
439/* you can call this as often as you like */ 550ev_is_default_loop (EV_P)
440EV_INLINE struct ev_loop *
441ev_default_loop (unsigned int flags)
442{ 551{
443 struct ev_loop *loop = ev_default_loop_uc (); 552 return EV_A == EV_DEFAULT_UC;
444
445 if (!loop)
446 {
447 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
448
449 loop = ev_default_loop_init (flags);
450 }
451
452 return loop;
453} 553}
454 554
455/* create and destroy alternative loops that don't handle signals */ 555/* create and destroy alternative loops that don't handle signals */
456struct ev_loop *ev_loop_new (unsigned int flags); 556struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
457void ev_loop_destroy (EV_P);
458void ev_loop_fork (EV_P);
459void ev_loop_verify (EV_P);
460 557
461ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 558ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
462void ev_now_update (EV_P);
463 559
464#else 560#else
465 561
466int ev_default_loop (unsigned int flags); /* returns true when successful */ 562int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */
467 563
468EV_INLINE ev_tstamp 564EV_INLINE ev_tstamp
469ev_now (void) 565ev_now (void)
470{ 566{
471 extern ev_tstamp ev_rt_now; 567 extern ev_tstamp ev_rt_now;
472 568
473 return ev_rt_now; 569 return ev_rt_now;
474} 570}
571
572/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
573EV_INLINE int
574ev_is_default_loop (void)
575{
576 return 1;
577}
578
475#endif /* multiplicity */ 579#endif /* multiplicity */
476 580
477EV_INLINE int 581/* destroy event loops, also works for the default loop */
478ev_is_default_loop (EV_P) 582void ev_loop_destroy (EV_P);
479{
480#if EV_MULTIPLICITY
481 extern struct ev_loop *ev_default_loop_ptr;
482 583
483 return !!(EV_A == ev_default_loop_ptr);
484#else
485 return 1;
486#endif
487}
488
489void ev_default_destroy (void); /* destroy the default loop */
490/* this needs to be called after fork, to duplicate the default loop */ 584/* this needs to be called after fork, to duplicate the loop */
491/* if you create alternative loops you have to call ev_loop_fork on them */ 585/* when you want to re-use it in the child */
492/* you can call it in either the parent or the child */ 586/* you can call it in either the parent or the child */
493/* you can actually call it at any time, anywhere :) */ 587/* you can actually call it at any time, anywhere :) */
494void ev_default_fork (void); 588void ev_loop_fork (EV_P);
495 589
496#if 0 590unsigned int ev_backend (EV_P); /* backend in use by loop */
591
592void ev_now_update (EV_P); /* update event loop time */
593
594#if EV_WALK_ENABLE
497/* walk (almost) all watchers in the loop of a given type, invoking the */ 595/* walk (almost) all watchers in the loop of a given type, invoking the */
498/* callback on every such watcher. The callback might stop the watcher, */ 596/* callback on every such watcher. The callback might stop the watcher, */
499/* but do nothing else with the loop */ 597/* but do nothing else with the loop */
500void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 598void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
501#endif 599#endif
502 600
503unsigned int ev_backend (EV_P); /* backend in use by loop */
504unsigned int ev_loop_count (EV_P); /* number of loop iterations */
505#endif /* prototypes */ 601#endif /* prototypes */
506 602
507#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 603/* ev_run flags values */
508#define EVLOOP_ONESHOT 2 /* block *once* only */ 604enum {
509#define EVUNLOOP_CANCEL 0 /* undo unloop */ 605 EVRUN_NOWAIT = 1, /* do not block/wait */
510#define EVUNLOOP_ONE 1 /* unloop once */ 606 EVRUN_ONCE = 2 /* block *once* only */
607};
608
609/* ev_break how values */
610enum {
611 EVBREAK_CANCEL = 0, /* undo unloop */
612 EVBREAK_ONE = 1, /* unloop once */
511#define EVUNLOOP_ALL 2 /* unloop all loops */ 613 EVBREAK_ALL = 2 /* unloop all loops */
614};
512 615
513#if EV_PROTOTYPES 616#if EV_PROTOTYPES
514void ev_loop (EV_P_ int flags); 617void ev_run (EV_P_ int flags EV_CPP (= 0));
515void 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 */ 618void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */
516
517void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
518void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
519 619
520/* 620/*
521 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 621 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
522 * keeps one reference. if you have a long-runing watcher you never unregister that 622 * keeps one reference. if you have a long-running watcher you never unregister that
523 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 623 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
524 */ 624 */
525void ev_ref (EV_P); 625void ev_ref (EV_P);
526void ev_unref (EV_P); 626void ev_unref (EV_P);
527 627
628/*
528/* convenience function, wait for a single event, without registering an event watcher */ 629 * convenience function, wait for a single event, without registering an event watcher
529/* if timeout is < 0, do wait indefinitely */ 630 * if timeout is < 0, do wait indefinitely
631 */
530void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 632void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
633
634# if EV_FEATURE_API
635unsigned int ev_iteration (EV_P); /* number of loop iterations */
636unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
637void ev_verify (EV_P); /* abort if loop data corrupted */
638
639void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
640void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
641
642/* advanced stuff for threading etc. support, see docs */
643void ev_set_userdata (EV_P_ void *data);
644void *ev_userdata (EV_P);
645void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
646void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
647
648unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
649void ev_invoke_pending (EV_P); /* invoke all pending watchers */
650
651/*
652 * stop/start the timer handling.
653 */
654void ev_suspend (EV_P);
655void ev_resume (EV_P);
656#endif
657
531#endif 658#endif
532 659
533/* these may evaluate ev multiple times, and the other arguments at most once */ 660/* these may evaluate ev multiple times, and the other arguments at most once */
534/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 661/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
535#define ev_init(ev,cb_) do { \ 662#define ev_init(ev,cb_) do { \
536 ((ev_watcher *)(void *)(ev))->active = \ 663 ((ev_watcher *)(void *)(ev))->active = \
537 ((ev_watcher *)(void *)(ev))->pending = \ 664 ((ev_watcher *)(void *)(ev))->pending = 0; \
538 ((ev_watcher *)(void *)(ev))->priority = 0; \ 665 ev_set_priority ((ev), 0); \
539 ev_set_cb ((ev), cb_); \ 666 ev_set_cb ((ev), cb_); \
540} while (0) 667} while (0)
541 668
542#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0) 669#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
543#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0) 670#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
… …
548#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 675#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
549#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 676#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
550#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 677#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
551#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 678#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
552#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 679#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
553#define ev_async_set(ev) do { (ev)->sent = 0; } while (0) 680#define ev_cleanup_set(ev) /* nop, yes, this is a serious in-joke */
681#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
554 682
555#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 683#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
556#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 684#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
557#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0) 685#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
558#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 686#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
… …
561#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 689#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
562#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 690#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
563#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 691#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
564#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) 692#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
565#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 693#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
694#define ev_cleanup_init(ev,cb) do { ev_init ((ev), (cb)); ev_cleanup_set ((ev)); } while (0)
566#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 695#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
567 696
568#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 697#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
569#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 698#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
570 699
571#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
572#define ev_cb(ev) (ev)->cb /* rw */ 700#define ev_cb(ev) (ev)->cb /* rw */
701
702#if EV_MINPRI == EV_MAXPRI
703# define ev_priority(ev) ((ev), EV_MINPRI)
704# define ev_set_priority(ev,pri) ((ev), (pri))
705#else
706# define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
573#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) 707# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
708#endif
574 709
575#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 710#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
576 711
577#ifndef ev_set_cb 712#ifndef ev_set_cb
578# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 713# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
579#endif 714#endif
580 715
… …
584 719
585/* feeds an event into a watcher as if the event actually occured */ 720/* feeds an event into a watcher as if the event actually occured */
586/* accepts any ev_watcher type */ 721/* accepts any ev_watcher type */
587void ev_feed_event (EV_P_ void *w, int revents); 722void ev_feed_event (EV_P_ void *w, int revents);
588void ev_feed_fd_event (EV_P_ int fd, int revents); 723void ev_feed_fd_event (EV_P_ int fd, int revents);
724#if EV_SIGNAL_ENABLE
725void ev_feed_signal (int signum);
589void ev_feed_signal_event (EV_P_ int signum); 726void ev_feed_signal_event (EV_P_ int signum);
727#endif
590void ev_invoke (EV_P_ void *w, int revents); 728void ev_invoke (EV_P_ void *w, int revents);
591int ev_clear_pending (EV_P_ void *w); 729int ev_clear_pending (EV_P_ void *w);
592 730
593void ev_io_start (EV_P_ ev_io *w); 731void ev_io_start (EV_P_ ev_io *w);
594void ev_io_stop (EV_P_ ev_io *w); 732void ev_io_stop (EV_P_ ev_io *w);
595 733
596void ev_timer_start (EV_P_ ev_timer *w); 734void ev_timer_start (EV_P_ ev_timer *w);
597void ev_timer_stop (EV_P_ ev_timer *w); 735void ev_timer_stop (EV_P_ ev_timer *w);
598/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 736/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
599void ev_timer_again (EV_P_ ev_timer *w); 737void ev_timer_again (EV_P_ ev_timer *w);
738/* return remaining time */
739ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
600 740
601#if EV_PERIODIC_ENABLE 741#if EV_PERIODIC_ENABLE
602void ev_periodic_start (EV_P_ ev_periodic *w); 742void ev_periodic_start (EV_P_ ev_periodic *w);
603void ev_periodic_stop (EV_P_ ev_periodic *w); 743void ev_periodic_stop (EV_P_ ev_periodic *w);
604void ev_periodic_again (EV_P_ ev_periodic *w); 744void ev_periodic_again (EV_P_ ev_periodic *w);
605#endif 745#endif
606 746
607/* only supported in the default loop */ 747/* only supported in the default loop */
748#if EV_SIGNAL_ENABLE
608void ev_signal_start (EV_P_ ev_signal *w); 749void ev_signal_start (EV_P_ ev_signal *w);
609void ev_signal_stop (EV_P_ ev_signal *w); 750void ev_signal_stop (EV_P_ ev_signal *w);
751#endif
610 752
611/* only supported in the default loop */ 753/* only supported in the default loop */
754# if EV_CHILD_ENABLE
612void ev_child_start (EV_P_ ev_child *w); 755void ev_child_start (EV_P_ ev_child *w);
613void ev_child_stop (EV_P_ ev_child *w); 756void ev_child_stop (EV_P_ ev_child *w);
757# endif
614 758
615# if EV_STAT_ENABLE 759# if EV_STAT_ENABLE
616void ev_stat_start (EV_P_ ev_stat *w); 760void ev_stat_start (EV_P_ ev_stat *w);
617void ev_stat_stop (EV_P_ ev_stat *w); 761void ev_stat_stop (EV_P_ ev_stat *w);
618void ev_stat_stat (EV_P_ ev_stat *w); 762void ev_stat_stat (EV_P_ ev_stat *w);
… …
621# if EV_IDLE_ENABLE 765# if EV_IDLE_ENABLE
622void ev_idle_start (EV_P_ ev_idle *w); 766void ev_idle_start (EV_P_ ev_idle *w);
623void ev_idle_stop (EV_P_ ev_idle *w); 767void ev_idle_stop (EV_P_ ev_idle *w);
624# endif 768# endif
625 769
770#if EV_PREPARE_ENABLE
626void ev_prepare_start (EV_P_ ev_prepare *w); 771void ev_prepare_start (EV_P_ ev_prepare *w);
627void ev_prepare_stop (EV_P_ ev_prepare *w); 772void ev_prepare_stop (EV_P_ ev_prepare *w);
773#endif
628 774
775#if EV_CHECK_ENABLE
629void ev_check_start (EV_P_ ev_check *w); 776void ev_check_start (EV_P_ ev_check *w);
630void ev_check_stop (EV_P_ ev_check *w); 777void ev_check_stop (EV_P_ ev_check *w);
778#endif
631 779
632# if EV_FORK_ENABLE 780# if EV_FORK_ENABLE
633void ev_fork_start (EV_P_ ev_fork *w); 781void ev_fork_start (EV_P_ ev_fork *w);
634void ev_fork_stop (EV_P_ ev_fork *w); 782void ev_fork_stop (EV_P_ ev_fork *w);
783# endif
784
785# if EV_CLEANUP_ENABLE
786void ev_cleanup_start (EV_P_ ev_cleanup *w);
787void ev_cleanup_stop (EV_P_ ev_cleanup *w);
635# endif 788# endif
636 789
637# if EV_EMBED_ENABLE 790# if EV_EMBED_ENABLE
638/* only supported when loop to be embedded is in fact embeddable */ 791/* only supported when loop to be embedded is in fact embeddable */
639void ev_embed_start (EV_P_ ev_embed *w); 792void ev_embed_start (EV_P_ ev_embed *w);
… …
645void ev_async_start (EV_P_ ev_async *w); 798void ev_async_start (EV_P_ ev_async *w);
646void ev_async_stop (EV_P_ ev_async *w); 799void ev_async_stop (EV_P_ ev_async *w);
647void ev_async_send (EV_P_ ev_async *w); 800void ev_async_send (EV_P_ ev_async *w);
648# endif 801# endif
649 802
803#if EV_COMPAT3
804 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
805 #define EVLOOP_ONESHOT EVRUN_ONCE
806 #define EVUNLOOP_CANCEL EVBREAK_CANCEL
807 #define EVUNLOOP_ONE EVBREAK_ONE
808 #define EVUNLOOP_ALL EVBREAK_ALL
809 #if EV_PROTOTYPES
810 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
811 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
812 EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); }
813 EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); }
814 #if EV_FEATURE_API
815 EV_INLINE unsigned int ev_loop_count (EV_P) { return ev_iteration (EV_A); }
816 EV_INLINE unsigned int ev_loop_depth (EV_P) { return ev_depth (EV_A); }
817 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
818 #endif
650#endif 819 #endif
651 820#else
652#ifdef __cplusplus 821 typedef struct ev_loop ev_loop;
653}
654#endif 822#endif
655 823
656#endif 824#endif
657 825
826EV_CPP(})
827
828#endif
829

Diff Legend

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