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

Comparing libev/ev.h (file contents):
Revision 1.69 by root, Mon Nov 26 19:49:36 2007 UTC vs.
Revision 1.106 by root, Mon Sep 29 03:31:14 2008 UTC

1/* 1/*
2 * libev native API header
3 *
2 * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008 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
54 64
55#ifndef EV_STAT_ENABLE 65#ifndef EV_STAT_ENABLE
56# define EV_STAT_ENABLE 1 66# define EV_STAT_ENABLE 1
57#endif 67#endif
58 68
69#ifndef EV_IDLE_ENABLE
70# define EV_IDLE_ENABLE 1
71#endif
72
73#ifndef EV_FORK_ENABLE
74# define EV_FORK_ENABLE 1
75#endif
76
59#ifndef EV_EMBED_ENABLE 77#ifndef EV_EMBED_ENABLE
60# define EV_EMBED_ENABLE 1 78# define EV_EMBED_ENABLE 1
61#endif 79#endif
62 80
81#ifndef EV_ASYNC_ENABLE
82# define EV_ASYNC_ENABLE 1
83#endif
84
85#ifndef EV_ATOMIC_T
86# include <signal.h>
87# define EV_ATOMIC_T sig_atomic_t volatile
88#endif
89
63/*****************************************************************************/ 90/*****************************************************************************/
64 91
65#if EV_STAT_ENABLE 92#if EV_STAT_ENABLE
93# ifdef _WIN32
94# include <time.h>
95# include <sys/types.h>
96# endif
66# include <sys/stat.h> 97# include <sys/stat.h>
67#endif 98#endif
68 99
69/* support multiple event loops? */ 100/* support multiple event loops? */
70#if EV_MULTIPLICITY 101#if EV_MULTIPLICITY
71struct ev_loop; 102struct ev_loop;
72# define EV_P struct ev_loop *loop 103# define EV_P struct ev_loop *loop
73# define EV_P_ EV_P, 104# define EV_P_ EV_P,
74# define EV_A loop 105# define EV_A loop
75# define EV_A_ EV_A, 106# define EV_A_ EV_A,
107# define EV_DEFAULT_UC ev_default_loop_uc ()
108# define EV_DEFAULT_UC_ EV_DEFAULT_UC,
76# define EV_DEFAULT_A ev_default_loop (0) 109# define EV_DEFAULT ev_default_loop (0)
77# define EV_DEFAULT_A_ EV_DEFAULT_A, 110# define EV_DEFAULT_ EV_DEFAULT,
78#else 111#else
79# define EV_P void 112# define EV_P void
80# define EV_P_ 113# define EV_P_
81# define EV_A 114# define EV_A
82# define EV_A_ 115# define EV_A_
116# define EV_DEFAULT
83# define EV_DEFAULT_A 117# define EV_DEFAULT_
118# define EV_DEFAULT_UC
84# define EV_DEFAULT_A_ 119# define EV_DEFAULT_UC_
85
86# undef EV_EMBED_ENABLE 120# undef EV_EMBED_ENABLE
87#endif 121#endif
88 122
123#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
124# define EV_INLINE static inline
125#else
126# define EV_INLINE static
127#endif
128
129/*****************************************************************************/
130
89/* eventmask, revents, events... */ 131/* eventmask, revents, events... */
90#define EV_UNDEF -1L /* guaranteed to be invalid */ 132#define EV_UNDEF -1 /* guaranteed to be invalid */
91#define EV_NONE 0x00L /* no events */ 133#define EV_NONE 0x00 /* no events */
92#define EV_READ 0x01L /* ev_io detected read will not block */ 134#define EV_READ 0x01 /* ev_io detected read will not block */
93#define EV_WRITE 0x02L /* ev_io detected write will not block */ 135#define EV_WRITE 0x02 /* ev_io detected write will not block */
136#define EV_IOFDSET 0x80 /* internal use only */
94#define EV_TIMEOUT 0x00000100L /* timer timed out */ 137#define EV_TIMEOUT 0x00000100 /* timer timed out */
95#define EV_PERIODIC 0x00000200L /* periodic timer timed out */ 138#define EV_PERIODIC 0x00000200 /* periodic timer timed out */
96#define EV_SIGNAL 0x00000400L /* signal was received */ 139#define EV_SIGNAL 0x00000400 /* signal was received */
140#define EV_CHILD 0x00000800 /* child/pid had status change */
141#define EV_STAT 0x00001000 /* stat data changed */
97#define EV_IDLE 0x00000800L /* event loop is idling */ 142#define EV_IDLE 0x00002000 /* event loop is idling */
98#define EV_PREPARE 0x00001000L /* event loop about to poll */ 143#define EV_PREPARE 0x00004000 /* event loop about to poll */
99#define EV_CHECK 0x00002000L /* event loop finished poll */ 144#define EV_CHECK 0x00008000 /* event loop finished poll */
100#define EV_CHILD 0x00004000L /* child/pid had status change */
101#define EV_EMBED 0x00008000L /* embedded event loop needs sweep */ 145#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
102#define EV_STAT 0x00010000L /* stat data changed */ 146#define EV_FORK 0x00020000 /* event loop resumed in child */
147#define EV_ASYNC 0x00040000 /* async intra-loop signal */
103#define EV_ERROR 0x80000000L /* sent when an error occurs */ 148#define EV_ERROR 0x80000000 /* sent when an error occurs */
104 149
105/* can be used to add custom fields to all watchers, while losing binary compatibility */ 150/* can be used to add custom fields to all watchers, while losing binary compatibility */
106#ifndef EV_COMMON 151#ifndef EV_COMMON
107# define EV_COMMON void *data; 152# define EV_COMMON void *data;
108#endif 153#endif
109#ifndef EV_PROTOTYPES 154#ifndef EV_PROTOTYPES
110# define EV_PROTOTYPES 1 155# define EV_PROTOTYPES 1
111#endif 156#endif
112 157
113#define EV_VERSION_MAJOR 1 158#define EV_VERSION_MAJOR 3
114#define EV_VERSION_MINOR 1 159#define EV_VERSION_MINOR 0
115 160
116#ifndef EV_CB_DECLARE 161#ifndef EV_CB_DECLARE
117# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 162# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
118#endif 163#endif
119#ifndef EV_CB_INVOKE 164#ifndef EV_CB_INVOKE
123/* 168/*
124 * struct member types: 169 * struct member types:
125 * private: you can look at them, but not change them, and they might not mean anything to you. 170 * private: you can look at them, but not change them, and they might not mean anything to you.
126 * ro: can be read anytime, but only changed when the watcher isn't active 171 * ro: can be read anytime, but only changed when the watcher isn't active
127 * rw: can be read and modified anytime, even when the watcher is active 172 * rw: can be read and modified anytime, even when the watcher is active
173 *
174 * some internal details that might be helpful for debugging:
175 *
176 * active is either 0, which means the watcher is not active,
177 * or the array index of the watcher (periodics, timers)
178 * or the array index + 1 (most other watchers)
179 * or simply 1 for watchers that aren't in some array.
180 * pending is either 0, in which case the watcher isn't,
181 * or the array index + 1 in the pendings array.
128 */ 182 */
129 183
130/* shared by all watchers */ 184/* shared by all watchers */
131#define EV_WATCHER(type) \ 185#define EV_WATCHER(type) \
132 int active; /* private */ \ 186 int active; /* private */ \
159typedef struct ev_watcher_time 213typedef struct ev_watcher_time
160{ 214{
161 EV_WATCHER_TIME (ev_watcher_time) 215 EV_WATCHER_TIME (ev_watcher_time)
162} ev_watcher_time; 216} ev_watcher_time;
163 217
218/* invoked when fd is either EV_READable or EV_WRITEable */
219/* revent EV_READ, EV_WRITE */
220typedef struct ev_io
221{
222 EV_WATCHER_LIST (ev_io)
223
224 int fd; /* ro */
225 int events; /* ro */
226} ev_io;
227
164/* invoked after a specific time, repeatable (based on monotonic clock) */ 228/* invoked after a specific time, repeatable (based on monotonic clock) */
165/* revent EV_TIMEOUT */ 229/* revent EV_TIMEOUT */
166typedef struct ev_timer 230typedef struct ev_timer
167{ 231{
168 EV_WATCHER_TIME (ev_timer) 232 EV_WATCHER_TIME (ev_timer)
174/* revent EV_PERIODIC */ 238/* revent EV_PERIODIC */
175typedef struct ev_periodic 239typedef struct ev_periodic
176{ 240{
177 EV_WATCHER_TIME (ev_periodic) 241 EV_WATCHER_TIME (ev_periodic)
178 242
243 ev_tstamp offset; /* rw */
179 ev_tstamp interval; /* rw */ 244 ev_tstamp interval; /* rw */
180 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 245 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
181} ev_periodic; 246} ev_periodic;
182 247
183/* invoked when fd is either EV_READable or EV_WRITEable */
184/* revent EV_READ, EV_WRITE */
185typedef struct ev_io
186{
187 EV_WATCHER_LIST (ev_io)
188
189 int fd; /* ro */
190 int events; /* ro */
191} ev_io;
192
193/* invoked when the given signal has been received */ 248/* invoked when the given signal has been received */
194/* revent EV_SIGNAL */ 249/* revent EV_SIGNAL */
195typedef struct ev_signal 250typedef struct ev_signal
196{ 251{
197 EV_WATCHER_LIST (ev_signal) 252 EV_WATCHER_LIST (ev_signal)
198 253
199 int signum; /* ro */ 254 int signum; /* ro */
200} ev_signal; 255} ev_signal;
201 256
257/* invoked when sigchld is received and waitpid indicates the given pid */
258/* revent EV_CHILD */
259/* does not support priorities */
260typedef struct ev_child
261{
262 EV_WATCHER_LIST (ev_child)
263
264 int flags; /* private */
265 int pid; /* ro */
266 int rpid; /* rw, holds the received pid */
267 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
268} ev_child;
269
270#if EV_STAT_ENABLE
271/* st_nlink = 0 means missing file or other error */
272# ifdef _WIN32
273typedef struct _stati64 ev_statdata;
274# else
275typedef struct stat ev_statdata;
276# endif
277
278/* invoked each time the stat data changes for a given path */
279/* revent EV_STAT */
280typedef struct ev_stat
281{
282 EV_WATCHER_LIST (ev_stat)
283
284 ev_timer timer; /* private */
285 ev_tstamp interval; /* ro */
286 const char *path; /* ro */
287 ev_statdata prev; /* ro */
288 ev_statdata attr; /* ro */
289
290 int wd; /* wd for inotify, fd for kqueue */
291} ev_stat;
292#endif
293
294#if EV_IDLE_ENABLE
202/* invoked when the nothing else needs to be done, keeps the process from blocking */ 295/* invoked when the nothing else needs to be done, keeps the process from blocking */
203/* revent EV_IDLE */ 296/* revent EV_IDLE */
204typedef struct ev_idle 297typedef struct ev_idle
205{ 298{
206 EV_WATCHER (ev_idle) 299 EV_WATCHER (ev_idle)
207} ev_idle; 300} ev_idle;
301#endif
208 302
209/* invoked for each run of the mainloop, just before the blocking call */ 303/* invoked for each run of the mainloop, just before the blocking call */
210/* you can still change events in any way you like */ 304/* you can still change events in any way you like */
211/* revent EV_PREPARE */ 305/* revent EV_PREPARE */
212typedef struct ev_prepare 306typedef struct ev_prepare
219typedef struct ev_check 313typedef struct ev_check
220{ 314{
221 EV_WATCHER (ev_check) 315 EV_WATCHER (ev_check)
222} ev_check; 316} ev_check;
223 317
224/* invoked when sigchld is received and waitpid indicates the given pid */ 318#if EV_FORK_ENABLE
225/* revent EV_CHILD */ 319/* the callback gets invoked before check in the child process when a fork was detected */
226/* does not support priorities */
227typedef struct ev_child 320typedef struct ev_fork
228{ 321{
229 EV_WATCHER_LIST (ev_child) 322 EV_WATCHER (ev_fork)
230 323} ev_fork;
231 int pid; /* ro */ 324#endif
232 int rpid; /* rw, holds the received pid */
233 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
234} ev_child;
235 325
236#if EV_EMBED_ENABLE 326#if EV_EMBED_ENABLE
237/* used to embed an event loop inside another */ 327/* used to embed an event loop inside another */
238/* the callback gets invoked when the event loop has handled events, and can be 0 */ 328/* the callback gets invoked when the event loop has handled events, and can be 0 */
239typedef struct ev_embed 329typedef struct ev_embed
240{ 330{
241 EV_WATCHER (ev_embed) 331 EV_WATCHER (ev_embed)
242 332
243 ev_io io; /* private */
244 struct ev_loop *loop; /* ro */ 333 struct ev_loop *other; /* ro */
334 ev_io io; /* private */
335 ev_prepare prepare; /* private */
336 ev_check check; /* unused */
337 ev_timer timer; /* unused */
338 ev_periodic periodic; /* unused */
339 ev_idle idle; /* unused */
340 ev_fork fork; /* private */
245} ev_embed; 341} ev_embed;
246#endif 342#endif
247 343
248#if EV_STAT_ENABLE 344#if EV_ASYNC_ENABLE
249/* st_nlink = 0 means missing file or other error */ 345/* invoked when somebody calls ev_async_send on the watcher */
250typedef struct stat ev_statdata;
251
252/* invoked each time the stat data changes for a given path */
253/* revent EV_STAT */ 346/* revent EV_ASYNC */
254typedef struct ev_stat 347typedef struct ev_async
255{ 348{
256 EV_WATCHER (ev_stat) 349 EV_WATCHER (ev_async)
257 350
258 ev_timer timer; /* private */ 351 EV_ATOMIC_T sent; /* private */
259 ev_tstamp interval; /* rw */ 352} ev_async;
260 const char *path; /* ro */ 353
261 ev_statdata prev; /* ro */ 354# define ev_async_pending(w) ((w)->sent + 0)
262 ev_statdata attr; /* ro */
263} ev_stat;
264#endif 355#endif
265 356
266/* the presence of this union forces similar struct layout */ 357/* the presence of this union forces similar struct layout */
267union ev_any_watcher 358union ev_any_watcher
268{ 359{
270 struct ev_watcher_list wl; 361 struct ev_watcher_list wl;
271 362
272 struct ev_io io; 363 struct ev_io io;
273 struct ev_timer timer; 364 struct ev_timer timer;
274 struct ev_periodic periodic; 365 struct ev_periodic periodic;
366 struct ev_signal signal;
367 struct ev_child child;
368#if EV_STAT_ENABLE
369 struct ev_stat stat;
370#endif
371#if EV_IDLE_ENABLE
275 struct ev_idle idle; 372 struct ev_idle idle;
373#endif
276 struct ev_prepare prepare; 374 struct ev_prepare prepare;
277 struct ev_check check; 375 struct ev_check check;
278 struct ev_signal signal; 376#if EV_FORK_ENABLE
279 struct ev_child child; 377 struct ev_fork fork;
378#endif
280#if EV_EMBED_ENABLE 379#if EV_EMBED_ENABLE
281 struct ev_embed embed; 380 struct ev_embed embed;
282#endif 381#endif
283#if EV_STAT_ENABLE 382#if EV_ASYNC_ENABLE
284 struct ev_stat stat; 383 struct ev_async async;
285#endif 384#endif
286}; 385};
287 386
288/* bits for ev_default_loop and ev_loop_new */ 387/* bits for ev_default_loop and ev_loop_new */
289/* the default */ 388/* the default */
290#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */ 389#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
291/* flag bits */ 390/* flag bits */
292#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */ 391#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
392#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
293/* method bits to be ored together */ 393/* method bits to be ored together */
294#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */ 394#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
295#define EVBACKEND_POLL 0x00000002UL /* !win */ 395#define EVBACKEND_POLL 0x00000002U /* !win */
296#define EVBACKEND_EPOLL 0x00000004UL /* linux */ 396#define EVBACKEND_EPOLL 0x00000004U /* linux */
297#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */ 397#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
298#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */ 398#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
299#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */ 399#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
300 400
301#if EV_PROTOTYPES 401#if EV_PROTOTYPES
302int ev_version_major (void); 402int ev_version_major (void);
303int ev_version_minor (void); 403int ev_version_minor (void);
304 404
305unsigned int ev_supported_backends (void); 405unsigned int ev_supported_backends (void);
306unsigned int ev_recommended_backends (void); 406unsigned int ev_recommended_backends (void);
307unsigned int ev_embeddable_backends (void); 407unsigned int ev_embeddable_backends (void);
308 408
309ev_tstamp ev_time (void); 409ev_tstamp ev_time (void);
410void ev_sleep (ev_tstamp delay); /* sleep for a while */
310 411
311/* Sets the allocation function to use, works like realloc. 412/* Sets the allocation function to use, works like realloc.
312 * It is used to allocate and free memory. 413 * It is used to allocate and free memory.
313 * If it returns zero when memory needs to be allocated, the library might abort 414 * If it returns zero when memory needs to be allocated, the library might abort
314 * or take some potentially destructive action. 415 * or take some potentially destructive action.
320 * retryable syscall error 421 * retryable syscall error
321 * (such as failed select, poll, epoll_wait) 422 * (such as failed select, poll, epoll_wait)
322 */ 423 */
323void ev_set_syserr_cb (void (*cb)(const char *msg)); 424void ev_set_syserr_cb (void (*cb)(const char *msg));
324 425
325# if EV_MULTIPLICITY 426#if EV_MULTIPLICITY
427EV_INLINE struct ev_loop *
428ev_default_loop_uc (void)
429{
430 extern struct ev_loop *ev_default_loop_ptr;
431
432 return ev_default_loop_ptr;
433}
434
326/* the default loop is the only one that handles signals and child watchers */ 435/* the default loop is the only one that handles signals and child watchers */
327/* you can call this as often as you like */ 436/* you can call this as often as you like */
328static struct ev_loop * 437EV_INLINE struct ev_loop *
329ev_default_loop (unsigned int flags) 438ev_default_loop (unsigned int flags)
330{ 439{
331 extern struct ev_loop *ev_default_loop_ptr; 440 struct ev_loop *loop = ev_default_loop_uc ();
441
442 if (!loop)
443 {
332 extern struct ev_loop *ev_default_loop_init (unsigned int flags); 444 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
333 445
334 if (!ev_default_loop_ptr)
335 ev_default_loop_init (flags); 446 loop = ev_default_loop_init (flags);
447 }
336 448
337 return ev_default_loop_ptr; 449 return loop;
338} 450}
339 451
340/* create and destroy alternative loops that don't handle signals */ 452/* create and destroy alternative loops that don't handle signals */
341struct ev_loop *ev_loop_new (unsigned int flags); 453struct ev_loop *ev_loop_new (unsigned int flags);
342void ev_loop_destroy (EV_P); 454void ev_loop_destroy (EV_P);
343void ev_loop_fork (EV_P); 455void ev_loop_fork (EV_P);
456void ev_loop_verify (EV_P);
344 457
345ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 458ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
459void ev_now_update (EV_P);
346 460
347# else 461#else
348 462
349int ev_default_loop (unsigned int flags); /* returns true when successful */ 463int ev_default_loop (unsigned int flags); /* returns true when successful */
350 464
351static ev_tstamp 465EV_INLINE ev_tstamp
352ev_now (void) 466ev_now (void)
353{ 467{
354 extern ev_tstamp ev_rt_now; 468 extern ev_tstamp ev_rt_now;
355 469
356 return ev_rt_now; 470 return ev_rt_now;
357} 471}
472#endif /* multiplicity */
473
474EV_INLINE int
475ev_is_default_loop (EV_P)
476{
477#if EV_MULTIPLICITY
478 extern struct ev_loop *ev_default_loop_ptr;
479
480 return !!(EV_A == ev_default_loop_ptr);
481#else
482 return 1;
358# endif 483#endif
484}
359 485
360void ev_default_destroy (void); /* destroy the default loop */ 486void ev_default_destroy (void); /* destroy the default loop */
361/* this needs to be called after fork, to duplicate the default loop */ 487/* this needs to be called after fork, to duplicate the default loop */
362/* if you create alternative loops you have to call ev_loop_fork on them */ 488/* if you create alternative loops you have to call ev_loop_fork on them */
363/* you can call it in either the parent or the child */ 489/* you can call it in either the parent or the child */
364/* you can actually call it at any time, anywhere :) */ 490/* you can actually call it at any time, anywhere :) */
365void ev_default_fork (void); 491void ev_default_fork (void);
366 492
367unsigned int ev_backend (EV_P); 493unsigned int ev_backend (EV_P); /* backend in use by loop */
368#endif 494unsigned int ev_loop_count (EV_P); /* number of loop iterations */
495#endif /* prototypes */
369 496
370#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 497#define EVLOOP_NONBLOCK 1 /* do not block/wait */
371#define EVLOOP_ONESHOT 2 /* block *once* only */ 498#define EVLOOP_ONESHOT 2 /* block *once* only */
372#define EVUNLOOP_CANCEL 0 /* undo unloop */ 499#define EVUNLOOP_CANCEL 0 /* undo unloop */
373#define EVUNLOOP_ONE 1 /* unloop once */ 500#define EVUNLOOP_ONE 1 /* unloop once */
374#define EVUNLOOP_ALL 2 /* unloop all loops */ 501#define EVUNLOOP_ALL 2 /* unloop all loops */
375 502
376#if EV_PROTOTYPES 503#if EV_PROTOTYPES
377void ev_loop (EV_P_ int flags); 504void ev_loop (EV_P_ int flags);
378void 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 */ 505void 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 */
506
507void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
508void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
379 509
380/* 510/*
381 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 511 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
382 * keeps one reference. if you have a long-runing watcher you never unregister that 512 * keeps one reference. if you have a long-runing watcher you never unregister that
383 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 513 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
390void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 520void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
391#endif 521#endif
392 522
393/* these may evaluate ev multiple times, and the other arguments at most once */ 523/* these may evaluate ev multiple times, and the other arguments at most once */
394/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 524/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
395#define ev_init(ev,cb_) do { \ 525#define ev_init(ev,cb_) do { \
396 ((ev_watcher *)(void *)(ev))->active = \ 526 ((ev_watcher *)(void *)(ev))->active = \
397 ((ev_watcher *)(void *)(ev))->pending = \ 527 ((ev_watcher *)(void *)(ev))->pending = \
398 ((ev_watcher *)(void *)(ev))->priority = 0; \ 528 ((ev_watcher *)(void *)(ev))->priority = 0; \
399 ev_set_cb ((ev), cb_); \ 529 ev_set_cb ((ev), cb_); \
400} while (0) 530} while (0)
401 531
402#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 532#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0)
403#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 533#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
404#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 534#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
405#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 535#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
536#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
537#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
406#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 538#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
407#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 539#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
408#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 540#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
409#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
410#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0) 541#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
411#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); } while (0) 542#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
543#define ev_async_set(ev) do { (ev)->sent = 0; } while (0)
412 544
413#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 545#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
414#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 546#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
415#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 547#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
416#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 548#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
549#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
550#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
417#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 551#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
418#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 552#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
419#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 553#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
420#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
421#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0) 554#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
422#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0) 555#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
556#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
423 557
424#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 558#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
425#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 559#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
426 560
427#define ev_priority(ev) ((ev_watcher *)(void *)(ev))->priority /* rw */ 561#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
428#define ev_cb(ev) (ev)->cb /* rw */ 562#define ev_cb(ev) (ev)->cb /* rw */
429#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) 563#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri)
564
565#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)
430 566
431#ifndef ev_set_cb 567#ifndef ev_set_cb
432# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 568# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
433#endif 569#endif
434 570
439/* feeds an event into a watcher as if the event actually occured */ 575/* feeds an event into a watcher as if the event actually occured */
440/* accepts any ev_watcher type */ 576/* accepts any ev_watcher type */
441void ev_feed_event (EV_P_ void *w, int revents); 577void ev_feed_event (EV_P_ void *w, int revents);
442void ev_feed_fd_event (EV_P_ int fd, int revents); 578void ev_feed_fd_event (EV_P_ int fd, int revents);
443void ev_feed_signal_event (EV_P_ int signum); 579void ev_feed_signal_event (EV_P_ int signum);
580void ev_invoke (EV_P_ void *w, int revents);
581int ev_clear_pending (EV_P_ void *w);
444 582
445void ev_io_start (EV_P_ ev_io *w); 583void ev_io_start (EV_P_ ev_io *w);
446void ev_io_stop (EV_P_ ev_io *w); 584void ev_io_stop (EV_P_ ev_io *w);
447 585
448void ev_timer_start (EV_P_ ev_timer *w); 586void ev_timer_start (EV_P_ ev_timer *w);
454void ev_periodic_start (EV_P_ ev_periodic *w); 592void ev_periodic_start (EV_P_ ev_periodic *w);
455void ev_periodic_stop (EV_P_ ev_periodic *w); 593void ev_periodic_stop (EV_P_ ev_periodic *w);
456void ev_periodic_again (EV_P_ ev_periodic *w); 594void ev_periodic_again (EV_P_ ev_periodic *w);
457#endif 595#endif
458 596
459void ev_idle_start (EV_P_ ev_idle *w);
460void ev_idle_stop (EV_P_ ev_idle *w);
461
462void ev_prepare_start (EV_P_ ev_prepare *w);
463void ev_prepare_stop (EV_P_ ev_prepare *w);
464
465void ev_check_start (EV_P_ ev_check *w);
466void ev_check_stop (EV_P_ ev_check *w);
467
468/* only supported in the default loop */ 597/* only supported in the default loop */
469void ev_signal_start (EV_P_ ev_signal *w); 598void ev_signal_start (EV_P_ ev_signal *w);
470void ev_signal_stop (EV_P_ ev_signal *w); 599void ev_signal_stop (EV_P_ ev_signal *w);
471 600
472/* only supported in the default loop */ 601/* only supported in the default loop */
473void ev_child_start (EV_P_ ev_child *w); 602void ev_child_start (EV_P_ ev_child *w);
474void ev_child_stop (EV_P_ ev_child *w); 603void ev_child_stop (EV_P_ ev_child *w);
604
605# if EV_STAT_ENABLE
606void ev_stat_start (EV_P_ ev_stat *w);
607void ev_stat_stop (EV_P_ ev_stat *w);
608void ev_stat_stat (EV_P_ ev_stat *w);
609# endif
610
611# if EV_IDLE_ENABLE
612void ev_idle_start (EV_P_ ev_idle *w);
613void ev_idle_stop (EV_P_ ev_idle *w);
614# endif
615
616void ev_prepare_start (EV_P_ ev_prepare *w);
617void ev_prepare_stop (EV_P_ ev_prepare *w);
618
619void ev_check_start (EV_P_ ev_check *w);
620void ev_check_stop (EV_P_ ev_check *w);
621
622# if EV_FORK_ENABLE
623void ev_fork_start (EV_P_ ev_fork *w);
624void ev_fork_stop (EV_P_ ev_fork *w);
625# endif
475 626
476# if EV_EMBED_ENABLE 627# if EV_EMBED_ENABLE
477/* only supported when loop to be embedded is in fact embeddable */ 628/* only supported when loop to be embedded is in fact embeddable */
478void ev_embed_start (EV_P_ ev_embed *w); 629void ev_embed_start (EV_P_ ev_embed *w);
479void ev_embed_stop (EV_P_ ev_embed *w); 630void ev_embed_stop (EV_P_ ev_embed *w);
480void ev_embed_sweep (EV_P_ ev_embed *w); 631void ev_embed_sweep (EV_P_ ev_embed *w);
481# endif 632# endif
482 633
483# if EV_STAT_ENABLE 634# if EV_ASYNC_ENABLE
484void ev_stat_start (EV_P_ ev_stat *w); 635void ev_async_start (EV_P_ ev_async *w);
485void ev_stat_stop (EV_P_ ev_stat *w); 636void ev_async_stop (EV_P_ ev_async *w);
486void ev_stat_stat (EV_P_ ev_stat *w); 637void ev_async_send (EV_P_ ev_async *w);
487# endif 638# endif
488 639
489#endif 640#endif
490 641
491#ifdef __cplusplus 642#ifdef __cplusplus

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines