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

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

Diff Legend

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