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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines