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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines