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

Comparing libev/ev.h (file contents):
Revision 1.99 by root, Wed Apr 16 01:37:14 2008 UTC vs.
Revision 1.160 by root, Wed Feb 16 08:07:25 2011 UTC

1/* 1/*
2 * libev native API header 2 * libev native API header
3 * 3 *
4 * Copyright (c) 2007,2008 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008,2009,2010,2011 Marc Alexander Lehmann <libev@schmorp.de>
5 * All rights reserved. 5 * All rights reserved.
6 * 6 *
7 * Redistribution and use in source and binary forms, with or without modifica- 7 * Redistribution and use in source and binary forms, with or without modifica-
8 * tion, are permitted provided that the following conditions are met: 8 * tion, are permitted provided that the following conditions are met:
9 * 9 *
10 * 1. Redistributions of source code must retain the above copyright notice, 10 * 1. Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer. 11 * this list of conditions and the following disclaimer.
12 * 12 *
13 * 2. Redistributions in binary form must reproduce the above copyright 13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the 14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution. 15 * documentation and/or other materials provided with the distribution.
16 * 16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 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- 18 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
19 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 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- 20 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
21 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 21 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
35 * and other provisions required by the GPL. If you do not delete the 35 * and other provisions required by the GPL. If you do not delete the
36 * provisions above, a recipient may use your version of this file under 36 * provisions above, a recipient may use your version of this file under
37 * either the BSD or the GPL. 37 * either the BSD or the GPL.
38 */ 38 */
39 39
40#ifndef EV_H__ 40#ifndef EV_H_
41#define EV_H__ 41#define EV_H_
42 42
43#ifdef __cplusplus 43#ifdef __cplusplus
44# define EV_CPP(x) x
45#else
46# define EV_CPP(x)
47#endif
48
44extern "C" { 49EV_CPP(extern "C" {)
50
51/*****************************************************************************/
52
53/* pre-4.0 compatibility */
54#ifndef EV_COMPAT3
55# define EV_COMPAT3 1
45#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 EV_FEATURE_WATCHERS
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/*****************************************************************************/
46 142
47typedef double ev_tstamp; 143typedef double ev_tstamp;
48
49/* these priorities are inclusive, higher priorities will be called earlier */
50#ifndef EV_MINPRI
51# define EV_MINPRI -2
52#endif
53#ifndef EV_MAXPRI
54# define EV_MAXPRI +2
55#endif
56
57#ifndef EV_MULTIPLICITY
58# define EV_MULTIPLICITY 1
59#endif
60
61#ifndef EV_PERIODIC_ENABLE
62# define EV_PERIODIC_ENABLE 1
63#endif
64
65#ifndef EV_STAT_ENABLE
66# define EV_STAT_ENABLE 1
67#endif
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
77#ifndef EV_EMBED_ENABLE
78# define EV_EMBED_ENABLE 1
79#endif
80
81#ifndef EV_ASYNC_ENABLE
82# define EV_ASYNC_ENABLE 1
83#endif
84 144
85#ifndef EV_ATOMIC_T 145#ifndef EV_ATOMIC_T
86# include <signal.h> 146# include <signal.h>
87# define EV_ATOMIC_T sig_atomic_t volatile 147# define EV_ATOMIC_T sig_atomic_t volatile
88#endif 148#endif
89 149
90/*****************************************************************************/
91
92#if EV_STAT_ENABLE 150#if EV_STAT_ENABLE
151# ifdef _WIN32
152# include <time.h>
153# include <sys/types.h>
154# endif
93# include <sys/stat.h> 155# include <sys/stat.h>
94#endif 156#endif
95 157
96/* support multiple event loops? */ 158/* support multiple event loops? */
97#if EV_MULTIPLICITY 159#if EV_MULTIPLICITY
98struct ev_loop; 160struct ev_loop;
99# define EV_P struct ev_loop *loop 161# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
100# define EV_P_ EV_P, 162# define EV_P_ EV_P, /* a loop as first of multiple parameters */
101# define EV_A loop 163# define EV_A loop /* a loop as sole argument to a function call */
102# define EV_A_ EV_A, 164# define EV_A_ EV_A, /* a loop as first of multiple arguments */
103# define EV_DEFAULT_UC ev_default_loop_uc () 165# define EV_DEFAULT_UC ev_default_loop_uc_ () /* the default loop, if initialised, as sole arg */
104# define EV_DEFAULT_UC_ EV_DEFAULT_UC, 166# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
105# define EV_DEFAULT ev_default_loop (0) 167# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
106# define EV_DEFAULT_ EV_DEFAULT, 168# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
107#else 169#else
108# define EV_P void 170# define EV_P void
109# define EV_P_ 171# define EV_P_
110# define EV_A 172# define EV_A
111# define EV_A_ 173# define EV_A_
114# define EV_DEFAULT_UC 176# define EV_DEFAULT_UC
115# define EV_DEFAULT_UC_ 177# define EV_DEFAULT_UC_
116# undef EV_EMBED_ENABLE 178# undef EV_EMBED_ENABLE
117#endif 179#endif
118 180
181/* EV_INLINE is used for functions in header files */
119#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 182#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
120# define EV_INLINE static inline 183# define EV_INLINE static inline
121#else 184#else
122# define EV_INLINE static 185# define EV_INLINE static
123#endif 186#endif
124 187
188/* EV_PROTOTYPES can be used to switch of prototype declarations */
189#ifndef EV_PROTOTYPES
190# define EV_PROTOTYPES 1
191#endif
192
125/*****************************************************************************/ 193/*****************************************************************************/
126 194
195#define EV_VERSION_MAJOR 4
196#define EV_VERSION_MINOR 4
197
127/* eventmask, revents, events... */ 198/* eventmask, revents, events... */
128#define EV_UNDEF -1 /* guaranteed to be invalid */ 199enum {
200 EV_UNDEF = 0xFFFFFFFF, /* guaranteed to be invalid */
129#define EV_NONE 0x00 /* no events */ 201 EV_NONE = 0x00, /* no events */
130#define EV_READ 0x01 /* ev_io detected read will not block */ 202 EV_READ = 0x01, /* ev_io detected read will not block */
131#define EV_WRITE 0x02 /* ev_io detected write will not block */ 203 EV_WRITE = 0x02, /* ev_io detected write will not block */
132#define EV_IOFDSET 0x80 /* internal use only */ 204 EV__IOFDSET = 0x80, /* internal use only */
205 EV_IO = EV_READ, /* alias for type-detection */
133#define EV_TIMEOUT 0x00000100 /* 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
134#define EV_PERIODIC 0x00000200 /* periodic timer timed out */ 210 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
135#define EV_SIGNAL 0x00000400 /* signal was received */ 211 EV_SIGNAL = 0x00000400, /* signal was received */
136#define EV_CHILD 0x00000800 /* child/pid had status change */ 212 EV_CHILD = 0x00000800, /* child/pid had status change */
137#define EV_STAT 0x00001000 /* stat data changed */ 213 EV_STAT = 0x00001000, /* stat data changed */
138#define EV_IDLE 0x00002000 /* event loop is idling */ 214 EV_IDLE = 0x00002000, /* event loop is idling */
139#define EV_PREPARE 0x00004000 /* event loop about to poll */ 215 EV_PREPARE = 0x00004000, /* event loop about to poll */
140#define EV_CHECK 0x00008000 /* event loop finished poll */ 216 EV_CHECK = 0x00008000, /* event loop finished poll */
141#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ 217 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
142#define EV_FORK 0x00020000 /* event loop resumed in child */ 218 EV_FORK = 0x00020000, /* event loop resumed in child */
219 EV_CLEANUP = 0x00040000, /* event loop resumed in child */
143#define EV_ASYNC 0x00040000 /* async intra-loop signal */ 220 EV_ASYNC = 0x00080000, /* async intra-loop signal */
221 EV_CUSTOM = 0x01000000, /* for use by user code */
144#define EV_ERROR 0x80000000 /* sent when an error occurs */ 222 EV_ERROR = 0x80000000 /* sent when an error occurs */
223};
145 224
146/* 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 */
147#ifndef EV_COMMON 226#ifndef EV_COMMON
148# define EV_COMMON void *data; 227# define EV_COMMON void *data;
149#endif 228#endif
150#ifndef EV_PROTOTYPES
151# define EV_PROTOTYPES 1
152#endif
153
154#define EV_VERSION_MAJOR 3
155#define EV_VERSION_MINOR 0
156 229
157#ifndef EV_CB_DECLARE 230#ifndef EV_CB_DECLARE
158# 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);
159#endif 232#endif
160#ifndef EV_CB_INVOKE 233#ifndef EV_CB_INVOKE
161# 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))
162#endif 235#endif
163 236
237/* not official, do not use */
238#define EV_CB(type,name) void name (EV_P_ struct ev_ ## type *w, int revents)
239
164/* 240/*
165 * struct member types: 241 * struct member types:
166 * 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.
167 * 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.
168 * 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.
169 */ 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
170 262
171/* shared by all watchers */ 263/* shared by all watchers */
172#define EV_WATCHER(type) \ 264#define EV_WATCHER(type) \
173 int active; /* private */ \ 265 int active; /* private */ \
174 int pending; /* private */ \ 266 int pending; /* private */ \
175 int priority; /* private */ \ 267 EV_DECL_PRIORITY /* private */ \
176 EV_COMMON /* rw */ \ 268 EV_COMMON /* rw */ \
177 EV_CB_DECLARE (type) /* private */ 269 EV_CB_DECLARE (type) /* private */
178 270
179#define EV_WATCHER_LIST(type) \ 271#define EV_WATCHER_LIST(type) \
180 EV_WATCHER (type) \ 272 EV_WATCHER (type) \
302 EV_WATCHER (ev_check) 394 EV_WATCHER (ev_check)
303} ev_check; 395} ev_check;
304 396
305#if EV_FORK_ENABLE 397#if EV_FORK_ENABLE
306/* 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 */
307typedef struct ev_fork 400typedef struct ev_fork
308{ 401{
309 EV_WATCHER (ev_fork) 402 EV_WATCHER (ev_fork)
310} 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;
311#endif 413#endif
312 414
313#if EV_EMBED_ENABLE 415#if EV_EMBED_ENABLE
314/* used to embed an event loop inside another */ 416/* used to embed an event loop inside another */
315/* 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 */
322 ev_prepare prepare; /* private */ 424 ev_prepare prepare; /* private */
323 ev_check check; /* unused */ 425 ev_check check; /* unused */
324 ev_timer timer; /* unused */ 426 ev_timer timer; /* unused */
325 ev_periodic periodic; /* unused */ 427 ev_periodic periodic; /* unused */
326 ev_idle idle; /* unused */ 428 ev_idle idle; /* unused */
327 ev_fork fork; /* unused */ 429 ev_fork fork; /* private */
430#if EV_CLEANUP_ENABLE
431 ev_cleanup cleanup; /* unused */
432#endif
328} ev_embed; 433} ev_embed;
329#endif 434#endif
330 435
331#if EV_ASYNC_ENABLE 436#if EV_ASYNC_ENABLE
332/* invoked when somebody calls ev_async_send on the watcher */ 437/* invoked when somebody calls ev_async_send on the watcher */
336 EV_WATCHER (ev_async) 441 EV_WATCHER (ev_async)
337 442
338 EV_ATOMIC_T sent; /* private */ 443 EV_ATOMIC_T sent; /* private */
339} ev_async; 444} ev_async;
340 445
341# define ev_async_pending(w) ((w)->sent + 0) 446# define ev_async_pending(w) (+(w)->sent)
342#endif 447#endif
343 448
344/* the presence of this union forces similar struct layout */ 449/* the presence of this union forces similar struct layout */
345union ev_any_watcher 450union ev_any_watcher
346{ 451{
361 struct ev_prepare prepare; 466 struct ev_prepare prepare;
362 struct ev_check check; 467 struct ev_check check;
363#if EV_FORK_ENABLE 468#if EV_FORK_ENABLE
364 struct ev_fork fork; 469 struct ev_fork fork;
365#endif 470#endif
471#if EV_CLEANUP_ENABLE
472 struct ev_cleanup cleanup;
473#endif
366#if EV_EMBED_ENABLE 474#if EV_EMBED_ENABLE
367 struct ev_embed embed; 475 struct ev_embed embed;
368#endif 476#endif
369#if EV_ASYNC_ENABLE 477#if EV_ASYNC_ENABLE
370 struct ev_async async; 478 struct ev_async async;
371#endif 479#endif
372}; 480};
373 481
374/* bits for ev_default_loop and ev_loop_new */ 482/* flag bits for ev_default_loop and ev_loop_new */
483enum {
375/* the default */ 484 /* the default */
376#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 485 EVFLAG_AUTO = 0x00000000U, /* not quite a mask */
377/* flag bits */ 486 /* flag bits */
378#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 487 EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */
379#define EVFLAG_FORKCHECK 0x02000000U /* 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 EVFLAG_NOSIGMASK = 0x00400000U /* avoid modifying the signal mask */
496};
497
380/* method bits to be ored together */ 498/* method bits to be ored together */
499enum {
381#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 500 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
382#define EVBACKEND_POLL 0x00000002U /* !win */ 501 EVBACKEND_POLL = 0x00000002U, /* !win */
383#define EVBACKEND_EPOLL 0x00000004U /* linux */ 502 EVBACKEND_EPOLL = 0x00000004U, /* linux */
384#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 503 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
385#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 504 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
386#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 505 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
506 EVBACKEND_ALL = 0x0000003FU, /* all known backends */
507 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
508};
387 509
388#if EV_PROTOTYPES 510#if EV_PROTOTYPES
389int ev_version_major (void); 511int ev_version_major (void);
390int ev_version_minor (void); 512int ev_version_minor (void);
391 513
408 * retryable syscall error 530 * retryable syscall error
409 * (such as failed select, poll, epoll_wait) 531 * (such as failed select, poll, epoll_wait)
410 */ 532 */
411void ev_set_syserr_cb (void (*cb)(const char *msg)); 533void ev_set_syserr_cb (void (*cb)(const char *msg));
412 534
413# if EV_MULTIPLICITY 535#if EV_MULTIPLICITY
536
537/* the default loop is the only one that handles signals and child watchers */
538/* you can call this as often as you like */
539struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0));
540
414EV_INLINE struct ev_loop * 541EV_INLINE struct ev_loop *
415ev_default_loop_uc (void) 542ev_default_loop_uc_ (void)
416{ 543{
417 extern struct ev_loop *ev_default_loop_ptr; 544 extern struct ev_loop *ev_default_loop_ptr;
418 545
419 return ev_default_loop_ptr; 546 return ev_default_loop_ptr;
420} 547}
421 548
422/* the default loop is the only one that handles signals and child watchers */ 549EV_INLINE int
423/* you can call this as often as you like */ 550ev_is_default_loop (EV_P)
424EV_INLINE struct ev_loop *
425ev_default_loop (unsigned int flags)
426{ 551{
427 struct ev_loop *loop = ev_default_loop_uc (); 552 return EV_A == EV_DEFAULT_UC;
428
429 if (!loop)
430 {
431 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
432
433 loop = ev_default_loop_init (flags);
434 }
435
436 return loop;
437} 553}
438 554
439/* create and destroy alternative loops that don't handle signals */ 555/* create and destroy alternative loops that don't handle signals */
440struct ev_loop *ev_loop_new (unsigned int flags); 556struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
441void ev_loop_destroy (EV_P);
442void ev_loop_fork (EV_P);
443 557
444ev_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 */
445 559
446# else 560#else
447 561
448int ev_default_loop (unsigned int flags); /* returns true when successful */ 562int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */
449 563
450EV_INLINE ev_tstamp 564EV_INLINE ev_tstamp
451ev_now (void) 565ev_now (void)
452{ 566{
453 extern ev_tstamp ev_rt_now; 567 extern ev_tstamp ev_rt_now;
454 568
455 return ev_rt_now; 569 return ev_rt_now;
456} 570}
457# endif
458 571
572/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
459EV_INLINE int 573EV_INLINE int
460ev_is_default_loop (EV_P) 574ev_is_default_loop (void)
461{ 575{
462#if EV_MULTIPLICITY
463 extern struct ev_loop *ev_default_loop_ptr;
464
465 return !!(EV_A == ev_default_loop_ptr);
466#else
467 return 1; 576 return 1;
468#endif
469} 577}
470 578
471void ev_default_destroy (void); /* destroy the default loop */ 579#endif /* multiplicity */
580
581/* destroy event loops, also works for the default loop */
582void ev_loop_destroy (EV_P);
583
472/* this needs to be called after fork, to duplicate the default loop */ 584/* this needs to be called after fork, to duplicate the loop */
473/* if you create alternative loops you have to call ev_loop_fork on them */ 585/* when you want to re-use it in the child */
474/* you can call it in either the parent or the child */ 586/* you can call it in either the parent or the child */
475/* you can actually call it at any time, anywhere :) */ 587/* you can actually call it at any time, anywhere :) */
476void ev_default_fork (void); 588void ev_loop_fork (EV_P);
477 589
478unsigned int ev_backend (EV_P); /* backend in use by loop */ 590unsigned int ev_backend (EV_P); /* backend in use by loop */
479unsigned int ev_loop_count (EV_P); /* number of loop iterations */
480#endif
481 591
482#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 592void ev_now_update (EV_P); /* update event loop time */
483#define EVLOOP_ONESHOT 2 /* block *once* only */ 593
484#define EVUNLOOP_CANCEL 0 /* undo unloop */ 594#if EV_WALK_ENABLE
485#define EVUNLOOP_ONE 1 /* unloop once */ 595/* walk (almost) all watchers in the loop of a given type, invoking the */
596/* callback on every such watcher. The callback might stop the watcher, */
597/* but do nothing else with the loop */
598void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
599#endif
600
601#endif /* prototypes */
602
603/* ev_run flags values */
604enum {
605 EVRUN_NOWAIT = 1, /* do not block/wait */
606 EVRUN_ONCE = 2 /* block *once* only */
607};
608
609/* ev_break how values */
610enum {
611 EVBREAK_CANCEL = 0, /* undo unloop */
612 EVBREAK_ONE = 1, /* unloop once */
486#define EVUNLOOP_ALL 2 /* unloop all loops */ 613 EVBREAK_ALL = 2 /* unloop all loops */
614};
487 615
488#if EV_PROTOTYPES 616#if EV_PROTOTYPES
489void ev_loop (EV_P_ int flags); 617void ev_run (EV_P_ int flags EV_CPP (= 0));
490void 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 */ 618void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */
491
492void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
493void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
494 619
495/* 620/*
496 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 621 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
497 * keeps one reference. if you have a long-runing watcher you never unregister that 622 * keeps one reference. if you have a long-running watcher you never unregister that
498 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 623 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
499 */ 624 */
500void ev_ref (EV_P); 625void ev_ref (EV_P);
501void ev_unref (EV_P); 626void ev_unref (EV_P);
502 627
628/*
503/* convinience function, wait for a single event, without registering an event watcher */ 629 * convenience function, wait for a single event, without registering an event watcher
504/* if timeout is < 0, do wait indefinitely */ 630 * if timeout is < 0, do wait indefinitely
631 */
505void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 632void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
633
634# if EV_FEATURE_API
635unsigned int ev_iteration (EV_P); /* number of loop iterations */
636unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
637void ev_verify (EV_P); /* abort if loop data corrupted */
638
639void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
640void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
641
642/* advanced stuff for threading etc. support, see docs */
643void ev_set_userdata (EV_P_ void *data);
644void *ev_userdata (EV_P);
645void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
646void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
647
648unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
649void ev_invoke_pending (EV_P); /* invoke all pending watchers */
650
651/*
652 * stop/start the timer handling.
653 */
654void ev_suspend (EV_P);
655void ev_resume (EV_P);
656#endif
657
506#endif 658#endif
507 659
508/* these may evaluate ev multiple times, and the other arguments at most once */ 660/* these may evaluate ev multiple times, and the other arguments at most once */
509/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 661/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
510#define ev_init(ev,cb_) do { \ 662#define ev_init(ev,cb_) do { \
511 ((ev_watcher *)(void *)(ev))->active = \ 663 ((ev_watcher *)(void *)(ev))->active = \
512 ((ev_watcher *)(void *)(ev))->pending = \ 664 ((ev_watcher *)(void *)(ev))->pending = 0; \
513 ((ev_watcher *)(void *)(ev))->priority = 0; \ 665 ev_set_priority ((ev), 0); \
514 ev_set_cb ((ev), cb_); \ 666 ev_set_cb ((ev), cb_); \
515} while (0) 667} while (0)
516 668
517#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0) 669#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
518#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 670#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
519#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 671#define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0)
520#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 672#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
521#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0) 673#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
522#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0) 674#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
523#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 675#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
524#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 676#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
525#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 677#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
526#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 678#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
527#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 679#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
528#define ev_async_set(ev) do { (ev)->sent = 0; } while (0) 680#define ev_cleanup_set(ev) /* nop, yes, this is a serious in-joke */
681#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
529 682
530#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 683#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
531#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 684#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
532#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 685#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
533#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 686#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
534#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0) 687#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
535#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0) 688#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
536#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 689#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
537#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 690#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
538#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 691#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
539#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) 692#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
540#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 693#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
694#define ev_cleanup_init(ev,cb) do { ev_init ((ev), (cb)); ev_cleanup_set ((ev)); } while (0)
541#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 695#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
542 696
543#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 697#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
544#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 698#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
545 699
546#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
547#define ev_cb(ev) (ev)->cb /* rw */ 700#define ev_cb(ev) (ev)->cb /* rw */
701
702#if EV_MINPRI == EV_MAXPRI
703# define ev_priority(ev) ((ev), EV_MINPRI)
704# define ev_set_priority(ev,pri) ((ev), (pri))
705#else
706# define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
548#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) 707# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
708#endif
709
710#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
549 711
550#ifndef ev_set_cb 712#ifndef ev_set_cb
551# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 713# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
552#endif 714#endif
553 715
554/* stopping (enabling, adding) a watcher does nothing if it is already running */ 716/* stopping (enabling, adding) a watcher does nothing if it is already running */
555/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 717/* stopping (disabling, deleting) a watcher does nothing unless its already running */
556#if EV_PROTOTYPES 718#if EV_PROTOTYPES
557 719
558/* feeds an event into a watcher as if the event actually occured */ 720/* feeds an event into a watcher as if the event actually occured */
559/* accepts any ev_watcher type */ 721/* accepts any ev_watcher type */
560void ev_feed_event (EV_P_ void *w, int revents); 722void ev_feed_event (EV_P_ void *w, int revents);
561void ev_feed_fd_event (EV_P_ int fd, int revents); 723void ev_feed_fd_event (EV_P_ int fd, int revents);
724#if EV_SIGNAL_ENABLE
725void ev_feed_signal (int signum);
562void ev_feed_signal_event (EV_P_ int signum); 726void ev_feed_signal_event (EV_P_ int signum);
727#endif
563void ev_invoke (EV_P_ void *w, int revents); 728void ev_invoke (EV_P_ void *w, int revents);
564int ev_clear_pending (EV_P_ void *w); 729int ev_clear_pending (EV_P_ void *w);
565 730
566void ev_io_start (EV_P_ ev_io *w); 731void ev_io_start (EV_P_ ev_io *w);
567void ev_io_stop (EV_P_ ev_io *w); 732void ev_io_stop (EV_P_ ev_io *w);
568 733
569void ev_timer_start (EV_P_ ev_timer *w); 734void ev_timer_start (EV_P_ ev_timer *w);
570void ev_timer_stop (EV_P_ ev_timer *w); 735void ev_timer_stop (EV_P_ ev_timer *w);
571/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 736/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
572void ev_timer_again (EV_P_ ev_timer *w); 737void ev_timer_again (EV_P_ ev_timer *w);
738/* return remaining time */
739ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
573 740
574#if EV_PERIODIC_ENABLE 741#if EV_PERIODIC_ENABLE
575void ev_periodic_start (EV_P_ ev_periodic *w); 742void ev_periodic_start (EV_P_ ev_periodic *w);
576void ev_periodic_stop (EV_P_ ev_periodic *w); 743void ev_periodic_stop (EV_P_ ev_periodic *w);
577void ev_periodic_again (EV_P_ ev_periodic *w); 744void ev_periodic_again (EV_P_ ev_periodic *w);
578#endif 745#endif
579 746
580/* only supported in the default loop */ 747/* only supported in the default loop */
748#if EV_SIGNAL_ENABLE
581void ev_signal_start (EV_P_ ev_signal *w); 749void ev_signal_start (EV_P_ ev_signal *w);
582void ev_signal_stop (EV_P_ ev_signal *w); 750void ev_signal_stop (EV_P_ ev_signal *w);
751#endif
583 752
584/* only supported in the default loop */ 753/* only supported in the default loop */
754# if EV_CHILD_ENABLE
585void ev_child_start (EV_P_ ev_child *w); 755void ev_child_start (EV_P_ ev_child *w);
586void ev_child_stop (EV_P_ ev_child *w); 756void ev_child_stop (EV_P_ ev_child *w);
757# endif
587 758
588# if EV_STAT_ENABLE 759# if EV_STAT_ENABLE
589void ev_stat_start (EV_P_ ev_stat *w); 760void ev_stat_start (EV_P_ ev_stat *w);
590void ev_stat_stop (EV_P_ ev_stat *w); 761void ev_stat_stop (EV_P_ ev_stat *w);
591void ev_stat_stat (EV_P_ ev_stat *w); 762void ev_stat_stat (EV_P_ ev_stat *w);
594# if EV_IDLE_ENABLE 765# if EV_IDLE_ENABLE
595void ev_idle_start (EV_P_ ev_idle *w); 766void ev_idle_start (EV_P_ ev_idle *w);
596void ev_idle_stop (EV_P_ ev_idle *w); 767void ev_idle_stop (EV_P_ ev_idle *w);
597# endif 768# endif
598 769
770#if EV_PREPARE_ENABLE
599void ev_prepare_start (EV_P_ ev_prepare *w); 771void ev_prepare_start (EV_P_ ev_prepare *w);
600void ev_prepare_stop (EV_P_ ev_prepare *w); 772void ev_prepare_stop (EV_P_ ev_prepare *w);
773#endif
601 774
775#if EV_CHECK_ENABLE
602void ev_check_start (EV_P_ ev_check *w); 776void ev_check_start (EV_P_ ev_check *w);
603void ev_check_stop (EV_P_ ev_check *w); 777void ev_check_stop (EV_P_ ev_check *w);
778#endif
604 779
605# if EV_FORK_ENABLE 780# if EV_FORK_ENABLE
606void ev_fork_start (EV_P_ ev_fork *w); 781void ev_fork_start (EV_P_ ev_fork *w);
607void ev_fork_stop (EV_P_ ev_fork *w); 782void ev_fork_stop (EV_P_ ev_fork *w);
783# endif
784
785# if EV_CLEANUP_ENABLE
786void ev_cleanup_start (EV_P_ ev_cleanup *w);
787void ev_cleanup_stop (EV_P_ ev_cleanup *w);
608# endif 788# endif
609 789
610# if EV_EMBED_ENABLE 790# if EV_EMBED_ENABLE
611/* only supported when loop to be embedded is in fact embeddable */ 791/* only supported when loop to be embedded is in fact embeddable */
612void ev_embed_start (EV_P_ ev_embed *w); 792void ev_embed_start (EV_P_ ev_embed *w);
618void ev_async_start (EV_P_ ev_async *w); 798void ev_async_start (EV_P_ ev_async *w);
619void ev_async_stop (EV_P_ ev_async *w); 799void ev_async_stop (EV_P_ ev_async *w);
620void ev_async_send (EV_P_ ev_async *w); 800void ev_async_send (EV_P_ ev_async *w);
621# endif 801# endif
622 802
803#if EV_COMPAT3
804 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
805 #define EVLOOP_ONESHOT EVRUN_ONCE
806 #define EVUNLOOP_CANCEL EVBREAK_CANCEL
807 #define EVUNLOOP_ONE EVBREAK_ONE
808 #define EVUNLOOP_ALL EVBREAK_ALL
809 #if EV_PROTOTYPES
810 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
811 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
812 EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); }
813 EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); }
814 #if EV_FEATURE_API
815 EV_INLINE unsigned int ev_loop_count (EV_P) { return ev_iteration (EV_A); }
816 EV_INLINE unsigned int ev_loop_depth (EV_P) { return ev_depth (EV_A); }
817 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
818 #endif
623#endif 819 #endif
624 820#else
625#ifdef __cplusplus 821 typedef struct ev_loop ev_loop;
626}
627#endif 822#endif
628 823
629#endif 824#endif
630 825
826EV_CPP(})
827
828#endif
829

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines