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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines