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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines