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

Comparing libev/ev.h (file contents):
Revision 1.72 by root, Tue Nov 27 10:59:11 2007 UTC vs.
Revision 1.116 by root, Wed Jul 8 02:46:05 2009 UTC

1/* 1/*
2 * libev native API header
3 *
2 * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008,2009 Marc Alexander Lehmann <libev@schmorp.de>
3 * All rights reserved. 5 * All rights reserved.
4 * 6 *
5 * Redistribution and use in source and binary forms, with or without 7 * Redistribution and use in source and binary forms, with or without modifica-
6 * modification, are permitted provided that the following conditions are 8 * tion, are permitted provided that the following conditions are met:
7 * met: 9 *
10 * 1. Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
12 *
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
18 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
19 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
20 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
21 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
23 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
25 * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
26 * OF THE POSSIBILITY OF SUCH DAMAGE.
8 * 27 *
9 * * Redistributions of source code must retain the above copyright 28 * Alternatively, the contents of this file may be used under the terms of
10 * notice, this list of conditions and the following disclaimer. 29 * the GNU General Public License ("GPL") version 2 or any later version,
11 * 30 * in which case the provisions of the GPL are applicable instead of
12 * * Redistributions in binary form must reproduce the above 31 * the above. If you wish to allow the use of your version of this file
13 * copyright notice, this list of conditions and the following 32 * only under the terms of the GPL and not to allow others to use your
14 * disclaimer in the documentation and/or other materials provided 33 * version of this file under the BSD license, indicate your decision
15 * with the distribution. 34 * by deleting the provisions above and replace them with the notice
16 * 35 * and other provisions required by the GPL. If you do not delete the
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 36 * provisions above, a recipient may use your version of this file under
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 37 * either the BSD or the GPL.
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */ 38 */
29 39
30#ifndef EV_H__ 40#ifndef EV_H__
31#define EV_H__ 41#define EV_H__
32 42
54 64
55#ifndef EV_STAT_ENABLE 65#ifndef EV_STAT_ENABLE
56# define EV_STAT_ENABLE 1 66# define EV_STAT_ENABLE 1
57#endif 67#endif
58 68
69#ifndef EV_IDLE_ENABLE
70# define EV_IDLE_ENABLE 1
71#endif
72
59#ifndef EV_FORK_ENABLE 73#ifndef EV_FORK_ENABLE
60# define EV_FORK_ENABLE 1 74# define EV_FORK_ENABLE 1
61#endif 75#endif
62 76
63#ifndef EV_EMBED_ENABLE 77#ifndef EV_EMBED_ENABLE
64# define EV_EMBED_ENABLE 1 78# define EV_EMBED_ENABLE 1
65#endif 79#endif
66 80
81#ifndef EV_ASYNC_ENABLE
82# define EV_ASYNC_ENABLE 1
83#endif
84
85#ifndef EV_WALK_ENABLE
86# define EV_WALK_ENABLE 0 /* not yet */
87#endif
88
89#ifndef EV_ATOMIC_T
90# include <signal.h>
91# define EV_ATOMIC_T sig_atomic_t volatile
92#endif
93
67/*****************************************************************************/ 94/*****************************************************************************/
68 95
69#if EV_STAT_ENABLE 96#if EV_STAT_ENABLE
97# ifdef _WIN32
98# include <time.h>
99# include <sys/types.h>
100# endif
70# include <sys/stat.h> 101# include <sys/stat.h>
71#endif 102#endif
72 103
73/* support multiple event loops? */ 104/* support multiple event loops? */
74#if EV_MULTIPLICITY 105#if EV_MULTIPLICITY
75struct ev_loop; 106struct ev_loop;
76# define EV_P struct ev_loop *loop 107# define EV_P struct ev_loop *loop
77# define EV_P_ EV_P, 108# define EV_P_ EV_P,
78# define EV_A loop 109# define EV_A loop
79# define EV_A_ EV_A, 110# define EV_A_ EV_A,
111# define EV_DEFAULT_UC ev_default_loop_uc ()
112# define EV_DEFAULT_UC_ EV_DEFAULT_UC,
80# define EV_DEFAULT ev_default_loop (0) 113# define EV_DEFAULT ev_default_loop (0)
81# define EV_DEFAULT_ EV_DEFAULT, 114# define EV_DEFAULT_ EV_DEFAULT,
82#else 115#else
83# define EV_P void 116# define EV_P void
84# define EV_P_ 117# define EV_P_
85# define EV_A 118# define EV_A
86# define EV_A_ 119# define EV_A_
87# define EV_DEFAULT 120# define EV_DEFAULT
88# define EV_DEFAULT_ 121# define EV_DEFAULT_
89 122# define EV_DEFAULT_UC
123# define EV_DEFAULT_UC_
90# undef EV_EMBED_ENABLE 124# undef EV_EMBED_ENABLE
91#endif 125#endif
92 126
127#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
128# define EV_INLINE static inline
129#else
130# define EV_INLINE static
131#endif
132
133/*****************************************************************************/
134
93/* eventmask, revents, events... */ 135/* eventmask, revents, events... */
94#define EV_UNDEF -1L /* guaranteed to be invalid */ 136#define EV_UNDEF -1 /* guaranteed to be invalid */
95#define EV_NONE 0x00L /* no events */ 137#define EV_NONE 0x00 /* no events */
96#define EV_READ 0x01L /* ev_io detected read will not block */ 138#define EV_READ 0x01 /* ev_io detected read will not block */
97#define EV_WRITE 0x02L /* ev_io detected write will not block */ 139#define EV_WRITE 0x02 /* ev_io detected write will not block */
140#define EV__IOFDSET 0x80 /* internal use only */
141#define EV_IO EV_READ /* alias for type-detection */
98#define EV_TIMEOUT 0x00000100L /* timer timed out */ 142#define EV_TIMEOUT 0x00000100 /* timer timed out */
143#define EV_TIMER EV_TIMEOUT /* alias for type-detection */
99#define EV_PERIODIC 0x00000200L /* periodic timer timed out */ 144#define EV_PERIODIC 0x00000200 /* periodic timer timed out */
100#define EV_SIGNAL 0x00000400L /* signal was received */ 145#define EV_SIGNAL 0x00000400 /* signal was received */
101#define EV_CHILD 0x00000800L /* child/pid had status change */ 146#define EV_CHILD 0x00000800 /* child/pid had status change */
102#define EV_STAT 0x00001000L /* stat data changed */ 147#define EV_STAT 0x00001000 /* stat data changed */
103#define EV_IDLE 0x00002000L /* event loop is idling */ 148#define EV_IDLE 0x00002000 /* event loop is idling */
104#define EV_PREPARE 0x00004000L /* event loop about to poll */ 149#define EV_PREPARE 0x00004000 /* event loop about to poll */
105#define EV_CHECK 0x00008000L /* event loop finished poll */ 150#define EV_CHECK 0x00008000 /* event loop finished poll */
106#define EV_EMBED 0x00010000L /* embedded event loop needs sweep */ 151#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
107#define EV_FORK 0x00020000L /* event loop resumed in child */ 152#define EV_FORK 0x00020000 /* event loop resumed in child */
153#define EV_ASYNC 0x00040000 /* async intra-loop signal */
154#define EV_CUSTOM 0x01000000 /* for use by user code */
108#define EV_ERROR 0x80000000L /* sent when an error occurs */ 155#define EV_ERROR 0x80000000 /* sent when an error occurs */
109 156
110/* can be used to add custom fields to all watchers, while losing binary compatibility */ 157/* can be used to add custom fields to all watchers, while losing binary compatibility */
111#ifndef EV_COMMON 158#ifndef EV_COMMON
112# define EV_COMMON void *data; 159# define EV_COMMON void *data;
113#endif 160#endif
114#ifndef EV_PROTOTYPES 161#ifndef EV_PROTOTYPES
115# define EV_PROTOTYPES 1 162# define EV_PROTOTYPES 1
116#endif 163#endif
117 164
118#define EV_VERSION_MAJOR 1 165#define EV_VERSION_MAJOR 3
119#define EV_VERSION_MINOR 1 166#define EV_VERSION_MINOR 0
120 167
121#ifndef EV_CB_DECLARE 168#ifndef EV_CB_DECLARE
122# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 169# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
123#endif 170#endif
124#ifndef EV_CB_INVOKE 171#ifndef EV_CB_INVOKE
125# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) 172# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
126#endif 173#endif
127 174
128/* 175/*
129 * struct member types: 176 * struct member types:
130 * private: you can look at them, but not change them, and they might not mean anything to you. 177 * private: you may look at them, but not change them,
178 * and they might not mean anything to you.
131 * ro: can be read anytime, but only changed when the watcher isn't active 179 * ro: can be read anytime, but only changed when the watcher isn't active.
132 * rw: can be read and modified anytime, even when the watcher is active 180 * rw: can be read and modified anytime, even when the watcher is active.
181 *
182 * some internal details that might be helpful for debugging:
183 *
184 * active is either 0, which means the watcher is not active,
185 * or the array index of the watcher (periodics, timers)
186 * or the array index + 1 (most other watchers)
187 * or simply 1 for watchers that aren't in some array.
188 * pending is either 0, in which case the watcher isn't,
189 * or the array index + 1 in the pendings array.
133 */ 190 */
134 191
135/* shared by all watchers */ 192/* shared by all watchers */
136#define EV_WATCHER(type) \ 193#define EV_WATCHER(type) \
137 int active; /* private */ \ 194 int active; /* private */ \
189/* revent EV_PERIODIC */ 246/* revent EV_PERIODIC */
190typedef struct ev_periodic 247typedef struct ev_periodic
191{ 248{
192 EV_WATCHER_TIME (ev_periodic) 249 EV_WATCHER_TIME (ev_periodic)
193 250
251 ev_tstamp offset; /* rw */
194 ev_tstamp interval; /* rw */ 252 ev_tstamp interval; /* rw */
195 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 253 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
196} ev_periodic; 254} ev_periodic;
197 255
198/* invoked when the given signal has been received */ 256/* invoked when the given signal has been received */
209/* does not support priorities */ 267/* does not support priorities */
210typedef struct ev_child 268typedef struct ev_child
211{ 269{
212 EV_WATCHER_LIST (ev_child) 270 EV_WATCHER_LIST (ev_child)
213 271
272 int flags; /* private */
214 int pid; /* ro */ 273 int pid; /* ro */
215 int rpid; /* rw, holds the received pid */ 274 int rpid; /* rw, holds the received pid */
216 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 275 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
217} ev_child; 276} ev_child;
218 277
219#if EV_STAT_ENABLE 278#if EV_STAT_ENABLE
220/* st_nlink = 0 means missing file or other error */ 279/* st_nlink = 0 means missing file or other error */
221#ifdef _WIN32 280# ifdef _WIN32
222typedef struct _stati64 ev_statdata; 281typedef struct _stati64 ev_statdata;
223#else 282# else
224typedef struct stat ev_statdata; 283typedef struct stat ev_statdata;
225#endif 284# endif
226 285
227/* invoked each time the stat data changes for a given path */ 286/* invoked each time the stat data changes for a given path */
228/* revent EV_STAT */ 287/* revent EV_STAT */
229typedef struct ev_stat 288typedef struct ev_stat
230{ 289{
231 EV_WATCHER (ev_stat) 290 EV_WATCHER_LIST (ev_stat)
232 291
233 ev_timer timer; /* private */ 292 ev_timer timer; /* private */
234 ev_tstamp interval; /* ro */ 293 ev_tstamp interval; /* ro */
235 const char *path; /* ro */ 294 const char *path; /* ro */
236 ev_statdata prev; /* ro */ 295 ev_statdata prev; /* ro */
237 ev_statdata attr; /* ro */ 296 ev_statdata attr; /* ro */
297
298 int wd; /* wd for inotify, fd for kqueue */
238} ev_stat; 299} ev_stat;
239#endif 300#endif
240 301
302#if EV_IDLE_ENABLE
241/* invoked when the nothing else needs to be done, keeps the process from blocking */ 303/* invoked when the nothing else needs to be done, keeps the process from blocking */
242/* revent EV_IDLE */ 304/* revent EV_IDLE */
243typedef struct ev_idle 305typedef struct ev_idle
244{ 306{
245 EV_WATCHER (ev_idle) 307 EV_WATCHER (ev_idle)
246} ev_idle; 308} ev_idle;
309#endif
247 310
248/* invoked for each run of the mainloop, just before the blocking call */ 311/* invoked for each run of the mainloop, just before the blocking call */
249/* you can still change events in any way you like */ 312/* you can still change events in any way you like */
250/* revent EV_PREPARE */ 313/* revent EV_PREPARE */
251typedef struct ev_prepare 314typedef struct ev_prepare
273/* the callback gets invoked when the event loop has handled events, and can be 0 */ 336/* the callback gets invoked when the event loop has handled events, and can be 0 */
274typedef struct ev_embed 337typedef struct ev_embed
275{ 338{
276 EV_WATCHER (ev_embed) 339 EV_WATCHER (ev_embed)
277 340
278 ev_io io; /* private */
279 struct ev_loop *loop; /* ro */ 341 struct ev_loop *other; /* ro */
342 ev_io io; /* private */
343 ev_prepare prepare; /* private */
344 ev_check check; /* unused */
345 ev_timer timer; /* unused */
346 ev_periodic periodic; /* unused */
347 ev_idle idle; /* unused */
348 ev_fork fork; /* private */
280} ev_embed; 349} ev_embed;
350#endif
351
352#if EV_ASYNC_ENABLE
353/* invoked when somebody calls ev_async_send on the watcher */
354/* revent EV_ASYNC */
355typedef struct ev_async
356{
357 EV_WATCHER (ev_async)
358
359 EV_ATOMIC_T sent; /* private */
360} ev_async;
361
362# define ev_async_pending(w) ((w)->sent + 0)
281#endif 363#endif
282 364
283/* the presence of this union forces similar struct layout */ 365/* the presence of this union forces similar struct layout */
284union ev_any_watcher 366union ev_any_watcher
285{ 367{
292 struct ev_signal signal; 374 struct ev_signal signal;
293 struct ev_child child; 375 struct ev_child child;
294#if EV_STAT_ENABLE 376#if EV_STAT_ENABLE
295 struct ev_stat stat; 377 struct ev_stat stat;
296#endif 378#endif
379#if EV_IDLE_ENABLE
297 struct ev_idle idle; 380 struct ev_idle idle;
381#endif
298 struct ev_prepare prepare; 382 struct ev_prepare prepare;
299 struct ev_check check; 383 struct ev_check check;
300#if EV_FORK_ENABLE 384#if EV_FORK_ENABLE
301 struct ev_fork fork; 385 struct ev_fork fork;
302#endif 386#endif
303#if EV_EMBED_ENABLE 387#if EV_EMBED_ENABLE
304 struct ev_embed embed; 388 struct ev_embed embed;
305#endif 389#endif
390#if EV_ASYNC_ENABLE
391 struct ev_async async;
392#endif
306}; 393};
307 394
308/* bits for ev_default_loop and ev_loop_new */ 395/* bits for ev_default_loop and ev_loop_new */
309/* the default */ 396/* the default */
310#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */ 397#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
311/* flag bits */ 398/* flag bits */
312#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */ 399#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
400#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
313/* method bits to be ored together */ 401/* method bits to be ored together */
314#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */ 402#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
315#define EVBACKEND_POLL 0x00000002UL /* !win */ 403#define EVBACKEND_POLL 0x00000002U /* !win */
316#define EVBACKEND_EPOLL 0x00000004UL /* linux */ 404#define EVBACKEND_EPOLL 0x00000004U /* linux */
317#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */ 405#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
318#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */ 406#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
319#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */ 407#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
320 408
321#if EV_PROTOTYPES 409#if EV_PROTOTYPES
322int ev_version_major (void); 410int ev_version_major (void);
323int ev_version_minor (void); 411int ev_version_minor (void);
324 412
325unsigned int ev_supported_backends (void); 413unsigned int ev_supported_backends (void);
326unsigned int ev_recommended_backends (void); 414unsigned int ev_recommended_backends (void);
327unsigned int ev_embeddable_backends (void); 415unsigned int ev_embeddable_backends (void);
328 416
329ev_tstamp ev_time (void); 417ev_tstamp ev_time (void);
418void ev_sleep (ev_tstamp delay); /* sleep for a while */
330 419
331/* Sets the allocation function to use, works like realloc. 420/* Sets the allocation function to use, works like realloc.
332 * It is used to allocate and free memory. 421 * It is used to allocate and free memory.
333 * If it returns zero when memory needs to be allocated, the library might abort 422 * If it returns zero when memory needs to be allocated, the library might abort
334 * or take some potentially destructive action. 423 * or take some potentially destructive action.
340 * retryable syscall error 429 * retryable syscall error
341 * (such as failed select, poll, epoll_wait) 430 * (such as failed select, poll, epoll_wait)
342 */ 431 */
343void ev_set_syserr_cb (void (*cb)(const char *msg)); 432void ev_set_syserr_cb (void (*cb)(const char *msg));
344 433
345# if EV_MULTIPLICITY 434#if EV_MULTIPLICITY
435EV_INLINE struct ev_loop *
436ev_default_loop_uc (void)
437{
438 extern struct ev_loop *ev_default_loop_ptr;
439
440 return ev_default_loop_ptr;
441}
442
346/* the default loop is the only one that handles signals and child watchers */ 443/* the default loop is the only one that handles signals and child watchers */
347/* you can call this as often as you like */ 444/* you can call this as often as you like */
348static struct ev_loop * 445EV_INLINE struct ev_loop *
349ev_default_loop (unsigned int flags) 446ev_default_loop (unsigned int flags)
350{ 447{
351 extern struct ev_loop *ev_default_loop_ptr; 448 struct ev_loop *loop = ev_default_loop_uc ();
449
450 if (!loop)
451 {
352 extern struct ev_loop *ev_default_loop_init (unsigned int flags); 452 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
353 453
354 if (!ev_default_loop_ptr)
355 ev_default_loop_init (flags); 454 loop = ev_default_loop_init (flags);
455 }
356 456
357 return ev_default_loop_ptr; 457 return loop;
358} 458}
359 459
360/* create and destroy alternative loops that don't handle signals */ 460/* create and destroy alternative loops that don't handle signals */
361struct ev_loop *ev_loop_new (unsigned int flags); 461struct ev_loop *ev_loop_new (unsigned int flags);
362void ev_loop_destroy (EV_P); 462void ev_loop_destroy (EV_P);
363void ev_loop_fork (EV_P); 463void ev_loop_fork (EV_P);
364 464
365ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 465ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
466void ev_now_update (EV_P);
366 467
367# else 468#else
368 469
369int ev_default_loop (unsigned int flags); /* returns true when successful */ 470int ev_default_loop (unsigned int flags); /* returns true when successful */
370 471
371static ev_tstamp 472EV_INLINE ev_tstamp
372ev_now (void) 473ev_now (void)
373{ 474{
374 extern ev_tstamp ev_rt_now; 475 extern ev_tstamp ev_rt_now;
375 476
376 return ev_rt_now; 477 return ev_rt_now;
377} 478}
479#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;
378# endif 490#endif
491}
379 492
380void ev_default_destroy (void); /* destroy the default loop */ 493void ev_default_destroy (void); /* destroy the default loop */
381/* this needs to be called after fork, to duplicate the default loop */ 494/* this needs to be called after fork, to duplicate the default loop */
382/* if you create alternative loops you have to call ev_loop_fork on them */ 495/* if you create alternative loops you have to call ev_loop_fork on them */
383/* you can call it in either the parent or the child */ 496/* you can call it in either the parent or the child */
384/* you can actually call it at any time, anywhere :) */ 497/* you can actually call it at any time, anywhere :) */
385void ev_default_fork (void); 498void ev_default_fork (void);
386 499
387unsigned int ev_backend (EV_P); 500unsigned int ev_backend (EV_P); /* backend in use by loop */
501unsigned int ev_loop_count (EV_P); /* number of loop iterations */
502unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
503void ev_loop_verify (EV_P); /* abort if loop data corrupted */
504
505#if EV_WALK_ENABLE
506/* 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, */
508/* but do nothing else with the loop */
509void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
388#endif 510#endif
511
512#endif /* prototypes */
389 513
390#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 514#define EVLOOP_NONBLOCK 1 /* do not block/wait */
391#define EVLOOP_ONESHOT 2 /* block *once* only */ 515#define EVLOOP_ONESHOT 2 /* block *once* only */
392#define EVUNLOOP_CANCEL 0 /* undo unloop */ 516#define EVUNLOOP_CANCEL 0 /* undo unloop */
393#define EVUNLOOP_ONE 1 /* unloop once */ 517#define EVUNLOOP_ONE 1 /* unloop once */
394#define EVUNLOOP_ALL 2 /* unloop all loops */ 518#define EVUNLOOP_ALL 2 /* unloop all loops */
395 519
396#if EV_PROTOTYPES 520#if EV_PROTOTYPES
397void ev_loop (EV_P_ int flags); 521void ev_loop (EV_P_ int flags);
398void 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 */ 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 */
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 */
399 526
400/* 527/*
401 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 528 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
402 * keeps one reference. if you have a long-runing watcher you never unregister that 529 * keeps one reference. if you have a long-runing watcher you never unregister that
403 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 530 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
404 */ 531 */
405void ev_ref (EV_P); 532void ev_ref (EV_P);
406void ev_unref (EV_P); 533void ev_unref (EV_P);
407 534
535/*
536 * stop/start the timer handling.
537 */
538void ev_suspend (EV_P);
539void ev_resume (EV_P);
540
541/*
408/* convinience function, wait for a single event, without registering an event watcher */ 542 * convenience function, wait for a single event, without registering an event watcher
409/* if timeout is < 0, do wait indefinitely */ 543 * if timeout is < 0, do wait indefinitely
544 */
410void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 545void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
411#endif 546#endif
412 547
413/* these may evaluate ev multiple times, and the other arguments at most once */ 548/* these may evaluate ev multiple times, and the other arguments at most once */
414/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 549/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
415#define ev_init(ev,cb_) do { \ 550#define ev_init(ev,cb_) do { \
416 ((ev_watcher *)(void *)(ev))->active = \ 551 ((ev_watcher *)(void *)(ev))->active = \
417 ((ev_watcher *)(void *)(ev))->pending = \ 552 ((ev_watcher *)(void *)(ev))->pending = \
418 ((ev_watcher *)(void *)(ev))->priority = 0; \ 553 ((ev_watcher *)(void *)(ev))->priority = 0; \
419 ev_set_cb ((ev), cb_); \ 554 ev_set_cb ((ev), cb_); \
420} while (0) 555} while (0)
421 556
422#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 557#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
423#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 558#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
424#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 559#define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0)
425#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 560#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
426#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 561#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
427#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); } while (0) 562#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
428#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 563#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
429#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 564#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
430#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 565#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
431#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0) 566#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
432#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 567#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)
433 569
434#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 570#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
435#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 571#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
436#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } 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)
437#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 573#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
438#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 574#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
439#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0) 575#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
440#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 576#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
441#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 577#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
442#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 578#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
443#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0) 579#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
444#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 580#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
581#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
445 582
446#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 583#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
447#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 584#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
448 585
449#define ev_priority(ev) ((ev_watcher *)(void *)(ev))->priority /* rw */ 586#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
450#define ev_cb(ev) (ev)->cb /* rw */ 587#define ev_cb(ev) (ev)->cb /* rw */
451#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) 588#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri)
589
590#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)
452 591
453#ifndef ev_set_cb 592#ifndef ev_set_cb
454# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 593# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
455#endif 594#endif
456 595
457/* stopping (enabling, adding) a watcher does nothing if it is already running */ 596/* stopping (enabling, adding) a watcher does nothing if it is already running */
458/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 597/* stopping (disabling, deleting) a watcher does nothing unless its already running */
459#if EV_PROTOTYPES 598#if EV_PROTOTYPES
461/* feeds an event into a watcher as if the event actually occured */ 600/* feeds an event into a watcher as if the event actually occured */
462/* accepts any ev_watcher type */ 601/* accepts any ev_watcher type */
463void ev_feed_event (EV_P_ void *w, int revents); 602void ev_feed_event (EV_P_ void *w, int revents);
464void ev_feed_fd_event (EV_P_ int fd, int revents); 603void ev_feed_fd_event (EV_P_ int fd, int revents);
465void ev_feed_signal_event (EV_P_ int signum); 604void ev_feed_signal_event (EV_P_ int signum);
605void ev_invoke (EV_P_ void *w, int revents);
606int ev_clear_pending (EV_P_ void *w);
466 607
467void ev_io_start (EV_P_ ev_io *w); 608void ev_io_start (EV_P_ ev_io *w);
468void ev_io_stop (EV_P_ ev_io *w); 609void ev_io_stop (EV_P_ ev_io *w);
469 610
470void ev_timer_start (EV_P_ ev_timer *w); 611void ev_timer_start (EV_P_ ev_timer *w);
490void ev_stat_start (EV_P_ ev_stat *w); 631void ev_stat_start (EV_P_ ev_stat *w);
491void ev_stat_stop (EV_P_ ev_stat *w); 632void ev_stat_stop (EV_P_ ev_stat *w);
492void ev_stat_stat (EV_P_ ev_stat *w); 633void ev_stat_stat (EV_P_ ev_stat *w);
493# endif 634# endif
494 635
636# if EV_IDLE_ENABLE
495void ev_idle_start (EV_P_ ev_idle *w); 637void ev_idle_start (EV_P_ ev_idle *w);
496void ev_idle_stop (EV_P_ ev_idle *w); 638void ev_idle_stop (EV_P_ ev_idle *w);
639# endif
497 640
498void ev_prepare_start (EV_P_ ev_prepare *w); 641void ev_prepare_start (EV_P_ ev_prepare *w);
499void ev_prepare_stop (EV_P_ ev_prepare *w); 642void ev_prepare_stop (EV_P_ ev_prepare *w);
500 643
501void ev_check_start (EV_P_ ev_check *w); 644void ev_check_start (EV_P_ ev_check *w);
511void ev_embed_start (EV_P_ ev_embed *w); 654void ev_embed_start (EV_P_ ev_embed *w);
512void ev_embed_stop (EV_P_ ev_embed *w); 655void ev_embed_stop (EV_P_ ev_embed *w);
513void ev_embed_sweep (EV_P_ ev_embed *w); 656void ev_embed_sweep (EV_P_ ev_embed *w);
514# endif 657# endif
515 658
659# if EV_ASYNC_ENABLE
660void ev_async_start (EV_P_ ev_async *w);
661void ev_async_stop (EV_P_ ev_async *w);
662void ev_async_send (EV_P_ ev_async *w);
663# endif
664
516#endif 665#endif
517 666
518#ifdef __cplusplus 667#ifdef __cplusplus
519} 668}
520#endif 669#endif

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines