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

Comparing libev/ev.h (file contents):
Revision 1.91 by root, Fri Jan 25 15:45:09 2008 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 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" {)
50
51/*****************************************************************************/
52
53/* pre-4.0 compatibility */
54#ifndef EV_COMPAT3
55# define EV_COMPAT3 1
45#endif 56#endif
57
58#ifndef EV_FEATURES
59# define EV_FEATURES 0x7f
60#endif
61
62#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
63#define EV_FEATURE_DATA ((EV_FEATURES) & 2)
64#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4)
65#define EV_FEATURE_API ((EV_FEATURES) & 8)
66#define EV_FEATURE_WATCHERS ((EV_FEATURES) & 16)
67#define EV_FEATURE_BACKENDS ((EV_FEATURES) & 32)
68#define EV_FEATURE_OS ((EV_FEATURES) & 64)
69
70/* these priorities are inclusive, higher priorities will be invoked earlier */
71#ifndef EV_MINPRI
72# define EV_MINPRI (EV_FEATURE_CONFIG ? -2 : 0)
73#endif
74#ifndef EV_MAXPRI
75# define EV_MAXPRI (EV_FEATURE_CONFIG ? +2 : 0)
76#endif
77
78#ifndef EV_MULTIPLICITY
79# define EV_MULTIPLICITY EV_FEATURE_CONFIG
80#endif
81
82#ifndef EV_PERIODIC_ENABLE
83# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
84#endif
85
86#ifndef EV_STAT_ENABLE
87# define EV_STAT_ENABLE EV_FEATURE_WATCHERS
88#endif
89
90#ifndef EV_PREPARE_ENABLE
91# define EV_PREPARE_ENABLE EV_FEATURE_WATCHERS
92#endif
93
94#ifndef EV_CHECK_ENABLE
95# define EV_CHECK_ENABLE EV_FEATURE_WATCHERS
96#endif
97
98#ifndef EV_IDLE_ENABLE
99# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
100#endif
101
102#ifndef EV_FORK_ENABLE
103# define EV_FORK_ENABLE 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
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
124#endif
125
126#ifndef EV_EMBED_ENABLE
127# define EV_EMBED_ENABLE EV_FEATURE_WATCHERS
128#endif
129
130#ifndef EV_WALK_ENABLE
131# define EV_WALK_ENABLE 0 /* not yet */
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/*****************************************************************************/
46 142
47typedef double ev_tstamp; 143typedef double ev_tstamp;
48 144
49/* these priorities are inclusive, higher priorities will be called earlier */ 145#ifndef EV_ATOMIC_T
50#ifndef EV_MINPRI 146# include <signal.h>
51# define EV_MINPRI -2 147# define EV_ATOMIC_T sig_atomic_t volatile
52#endif 148#endif
53#ifndef EV_MAXPRI
54# define EV_MAXPRI +2
55#endif
56
57#ifndef EV_MULTIPLICITY
58# define EV_MULTIPLICITY 1
59#endif
60
61#ifndef EV_PERIODIC_ENABLE
62# define EV_PERIODIC_ENABLE 1
63#endif
64
65#ifndef EV_STAT_ENABLE
66# define EV_STAT_ENABLE 1
67#endif
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
77#ifndef EV_EMBED_ENABLE
78# define EV_EMBED_ENABLE 1
79#endif
80
81/*****************************************************************************/
82 149
83#if EV_STAT_ENABLE 150#if EV_STAT_ENABLE
151# ifdef _WIN32
152# include <time.h>
153# include <sys/types.h>
154# endif
84# include <sys/stat.h> 155# include <sys/stat.h>
85#endif 156#endif
86 157
87/* support multiple event loops? */ 158/* support multiple event loops? */
88#if EV_MULTIPLICITY 159#if EV_MULTIPLICITY
89struct ev_loop; 160struct ev_loop;
90# define EV_P struct ev_loop *loop 161# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
91# define EV_P_ EV_P, 162# define EV_P_ EV_P, /* a loop as first of multiple parameters */
92# define EV_A loop 163# define EV_A loop /* a loop as sole argument to a function call */
93# define EV_A_ EV_A, 164# define EV_A_ EV_A, /* a loop as first of multiple arguments */
94# define EV_DEFAULT ev_default_loop (0) 165# define EV_DEFAULT_UC ev_default_loop_uc_ () /* the default loop, if initialised, as sole arg */
95# define EV_DEFAULT_ EV_DEFAULT, 166# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
167# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
168# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
96#else 169#else
97# define EV_P void 170# define EV_P void
98# define EV_P_ 171# define EV_P_
99# define EV_A 172# define EV_A
100# define EV_A_ 173# define EV_A_
101# define EV_DEFAULT 174# define EV_DEFAULT
102# define EV_DEFAULT_ 175# define EV_DEFAULT_
103 176# define EV_DEFAULT_UC
177# define EV_DEFAULT_UC_
104# undef EV_EMBED_ENABLE 178# undef EV_EMBED_ENABLE
105#endif 179#endif
106 180
181/* EV_INLINE is used for functions in header files */
182#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
183# define EV_INLINE static inline
184#else
185# define EV_INLINE static
186#endif
187
188/* EV_PROTOTYPES can be sued to switch of prototype declarations */
189#ifndef EV_PROTOTYPES
190# define EV_PROTOTYPES 1
191#endif
192
193/*****************************************************************************/
194
195#define EV_VERSION_MAJOR 4
196#define EV_VERSION_MINOR 0
197
107/* eventmask, revents, events... */ 198/* eventmask, revents, events... */
199enum {
108#define EV_UNDEF -1L /* guaranteed to be invalid */ 200 EV_UNDEF = -1, /* guaranteed to be invalid */
109#define EV_NONE 0x00L /* no events */ 201 EV_NONE = 0x00, /* no events */
110#define EV_READ 0x01L /* ev_io detected read will not block */ 202 EV_READ = 0x01, /* ev_io detected read will not block */
111#define EV_WRITE 0x02L /* ev_io detected write will not block */ 203 EV_WRITE = 0x02, /* ev_io detected write will not block */
112#define EV_IOFDSET 0x80L /* internal use only */ 204 EV__IOFDSET = 0x80, /* internal use only */
205 EV_IO = EV_READ, /* alias for type-detection */
113#define EV_TIMEOUT 0x00000100L /* timer timed out */ 206 EV_TIMER = 0x00000100, /* timer timed out */
207#if EV_COMPAT3
208 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
209#endif
114#define EV_PERIODIC 0x00000200L /* periodic timer timed out */ 210 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
115#define EV_SIGNAL 0x00000400L /* signal was received */ 211 EV_SIGNAL = 0x00000400, /* signal was received */
116#define EV_CHILD 0x00000800L /* child/pid had status change */ 212 EV_CHILD = 0x00000800, /* child/pid had status change */
117#define EV_STAT 0x00001000L /* stat data changed */ 213 EV_STAT = 0x00001000, /* stat data changed */
118#define EV_IDLE 0x00002000L /* event loop is idling */ 214 EV_IDLE = 0x00002000, /* event loop is idling */
119#define EV_PREPARE 0x00004000L /* event loop about to poll */ 215 EV_PREPARE = 0x00004000, /* event loop about to poll */
120#define EV_CHECK 0x00008000L /* event loop finished poll */ 216 EV_CHECK = 0x00008000, /* event loop finished poll */
121#define EV_EMBED 0x00010000L /* embedded event loop needs sweep */ 217 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
122#define EV_FORK 0x00020000L /* event loop resumed in child */ 218 EV_FORK = 0x00020000, /* event loop resumed in child */
219 EV_CLEANUP = 0x00040000, /* event loop resumed in child */
220 EV_ASYNC = 0x00080000, /* async intra-loop signal */
221 EV_CUSTOM = 0x01000000, /* for use by user code */
123#define EV_ERROR 0x80000000L /* sent when an error occurs */ 222 EV_ERROR = 0x80000000 /* sent when an error occurs */
223};
124 224
125/* 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 */
126#ifndef EV_COMMON 226#ifndef EV_COMMON
127# define EV_COMMON void *data; 227# define EV_COMMON void *data;
128#endif 228#endif
129#ifndef EV_PROTOTYPES
130# define EV_PROTOTYPES 1
131#endif
132
133#define EV_VERSION_MAJOR 3
134#define EV_VERSION_MINOR 0
135 229
136#ifndef EV_CB_DECLARE 230#ifndef EV_CB_DECLARE
137# 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);
138#endif 232#endif
139#ifndef EV_CB_INVOKE 233#ifndef EV_CB_INVOKE
140# 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))
141#endif 235#endif
142 236
237/* not official, do not use */
238#define EV_CB(type,name) void name (EV_P_ struct ev_ ## type *w, int revents)
239
143/* 240/*
144 * struct member types: 241 * struct member types:
145 * private: you can look at them, but not change them, and they might not mean anything to you. 242 * private: you may look at them, but not change them,
243 * and they might not mean anything to you.
146 * ro: can be read anytime, but only changed when the watcher isn't active 244 * ro: can be read anytime, but only changed when the watcher isn't active.
147 * rw: can be read and modified anytime, even when the watcher is active 245 * rw: can be read and modified anytime, even when the watcher is active.
246 *
247 * some internal details that might be helpful for debugging:
248 *
249 * active is either 0, which means the watcher is not active,
250 * or the array index of the watcher (periodics, timers)
251 * or the array index + 1 (most other watchers)
252 * or simply 1 for watchers that aren't in some array.
253 * pending is either 0, in which case the watcher isn't,
254 * or the array index + 1 in the pendings array.
148 */ 255 */
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
149 262
150/* shared by all watchers */ 263/* shared by all watchers */
151#define EV_WATCHER(type) \ 264#define EV_WATCHER(type) \
152 int active; /* private */ \ 265 int active; /* private */ \
153 int pending; /* private */ \ 266 int pending; /* private */ \
154 int priority; /* private */ \ 267 EV_DECL_PRIORITY /* private */ \
155 EV_COMMON /* rw */ \ 268 EV_COMMON /* rw */ \
156 EV_CB_DECLARE (type) /* private */ 269 EV_CB_DECLARE (type) /* private */
157 270
158#define EV_WATCHER_LIST(type) \ 271#define EV_WATCHER_LIST(type) \
159 EV_WATCHER (type) \ 272 EV_WATCHER (type) \
281 EV_WATCHER (ev_check) 394 EV_WATCHER (ev_check)
282} ev_check; 395} ev_check;
283 396
284#if EV_FORK_ENABLE 397#if EV_FORK_ENABLE
285/* 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 */
286typedef struct ev_fork 400typedef struct ev_fork
287{ 401{
288 EV_WATCHER (ev_fork) 402 EV_WATCHER (ev_fork)
289} 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;
290#endif 413#endif
291 414
292#if EV_EMBED_ENABLE 415#if EV_EMBED_ENABLE
293/* used to embed an event loop inside another */ 416/* used to embed an event loop inside another */
294/* 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 */
301 ev_prepare prepare; /* private */ 424 ev_prepare prepare; /* private */
302 ev_check check; /* unused */ 425 ev_check check; /* unused */
303 ev_timer timer; /* unused */ 426 ev_timer timer; /* unused */
304 ev_periodic periodic; /* unused */ 427 ev_periodic periodic; /* unused */
305 ev_idle idle; /* unused */ 428 ev_idle idle; /* unused */
306 ev_fork fork; /* unused */ 429 ev_fork fork; /* private */
430 ev_cleanup cleanup; /* unused */
307} ev_embed; 431} ev_embed;
432#endif
433
434#if EV_ASYNC_ENABLE
435/* invoked when somebody calls ev_async_send on the watcher */
436/* revent EV_ASYNC */
437typedef struct ev_async
438{
439 EV_WATCHER (ev_async)
440
441 EV_ATOMIC_T sent; /* private */
442} ev_async;
443
444# define ev_async_pending(w) (+(w)->sent)
308#endif 445#endif
309 446
310/* the presence of this union forces similar struct layout */ 447/* the presence of this union forces similar struct layout */
311union ev_any_watcher 448union ev_any_watcher
312{ 449{
327 struct ev_prepare prepare; 464 struct ev_prepare prepare;
328 struct ev_check check; 465 struct ev_check check;
329#if EV_FORK_ENABLE 466#if EV_FORK_ENABLE
330 struct ev_fork fork; 467 struct ev_fork fork;
331#endif 468#endif
469#if EV_CLEANUP_ENABLE
470 struct ev_cleanup cleanup;
471#endif
332#if EV_EMBED_ENABLE 472#if EV_EMBED_ENABLE
333 struct ev_embed embed; 473 struct ev_embed embed;
334#endif 474#endif
475#if EV_ASYNC_ENABLE
476 struct ev_async async;
477#endif
335}; 478};
336 479
337/* bits for ev_default_loop and ev_loop_new */ 480/* flag bits for ev_default_loop and ev_loop_new */
481enum {
338/* the default */ 482 /* the default */
339#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */ 483 EVFLAG_AUTO = 0x00000000U, /* not quite a mask */
340/* flag bits */ 484 /* flag bits */
341#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */ 485 EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */
342#define EVFLAG_FORKCHECK 0x02000000UL /* 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
343/* method bits to be ored together */ 495/* method bits to be ored together */
496enum {
344#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */ 497 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
345#define EVBACKEND_POLL 0x00000002UL /* !win */ 498 EVBACKEND_POLL = 0x00000002U, /* !win */
346#define EVBACKEND_EPOLL 0x00000004UL /* linux */ 499 EVBACKEND_EPOLL = 0x00000004U, /* linux */
347#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */ 500 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
348#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */ 501 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
349#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */ 502 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
503 EVBACKEND_ALL = 0x0000003FU
504};
350 505
351#if EV_PROTOTYPES 506#if EV_PROTOTYPES
352int ev_version_major (void); 507int ev_version_major (void);
353int ev_version_minor (void); 508int ev_version_minor (void);
354 509
371 * retryable syscall error 526 * retryable syscall error
372 * (such as failed select, poll, epoll_wait) 527 * (such as failed select, poll, epoll_wait)
373 */ 528 */
374void ev_set_syserr_cb (void (*cb)(const char *msg)); 529void ev_set_syserr_cb (void (*cb)(const char *msg));
375 530
376# if EV_MULTIPLICITY 531#if EV_MULTIPLICITY
532
377/* the default loop is the only one that handles signals and child watchers */ 533/* the default loop is the only one that handles signals and child watchers */
378/* you can call this as often as you like */ 534/* you can call this as often as you like */
379static struct ev_loop * 535struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0));
380ev_default_loop (unsigned int flags) 536
537EV_INLINE struct ev_loop *
538ev_default_loop_uc_ (void)
381{ 539{
382 extern struct ev_loop *ev_default_loop_ptr; 540 extern struct ev_loop *ev_default_loop_ptr;
383 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
384
385 if (!ev_default_loop_ptr)
386 ev_default_loop_init (flags);
387 541
388 return ev_default_loop_ptr; 542 return ev_default_loop_ptr;
389} 543}
390 544
545EV_INLINE int
546ev_is_default_loop (EV_P)
547{
548 return EV_A == EV_DEFAULT_UC;
549}
550
391/* create and destroy alternative loops that don't handle signals */ 551/* create and destroy alternative loops that don't handle signals */
392struct 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 */
393void ev_loop_destroy (EV_P); 554void ev_loop_destroy (EV_P);
394void ev_loop_fork (EV_P);
395 555
396ev_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 */
397 557
398# else 558#else
399 559
400int ev_default_loop (unsigned int flags); /* returns true when successful */ 560int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */
401 561
402static ev_tstamp 562EV_INLINE ev_tstamp
403ev_now (void) 563ev_now (void)
404{ 564{
405 extern ev_tstamp ev_rt_now; 565 extern ev_tstamp ev_rt_now;
406 566
407 return ev_rt_now; 567 return ev_rt_now;
408} 568}
409# endif
410 569
411void ev_default_destroy (void); /* destroy the default loop */ 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
577#endif /* multiplicity */
578
412/* this needs to be called after fork, to duplicate the default loop */ 579/* this needs to be called after fork, to duplicate the loop */
413/* 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 */
414/* you can call it in either the parent or the child */ 581/* you can call it in either the parent or the child */
415/* you can actually call it at any time, anywhere :) */ 582/* you can actually call it at any time, anywhere :) */
416void ev_default_fork (void); 583void ev_loop_fork (EV_P);
417 584
418unsigned int ev_backend (EV_P); /* backend in use by loop */ 585unsigned int ev_backend (EV_P); /* backend in use by loop */
419unsigned int ev_loop_count (EV_P); /* number of loop iterations */
420#endif
421 586
422#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 587void ev_now_update (EV_P); /* update event loop time */
423#define EVLOOP_ONESHOT 2 /* block *once* only */ 588
424#define EVUNLOOP_CANCEL 0 /* undo unloop */ 589#if EV_WALK_ENABLE
425#define EVUNLOOP_ONE 1 /* unloop once */ 590/* walk (almost) all watchers in the loop of a given type, invoking the */
591/* callback on every such watcher. The callback might stop the watcher, */
592/* but do nothing else with the loop */
593void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
594#endif
595
596#endif /* prototypes */
597
598/* ev_run flags values */
599enum {
600 EVRUN_NOWAIT = 1, /* do not block/wait */
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 */
426#define EVUNLOOP_ALL 2 /* unloop all loops */ 608 EVBREAK_ALL = 2 /* unloop all loops */
609};
427 610
428#if EV_PROTOTYPES 611#if EV_PROTOTYPES
429void ev_loop (EV_P_ int flags); 612void ev_run (EV_P_ int flags EV_CPP (= 0));
430void 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 */
431
432void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
433void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
434 614
435/* 615/*
436 * 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
437 * 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
438 * 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.
439 */ 619 */
440void ev_ref (EV_P); 620void ev_ref (EV_P);
441void ev_unref (EV_P); 621void ev_unref (EV_P);
442 622
623/*
443/* convinience function, wait for a single event, without registering an event watcher */ 624 * convenience function, wait for a single event, without registering an event watcher
444/* if timeout is < 0, do wait indefinitely */ 625 * if timeout is < 0, do wait indefinitely
626 */
445void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 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 */
645
646/*
647 * stop/start the timer handling.
648 */
649void ev_suspend (EV_P);
650void ev_resume (EV_P);
651#endif
652
446#endif 653#endif
447 654
448/* 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 */
449/* 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 */
450#define ev_init(ev,cb_) do { \ 657#define ev_init(ev,cb_) do { \
451 ((ev_watcher *)(void *)(ev))->active = \ 658 ((ev_watcher *)(void *)(ev))->active = \
452 ((ev_watcher *)(void *)(ev))->pending = \ 659 ((ev_watcher *)(void *)(ev))->pending = 0; \
453 ((ev_watcher *)(void *)(ev))->priority = 0; \ 660 ev_set_priority ((ev), 0); \
454 ev_set_cb ((ev), cb_); \ 661 ev_set_cb ((ev), cb_); \
455} while (0) 662} while (0)
456 663
457#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)
458#define ev_timer_set(ev,after_,repeat_) do { (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)
459#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 666#define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0)
460#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 667#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
461#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0) 668#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
462#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0) 669#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
463#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 */
464#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 */
465#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 */
466#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)
467#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 */
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 */
468 677
469#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)
470#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)
471#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } 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)
472#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)
473#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0) 682#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
474#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0) 683#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
475#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)
476#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)
477#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)
478#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)
479#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)
690#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
480 691
481#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 */
482#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 */
483 694
484#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
485#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))
486#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
704
705#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
487 706
488#ifndef ev_set_cb 707#ifndef ev_set_cb
489# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 708# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
490#endif 709#endif
491 710
492/* stopping (enabling, adding) a watcher does nothing if it is already running */ 711/* stopping (enabling, adding) a watcher does nothing if it is already running */
493/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 712/* stopping (disabling, deleting) a watcher does nothing unless its already running */
494#if EV_PROTOTYPES 713#if EV_PROTOTYPES
495 714
496/* 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 */
497/* accepts any ev_watcher type */ 716/* accepts any ev_watcher type */
498void ev_feed_event (EV_P_ void *w, int revents); 717void ev_feed_event (EV_P_ void *w, int revents);
499void 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
500void ev_feed_signal_event (EV_P_ int signum); 720void ev_feed_signal_event (EV_P_ int signum);
721#endif
501void ev_invoke (EV_P_ void *w, int revents); 722void ev_invoke (EV_P_ void *w, int revents);
502int ev_clear_pending (EV_P_ void *w); 723int ev_clear_pending (EV_P_ void *w);
503 724
504void ev_io_start (EV_P_ ev_io *w); 725void ev_io_start (EV_P_ ev_io *w);
505void ev_io_stop (EV_P_ ev_io *w); 726void ev_io_stop (EV_P_ ev_io *w);
506 727
507void ev_timer_start (EV_P_ ev_timer *w); 728void ev_timer_start (EV_P_ ev_timer *w);
508void ev_timer_stop (EV_P_ ev_timer *w); 729void ev_timer_stop (EV_P_ ev_timer *w);
509/* 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 */
510void 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);
511 734
512#if EV_PERIODIC_ENABLE 735#if EV_PERIODIC_ENABLE
513void ev_periodic_start (EV_P_ ev_periodic *w); 736void ev_periodic_start (EV_P_ ev_periodic *w);
514void ev_periodic_stop (EV_P_ ev_periodic *w); 737void ev_periodic_stop (EV_P_ ev_periodic *w);
515void ev_periodic_again (EV_P_ ev_periodic *w); 738void ev_periodic_again (EV_P_ ev_periodic *w);
516#endif 739#endif
517 740
518/* only supported in the default loop */ 741/* only supported in the default loop */
742#if EV_SIGNAL_ENABLE
519void ev_signal_start (EV_P_ ev_signal *w); 743void ev_signal_start (EV_P_ ev_signal *w);
520void ev_signal_stop (EV_P_ ev_signal *w); 744void ev_signal_stop (EV_P_ ev_signal *w);
745#endif
521 746
522/* only supported in the default loop */ 747/* only supported in the default loop */
748# if EV_CHILD_ENABLE
523void ev_child_start (EV_P_ ev_child *w); 749void ev_child_start (EV_P_ ev_child *w);
524void ev_child_stop (EV_P_ ev_child *w); 750void ev_child_stop (EV_P_ ev_child *w);
751# endif
525 752
526# if EV_STAT_ENABLE 753# if EV_STAT_ENABLE
527void ev_stat_start (EV_P_ ev_stat *w); 754void ev_stat_start (EV_P_ ev_stat *w);
528void ev_stat_stop (EV_P_ ev_stat *w); 755void ev_stat_stop (EV_P_ ev_stat *w);
529void ev_stat_stat (EV_P_ ev_stat *w); 756void ev_stat_stat (EV_P_ ev_stat *w);
532# if EV_IDLE_ENABLE 759# if EV_IDLE_ENABLE
533void ev_idle_start (EV_P_ ev_idle *w); 760void ev_idle_start (EV_P_ ev_idle *w);
534void ev_idle_stop (EV_P_ ev_idle *w); 761void ev_idle_stop (EV_P_ ev_idle *w);
535# endif 762# endif
536 763
764#if EV_PREPARE_ENABLE
537void ev_prepare_start (EV_P_ ev_prepare *w); 765void ev_prepare_start (EV_P_ ev_prepare *w);
538void ev_prepare_stop (EV_P_ ev_prepare *w); 766void ev_prepare_stop (EV_P_ ev_prepare *w);
767#endif
539 768
769#if EV_CHECK_ENABLE
540void ev_check_start (EV_P_ ev_check *w); 770void ev_check_start (EV_P_ ev_check *w);
541void ev_check_stop (EV_P_ ev_check *w); 771void ev_check_stop (EV_P_ ev_check *w);
772#endif
542 773
543# if EV_FORK_ENABLE 774# if EV_FORK_ENABLE
544void ev_fork_start (EV_P_ ev_fork *w); 775void ev_fork_start (EV_P_ ev_fork *w);
545void 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);
546# endif 782# endif
547 783
548# if EV_EMBED_ENABLE 784# if EV_EMBED_ENABLE
549/* only supported when loop to be embedded is in fact embeddable */ 785/* only supported when loop to be embedded is in fact embeddable */
550void ev_embed_start (EV_P_ ev_embed *w); 786void ev_embed_start (EV_P_ ev_embed *w);
551void ev_embed_stop (EV_P_ ev_embed *w); 787void ev_embed_stop (EV_P_ ev_embed *w);
552void ev_embed_sweep (EV_P_ ev_embed *w); 788void ev_embed_sweep (EV_P_ ev_embed *w);
553# endif 789# endif
554 790
791# if EV_ASYNC_ENABLE
792void ev_async_start (EV_P_ ev_async *w);
793void ev_async_stop (EV_P_ ev_async *w);
794void ev_async_send (EV_P_ ev_async *w);
555#endif 795# endif
556 796
557#ifdef __cplusplus 797#if EV_COMPAT3
558} 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
559#endif 813 #endif
560 814#else
815 typedef struct ev_loop ev_loop;
561#endif 816#endif
562 817
818#endif
819
820EV_CPP(})
821
822#endif
823

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines