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

Comparing libev/ev.h (file contents):
Revision 1.99 by root, Wed Apr 16 01:37:14 2008 UTC vs.
Revision 1.145 by root, Fri Oct 22 06:09:26 2010 UTC

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

Diff Legend

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