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

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

Diff Legend

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