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.123 by root, Wed Jul 15 16:58: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_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 7
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 */
191
192#if EV_MINPRI == EV_MAXPRI
193# define EV_DECL_PRIORITY
194#else
195# define EV_DECL_PRIORITY int priority;
196#endif
134 197
135/* shared by all watchers */ 198/* shared by all watchers */
136#define EV_WATCHER(type) \ 199#define EV_WATCHER(type) \
137 int active; /* private */ \ 200 int active; /* private */ \
138 int pending; /* private */ \ 201 int pending; /* private */ \
139 int priority; /* private */ \ 202 EV_DECL_PRIORITY /* private */ \
140 EV_COMMON /* rw */ \ 203 EV_COMMON /* rw */ \
141 EV_CB_DECLARE (type) /* private */ 204 EV_CB_DECLARE (type) /* private */
142 205
143#define EV_WATCHER_LIST(type) \ 206#define EV_WATCHER_LIST(type) \
144 EV_WATCHER (type) \ 207 EV_WATCHER (type) \
189/* revent EV_PERIODIC */ 252/* revent EV_PERIODIC */
190typedef struct ev_periodic 253typedef struct ev_periodic
191{ 254{
192 EV_WATCHER_TIME (ev_periodic) 255 EV_WATCHER_TIME (ev_periodic)
193 256
257 ev_tstamp offset; /* rw */
194 ev_tstamp interval; /* rw */ 258 ev_tstamp interval; /* rw */
195 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 259 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
196} ev_periodic; 260} ev_periodic;
197 261
198/* invoked when the given signal has been received */ 262/* invoked when the given signal has been received */
209/* does not support priorities */ 273/* does not support priorities */
210typedef struct ev_child 274typedef struct ev_child
211{ 275{
212 EV_WATCHER_LIST (ev_child) 276 EV_WATCHER_LIST (ev_child)
213 277
278 int flags; /* private */
214 int pid; /* ro */ 279 int pid; /* ro */
215 int rpid; /* rw, holds the received pid */ 280 int rpid; /* rw, holds the received pid */
216 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 281 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
217} ev_child; 282} ev_child;
218 283
238 303
239 int wd; /* wd for inotify, fd for kqueue */ 304 int wd; /* wd for inotify, fd for kqueue */
240} ev_stat; 305} ev_stat;
241#endif 306#endif
242 307
308#if EV_IDLE_ENABLE
243/* invoked when the nothing else needs to be done, keeps the process from blocking */ 309/* invoked when the nothing else needs to be done, keeps the process from blocking */
244/* revent EV_IDLE */ 310/* revent EV_IDLE */
245typedef struct ev_idle 311typedef struct ev_idle
246{ 312{
247 EV_WATCHER (ev_idle) 313 EV_WATCHER (ev_idle)
248} ev_idle; 314} ev_idle;
315#endif
249 316
250/* invoked for each run of the mainloop, just before the blocking call */ 317/* invoked for each run of the mainloop, just before the blocking call */
251/* you can still change events in any way you like */ 318/* you can still change events in any way you like */
252/* revent EV_PREPARE */ 319/* revent EV_PREPARE */
253typedef struct ev_prepare 320typedef struct ev_prepare
275/* the callback gets invoked when the event loop has handled events, and can be 0 */ 342/* the callback gets invoked when the event loop has handled events, and can be 0 */
276typedef struct ev_embed 343typedef struct ev_embed
277{ 344{
278 EV_WATCHER (ev_embed) 345 EV_WATCHER (ev_embed)
279 346
280 ev_io io; /* private */
281 struct ev_loop *loop; /* ro */ 347 struct ev_loop *other; /* ro */
348 ev_io io; /* private */
349 ev_prepare prepare; /* private */
350 ev_check check; /* unused */
351 ev_timer timer; /* unused */
352 ev_periodic periodic; /* unused */
353 ev_idle idle; /* unused */
354 ev_fork fork; /* private */
282} ev_embed; 355} ev_embed;
356#endif
357
358#if EV_ASYNC_ENABLE
359/* invoked when somebody calls ev_async_send on the watcher */
360/* revent EV_ASYNC */
361typedef struct ev_async
362{
363 EV_WATCHER (ev_async)
364
365 EV_ATOMIC_T sent; /* private */
366} ev_async;
367
368# define ev_async_pending(w) ((w)->sent + 0)
283#endif 369#endif
284 370
285/* the presence of this union forces similar struct layout */ 371/* the presence of this union forces similar struct layout */
286union ev_any_watcher 372union ev_any_watcher
287{ 373{
294 struct ev_signal signal; 380 struct ev_signal signal;
295 struct ev_child child; 381 struct ev_child child;
296#if EV_STAT_ENABLE 382#if EV_STAT_ENABLE
297 struct ev_stat stat; 383 struct ev_stat stat;
298#endif 384#endif
385#if EV_IDLE_ENABLE
299 struct ev_idle idle; 386 struct ev_idle idle;
387#endif
300 struct ev_prepare prepare; 388 struct ev_prepare prepare;
301 struct ev_check check; 389 struct ev_check check;
302#if EV_FORK_ENABLE 390#if EV_FORK_ENABLE
303 struct ev_fork fork; 391 struct ev_fork fork;
304#endif 392#endif
305#if EV_EMBED_ENABLE 393#if EV_EMBED_ENABLE
306 struct ev_embed embed; 394 struct ev_embed embed;
307#endif 395#endif
396#if EV_ASYNC_ENABLE
397 struct ev_async async;
398#endif
308}; 399};
309 400
310/* bits for ev_default_loop and ev_loop_new */ 401/* bits for ev_default_loop and ev_loop_new */
311/* the default */ 402/* the default */
312#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */ 403#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
313/* flag bits */ 404/* flag bits */
314#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */ 405#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
406#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
315/* method bits to be ored together */ 407/* method bits to be ored together */
316#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */ 408#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
317#define EVBACKEND_POLL 0x00000002UL /* !win */ 409#define EVBACKEND_POLL 0x00000002U /* !win */
318#define EVBACKEND_EPOLL 0x00000004UL /* linux */ 410#define EVBACKEND_EPOLL 0x00000004U /* linux */
319#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */ 411#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
320#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */ 412#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
321#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */ 413#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
322 414
323#if EV_PROTOTYPES 415#if EV_PROTOTYPES
324int ev_version_major (void); 416int ev_version_major (void);
325int ev_version_minor (void); 417int ev_version_minor (void);
326 418
327unsigned int ev_supported_backends (void); 419unsigned int ev_supported_backends (void);
328unsigned int ev_recommended_backends (void); 420unsigned int ev_recommended_backends (void);
329unsigned int ev_embeddable_backends (void); 421unsigned int ev_embeddable_backends (void);
330 422
331ev_tstamp ev_time (void); 423ev_tstamp ev_time (void);
424void ev_sleep (ev_tstamp delay); /* sleep for a while */
332 425
333/* Sets the allocation function to use, works like realloc. 426/* Sets the allocation function to use, works like realloc.
334 * It is used to allocate and free memory. 427 * It is used to allocate and free memory.
335 * If it returns zero when memory needs to be allocated, the library might abort 428 * If it returns zero when memory needs to be allocated, the library might abort
336 * or take some potentially destructive action. 429 * or take some potentially destructive action.
342 * retryable syscall error 435 * retryable syscall error
343 * (such as failed select, poll, epoll_wait) 436 * (such as failed select, poll, epoll_wait)
344 */ 437 */
345void ev_set_syserr_cb (void (*cb)(const char *msg)); 438void ev_set_syserr_cb (void (*cb)(const char *msg));
346 439
347# if EV_MULTIPLICITY 440#if EV_MULTIPLICITY
441EV_INLINE struct ev_loop *
442ev_default_loop_uc (void)
443{
444 extern struct ev_loop *ev_default_loop_ptr;
445
446 return ev_default_loop_ptr;
447}
448
348/* the default loop is the only one that handles signals and child watchers */ 449/* the default loop is the only one that handles signals and child watchers */
349/* you can call this as often as you like */ 450/* you can call this as often as you like */
350static struct ev_loop * 451EV_INLINE struct ev_loop *
351ev_default_loop (unsigned int flags) 452ev_default_loop (unsigned int flags)
352{ 453{
353 extern struct ev_loop *ev_default_loop_ptr; 454 struct ev_loop *loop = ev_default_loop_uc ();
455
456 if (!loop)
457 {
354 extern struct ev_loop *ev_default_loop_init (unsigned int flags); 458 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
355 459
356 if (!ev_default_loop_ptr)
357 ev_default_loop_init (flags); 460 loop = ev_default_loop_init (flags);
461 }
358 462
359 return ev_default_loop_ptr; 463 return loop;
360} 464}
361 465
362/* create and destroy alternative loops that don't handle signals */ 466/* create and destroy alternative loops that don't handle signals */
363struct ev_loop *ev_loop_new (unsigned int flags); 467struct ev_loop *ev_loop_new (unsigned int flags);
364void ev_loop_destroy (EV_P); 468void ev_loop_destroy (EV_P);
365void ev_loop_fork (EV_P); 469void ev_loop_fork (EV_P);
366 470
367ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 471ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
368 472
369# else 473#else
370 474
371int ev_default_loop (unsigned int flags); /* returns true when successful */ 475int ev_default_loop (unsigned int flags); /* returns true when successful */
372 476
373static ev_tstamp 477EV_INLINE ev_tstamp
374ev_now (void) 478ev_now (void)
375{ 479{
376 extern ev_tstamp ev_rt_now; 480 extern ev_tstamp ev_rt_now;
377 481
378 return ev_rt_now; 482 return ev_rt_now;
379} 483}
484#endif /* multiplicity */
485
486EV_INLINE int
487ev_is_default_loop (EV_P)
488{
489#if EV_MULTIPLICITY
490 extern struct ev_loop *ev_default_loop_ptr;
491
492 return !!(EV_A == ev_default_loop_ptr);
493#else
494 return 1;
380# endif 495#endif
496}
381 497
382void ev_default_destroy (void); /* destroy the default loop */ 498void ev_default_destroy (void); /* destroy the default loop */
383/* this needs to be called after fork, to duplicate the default loop */ 499/* 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 */ 500/* 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 */ 501/* you can call it in either the parent or the child */
386/* you can actually call it at any time, anywhere :) */ 502/* you can actually call it at any time, anywhere :) */
387void ev_default_fork (void); 503void ev_default_fork (void);
388 504
389unsigned int ev_backend (EV_P); 505unsigned int ev_backend (EV_P); /* backend in use by loop */
506
507void ev_now_update (EV_P); /* update event loop time */
508
509#if EV_WALK_ENABLE
510/* walk (almost) all watchers in the loop of a given type, invoking the */
511/* callback on every such watcher. The callback might stop the watcher, */
512/* but do nothing else with the loop */
513void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
390#endif 514#endif
515
516#endif /* prototypes */
391 517
392#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 518#define EVLOOP_NONBLOCK 1 /* do not block/wait */
393#define EVLOOP_ONESHOT 2 /* block *once* only */ 519#define EVLOOP_ONESHOT 2 /* block *once* only */
394#define EVUNLOOP_CANCEL 0 /* undo unloop */ 520#define EVUNLOOP_CANCEL 0 /* undo unloop */
395#define EVUNLOOP_ONE 1 /* unloop once */ 521#define EVUNLOOP_ONE 1 /* unloop once */
399void ev_loop (EV_P_ int flags); 525void 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 */ 526void 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 */
401 527
402/* 528/*
403 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 529 * 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 530 * keeps one reference. if you have a long-running watcher you never unregister that
405 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 531 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
406 */ 532 */
407void ev_ref (EV_P); 533void ev_ref (EV_P);
408void ev_unref (EV_P); 534void ev_unref (EV_P);
409 535
536/*
410/* convinience function, wait for a single event, without registering an event watcher */ 537 * convenience function, wait for a single event, without registering an event watcher
411/* if timeout is < 0, do wait indefinitely */ 538 * if timeout is < 0, do wait indefinitely
539 */
412void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 540void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
541
542# if EV_MINIMAL < 2
543unsigned int ev_loop_count (EV_P); /* number of loop iterations */
544unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
545void ev_loop_verify (EV_P); /* abort if loop data corrupted */
546
547void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
548void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
549
550/* advanced stuff for threading etc. support, see docs */
551void ev_set_userdata (EV_P_ void *data);
552void *ev_userdata (EV_P);
553void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
554void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
555
556unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
557void ev_invoke_pending (EV_P); /* invoke all pending watchers */
558
559/*
560 * stop/start the timer handling.
561 */
562void ev_suspend (EV_P);
563void ev_resume (EV_P);
564#endif
565
413#endif 566#endif
414 567
415/* these may evaluate ev multiple times, and the other arguments at most once */ 568/* 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 */ 569/* 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 { \ 570#define ev_init(ev,cb_) do { \
418 ((ev_watcher *)(void *)(ev))->active = \ 571 ((ev_watcher *)(void *)(ev))->active = \
419 ((ev_watcher *)(void *)(ev))->pending = \ 572 ((ev_watcher *)(void *)(ev))->pending = 0; \
420 ((ev_watcher *)(void *)(ev))->priority = 0; \ 573 ev_set_priority ((ev), 0); \
421 ev_set_cb ((ev), cb_); \ 574 ev_set_cb ((ev), cb_); \
422} while (0) 575} while (0)
423 576
424#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 577#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) 578#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) 579#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) 580#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) 581#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) 582#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 */ 583#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 */ 584#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 */ 585#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) 586#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 */ 587#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
588#define ev_async_set(ev) do { (ev)->sent = 0; } while (0)
435 589
436#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 590#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) 591#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) 592#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) 593#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) 594#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) 595#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) 596#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) 597#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) 598#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) 599#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) 600#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
601#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
447 602
448#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 603#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 */ 604#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
450 605
451#define ev_priority(ev) ((ev_watcher *)(void *)(ev))->priority /* rw */
452#define ev_cb(ev) (ev)->cb /* rw */ 606#define ev_cb(ev) (ev)->cb /* rw */
607
608#if EV_MINPRI == EV_MAXPRI
609# define ev_priority(ev) ((ev), EV_MINPRI)
453#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) 610# define ev_set_priority(ev,pri) ((ev), (pri))
611#else
612# define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
613# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
614#endif
615
616#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)
454 617
455#ifndef ev_set_cb 618#ifndef ev_set_cb
456# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 619# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
457#endif 620#endif
458 621
459/* stopping (enabling, adding) a watcher does nothing if it is already running */ 622/* stopping (enabling, adding) a watcher does nothing if it is already running */
460/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 623/* stopping (disabling, deleting) a watcher does nothing unless its already running */
461#if EV_PROTOTYPES 624#if EV_PROTOTYPES
463/* feeds an event into a watcher as if the event actually occured */ 626/* feeds an event into a watcher as if the event actually occured */
464/* accepts any ev_watcher type */ 627/* accepts any ev_watcher type */
465void ev_feed_event (EV_P_ void *w, int revents); 628void ev_feed_event (EV_P_ void *w, int revents);
466void ev_feed_fd_event (EV_P_ int fd, int revents); 629void ev_feed_fd_event (EV_P_ int fd, int revents);
467void ev_feed_signal_event (EV_P_ int signum); 630void ev_feed_signal_event (EV_P_ int signum);
631void ev_invoke (EV_P_ void *w, int revents);
632int ev_clear_pending (EV_P_ void *w);
468 633
469void ev_io_start (EV_P_ ev_io *w); 634void ev_io_start (EV_P_ ev_io *w);
470void ev_io_stop (EV_P_ ev_io *w); 635void ev_io_stop (EV_P_ ev_io *w);
471 636
472void ev_timer_start (EV_P_ ev_timer *w); 637void ev_timer_start (EV_P_ ev_timer *w);
473void ev_timer_stop (EV_P_ ev_timer *w); 638void ev_timer_stop (EV_P_ ev_timer *w);
474/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 639/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
475void ev_timer_again (EV_P_ ev_timer *w); 640void ev_timer_again (EV_P_ ev_timer *w);
641/* return remaining time */
642ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
476 643
477#if EV_PERIODIC_ENABLE 644#if EV_PERIODIC_ENABLE
478void ev_periodic_start (EV_P_ ev_periodic *w); 645void ev_periodic_start (EV_P_ ev_periodic *w);
479void ev_periodic_stop (EV_P_ ev_periodic *w); 646void ev_periodic_stop (EV_P_ ev_periodic *w);
480void ev_periodic_again (EV_P_ ev_periodic *w); 647void ev_periodic_again (EV_P_ ev_periodic *w);
492void ev_stat_start (EV_P_ ev_stat *w); 659void ev_stat_start (EV_P_ ev_stat *w);
493void ev_stat_stop (EV_P_ ev_stat *w); 660void ev_stat_stop (EV_P_ ev_stat *w);
494void ev_stat_stat (EV_P_ ev_stat *w); 661void ev_stat_stat (EV_P_ ev_stat *w);
495# endif 662# endif
496 663
664# if EV_IDLE_ENABLE
497void ev_idle_start (EV_P_ ev_idle *w); 665void ev_idle_start (EV_P_ ev_idle *w);
498void ev_idle_stop (EV_P_ ev_idle *w); 666void ev_idle_stop (EV_P_ ev_idle *w);
667# endif
499 668
500void ev_prepare_start (EV_P_ ev_prepare *w); 669void ev_prepare_start (EV_P_ ev_prepare *w);
501void ev_prepare_stop (EV_P_ ev_prepare *w); 670void ev_prepare_stop (EV_P_ ev_prepare *w);
502 671
503void ev_check_start (EV_P_ ev_check *w); 672void ev_check_start (EV_P_ ev_check *w);
513void ev_embed_start (EV_P_ ev_embed *w); 682void ev_embed_start (EV_P_ ev_embed *w);
514void ev_embed_stop (EV_P_ ev_embed *w); 683void ev_embed_stop (EV_P_ ev_embed *w);
515void ev_embed_sweep (EV_P_ ev_embed *w); 684void ev_embed_sweep (EV_P_ ev_embed *w);
516# endif 685# endif
517 686
687# if EV_ASYNC_ENABLE
688void ev_async_start (EV_P_ ev_async *w);
689void ev_async_stop (EV_P_ ev_async *w);
690void ev_async_send (EV_P_ ev_async *w);
691# endif
692
518#endif 693#endif
519 694
520#ifdef __cplusplus 695#ifdef __cplusplus
521} 696}
522#endif 697#endif

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines