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

Comparing libev/ev.h (file contents):
Revision 1.49 by root, Sat Nov 10 21:19:30 2007 UTC vs.
Revision 1.117 by root, Wed Jul 8 04:29:31 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines