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

Comparing libev/ev.h (file contents):
Revision 1.91 by root, Fri Jan 25 15:45:09 2008 UTC vs.
Revision 1.166 by root, Mon Apr 2 23:46:11 2012 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines