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

Comparing libev/ev.h (file contents):
Revision 1.49 by root, Sat Nov 10 21:19:30 2007 UTC vs.
Revision 1.149 by root, Sun Oct 24 17:58:41 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines