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

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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines