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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines