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

Comparing libev/ev.h (file contents):
Revision 1.24 by root, Sat Nov 3 09:19:58 2007 UTC vs.
Revision 1.111 by root, Mon Mar 16 21:15:06 2009 UTC

1/* 1/*
2 * libev native API header
3 *
2 * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008,2009 Marc Alexander Lehmann <libev@schmorp.de>
3 * All rights reserved. 5 * All rights reserved.
4 * 6 *
5 * Redistribution and use in source and binary forms, with or without 7 * Redistribution and use in source and binary forms, with or without modifica-
6 * modification, are permitted provided that the following conditions are 8 * tion, are permitted provided that the following conditions are met:
7 * met: 9 *
10 * 1. Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
12 *
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
18 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
19 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
20 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
21 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
23 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
25 * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
26 * OF THE POSSIBILITY OF SUCH DAMAGE.
8 * 27 *
9 * * Redistributions of source code must retain the above copyright 28 * Alternatively, the contents of this file may be used under the terms of
10 * notice, this list of conditions and the following disclaimer. 29 * the GNU General Public License ("GPL") version 2 or any later version,
11 * 30 * in which case the provisions of the GPL are applicable instead of
12 * * Redistributions in binary form must reproduce the above 31 * the above. If you wish to allow the use of your version of this file
13 * copyright notice, this list of conditions and the following 32 * only under the terms of the GPL and not to allow others to use your
14 * disclaimer in the documentation and/or other materials provided 33 * version of this file under the BSD license, indicate your decision
15 * with the distribution. 34 * by deleting the provisions above and replace them with the notice
16 * 35 * and other provisions required by the GPL. If you do not delete the
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 36 * provisions above, a recipient may use your version of this file under
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 37 * either the BSD or the GPL.
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */ 38 */
29 39
30#ifndef EV_H 40#ifndef EV_H__
31#define EV_H 41#define EV_H__
32 42
33#ifdef __cplusplus 43#ifdef __cplusplus
34extern "C" { 44extern "C" {
35#endif 45#endif
36 46
… …
42#endif 52#endif
43#ifndef EV_MAXPRI 53#ifndef EV_MAXPRI
44# define EV_MAXPRI +2 54# define EV_MAXPRI +2
45#endif 55#endif
46 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
85#ifndef EV_ATOMIC_T
86# include <signal.h>
87# define EV_ATOMIC_T sig_atomic_t volatile
88#endif
89
90/*****************************************************************************/
91
92#if EV_STAT_ENABLE
93# ifdef _WIN32
94# include <time.h>
95# include <sys/types.h>
96# endif
97# include <sys/stat.h>
98#endif
99
100/* support multiple event loops? */
101#if EV_MULTIPLICITY
102struct ev_loop;
103# define EV_P struct ev_loop *loop
104# define EV_P_ EV_P,
105# define EV_A loop
106# define EV_A_ EV_A,
107# define EV_DEFAULT_UC ev_default_loop_uc ()
108# define EV_DEFAULT_UC_ EV_DEFAULT_UC,
109# define EV_DEFAULT ev_default_loop (0)
110# define EV_DEFAULT_ EV_DEFAULT,
111#else
112# define EV_P void
113# define EV_P_
114# define EV_A
115# define EV_A_
116# define EV_DEFAULT
117# define EV_DEFAULT_
118# define EV_DEFAULT_UC
119# define EV_DEFAULT_UC_
120# undef EV_EMBED_ENABLE
121#endif
122
123#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
124# define EV_INLINE static inline
125#else
126# define EV_INLINE static
127#endif
128
129/*****************************************************************************/
130
47/* eventmask, revents, events... */ 131/* eventmask, revents, events... */
48#define EV_UNDEF -1 /* guaranteed to be invalid */ 132#define EV_UNDEF -1 /* guaranteed to be invalid */
49#define EV_NONE 0x00 133#define EV_NONE 0x00 /* no events */
50#define EV_READ 0x01 134#define EV_READ 0x01 /* ev_io detected read will not block */
51#define EV_WRITE 0x02 135#define EV_WRITE 0x02 /* ev_io detected write will not block */
52#define EV_TIMEOUT 0x000100 136#define EV__IOFDSET 0x80 /* internal use only */
53#define EV_PERIODIC 0x000200 137#define EV_IO EV_READ /* alias for type-detection */
54#define EV_SIGNAL 0x000400 138#define EV_TIMEOUT 0x00000100 /* timer timed out */
55#define EV_IDLE 0x000800 139#define EV_PERIODIC 0x00000200 /* periodic timer timed out */
56#define EV_CHECK 0x001000 140#define EV_SIGNAL 0x00000400 /* signal was received */
57#define EV_PREPARE 0x002000 141#define EV_CHILD 0x00000800 /* child/pid had status change */
58#define EV_CHILD 0x004000 142#define EV_STAT 0x00001000 /* stat data changed */
143#define EV_IDLE 0x00002000 /* event loop is idling */
144#define EV_PREPARE 0x00004000 /* event loop about to poll */
145#define EV_CHECK 0x00008000 /* event loop finished poll */
146#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
147#define EV_FORK 0x00020000 /* event loop resumed in child */
148#define EV_ASYNC 0x00040000 /* async intra-loop signal */
59#define EV_ERROR 0x800000 /* sent when an error occurs */ 149#define EV_ERROR 0x80000000 /* sent when an error occurs */
60 150
61/* can be used to add custom fields to all watchers */ 151/* can be used to add custom fields to all watchers, while losing binary compatibility */
62#ifndef EV_COMMON 152#ifndef EV_COMMON
63# define EV_COMMON void *data 153# define EV_COMMON void *data;
64#endif 154#endif
65#ifndef EV_PROTOTYPES 155#ifndef EV_PROTOTYPES
66# define EV_PROTOTYPES 1 156# define EV_PROTOTYPES 1
67#endif 157#endif
68 158
69#define EV_VERSION_MAJOR 1 159#define EV_VERSION_MAJOR 3
70#define EV_VERSION_MINOR 1 160#define EV_VERSION_MINOR 0
161
162#ifndef EV_CB_DECLARE
163# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
164#endif
165#ifndef EV_CB_INVOKE
166# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
167#endif
71 168
72/* 169/*
73 * struct member types: 170 * struct member types:
74 * private: you can look at them, but not change them, and they might not mean anything to you. 171 * private: you may look at them, but not change them,
172 * and they might not mean anything to you.
75 * ro: can be read anytime, but only changed when the watcher isn't active 173 * ro: can be read anytime, but only changed when the watcher isn't active.
76 * rw: can be read and modified anytime, even when the watcher is active 174 * rw: can be read and modified anytime, even when the watcher is active.
175 *
176 * some internal details that might be helpful for debugging:
177 *
178 * active is either 0, which means the watcher is not active,
179 * or the array index of the watcher (periodics, timers)
180 * or the array index + 1 (most other watchers)
181 * or simply 1 for watchers that aren't in some array.
182 * pending is either 0, in which case the watcher isn't,
183 * or the array index + 1 in the pendings array.
77 */ 184 */
78 185
79/* shared by all watchers */ 186/* shared by all watchers */
80#define EV_WATCHER(type) \ 187#define EV_WATCHER(type) \
81 int active; /* private */ \ 188 int active; /* private */ \
82 int pending; /* private */ \ 189 int pending; /* private */ \
83 int priority; /* ro */ \ 190 int priority; /* private */ \
84 EV_COMMON; /* rw */ \ 191 EV_COMMON /* rw */ \
85 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */ 192 EV_CB_DECLARE (type) /* private */
86 193
87#define EV_WATCHER_LIST(type) \ 194#define EV_WATCHER_LIST(type) \
88 EV_WATCHER (type); \ 195 EV_WATCHER (type) \
89 struct type *next /* private */ 196 struct ev_watcher_list *next; /* private */
90 197
91#define EV_WATCHER_TIME(type) \ 198#define EV_WATCHER_TIME(type) \
92 EV_WATCHER (type); \ 199 EV_WATCHER (type) \
93 ev_tstamp at /* private */ 200 ev_tstamp at; /* private */
94 201
95/* base class, nothing to see here unless you subclass */ 202/* base class, nothing to see here unless you subclass */
96struct ev_watcher { 203typedef struct ev_watcher
204{
97 EV_WATCHER (ev_watcher); 205 EV_WATCHER (ev_watcher)
98}; 206} ev_watcher;
99 207
100/* base class, nothing to see here unless you subclass */ 208/* base class, nothing to see here unless you subclass */
101struct ev_watcher_list { 209typedef struct ev_watcher_list
210{
102 EV_WATCHER_LIST (ev_watcher_list); 211 EV_WATCHER_LIST (ev_watcher_list)
103}; 212} ev_watcher_list;
104 213
105/* base class, nothing to see here unless you subclass */ 214/* base class, nothing to see here unless you subclass */
106struct ev_watcher_time { 215typedef struct ev_watcher_time
216{
107 EV_WATCHER_TIME (ev_watcher_time); 217 EV_WATCHER_TIME (ev_watcher_time)
108}; 218} ev_watcher_time;
219
220/* invoked when fd is either EV_READable or EV_WRITEable */
221/* revent EV_READ, EV_WRITE */
222typedef struct ev_io
223{
224 EV_WATCHER_LIST (ev_io)
225
226 int fd; /* ro */
227 int events; /* ro */
228} ev_io;
109 229
110/* invoked after a specific time, repeatable (based on monotonic clock) */ 230/* invoked after a specific time, repeatable (based on monotonic clock) */
111/* revent EV_TIMEOUT */ 231/* revent EV_TIMEOUT */
112struct ev_timer 232typedef struct ev_timer
113{ 233{
114 EV_WATCHER_TIME (ev_timer); 234 EV_WATCHER_TIME (ev_timer)
115 235
116 ev_tstamp repeat; /* rw */ 236 ev_tstamp repeat; /* rw */
117}; 237} ev_timer;
118 238
119/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 239/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
120/* revent EV_PERIODIC */ 240/* revent EV_PERIODIC */
121struct ev_periodic 241typedef struct ev_periodic
122{ 242{
123 EV_WATCHER_TIME (ev_periodic); 243 EV_WATCHER_TIME (ev_periodic)
124 244
245 ev_tstamp offset; /* rw */
125 ev_tstamp interval; /* rw */ 246 ev_tstamp interval; /* rw */
126}; 247 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
127 248} ev_periodic;
128/* invoked when fd is either EV_READable or EV_WRITEable */
129/* revent EV_READ, EV_WRITE */
130struct ev_io
131{
132 EV_WATCHER_LIST (ev_io);
133
134 int fd; /* ro */
135 int events; /* ro */
136};
137 249
138/* invoked when the given signal has been received */ 250/* invoked when the given signal has been received */
139/* revent EV_SIGNAL */ 251/* revent EV_SIGNAL */
140struct ev_signal 252typedef struct ev_signal
141{ 253{
142 EV_WATCHER_LIST (ev_signal); 254 EV_WATCHER_LIST (ev_signal)
143 255
144 int signum; /* ro */ 256 int signum; /* ro */
145}; 257} ev_signal;
146 258
259/* invoked when sigchld is received and waitpid indicates the given pid */
260/* revent EV_CHILD */
261/* does not support priorities */
262typedef struct ev_child
263{
264 EV_WATCHER_LIST (ev_child)
265
266 int flags; /* private */
267 int pid; /* ro */
268 int rpid; /* rw, holds the received pid */
269 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
270} ev_child;
271
272#if EV_STAT_ENABLE
273/* st_nlink = 0 means missing file or other error */
274# ifdef _WIN32
275typedef struct _stati64 ev_statdata;
276# else
277typedef struct stat ev_statdata;
278# endif
279
280/* invoked each time the stat data changes for a given path */
281/* revent EV_STAT */
282typedef struct ev_stat
283{
284 EV_WATCHER_LIST (ev_stat)
285
286 ev_timer timer; /* private */
287 ev_tstamp interval; /* ro */
288 const char *path; /* ro */
289 ev_statdata prev; /* ro */
290 ev_statdata attr; /* ro */
291
292 int wd; /* wd for inotify, fd for kqueue */
293} ev_stat;
294#endif
295
296#if EV_IDLE_ENABLE
147/* invoked when the nothing else needs to be done, keeps the process from blocking */ 297/* invoked when the nothing else needs to be done, keeps the process from blocking */
148/* revent EV_IDLE */ 298/* revent EV_IDLE */
149struct ev_idle 299typedef struct ev_idle
150{ 300{
151 EV_WATCHER (ev_idle); 301 EV_WATCHER (ev_idle)
152}; 302} ev_idle;
303#endif
153 304
154/* invoked for each run of the mainloop, just before the blocking call */ 305/* invoked for each run of the mainloop, just before the blocking call */
155/* you can still change events in any way you like */ 306/* you can still change events in any way you like */
156/* revent EV_PREPARE */ 307/* revent EV_PREPARE */
157struct ev_prepare 308typedef struct ev_prepare
158{ 309{
159 EV_WATCHER (ev_prepare); 310 EV_WATCHER (ev_prepare)
160}; 311} ev_prepare;
161 312
162/* invoked for each run of the mainloop, just after the blocking call */ 313/* invoked for each run of the mainloop, just after the blocking call */
163/* revent EV_CHECK */ 314/* revent EV_CHECK */
164struct ev_check 315typedef struct ev_check
165{ 316{
166 EV_WATCHER (ev_check); 317 EV_WATCHER (ev_check)
318} ev_check;
319
320#if EV_FORK_ENABLE
321/* the callback gets invoked before check in the child process when a fork was detected */
322typedef struct ev_fork
323{
324 EV_WATCHER (ev_fork)
325} ev_fork;
326#endif
327
328#if EV_EMBED_ENABLE
329/* used to embed an event loop inside another */
330/* the callback gets invoked when the event loop has handled events, and can be 0 */
331typedef struct ev_embed
332{
333 EV_WATCHER (ev_embed)
334
335 struct ev_loop *other; /* ro */
336 ev_io io; /* private */
337 ev_prepare prepare; /* private */
338 ev_check check; /* unused */
339 ev_timer timer; /* unused */
340 ev_periodic periodic; /* unused */
341 ev_idle idle; /* unused */
342 ev_fork fork; /* private */
343} ev_embed;
344#endif
345
346#if EV_ASYNC_ENABLE
347/* invoked when somebody calls ev_async_send on the watcher */
348/* revent EV_ASYNC */
349typedef struct ev_async
350{
351 EV_WATCHER (ev_async)
352
353 EV_ATOMIC_T sent; /* private */
354} ev_async;
355
356# define ev_async_pending(w) ((w)->sent + 0)
357#endif
358
359/* the presence of this union forces similar struct layout */
360union ev_any_watcher
361{
362 struct ev_watcher w;
363 struct ev_watcher_list wl;
364
365 struct ev_io io;
366 struct ev_timer timer;
367 struct ev_periodic periodic;
368 struct ev_signal signal;
369 struct ev_child child;
370#if EV_STAT_ENABLE
371 struct ev_stat stat;
372#endif
373#if EV_IDLE_ENABLE
374 struct ev_idle idle;
375#endif
376 struct ev_prepare prepare;
377 struct ev_check check;
378#if EV_FORK_ENABLE
379 struct ev_fork fork;
380#endif
381#if EV_EMBED_ENABLE
382 struct ev_embed embed;
383#endif
384#if EV_ASYNC_ENABLE
385 struct ev_async async;
386#endif
167}; 387};
168 388
169/* invoked when sigchld is received and waitpid indicates the givne pid */ 389/* bits for ev_default_loop and ev_loop_new */
170/* revent EV_CHILD */ 390/* the default */
171struct ev_child 391#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
172{ 392/* flag bits */
173 EV_WATCHER_LIST (ev_child); 393#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
394#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
395/* method bits to be ored together */
396#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
397#define EVBACKEND_POLL 0x00000002U /* !win */
398#define EVBACKEND_EPOLL 0x00000004U /* linux */
399#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
400#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
401#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
174 402
175 int pid; /* ro */
176 int rpid; /* rw, holds the received pid */
177 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
178};
179
180#define EVMETHOD_AUTO 0 /* consults environment */
181#define EVMETHOD_SELECT 1
182#define EVMETHOD_POLL 2
183#define EVMETHOD_EPOLL 4
184#define EVMETHOD_KQUEUE 8
185#define EVMETHOD_DEVPOLL 16 /* NYI */
186#define EVMETHOD_PORT 32 /* NYI */
187#define EVMETHOD_ANY ~0 /* any method, do not consult env */
188#if EV_PROTOTYPES 403#if EV_PROTOTYPES
189extern int ev_method;
190int ev_init (int methods); /* returns ev_method */
191int ev_version_major (void); 404int ev_version_major (void);
192int ev_version_minor (void); 405int ev_version_minor (void);
193 406
194/* these three calls are suitable for plugging into pthread_atfork */ 407unsigned int ev_supported_backends (void);
195void ev_fork_prepare (void); 408unsigned int ev_recommended_backends (void);
196void ev_fork_parent (void); 409unsigned int ev_embeddable_backends (void);
197void ev_fork_child (void);
198 410
199extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
200ev_tstamp ev_time (void); 411ev_tstamp ev_time (void);
412void ev_sleep (ev_tstamp delay); /* sleep for a while */
413
414/* Sets the allocation function to use, works like realloc.
415 * It is used to allocate and free memory.
416 * If it returns zero when memory needs to be allocated, the library might abort
417 * or take some potentially destructive action.
418 * The default is your system realloc function.
419 */
420void ev_set_allocator (void *(*cb)(void *ptr, long size));
421
422/* set the callback function to call on a
423 * retryable syscall error
424 * (such as failed select, poll, epoll_wait)
425 */
426void ev_set_syserr_cb (void (*cb)(const char *msg));
427
428#if EV_MULTIPLICITY
429EV_INLINE struct ev_loop *
430ev_default_loop_uc (void)
431{
432 extern struct ev_loop *ev_default_loop_ptr;
433
434 return ev_default_loop_ptr;
435}
436
437/* the default loop is the only one that handles signals and child watchers */
438/* you can call this as often as you like */
439EV_INLINE struct ev_loop *
440ev_default_loop (unsigned int flags)
441{
442 struct ev_loop *loop = ev_default_loop_uc ();
443
444 if (!loop)
445 {
446 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
447
448 loop = ev_default_loop_init (flags);
449 }
450
451 return loop;
452}
453
454/* create and destroy alternative loops that don't handle signals */
455struct ev_loop *ev_loop_new (unsigned int flags);
456void ev_loop_destroy (EV_P);
457void ev_loop_fork (EV_P);
458void ev_loop_verify (EV_P);
459
460ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
461void ev_now_update (EV_P);
462
463#else
464
465int ev_default_loop (unsigned int flags); /* returns true when successful */
466
467EV_INLINE ev_tstamp
468ev_now (void)
469{
470 extern ev_tstamp ev_rt_now;
471
472 return ev_rt_now;
473}
474#endif /* multiplicity */
475
476EV_INLINE int
477ev_is_default_loop (EV_P)
478{
479#if EV_MULTIPLICITY
480 extern struct ev_loop *ev_default_loop_ptr;
481
482 return !!(EV_A == ev_default_loop_ptr);
483#else
484 return 1;
201#endif 485#endif
486}
487
488void ev_default_destroy (void); /* destroy the default loop */
489/* this needs to be called after fork, to duplicate the default loop */
490/* if you create alternative loops you have to call ev_loop_fork on them */
491/* you can call it in either the parent or the child */
492/* you can actually call it at any time, anywhere :) */
493void ev_default_fork (void);
494
495unsigned int ev_backend (EV_P); /* backend in use by loop */
496unsigned int ev_loop_count (EV_P); /* number of loop iterations */
497#endif /* prototypes */
202 498
203#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 499#define EVLOOP_NONBLOCK 1 /* do not block/wait */
204#define EVLOOP_ONESHOT 2 /* block *once* only */ 500#define EVLOOP_ONESHOT 2 /* block *once* only */
501#define EVUNLOOP_CANCEL 0 /* undo unloop */
502#define EVUNLOOP_ONE 1 /* unloop once */
503#define EVUNLOOP_ALL 2 /* unloop all loops */
504
205#if EV_PROTOTYPES 505#if EV_PROTOTYPES
206void ev_loop (int flags); 506void ev_loop (EV_P_ int flags);
207extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ 507void 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 */
208 508
509void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
510void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
511
512/*
513 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
514 * keeps one reference. if you have a long-runing watcher you never unregister that
515 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
516 */
517void ev_ref (EV_P);
518void ev_unref (EV_P);
519
209/* convinience function, wait for a single event, without registering an event watcher */ 520/* convenience function, wait for a single event, without registering an event watcher */
210/* if timeout is < 0, do wait indefinitely */ 521/* if timeout is < 0, do wait indefinitely */
211void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 522void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
212#endif 523#endif
213 524
214/* these may evaluate ev multiple times, and the other arguments at most once */ 525/* these may evaluate ev multiple times, and the other arguments at most once */
215/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 526/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
216#define ev_watcher_init(ev,cb_) do { (ev)->active = (ev)->pending = (ev)->priority = 0; (ev)->cb = (cb_); } while (0) 527#define ev_init(ev,cb_) do { \
528 ((ev_watcher *)(void *)(ev))->active = \
529 ((ev_watcher *)(void *)(ev))->pending = \
530 ((ev_watcher *)(void *)(ev))->priority = 0; \
531 ev_set_cb ((ev), cb_); \
532} while (0)
217 533
218#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 534#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
219#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 535#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
220#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) 536#define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0)
221#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 537#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
538#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
539#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
222#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 540#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
223#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 541#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
224#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 542#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
225#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 543#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
544#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
545#define ev_async_set(ev) do { (ev)->sent = 0; } while (0)
226 546
227#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 547#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
228#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 548#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
229#define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0) 549#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
230#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 550#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
551#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
552#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
231#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 553#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
232#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 554#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
233#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 555#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
556#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
557#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
234#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 558#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
235 559
560#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
236#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 561#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
562
563#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
564#define ev_cb(ev) (ev)->cb /* rw */
237#define ev_set_priority(ev,pri) (ev)->priority = pri 565#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri)
566
567#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)
568
569#ifndef ev_set_cb
570# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
571#endif
238 572
239/* stopping (enabling, adding) a watcher does nothing if it is already running */ 573/* stopping (enabling, adding) a watcher does nothing if it is already running */
240/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 574/* stopping (disabling, deleting) a watcher does nothing unless its already running */
241#if EV_PROTOTYPES 575#if EV_PROTOTYPES
576
577/* feeds an event into a watcher as if the event actually occured */
578/* accepts any ev_watcher type */
579void ev_feed_event (EV_P_ void *w, int revents);
580void ev_feed_fd_event (EV_P_ int fd, int revents);
581void ev_feed_signal_event (EV_P_ int signum);
582void ev_invoke (EV_P_ void *w, int revents);
583int ev_clear_pending (EV_P_ void *w);
584
242void ev_io_start (struct ev_io *w); 585void ev_io_start (EV_P_ ev_io *w);
243void ev_io_stop (struct ev_io *w); 586void ev_io_stop (EV_P_ ev_io *w);
244 587
245void ev_timer_start (struct ev_timer *w); 588void ev_timer_start (EV_P_ ev_timer *w);
246void ev_timer_stop (struct ev_timer *w); 589void ev_timer_stop (EV_P_ ev_timer *w);
247void ev_timer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 590/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
591void ev_timer_again (EV_P_ ev_timer *w);
248 592
593#if EV_PERIODIC_ENABLE
249void ev_periodic_start (struct ev_periodic *w); 594void ev_periodic_start (EV_P_ ev_periodic *w);
250void ev_periodic_stop (struct ev_periodic *w); 595void ev_periodic_stop (EV_P_ ev_periodic *w);
596void ev_periodic_again (EV_P_ ev_periodic *w);
597#endif
251 598
599/* only supported in the default loop */
252void ev_signal_start (struct ev_signal *w); 600void ev_signal_start (EV_P_ ev_signal *w);
253void ev_signal_stop (struct ev_signal *w); 601void ev_signal_stop (EV_P_ ev_signal *w);
254 602
603/* only supported in the default loop */
604void ev_child_start (EV_P_ ev_child *w);
605void ev_child_stop (EV_P_ ev_child *w);
606
607# if EV_STAT_ENABLE
608void ev_stat_start (EV_P_ ev_stat *w);
609void ev_stat_stop (EV_P_ ev_stat *w);
610void ev_stat_stat (EV_P_ ev_stat *w);
611# endif
612
613# if EV_IDLE_ENABLE
255void ev_idle_start (struct ev_idle *w); 614void ev_idle_start (EV_P_ ev_idle *w);
256void ev_idle_stop (struct ev_idle *w); 615void ev_idle_stop (EV_P_ ev_idle *w);
616# endif
257 617
258void ev_prepare_start (struct ev_prepare *w); 618void ev_prepare_start (EV_P_ ev_prepare *w);
259void ev_prepare_stop (struct ev_prepare *w); 619void ev_prepare_stop (EV_P_ ev_prepare *w);
260 620
261void ev_check_start (struct ev_check *w); 621void ev_check_start (EV_P_ ev_check *w);
262void ev_check_stop (struct ev_check *w); 622void ev_check_stop (EV_P_ ev_check *w);
263 623
264void ev_child_start (struct ev_child *w); 624# if EV_FORK_ENABLE
265void ev_child_stop (struct ev_child *w); 625void ev_fork_start (EV_P_ ev_fork *w);
626void ev_fork_stop (EV_P_ ev_fork *w);
627# endif
628
629# if EV_EMBED_ENABLE
630/* only supported when loop to be embedded is in fact embeddable */
631void ev_embed_start (EV_P_ ev_embed *w);
632void ev_embed_stop (EV_P_ ev_embed *w);
633void ev_embed_sweep (EV_P_ ev_embed *w);
634# endif
635
636# if EV_ASYNC_ENABLE
637void ev_async_start (EV_P_ ev_async *w);
638void ev_async_stop (EV_P_ ev_async *w);
639void ev_async_send (EV_P_ ev_async *w);
640# endif
641
266#endif 642#endif
267 643
268#ifdef __cplusplus 644#ifdef __cplusplus
269} 645}
270#endif 646#endif

Diff Legend

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