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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines