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

Comparing libev/ev.h (file contents):
Revision 1.29 by root, Sun Nov 4 00:24:17 2007 UTC vs.
Revision 1.104 by root, Thu Jun 19 07:06:35 2008 UTC

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

Diff Legend

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