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

Comparing libev/ev.h (file contents):
Revision 1.115 by root, Sat Apr 25 14:12:48 2009 UTC vs.
Revision 1.150 by root, Sun Oct 24 18:05:53 2010 UTC

1/* 1/*
2 * libev native API header 2 * libev native API header
3 * 3 *
4 * Copyright (c) 2007,2008,2009 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008,2009,2010 Marc Alexander Lehmann <libev@schmorp.de>
5 * All rights reserved. 5 * All rights reserved.
6 * 6 *
7 * Redistribution and use in source and binary forms, with or without modifica- 7 * Redistribution and use in source and binary forms, with or without modifica-
8 * tion, are permitted provided that the following conditions are met: 8 * tion, are permitted provided that the following conditions are met:
9 * 9 *
35 * and other provisions required by the GPL. If you do not delete the 35 * and other provisions required by the GPL. If you do not delete the
36 * provisions above, a recipient may use your version of this file under 36 * provisions above, a recipient may use your version of this file under
37 * either the BSD or the GPL. 37 * either the BSD or the GPL.
38 */ 38 */
39 39
40#ifndef EV_H__ 40#ifndef EV_H_
41#define EV_H__ 41#define EV_H_
42 42
43#ifdef __cplusplus 43#ifdef __cplusplus
44# define EV_CPP(x) x
45#else
46# define EV_CPP(x)
47#endif
48
44extern "C" { 49EV_CPP(extern "C" {)
45#endif
46 50
47typedef double ev_tstamp; 51/*****************************************************************************/
48 52
53/* pre-4.0 compatibility */
54#ifndef EV_COMPAT3
55# define EV_COMPAT3 1
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
49/* these priorities are inclusive, higher priorities will be called earlier */ 70/* these priorities are inclusive, higher priorities will be invoked earlier */
50#ifndef EV_MINPRI 71#ifndef EV_MINPRI
51# define EV_MINPRI -2 72# define EV_MINPRI (EV_FEATURE_CONFIG ? -2 : 0)
52#endif 73#endif
53#ifndef EV_MAXPRI 74#ifndef EV_MAXPRI
54# define EV_MAXPRI +2 75# define EV_MAXPRI (EV_FEATURE_CONFIG ? +2 : 0)
55#endif 76#endif
56 77
57#ifndef EV_MULTIPLICITY 78#ifndef EV_MULTIPLICITY
58# define EV_MULTIPLICITY 1 79# define EV_MULTIPLICITY EV_FEATURE_CONFIG
59#endif 80#endif
60 81
61#ifndef EV_PERIODIC_ENABLE 82#ifndef EV_PERIODIC_ENABLE
62# define EV_PERIODIC_ENABLE 1 83# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
63#endif 84#endif
64 85
65#ifndef EV_STAT_ENABLE 86#ifndef EV_STAT_ENABLE
66# define EV_STAT_ENABLE 1 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
67#endif 96#endif
68 97
69#ifndef EV_IDLE_ENABLE 98#ifndef EV_IDLE_ENABLE
70# define EV_IDLE_ENABLE 1 99# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
71#endif 100#endif
72 101
73#ifndef EV_FORK_ENABLE 102#ifndef EV_FORK_ENABLE
103# define EV_FORK_ENABLE 0 /* not implemented */
104#endif
105
106#ifndef EV_CLEANUP_ENABLE
107# define EV_CLEANUP_ENABLE EV_FEATURE_WATCHERS
108#endif
109
110#ifndef EV_SIGNAL_ENABLE
111# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
112#endif
113
114#ifndef EV_CHILD_ENABLE
115# ifdef _WIN32
74# define EV_FORK_ENABLE 1 116# define EV_CHILD_ENABLE 0
117# else
118# define EV_CHILD_ENABLE EV_FEATURE_WATCHERS
119#endif
120#endif
121
122#ifndef EV_ASYNC_ENABLE
123# define EV_ASYNC_ENABLE EV_FEATURE_WATCHERS
75#endif 124#endif
76 125
77#ifndef EV_EMBED_ENABLE 126#ifndef EV_EMBED_ENABLE
78# define EV_EMBED_ENABLE 1 127# define EV_EMBED_ENABLE EV_FEATURE_WATCHERS
79#endif
80
81#ifndef EV_ASYNC_ENABLE
82# define EV_ASYNC_ENABLE 1
83#endif 128#endif
84 129
85#ifndef EV_WALK_ENABLE 130#ifndef EV_WALK_ENABLE
86# define EV_WALK_ENABLE 0 /* not yet */ 131# define EV_WALK_ENABLE 0 /* not yet */
87#endif 132#endif
133
134/*****************************************************************************/
135
136#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
137# undef EV_SIGNAL_ENABLE
138# define EV_SIGNAL_ENABLE 1
139#endif
140
141/*****************************************************************************/
142
143typedef double ev_tstamp;
88 144
89#ifndef EV_ATOMIC_T 145#ifndef EV_ATOMIC_T
90# include <signal.h> 146# include <signal.h>
91# define EV_ATOMIC_T sig_atomic_t volatile 147# define EV_ATOMIC_T sig_atomic_t volatile
92#endif 148#endif
93
94/*****************************************************************************/
95 149
96#if EV_STAT_ENABLE 150#if EV_STAT_ENABLE
97# ifdef _WIN32 151# ifdef _WIN32
98# include <time.h> 152# include <time.h>
99# include <sys/types.h> 153# include <sys/types.h>
102#endif 156#endif
103 157
104/* support multiple event loops? */ 158/* support multiple event loops? */
105#if EV_MULTIPLICITY 159#if EV_MULTIPLICITY
106struct ev_loop; 160struct ev_loop;
107# define EV_P struct ev_loop *loop 161# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
108# define EV_P_ EV_P, 162# define EV_P_ EV_P, /* a loop as first of multiple parameters */
109# define EV_A loop 163# define EV_A loop /* a loop as sole argument to a function call */
110# define EV_A_ EV_A, 164# define EV_A_ EV_A, /* a loop as first of multiple arguments */
111# define EV_DEFAULT_UC ev_default_loop_uc () 165# define EV_DEFAULT_UC ev_default_loop_uc_ () /* the default loop, if initialised, as sole arg */
112# define EV_DEFAULT_UC_ EV_DEFAULT_UC, 166# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
113# define EV_DEFAULT ev_default_loop (0) 167# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
114# define EV_DEFAULT_ EV_DEFAULT, 168# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
115#else 169#else
116# define EV_P void 170# define EV_P void
117# define EV_P_ 171# define EV_P_
118# define EV_A 172# define EV_A
119# define EV_A_ 173# define EV_A_
122# define EV_DEFAULT_UC 176# define EV_DEFAULT_UC
123# define EV_DEFAULT_UC_ 177# define EV_DEFAULT_UC_
124# undef EV_EMBED_ENABLE 178# undef EV_EMBED_ENABLE
125#endif 179#endif
126 180
181/* EV_INLINE is used for functions in header files */
127#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 182#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
128# define EV_INLINE static inline 183# define EV_INLINE static inline
129#else 184#else
130# define EV_INLINE static 185# define EV_INLINE static
131#endif 186#endif
132 187
188/* EV_PROTOTYPES can be sued to switch of prototype declarations */
189#ifndef EV_PROTOTYPES
190# define EV_PROTOTYPES 1
191#endif
192
133/*****************************************************************************/ 193/*****************************************************************************/
134 194
195#define EV_VERSION_MAJOR 4
196#define EV_VERSION_MINOR 0
197
135/* eventmask, revents, events... */ 198/* eventmask, revents, events... */
199enum {
136#define EV_UNDEF -1 /* guaranteed to be invalid */ 200 EV_UNDEF = -1, /* guaranteed to be invalid */
137#define EV_NONE 0x00 /* no events */ 201 EV_NONE = 0x00, /* no events */
138#define EV_READ 0x01 /* ev_io detected read will not block */ 202 EV_READ = 0x01, /* ev_io detected read will not block */
139#define EV_WRITE 0x02 /* ev_io detected write will not block */ 203 EV_WRITE = 0x02, /* ev_io detected write will not block */
140#define EV__IOFDSET 0x80 /* internal use only */ 204 EV__IOFDSET = 0x80, /* internal use only */
141#define EV_IO EV_READ /* alias for type-detection */ 205 EV_IO = EV_READ, /* alias for type-detection */
142#define EV_TIMEOUT 0x00000100 /* timer timed out */ 206 EV_TIMER = 0x00000100, /* timer timed out */
143#define EV_TIMER EV_TIMEOUT /* alias for type-detection */ 207#if EV_COMPAT3
208 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
209#endif
144#define EV_PERIODIC 0x00000200 /* periodic timer timed out */ 210 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
145#define EV_SIGNAL 0x00000400 /* signal was received */ 211 EV_SIGNAL = 0x00000400, /* signal was received */
146#define EV_CHILD 0x00000800 /* child/pid had status change */ 212 EV_CHILD = 0x00000800, /* child/pid had status change */
147#define EV_STAT 0x00001000 /* stat data changed */ 213 EV_STAT = 0x00001000, /* stat data changed */
148#define EV_IDLE 0x00002000 /* event loop is idling */ 214 EV_IDLE = 0x00002000, /* event loop is idling */
149#define EV_PREPARE 0x00004000 /* event loop about to poll */ 215 EV_PREPARE = 0x00004000, /* event loop about to poll */
150#define EV_CHECK 0x00008000 /* event loop finished poll */ 216 EV_CHECK = 0x00008000, /* event loop finished poll */
151#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ 217 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
152#define EV_FORK 0x00020000 /* event loop resumed in child */ 218 EV_FORK = 0x00020000, /* event loop resumed in child */
219 EV_CLEANUP = 0x00040000, /* event loop resumed in child */
153#define EV_ASYNC 0x00040000 /* async intra-loop signal */ 220 EV_ASYNC = 0x00080000, /* async intra-loop signal */
154#define EV_CUSTOM 0x01000000 /* for use by user code */ 221 EV_CUSTOM = 0x01000000, /* for use by user code */
155#define EV_ERROR 0x80000000 /* sent when an error occurs */ 222 EV_ERROR = 0x80000000 /* sent when an error occurs */
223};
156 224
157/* can be used to add custom fields to all watchers, while losing binary compatibility */ 225/* can be used to add custom fields to all watchers, while losing binary compatibility */
158#ifndef EV_COMMON 226#ifndef EV_COMMON
159# define EV_COMMON void *data; 227# define EV_COMMON void *data;
160#endif 228#endif
161#ifndef EV_PROTOTYPES
162# define EV_PROTOTYPES 1
163#endif
164
165#define EV_VERSION_MAJOR 3
166#define EV_VERSION_MINOR 0
167 229
168#ifndef EV_CB_DECLARE 230#ifndef EV_CB_DECLARE
169# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 231# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
170#endif 232#endif
171#ifndef EV_CB_INVOKE 233#ifndef EV_CB_INVOKE
172# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) 234# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
173#endif 235#endif
236
237/* not official, do not use */
238#define EV_CB(type,name) void name (EV_P_ struct ev_ ## type *w, int revents)
174 239
175/* 240/*
176 * struct member types: 241 * struct member types:
177 * private: you may look at them, but not change them, 242 * private: you may look at them, but not change them,
178 * and they might not mean anything to you. 243 * and they might not mean anything to you.
187 * or simply 1 for watchers that aren't in some array. 252 * or simply 1 for watchers that aren't in some array.
188 * pending is either 0, in which case the watcher isn't, 253 * pending is either 0, in which case the watcher isn't,
189 * or the array index + 1 in the pendings array. 254 * or the array index + 1 in the pendings array.
190 */ 255 */
191 256
257#if EV_MINPRI == EV_MAXPRI
258# define EV_DECL_PRIORITY
259#elif !defined (EV_DECL_PRIORITY)
260# define EV_DECL_PRIORITY int priority;
261#endif
262
192/* shared by all watchers */ 263/* shared by all watchers */
193#define EV_WATCHER(type) \ 264#define EV_WATCHER(type) \
194 int active; /* private */ \ 265 int active; /* private */ \
195 int pending; /* private */ \ 266 int pending; /* private */ \
196 int priority; /* private */ \ 267 EV_DECL_PRIORITY /* private */ \
197 EV_COMMON /* rw */ \ 268 EV_COMMON /* rw */ \
198 EV_CB_DECLARE (type) /* private */ 269 EV_CB_DECLARE (type) /* private */
199 270
200#define EV_WATCHER_LIST(type) \ 271#define EV_WATCHER_LIST(type) \
201 EV_WATCHER (type) \ 272 EV_WATCHER (type) \
323 EV_WATCHER (ev_check) 394 EV_WATCHER (ev_check)
324} ev_check; 395} ev_check;
325 396
326#if EV_FORK_ENABLE 397#if EV_FORK_ENABLE
327/* the callback gets invoked before check in the child process when a fork was detected */ 398/* the callback gets invoked before check in the child process when a fork was detected */
399/* revent EV_FORK */
328typedef struct ev_fork 400typedef struct ev_fork
329{ 401{
330 EV_WATCHER (ev_fork) 402 EV_WATCHER (ev_fork)
331} ev_fork; 403} ev_fork;
404#endif
405
406#if EV_CLEANUP_ENABLE
407/* is invoked just before the loop gets destroyed */
408/* revent EV_CLEANUP */
409typedef struct ev_cleanup
410{
411 EV_WATCHER (ev_cleanup)
412} ev_cleanup;
332#endif 413#endif
333 414
334#if EV_EMBED_ENABLE 415#if EV_EMBED_ENABLE
335/* used to embed an event loop inside another */ 416/* used to embed an event loop inside another */
336/* the callback gets invoked when the event loop has handled events, and can be 0 */ 417/* the callback gets invoked when the event loop has handled events, and can be 0 */
344 ev_check check; /* unused */ 425 ev_check check; /* unused */
345 ev_timer timer; /* unused */ 426 ev_timer timer; /* unused */
346 ev_periodic periodic; /* unused */ 427 ev_periodic periodic; /* unused */
347 ev_idle idle; /* unused */ 428 ev_idle idle; /* unused */
348 ev_fork fork; /* private */ 429 ev_fork fork; /* private */
430 ev_cleanup cleanup; /* unused */
349} ev_embed; 431} ev_embed;
350#endif 432#endif
351 433
352#if EV_ASYNC_ENABLE 434#if EV_ASYNC_ENABLE
353/* invoked when somebody calls ev_async_send on the watcher */ 435/* invoked when somebody calls ev_async_send on the watcher */
357 EV_WATCHER (ev_async) 439 EV_WATCHER (ev_async)
358 440
359 EV_ATOMIC_T sent; /* private */ 441 EV_ATOMIC_T sent; /* private */
360} ev_async; 442} ev_async;
361 443
362# define ev_async_pending(w) ((w)->sent + 0) 444# define ev_async_pending(w) (+(w)->sent)
363#endif 445#endif
364 446
365/* the presence of this union forces similar struct layout */ 447/* the presence of this union forces similar struct layout */
366union ev_any_watcher 448union ev_any_watcher
367{ 449{
382 struct ev_prepare prepare; 464 struct ev_prepare prepare;
383 struct ev_check check; 465 struct ev_check check;
384#if EV_FORK_ENABLE 466#if EV_FORK_ENABLE
385 struct ev_fork fork; 467 struct ev_fork fork;
386#endif 468#endif
469#if EV_CLEANUP_ENABLE
470 struct ev_cleanup cleanup;
471#endif
387#if EV_EMBED_ENABLE 472#if EV_EMBED_ENABLE
388 struct ev_embed embed; 473 struct ev_embed embed;
389#endif 474#endif
390#if EV_ASYNC_ENABLE 475#if EV_ASYNC_ENABLE
391 struct ev_async async; 476 struct ev_async async;
392#endif 477#endif
393}; 478};
394 479
395/* bits for ev_default_loop and ev_loop_new */ 480/* flag bits for ev_default_loop and ev_loop_new */
481enum {
396/* the default */ 482 /* the default */
397#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 483 EVFLAG_AUTO = 0x00000000U, /* not quite a mask */
398/* flag bits */ 484 /* flag bits */
399#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 485 EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */
400#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ 486 EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */
487 /* debugging/feature disable */
488 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
489#if EV_COMPAT3
490 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
491#endif
492 EVFLAG_SIGNALFD = 0x00200000U /* attempt to use signalfd */
493};
494
401/* method bits to be ored together */ 495/* method bits to be ored together */
496enum {
402#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 497 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
403#define EVBACKEND_POLL 0x00000002U /* !win */ 498 EVBACKEND_POLL = 0x00000002U, /* !win */
404#define EVBACKEND_EPOLL 0x00000004U /* linux */ 499 EVBACKEND_EPOLL = 0x00000004U, /* linux */
405#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 500 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
406#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 501 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
407#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 502 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
503 EVBACKEND_ALL = 0x0000003FU
504};
408 505
409#if EV_PROTOTYPES 506#if EV_PROTOTYPES
410int ev_version_major (void); 507int ev_version_major (void);
411int ev_version_minor (void); 508int ev_version_minor (void);
412 509
430 * (such as failed select, poll, epoll_wait) 527 * (such as failed select, poll, epoll_wait)
431 */ 528 */
432void ev_set_syserr_cb (void (*cb)(const char *msg)); 529void ev_set_syserr_cb (void (*cb)(const char *msg));
433 530
434#if EV_MULTIPLICITY 531#if EV_MULTIPLICITY
532
533/* the default loop is the only one that handles signals and child watchers */
534/* you can call this as often as you like */
535struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0));
536
435EV_INLINE struct ev_loop * 537EV_INLINE struct ev_loop *
436ev_default_loop_uc (void) 538ev_default_loop_uc_ (void)
437{ 539{
438 extern struct ev_loop *ev_default_loop_ptr; 540 extern struct ev_loop *ev_default_loop_ptr;
439 541
440 return ev_default_loop_ptr; 542 return ev_default_loop_ptr;
441} 543}
442 544
443/* the default loop is the only one that handles signals and child watchers */ 545EV_INLINE int
444/* you can call this as often as you like */ 546ev_is_default_loop (EV_P)
445EV_INLINE struct ev_loop *
446ev_default_loop (unsigned int flags)
447{ 547{
448 struct ev_loop *loop = ev_default_loop_uc (); 548 return EV_A == EV_DEFAULT_UC;
449
450 if (!loop)
451 {
452 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
453
454 loop = ev_default_loop_init (flags);
455 }
456
457 return loop;
458} 549}
459 550
460/* create and destroy alternative loops that don't handle signals */ 551/* create and destroy alternative loops that don't handle signals */
461struct ev_loop *ev_loop_new (unsigned int flags); 552struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
553/* destroy event loops, also works for the default loop */
462void ev_loop_destroy (EV_P); 554void ev_loop_destroy (EV_P);
463void ev_loop_fork (EV_P);
464void ev_loop_verify (EV_P);
465 555
466ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 556ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
467void ev_now_update (EV_P);
468 557
469#else 558#else
470 559
471int ev_default_loop (unsigned int flags); /* returns true when successful */ 560int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */
472 561
473EV_INLINE ev_tstamp 562EV_INLINE ev_tstamp
474ev_now (void) 563ev_now (void)
475{ 564{
476 extern ev_tstamp ev_rt_now; 565 extern ev_tstamp ev_rt_now;
477 566
478 return ev_rt_now; 567 return ev_rt_now;
479} 568}
569
570/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
571EV_INLINE int
572ev_is_default_loop (void)
573{
574 return 1;
575}
576
480#endif /* multiplicity */ 577#endif /* multiplicity */
481 578
482EV_INLINE int
483ev_is_default_loop (EV_P)
484{
485#if EV_MULTIPLICITY
486 extern struct ev_loop *ev_default_loop_ptr;
487
488 return !!(EV_A == ev_default_loop_ptr);
489#else
490 return 1;
491#endif
492}
493
494void ev_default_destroy (void); /* destroy the default loop */
495/* this needs to be called after fork, to duplicate the default loop */ 579/* this needs to be called after fork, to duplicate the loop */
496/* if you create alternative loops you have to call ev_loop_fork on them */ 580/* when you want to re-use it in the child */
497/* you can call it in either the parent or the child */ 581/* you can call it in either the parent or the child */
498/* you can actually call it at any time, anywhere :) */ 582/* you can actually call it at any time, anywhere :) */
499void ev_default_fork (void); 583void ev_loop_fork (EV_P);
584
585unsigned int ev_backend (EV_P); /* backend in use by loop */
586
587void ev_now_update (EV_P); /* update event loop time */
500 588
501#if EV_WALK_ENABLE 589#if EV_WALK_ENABLE
502/* walk (almost) all watchers in the loop of a given type, invoking the */ 590/* walk (almost) all watchers in the loop of a given type, invoking the */
503/* callback on every such watcher. The callback might stop the watcher, */ 591/* callback on every such watcher. The callback might stop the watcher, */
504/* but do nothing else with the loop */ 592/* but do nothing else with the loop */
505void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 593void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
506#endif 594#endif
507 595
508unsigned int ev_backend (EV_P); /* backend in use by loop */
509unsigned int ev_loop_count (EV_P); /* number of loop iterations */
510#endif /* prototypes */ 596#endif /* prototypes */
511 597
512#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 598/* ev_run flags values */
513#define EVLOOP_ONESHOT 2 /* block *once* only */ 599enum {
514#define EVUNLOOP_CANCEL 0 /* undo unloop */ 600 EVRUN_NOWAIT = 1, /* do not block/wait */
515#define EVUNLOOP_ONE 1 /* unloop once */ 601 EVRUN_ONCE = 2 /* block *once* only */
602};
603
604/* ev_break how values */
605enum {
606 EVBREAK_CANCEL = 0, /* undo unloop */
607 EVBREAK_ONE = 1, /* unloop once */
516#define EVUNLOOP_ALL 2 /* unloop all loops */ 608 EVBREAK_ALL = 2 /* unloop all loops */
609};
517 610
518#if EV_PROTOTYPES 611#if EV_PROTOTYPES
519void ev_loop (EV_P_ int flags); 612void ev_run (EV_P_ int flags EV_CPP (= 0));
520void 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 */ 613void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */
521
522void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
523void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
524 614
525/* 615/*
526 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 616 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
527 * keeps one reference. if you have a long-runing watcher you never unregister that 617 * keeps one reference. if you have a long-running watcher you never unregister that
528 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 618 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
529 */ 619 */
530void ev_ref (EV_P); 620void ev_ref (EV_P);
531void ev_unref (EV_P); 621void ev_unref (EV_P);
622
623/*
624 * convenience function, wait for a single event, without registering an event watcher
625 * if timeout is < 0, do wait indefinitely
626 */
627void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
628
629# if EV_FEATURE_API
630unsigned int ev_iteration (EV_P); /* number of loop iterations */
631unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
632void ev_verify (EV_P); /* abort if loop data corrupted */
633
634void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
635void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
636
637/* advanced stuff for threading etc. support, see docs */
638void ev_set_userdata (EV_P_ void *data);
639void *ev_userdata (EV_P);
640void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
641void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
642
643unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
644void ev_invoke_pending (EV_P); /* invoke all pending watchers */
532 645
533/* 646/*
534 * stop/start the timer handling. 647 * stop/start the timer handling.
535 */ 648 */
536void ev_suspend (EV_P); 649void ev_suspend (EV_P);
537void ev_resume (EV_P); 650void ev_resume (EV_P);
651#endif
538 652
539/*
540 * convenience function, wait for a single event, without registering an event watcher
541 * if timeout is < 0, do wait indefinitely
542 */
543void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
544#endif 653#endif
545 654
546/* these may evaluate ev multiple times, and the other arguments at most once */ 655/* these may evaluate ev multiple times, and the other arguments at most once */
547/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 656/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
548#define ev_init(ev,cb_) do { \ 657#define ev_init(ev,cb_) do { \
549 ((ev_watcher *)(void *)(ev))->active = \ 658 ((ev_watcher *)(void *)(ev))->active = \
550 ((ev_watcher *)(void *)(ev))->pending = \ 659 ((ev_watcher *)(void *)(ev))->pending = 0; \
551 ((ev_watcher *)(void *)(ev))->priority = 0; \ 660 ev_set_priority ((ev), 0); \
552 ev_set_cb ((ev), cb_); \ 661 ev_set_cb ((ev), cb_); \
553} while (0) 662} while (0)
554 663
555#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0) 664#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
556#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0) 665#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
561#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 670#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
562#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 671#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
563#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 672#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
564#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 673#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
565#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 674#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
566#define ev_async_set(ev) do { (ev)->sent = 0; } while (0) 675#define ev_cleanup_set(ev) /* nop, yes, this is a serious in-joke */
676#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
567 677
568#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 678#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
569#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 679#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
570#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0) 680#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
571#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 681#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
574#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 684#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
575#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 685#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
576#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 686#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
577#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) 687#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
578#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 688#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
689#define ev_cleanup_init(ev,cb) do { ev_init ((ev), (cb)); ev_cleanup_set ((ev)); } while (0)
579#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 690#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
580 691
581#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 692#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
582#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 693#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
583 694
584#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
585#define ev_cb(ev) (ev)->cb /* rw */ 695#define ev_cb(ev) (ev)->cb /* rw */
696
697#if EV_MINPRI == EV_MAXPRI
698# define ev_priority(ev) ((ev), EV_MINPRI)
699# define ev_set_priority(ev,pri) ((ev), (pri))
700#else
701# define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
586#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) 702# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
703#endif
587 704
588#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 705#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
589 706
590#ifndef ev_set_cb 707#ifndef ev_set_cb
591# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 708# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
592#endif 709#endif
593 710
597 714
598/* feeds an event into a watcher as if the event actually occured */ 715/* feeds an event into a watcher as if the event actually occured */
599/* accepts any ev_watcher type */ 716/* accepts any ev_watcher type */
600void ev_feed_event (EV_P_ void *w, int revents); 717void ev_feed_event (EV_P_ void *w, int revents);
601void ev_feed_fd_event (EV_P_ int fd, int revents); 718void ev_feed_fd_event (EV_P_ int fd, int revents);
719#if EV_SIGNAL_ENABLE
602void ev_feed_signal_event (EV_P_ int signum); 720void ev_feed_signal_event (EV_P_ int signum);
721#endif
603void ev_invoke (EV_P_ void *w, int revents); 722void ev_invoke (EV_P_ void *w, int revents);
604int ev_clear_pending (EV_P_ void *w); 723int ev_clear_pending (EV_P_ void *w);
605 724
606void ev_io_start (EV_P_ ev_io *w); 725void ev_io_start (EV_P_ ev_io *w);
607void ev_io_stop (EV_P_ ev_io *w); 726void ev_io_stop (EV_P_ ev_io *w);
608 727
609void ev_timer_start (EV_P_ ev_timer *w); 728void ev_timer_start (EV_P_ ev_timer *w);
610void ev_timer_stop (EV_P_ ev_timer *w); 729void ev_timer_stop (EV_P_ ev_timer *w);
611/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 730/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
612void ev_timer_again (EV_P_ ev_timer *w); 731void ev_timer_again (EV_P_ ev_timer *w);
732/* return remaining time */
733ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
613 734
614#if EV_PERIODIC_ENABLE 735#if EV_PERIODIC_ENABLE
615void ev_periodic_start (EV_P_ ev_periodic *w); 736void ev_periodic_start (EV_P_ ev_periodic *w);
616void ev_periodic_stop (EV_P_ ev_periodic *w); 737void ev_periodic_stop (EV_P_ ev_periodic *w);
617void ev_periodic_again (EV_P_ ev_periodic *w); 738void ev_periodic_again (EV_P_ ev_periodic *w);
618#endif 739#endif
619 740
620/* only supported in the default loop */ 741/* only supported in the default loop */
742#if EV_SIGNAL_ENABLE
621void ev_signal_start (EV_P_ ev_signal *w); 743void ev_signal_start (EV_P_ ev_signal *w);
622void ev_signal_stop (EV_P_ ev_signal *w); 744void ev_signal_stop (EV_P_ ev_signal *w);
745#endif
623 746
624/* only supported in the default loop */ 747/* only supported in the default loop */
748# if EV_CHILD_ENABLE
625void ev_child_start (EV_P_ ev_child *w); 749void ev_child_start (EV_P_ ev_child *w);
626void ev_child_stop (EV_P_ ev_child *w); 750void ev_child_stop (EV_P_ ev_child *w);
751# endif
627 752
628# if EV_STAT_ENABLE 753# if EV_STAT_ENABLE
629void ev_stat_start (EV_P_ ev_stat *w); 754void ev_stat_start (EV_P_ ev_stat *w);
630void ev_stat_stop (EV_P_ ev_stat *w); 755void ev_stat_stop (EV_P_ ev_stat *w);
631void ev_stat_stat (EV_P_ ev_stat *w); 756void ev_stat_stat (EV_P_ ev_stat *w);
634# if EV_IDLE_ENABLE 759# if EV_IDLE_ENABLE
635void ev_idle_start (EV_P_ ev_idle *w); 760void ev_idle_start (EV_P_ ev_idle *w);
636void ev_idle_stop (EV_P_ ev_idle *w); 761void ev_idle_stop (EV_P_ ev_idle *w);
637# endif 762# endif
638 763
764#if EV_PREPARE_ENABLE
639void ev_prepare_start (EV_P_ ev_prepare *w); 765void ev_prepare_start (EV_P_ ev_prepare *w);
640void ev_prepare_stop (EV_P_ ev_prepare *w); 766void ev_prepare_stop (EV_P_ ev_prepare *w);
767#endif
641 768
769#if EV_CHECK_ENABLE
642void ev_check_start (EV_P_ ev_check *w); 770void ev_check_start (EV_P_ ev_check *w);
643void ev_check_stop (EV_P_ ev_check *w); 771void ev_check_stop (EV_P_ ev_check *w);
772#endif
644 773
645# if EV_FORK_ENABLE 774# if EV_FORK_ENABLE
646void ev_fork_start (EV_P_ ev_fork *w); 775void ev_fork_start (EV_P_ ev_fork *w);
647void ev_fork_stop (EV_P_ ev_fork *w); 776void ev_fork_stop (EV_P_ ev_fork *w);
777# endif
778
779# if EV_CLEANUP_ENABLE
780void ev_cleanup_start (EV_P_ ev_cleanup *w);
781void ev_cleanup_stop (EV_P_ ev_cleanup *w);
648# endif 782# endif
649 783
650# if EV_EMBED_ENABLE 784# if EV_EMBED_ENABLE
651/* only supported when loop to be embedded is in fact embeddable */ 785/* only supported when loop to be embedded is in fact embeddable */
652void ev_embed_start (EV_P_ ev_embed *w); 786void ev_embed_start (EV_P_ ev_embed *w);
658void ev_async_start (EV_P_ ev_async *w); 792void ev_async_start (EV_P_ ev_async *w);
659void ev_async_stop (EV_P_ ev_async *w); 793void ev_async_stop (EV_P_ ev_async *w);
660void ev_async_send (EV_P_ ev_async *w); 794void ev_async_send (EV_P_ ev_async *w);
661# endif 795# endif
662 796
797#if EV_COMPAT3
798 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
799 #define EVLOOP_ONESHOT EVRUN_ONCE
800 #define EVUNLOOP_CANCEL EVBREAK_CANCEL
801 #define EVUNLOOP_ONE EVBREAK_ONE
802 #define EVUNLOOP_ALL EVBREAK_ALL
803 #if EV_PROTOTYPES
804 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
805 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
806 EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); }
807 EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); }
808 #if EV_FEATURE_API
809 EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); }
810 EV_INLINE void ev_loop_depth (EV_P) { ev_depth (EV_A); }
811 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
812 #endif
663#endif 813 #endif
664 814#else
665#ifdef __cplusplus 815 typedef struct ev_loop ev_loop;
666}
667#endif 816#endif
668 817
669#endif 818#endif
670 819
820EV_CPP(})
821
822#endif
823

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines