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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines