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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines