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

Comparing libev/ev.h (file contents):
Revision 1.106 by root, Mon Sep 29 03:31:14 2008 UTC vs.
Revision 1.146 by root, Fri Oct 22 06:14:28 2010 UTC

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

Diff Legend

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