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

Comparing libev/ev.h (file contents):
Revision 1.75 by root, Wed Nov 28 17:32:24 2007 UTC vs.
Revision 1.114 by root, Wed Apr 15 19:35:53 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_ATOMIC_T
86# include <signal.h>
87# define EV_ATOMIC_T sig_atomic_t volatile
88#endif
89
67/*****************************************************************************/ 90/*****************************************************************************/
68 91
69#if EV_STAT_ENABLE 92#if EV_STAT_ENABLE
93# ifdef _WIN32
94# include <time.h>
95# include <sys/types.h>
96# endif
70# include <sys/stat.h> 97# include <sys/stat.h>
71#endif 98#endif
72 99
73/* support multiple event loops? */ 100/* support multiple event loops? */
74#if EV_MULTIPLICITY 101#if EV_MULTIPLICITY
75struct ev_loop; 102struct ev_loop;
76# define EV_P struct ev_loop *loop 103# define EV_P struct ev_loop *loop
77# define EV_P_ EV_P, 104# define EV_P_ EV_P,
78# define EV_A loop 105# define EV_A loop
79# define EV_A_ EV_A, 106# define EV_A_ EV_A,
107# define EV_DEFAULT_UC ev_default_loop_uc ()
108# define EV_DEFAULT_UC_ EV_DEFAULT_UC,
80# define EV_DEFAULT ev_default_loop (0) 109# define EV_DEFAULT ev_default_loop (0)
81# define EV_DEFAULT_ EV_DEFAULT, 110# define EV_DEFAULT_ EV_DEFAULT,
82#else 111#else
83# define EV_P void 112# define EV_P void
84# define EV_P_ 113# define EV_P_
85# define EV_A 114# define EV_A
86# define EV_A_ 115# define EV_A_
87# define EV_DEFAULT 116# define EV_DEFAULT
88# define EV_DEFAULT_ 117# define EV_DEFAULT_
89 118# define EV_DEFAULT_UC
119# define EV_DEFAULT_UC_
90# undef EV_EMBED_ENABLE 120# undef EV_EMBED_ENABLE
91#endif 121#endif
92 122
123#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
124# define EV_INLINE static inline
125#else
126# define EV_INLINE static
127#endif
128
129/*****************************************************************************/
130
93/* eventmask, revents, events... */ 131/* eventmask, revents, events... */
94#define EV_UNDEF -1L /* guaranteed to be invalid */ 132#define EV_UNDEF -1 /* guaranteed to be invalid */
95#define EV_NONE 0x00L /* no events */ 133#define EV_NONE 0x00 /* no events */
96#define EV_READ 0x01L /* ev_io detected read will not block */ 134#define EV_READ 0x01 /* ev_io detected read will not block */
97#define EV_WRITE 0x02L /* ev_io detected write will not block */ 135#define EV_WRITE 0x02 /* ev_io detected write will not block */
136#define EV__IOFDSET 0x80 /* internal use only */
137#define EV_IO EV_READ /* alias for type-detection */
98#define EV_TIMEOUT 0x00000100L /* timer timed out */ 138#define EV_TIMEOUT 0x00000100 /* timer timed out */
139#define EV_TIMER EV_TIMEOUT /* alias for type-detection */
99#define EV_PERIODIC 0x00000200L /* periodic timer timed out */ 140#define EV_PERIODIC 0x00000200 /* periodic timer timed out */
100#define EV_SIGNAL 0x00000400L /* signal was received */ 141#define EV_SIGNAL 0x00000400 /* signal was received */
101#define EV_CHILD 0x00000800L /* child/pid had status change */ 142#define EV_CHILD 0x00000800 /* child/pid had status change */
102#define EV_STAT 0x00001000L /* stat data changed */ 143#define EV_STAT 0x00001000 /* stat data changed */
103#define EV_IDLE 0x00002000L /* event loop is idling */ 144#define EV_IDLE 0x00002000 /* event loop is idling */
104#define EV_PREPARE 0x00004000L /* event loop about to poll */ 145#define EV_PREPARE 0x00004000 /* event loop about to poll */
105#define EV_CHECK 0x00008000L /* event loop finished poll */ 146#define EV_CHECK 0x00008000 /* event loop finished poll */
106#define EV_EMBED 0x00010000L /* embedded event loop needs sweep */ 147#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
107#define EV_FORK 0x00020000L /* event loop resumed in child */ 148#define EV_FORK 0x00020000 /* event loop resumed in child */
149#define EV_ASYNC 0x00040000 /* async intra-loop signal */
150#define EV_CUSTOM 0x01000000 /* for use by user code */
108#define EV_ERROR 0x80000000L /* sent when an error occurs */ 151#define EV_ERROR 0x80000000 /* sent when an error occurs */
109 152
110/* can be used to add custom fields to all watchers, while losing binary compatibility */ 153/* can be used to add custom fields to all watchers, while losing binary compatibility */
111#ifndef EV_COMMON 154#ifndef EV_COMMON
112# define EV_COMMON void *data; 155# define EV_COMMON void *data;
113#endif 156#endif
114#ifndef EV_PROTOTYPES 157#ifndef EV_PROTOTYPES
115# define EV_PROTOTYPES 1 158# define EV_PROTOTYPES 1
116#endif 159#endif
117 160
118#define EV_VERSION_MAJOR 1 161#define EV_VERSION_MAJOR 3
119#define EV_VERSION_MINOR 1 162#define EV_VERSION_MINOR 0
120 163
121#ifndef EV_CB_DECLARE 164#ifndef EV_CB_DECLARE
122# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 165# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
123#endif 166#endif
124#ifndef EV_CB_INVOKE 167#ifndef EV_CB_INVOKE
125# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) 168# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
126#endif 169#endif
127 170
128/* 171/*
129 * struct member types: 172 * struct member types:
130 * private: you can look at them, but not change them, and they might not mean anything to you. 173 * private: you may look at them, but not change them,
174 * and they might not mean anything to you.
131 * ro: can be read anytime, but only changed when the watcher isn't active 175 * 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 176 * rw: can be read and modified anytime, even when the watcher is active.
177 *
178 * some internal details that might be helpful for debugging:
179 *
180 * active is either 0, which means the watcher is not active,
181 * or the array index of the watcher (periodics, timers)
182 * or the array index + 1 (most other watchers)
183 * or simply 1 for watchers that aren't in some array.
184 * pending is either 0, in which case the watcher isn't,
185 * or the array index + 1 in the pendings array.
133 */ 186 */
134 187
135/* shared by all watchers */ 188/* shared by all watchers */
136#define EV_WATCHER(type) \ 189#define EV_WATCHER(type) \
137 int active; /* private */ \ 190 int active; /* private */ \
189/* revent EV_PERIODIC */ 242/* revent EV_PERIODIC */
190typedef struct ev_periodic 243typedef struct ev_periodic
191{ 244{
192 EV_WATCHER_TIME (ev_periodic) 245 EV_WATCHER_TIME (ev_periodic)
193 246
247 ev_tstamp offset; /* rw */
194 ev_tstamp interval; /* rw */ 248 ev_tstamp interval; /* rw */
195 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 249 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
196} ev_periodic; 250} ev_periodic;
197 251
198/* invoked when the given signal has been received */ 252/* invoked when the given signal has been received */
209/* does not support priorities */ 263/* does not support priorities */
210typedef struct ev_child 264typedef struct ev_child
211{ 265{
212 EV_WATCHER_LIST (ev_child) 266 EV_WATCHER_LIST (ev_child)
213 267
268 int flags; /* private */
214 int pid; /* ro */ 269 int pid; /* ro */
215 int rpid; /* rw, holds the received pid */ 270 int rpid; /* rw, holds the received pid */
216 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 271 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
217} ev_child; 272} ev_child;
218 273
238 293
239 int wd; /* wd for inotify, fd for kqueue */ 294 int wd; /* wd for inotify, fd for kqueue */
240} ev_stat; 295} ev_stat;
241#endif 296#endif
242 297
298#if EV_IDLE_ENABLE
243/* invoked when the nothing else needs to be done, keeps the process from blocking */ 299/* invoked when the nothing else needs to be done, keeps the process from blocking */
244/* revent EV_IDLE */ 300/* revent EV_IDLE */
245typedef struct ev_idle 301typedef struct ev_idle
246{ 302{
247 EV_WATCHER (ev_idle) 303 EV_WATCHER (ev_idle)
248} ev_idle; 304} ev_idle;
305#endif
249 306
250/* invoked for each run of the mainloop, just before the blocking call */ 307/* invoked for each run of the mainloop, just before the blocking call */
251/* you can still change events in any way you like */ 308/* you can still change events in any way you like */
252/* revent EV_PREPARE */ 309/* revent EV_PREPARE */
253typedef struct ev_prepare 310typedef struct ev_prepare
275/* the callback gets invoked when the event loop has handled events, and can be 0 */ 332/* the callback gets invoked when the event loop has handled events, and can be 0 */
276typedef struct ev_embed 333typedef struct ev_embed
277{ 334{
278 EV_WATCHER (ev_embed) 335 EV_WATCHER (ev_embed)
279 336
280 ev_io io; /* private */
281 struct ev_loop *loop; /* ro */ 337 struct ev_loop *other; /* ro */
338 ev_io io; /* private */
339 ev_prepare prepare; /* private */
340 ev_check check; /* unused */
341 ev_timer timer; /* unused */
342 ev_periodic periodic; /* unused */
343 ev_idle idle; /* unused */
344 ev_fork fork; /* private */
282} ev_embed; 345} ev_embed;
346#endif
347
348#if EV_ASYNC_ENABLE
349/* invoked when somebody calls ev_async_send on the watcher */
350/* revent EV_ASYNC */
351typedef struct ev_async
352{
353 EV_WATCHER (ev_async)
354
355 EV_ATOMIC_T sent; /* private */
356} ev_async;
357
358# define ev_async_pending(w) ((w)->sent + 0)
283#endif 359#endif
284 360
285/* the presence of this union forces similar struct layout */ 361/* the presence of this union forces similar struct layout */
286union ev_any_watcher 362union ev_any_watcher
287{ 363{
294 struct ev_signal signal; 370 struct ev_signal signal;
295 struct ev_child child; 371 struct ev_child child;
296#if EV_STAT_ENABLE 372#if EV_STAT_ENABLE
297 struct ev_stat stat; 373 struct ev_stat stat;
298#endif 374#endif
375#if EV_IDLE_ENABLE
299 struct ev_idle idle; 376 struct ev_idle idle;
377#endif
300 struct ev_prepare prepare; 378 struct ev_prepare prepare;
301 struct ev_check check; 379 struct ev_check check;
302#if EV_FORK_ENABLE 380#if EV_FORK_ENABLE
303 struct ev_fork fork; 381 struct ev_fork fork;
304#endif 382#endif
305#if EV_EMBED_ENABLE 383#if EV_EMBED_ENABLE
306 struct ev_embed embed; 384 struct ev_embed embed;
307#endif 385#endif
386#if EV_ASYNC_ENABLE
387 struct ev_async async;
388#endif
308}; 389};
309 390
310/* bits for ev_default_loop and ev_loop_new */ 391/* bits for ev_default_loop and ev_loop_new */
311/* the default */ 392/* the default */
312#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */ 393#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
313/* flag bits */ 394/* flag bits */
314#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */ 395#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
396#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
315/* method bits to be ored together */ 397/* method bits to be ored together */
316#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */ 398#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
317#define EVBACKEND_POLL 0x00000002UL /* !win */ 399#define EVBACKEND_POLL 0x00000002U /* !win */
318#define EVBACKEND_EPOLL 0x00000004UL /* linux */ 400#define EVBACKEND_EPOLL 0x00000004U /* linux */
319#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */ 401#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
320#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */ 402#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
321#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */ 403#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
322 404
323#if EV_PROTOTYPES 405#if EV_PROTOTYPES
324int ev_version_major (void); 406int ev_version_major (void);
325int ev_version_minor (void); 407int ev_version_minor (void);
326 408
327unsigned int ev_supported_backends (void); 409unsigned int ev_supported_backends (void);
328unsigned int ev_recommended_backends (void); 410unsigned int ev_recommended_backends (void);
329unsigned int ev_embeddable_backends (void); 411unsigned int ev_embeddable_backends (void);
330 412
331ev_tstamp ev_time (void); 413ev_tstamp ev_time (void);
414void ev_sleep (ev_tstamp delay); /* sleep for a while */
332 415
333/* Sets the allocation function to use, works like realloc. 416/* Sets the allocation function to use, works like realloc.
334 * It is used to allocate and free memory. 417 * It is used to allocate and free memory.
335 * If it returns zero when memory needs to be allocated, the library might abort 418 * If it returns zero when memory needs to be allocated, the library might abort
336 * or take some potentially destructive action. 419 * or take some potentially destructive action.
342 * retryable syscall error 425 * retryable syscall error
343 * (such as failed select, poll, epoll_wait) 426 * (such as failed select, poll, epoll_wait)
344 */ 427 */
345void ev_set_syserr_cb (void (*cb)(const char *msg)); 428void ev_set_syserr_cb (void (*cb)(const char *msg));
346 429
347# if EV_MULTIPLICITY 430#if EV_MULTIPLICITY
431EV_INLINE struct ev_loop *
432ev_default_loop_uc (void)
433{
434 extern struct ev_loop *ev_default_loop_ptr;
435
436 return ev_default_loop_ptr;
437}
438
348/* the default loop is the only one that handles signals and child watchers */ 439/* the default loop is the only one that handles signals and child watchers */
349/* you can call this as often as you like */ 440/* you can call this as often as you like */
350static struct ev_loop * 441EV_INLINE struct ev_loop *
351ev_default_loop (unsigned int flags) 442ev_default_loop (unsigned int flags)
352{ 443{
353 extern struct ev_loop *ev_default_loop_ptr; 444 struct ev_loop *loop = ev_default_loop_uc ();
445
446 if (!loop)
447 {
354 extern struct ev_loop *ev_default_loop_init (unsigned int flags); 448 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
355 449
356 if (!ev_default_loop_ptr)
357 ev_default_loop_init (flags); 450 loop = ev_default_loop_init (flags);
451 }
358 452
359 return ev_default_loop_ptr; 453 return loop;
360} 454}
361 455
362/* create and destroy alternative loops that don't handle signals */ 456/* create and destroy alternative loops that don't handle signals */
363struct ev_loop *ev_loop_new (unsigned int flags); 457struct ev_loop *ev_loop_new (unsigned int flags);
364void ev_loop_destroy (EV_P); 458void ev_loop_destroy (EV_P);
365void ev_loop_fork (EV_P); 459void ev_loop_fork (EV_P);
460void ev_loop_verify (EV_P);
366 461
367ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 462ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
463void ev_now_update (EV_P);
368 464
369# else 465#else
370 466
371int ev_default_loop (unsigned int flags); /* returns true when successful */ 467int ev_default_loop (unsigned int flags); /* returns true when successful */
372 468
373static ev_tstamp 469EV_INLINE ev_tstamp
374ev_now (void) 470ev_now (void)
375{ 471{
376 extern ev_tstamp ev_rt_now; 472 extern ev_tstamp ev_rt_now;
377 473
378 return ev_rt_now; 474 return ev_rt_now;
379} 475}
476#endif /* multiplicity */
477
478EV_INLINE int
479ev_is_default_loop (EV_P)
480{
481#if EV_MULTIPLICITY
482 extern struct ev_loop *ev_default_loop_ptr;
483
484 return !!(EV_A == ev_default_loop_ptr);
485#else
486 return 1;
380# endif 487#endif
488}
381 489
382void ev_default_destroy (void); /* destroy the default loop */ 490void ev_default_destroy (void); /* destroy the default loop */
383/* this needs to be called after fork, to duplicate the default loop */ 491/* this needs to be called after fork, to duplicate the default loop */
384/* if you create alternative loops you have to call ev_loop_fork on them */ 492/* if you create alternative loops you have to call ev_loop_fork on them */
385/* you can call it in either the parent or the child */ 493/* you can call it in either the parent or the child */
386/* you can actually call it at any time, anywhere :) */ 494/* you can actually call it at any time, anywhere :) */
387void ev_default_fork (void); 495void ev_default_fork (void);
388 496
389unsigned int ev_backend (EV_P); 497#if 0
498/* walk (almost) all watchers in the loop of a given type, invoking the */
499/* callback on every such watcher. The callback might stop the watcher, */
500/* but do nothing else with the loop */
501void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
390#endif 502#endif
503
504unsigned int ev_backend (EV_P); /* backend in use by loop */
505unsigned int ev_loop_count (EV_P); /* number of loop iterations */
506#endif /* prototypes */
391 507
392#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 508#define EVLOOP_NONBLOCK 1 /* do not block/wait */
393#define EVLOOP_ONESHOT 2 /* block *once* only */ 509#define EVLOOP_ONESHOT 2 /* block *once* only */
394#define EVUNLOOP_CANCEL 0 /* undo unloop */ 510#define EVUNLOOP_CANCEL 0 /* undo unloop */
395#define EVUNLOOP_ONE 1 /* unloop once */ 511#define EVUNLOOP_ONE 1 /* unloop once */
396#define EVUNLOOP_ALL 2 /* unloop all loops */ 512#define EVUNLOOP_ALL 2 /* unloop all loops */
397 513
398#if EV_PROTOTYPES 514#if EV_PROTOTYPES
399void ev_loop (EV_P_ int flags); 515void ev_loop (EV_P_ int flags);
400void 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 */ 516void 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 */
517
518void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
519void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
401 520
402/* 521/*
403 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 522 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
404 * keeps one reference. if you have a long-runing watcher you never unregister that 523 * keeps one reference. if you have a long-runing watcher you never unregister that
405 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 524 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
406 */ 525 */
407void ev_ref (EV_P); 526void ev_ref (EV_P);
408void ev_unref (EV_P); 527void ev_unref (EV_P);
409 528
529/*
530 * stop/start the timer handling.
531 */
532void ev_suspend (EV_P);
533void ev_resume (EV_P);
534
535/*
410/* convinience function, wait for a single event, without registering an event watcher */ 536 * convenience function, wait for a single event, without registering an event watcher
411/* if timeout is < 0, do wait indefinitely */ 537 * if timeout is < 0, do wait indefinitely
538 */
412void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 539void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
413#endif 540#endif
414 541
415/* these may evaluate ev multiple times, and the other arguments at most once */ 542/* these may evaluate ev multiple times, and the other arguments at most once */
416/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 543/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
417#define ev_init(ev,cb_) do { \ 544#define ev_init(ev,cb_) do { \
418 ((ev_watcher *)(void *)(ev))->active = \ 545 ((ev_watcher *)(void *)(ev))->active = \
419 ((ev_watcher *)(void *)(ev))->pending = \ 546 ((ev_watcher *)(void *)(ev))->pending = \
420 ((ev_watcher *)(void *)(ev))->priority = 0; \ 547 ((ev_watcher *)(void *)(ev))->priority = 0; \
421 ev_set_cb ((ev), cb_); \ 548 ev_set_cb ((ev), cb_); \
422} while (0) 549} while (0)
423 550
424#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 551#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
425#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 552#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
426#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 553#define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0)
427#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 554#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
428#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 555#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
429#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0) 556#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
430#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 557#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
431#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 558#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
432#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 559#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
433#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0) 560#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
434#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 561#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
562#define ev_async_set(ev) do { (ev)->sent = 0; } while (0)
435 563
436#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 564#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
437#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 565#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
438#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 566#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
439#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 567#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
440#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 568#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
441#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0) 569#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
442#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 570#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
443#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 571#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
444#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 572#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
445#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0) 573#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
446#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 574#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
575#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
447 576
448#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 577#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
449#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 578#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
450 579
451#define ev_priority(ev) ((ev_watcher *)(void *)(ev))->priority /* rw */ 580#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
452#define ev_cb(ev) (ev)->cb /* rw */ 581#define ev_cb(ev) (ev)->cb /* rw */
453#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) 582#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri)
583
584#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)
454 585
455#ifndef ev_set_cb 586#ifndef ev_set_cb
456# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 587# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
457#endif 588#endif
458 589
459/* stopping (enabling, adding) a watcher does nothing if it is already running */ 590/* stopping (enabling, adding) a watcher does nothing if it is already running */
460/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 591/* stopping (disabling, deleting) a watcher does nothing unless its already running */
461#if EV_PROTOTYPES 592#if EV_PROTOTYPES
463/* feeds an event into a watcher as if the event actually occured */ 594/* feeds an event into a watcher as if the event actually occured */
464/* accepts any ev_watcher type */ 595/* accepts any ev_watcher type */
465void ev_feed_event (EV_P_ void *w, int revents); 596void ev_feed_event (EV_P_ void *w, int revents);
466void ev_feed_fd_event (EV_P_ int fd, int revents); 597void ev_feed_fd_event (EV_P_ int fd, int revents);
467void ev_feed_signal_event (EV_P_ int signum); 598void ev_feed_signal_event (EV_P_ int signum);
599void ev_invoke (EV_P_ void *w, int revents);
600int ev_clear_pending (EV_P_ void *w);
468 601
469void ev_io_start (EV_P_ ev_io *w); 602void ev_io_start (EV_P_ ev_io *w);
470void ev_io_stop (EV_P_ ev_io *w); 603void ev_io_stop (EV_P_ ev_io *w);
471 604
472void ev_timer_start (EV_P_ ev_timer *w); 605void ev_timer_start (EV_P_ ev_timer *w);
492void ev_stat_start (EV_P_ ev_stat *w); 625void ev_stat_start (EV_P_ ev_stat *w);
493void ev_stat_stop (EV_P_ ev_stat *w); 626void ev_stat_stop (EV_P_ ev_stat *w);
494void ev_stat_stat (EV_P_ ev_stat *w); 627void ev_stat_stat (EV_P_ ev_stat *w);
495# endif 628# endif
496 629
630# if EV_IDLE_ENABLE
497void ev_idle_start (EV_P_ ev_idle *w); 631void ev_idle_start (EV_P_ ev_idle *w);
498void ev_idle_stop (EV_P_ ev_idle *w); 632void ev_idle_stop (EV_P_ ev_idle *w);
633# endif
499 634
500void ev_prepare_start (EV_P_ ev_prepare *w); 635void ev_prepare_start (EV_P_ ev_prepare *w);
501void ev_prepare_stop (EV_P_ ev_prepare *w); 636void ev_prepare_stop (EV_P_ ev_prepare *w);
502 637
503void ev_check_start (EV_P_ ev_check *w); 638void ev_check_start (EV_P_ ev_check *w);
513void ev_embed_start (EV_P_ ev_embed *w); 648void ev_embed_start (EV_P_ ev_embed *w);
514void ev_embed_stop (EV_P_ ev_embed *w); 649void ev_embed_stop (EV_P_ ev_embed *w);
515void ev_embed_sweep (EV_P_ ev_embed *w); 650void ev_embed_sweep (EV_P_ ev_embed *w);
516# endif 651# endif
517 652
653# if EV_ASYNC_ENABLE
654void ev_async_start (EV_P_ ev_async *w);
655void ev_async_stop (EV_P_ ev_async *w);
656void ev_async_send (EV_P_ ev_async *w);
657# endif
658
518#endif 659#endif
519 660
520#ifdef __cplusplus 661#ifdef __cplusplus
521} 662}
522#endif 663#endif

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines