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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines