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

Comparing libev/ev.h (file contents):
Revision 1.69 by root, Mon Nov 26 19:49:36 2007 UTC vs.
Revision 1.133 by root, Wed Mar 10 09:23:07 2010 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
33#ifdef __cplusplus 43#ifdef __cplusplus
34extern "C" { 44extern "C" {
35#endif 45#endif
36 46
54 64
55#ifndef EV_STAT_ENABLE 65#ifndef EV_STAT_ENABLE
56# define EV_STAT_ENABLE 1 66# define EV_STAT_ENABLE 1
57#endif 67#endif
58 68
69#ifndef EV_PREPARE_ENABLE
70# define EV_PREPARE_ENABLE 1
71#endif
72
73#ifndef EV_CHECK_ENABLE
74# define EV_CHECK_ENABLE 1
75#endif
76
77#ifndef EV_IDLE_ENABLE
78# define EV_IDLE_ENABLE 1
79#endif
80
81#ifndef EV_FORK_ENABLE
82# define EV_FORK_ENABLE 1
83#endif
84
85#ifndef EV_SIGNAL_ENABLE
86# define EV_SIGNAL_ENABLE 1
87#endif
88
89#ifndef EV_CHILD_ENABLE
90# ifdef _WIN32
91# define EV_CHILD_ENABLE 0
92# else
93# define EV_CHILD_ENABLE 1
94#endif
95#endif
96
97#ifndef EV_ASYNC_ENABLE
98# define EV_ASYNC_ENABLE 1
99#endif
100
59#ifndef EV_EMBED_ENABLE 101#ifndef EV_EMBED_ENABLE
60# define EV_EMBED_ENABLE 1 102# define EV_EMBED_ENABLE 1
61#endif 103#endif
62 104
105#ifndef EV_WALK_ENABLE
106# define EV_WALK_ENABLE 0 /* not yet */
107#endif
108
109#ifndef EV_ATOMIC_T
110# include <signal.h>
111# define EV_ATOMIC_T sig_atomic_t volatile
112#endif
113
63/*****************************************************************************/ 114/*****************************************************************************/
64 115
116#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
117# undef EV_SIGNAL_ENABLE
118# define EV_SIGNAL_ENABLE 1
119#endif
120
65#if EV_STAT_ENABLE 121#if EV_STAT_ENABLE
122# ifdef _WIN32
123# include <time.h>
124# include <sys/types.h>
125# endif
66# include <sys/stat.h> 126# include <sys/stat.h>
67#endif 127#endif
68 128
69/* support multiple event loops? */ 129/* support multiple event loops? */
70#if EV_MULTIPLICITY 130#if EV_MULTIPLICITY
71struct ev_loop; 131struct ev_loop;
72# define EV_P struct ev_loop *loop 132# define EV_P struct ev_loop *loop
73# define EV_P_ EV_P, 133# define EV_P_ EV_P,
74# define EV_A loop 134# define EV_A loop
75# define EV_A_ EV_A, 135# define EV_A_ EV_A,
136# define EV_DEFAULT_UC ev_default_loop_uc ()
137# define EV_DEFAULT_UC_ EV_DEFAULT_UC,
76# define EV_DEFAULT_A ev_default_loop (0) 138# define EV_DEFAULT ev_default_loop (0)
77# define EV_DEFAULT_A_ EV_DEFAULT_A, 139# define EV_DEFAULT_ EV_DEFAULT,
78#else 140#else
79# define EV_P void 141# define EV_P void
80# define EV_P_ 142# define EV_P_
81# define EV_A 143# define EV_A
82# define EV_A_ 144# define EV_A_
145# define EV_DEFAULT
83# define EV_DEFAULT_A 146# define EV_DEFAULT_
147# define EV_DEFAULT_UC
84# define EV_DEFAULT_A_ 148# define EV_DEFAULT_UC_
85
86# undef EV_EMBED_ENABLE 149# undef EV_EMBED_ENABLE
87#endif 150#endif
88 151
152#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
153# define EV_INLINE static inline
154#else
155# define EV_INLINE static
156#endif
157
158/*****************************************************************************/
159
89/* eventmask, revents, events... */ 160/* eventmask, revents, events... */
90#define EV_UNDEF -1L /* guaranteed to be invalid */ 161#define EV_UNDEF -1 /* guaranteed to be invalid */
91#define EV_NONE 0x00L /* no events */ 162#define EV_NONE 0x00 /* no events */
92#define EV_READ 0x01L /* ev_io detected read will not block */ 163#define EV_READ 0x01 /* ev_io detected read will not block */
93#define EV_WRITE 0x02L /* ev_io detected write will not block */ 164#define EV_WRITE 0x02 /* ev_io detected write will not block */
165#define EV__IOFDSET 0x80 /* internal use only */
166#define EV_IO EV_READ /* alias for type-detection */
94#define EV_TIMEOUT 0x00000100L /* timer timed out */ 167#define EV_TIMEOUT 0x00000100 /* timer timed out */
168#define EV_TIMER EV_TIMEOUT /* alias for type-detection */
95#define EV_PERIODIC 0x00000200L /* periodic timer timed out */ 169#define EV_PERIODIC 0x00000200 /* periodic timer timed out */
96#define EV_SIGNAL 0x00000400L /* signal was received */ 170#define EV_SIGNAL 0x00000400 /* signal was received */
171#define EV_CHILD 0x00000800 /* child/pid had status change */
172#define EV_STAT 0x00001000 /* stat data changed */
97#define EV_IDLE 0x00000800L /* event loop is idling */ 173#define EV_IDLE 0x00002000 /* event loop is idling */
98#define EV_PREPARE 0x00001000L /* event loop about to poll */ 174#define EV_PREPARE 0x00004000 /* event loop about to poll */
99#define EV_CHECK 0x00002000L /* event loop finished poll */ 175#define EV_CHECK 0x00008000 /* event loop finished poll */
100#define EV_CHILD 0x00004000L /* child/pid had status change */
101#define EV_EMBED 0x00008000L /* embedded event loop needs sweep */ 176#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
102#define EV_STAT 0x00010000L /* stat data changed */ 177#define EV_FORK 0x00020000 /* event loop resumed in child */
178#define EV_ASYNC 0x00040000 /* async intra-loop signal */
179#define EV_CUSTOM 0x01000000 /* for use by user code */
103#define EV_ERROR 0x80000000L /* sent when an error occurs */ 180#define EV_ERROR 0x80000000 /* sent when an error occurs */
104 181
105/* can be used to add custom fields to all watchers, while losing binary compatibility */ 182/* can be used to add custom fields to all watchers, while losing binary compatibility */
106#ifndef EV_COMMON 183#ifndef EV_COMMON
107# define EV_COMMON void *data; 184# define EV_COMMON void *data;
108#endif 185#endif
109#ifndef EV_PROTOTYPES 186#ifndef EV_PROTOTYPES
110# define EV_PROTOTYPES 1 187# define EV_PROTOTYPES 1
111#endif 188#endif
112 189
113#define EV_VERSION_MAJOR 1 190#define EV_VERSION_MAJOR 3
114#define EV_VERSION_MINOR 1 191#define EV_VERSION_MINOR 9
115 192
116#ifndef EV_CB_DECLARE 193#ifndef EV_CB_DECLARE
117# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 194# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
118#endif 195#endif
119#ifndef EV_CB_INVOKE 196#ifndef EV_CB_INVOKE
120# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) 197# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
121#endif 198#endif
122 199
123/* 200/*
124 * struct member types: 201 * struct member types:
125 * private: you can look at them, but not change them, and they might not mean anything to you. 202 * private: you may look at them, but not change them,
203 * and they might not mean anything to you.
126 * ro: can be read anytime, but only changed when the watcher isn't active 204 * ro: can be read anytime, but only changed when the watcher isn't active.
127 * rw: can be read and modified anytime, even when the watcher is active 205 * rw: can be read and modified anytime, even when the watcher is active.
206 *
207 * some internal details that might be helpful for debugging:
208 *
209 * active is either 0, which means the watcher is not active,
210 * or the array index of the watcher (periodics, timers)
211 * or the array index + 1 (most other watchers)
212 * or simply 1 for watchers that aren't in some array.
213 * pending is either 0, in which case the watcher isn't,
214 * or the array index + 1 in the pendings array.
128 */ 215 */
216
217#if EV_MINPRI == EV_MAXPRI
218# define EV_DECL_PRIORITY
219#else
220# define EV_DECL_PRIORITY int priority;
221#endif
129 222
130/* shared by all watchers */ 223/* shared by all watchers */
131#define EV_WATCHER(type) \ 224#define EV_WATCHER(type) \
132 int active; /* private */ \ 225 int active; /* private */ \
133 int pending; /* private */ \ 226 int pending; /* private */ \
134 int priority; /* private */ \ 227 EV_DECL_PRIORITY /* private */ \
135 EV_COMMON /* rw */ \ 228 EV_COMMON /* rw */ \
136 EV_CB_DECLARE (type) /* private */ 229 EV_CB_DECLARE (type) /* private */
137 230
138#define EV_WATCHER_LIST(type) \ 231#define EV_WATCHER_LIST(type) \
139 EV_WATCHER (type) \ 232 EV_WATCHER (type) \
159typedef struct ev_watcher_time 252typedef struct ev_watcher_time
160{ 253{
161 EV_WATCHER_TIME (ev_watcher_time) 254 EV_WATCHER_TIME (ev_watcher_time)
162} ev_watcher_time; 255} ev_watcher_time;
163 256
257/* invoked when fd is either EV_READable or EV_WRITEable */
258/* revent EV_READ, EV_WRITE */
259typedef struct ev_io
260{
261 EV_WATCHER_LIST (ev_io)
262
263 int fd; /* ro */
264 int events; /* ro */
265} ev_io;
266
164/* invoked after a specific time, repeatable (based on monotonic clock) */ 267/* invoked after a specific time, repeatable (based on monotonic clock) */
165/* revent EV_TIMEOUT */ 268/* revent EV_TIMEOUT */
166typedef struct ev_timer 269typedef struct ev_timer
167{ 270{
168 EV_WATCHER_TIME (ev_timer) 271 EV_WATCHER_TIME (ev_timer)
174/* revent EV_PERIODIC */ 277/* revent EV_PERIODIC */
175typedef struct ev_periodic 278typedef struct ev_periodic
176{ 279{
177 EV_WATCHER_TIME (ev_periodic) 280 EV_WATCHER_TIME (ev_periodic)
178 281
282 ev_tstamp offset; /* rw */
179 ev_tstamp interval; /* rw */ 283 ev_tstamp interval; /* rw */
180 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 284 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
181} ev_periodic; 285} ev_periodic;
182 286
183/* invoked when fd is either EV_READable or EV_WRITEable */
184/* revent EV_READ, EV_WRITE */
185typedef struct ev_io
186{
187 EV_WATCHER_LIST (ev_io)
188
189 int fd; /* ro */
190 int events; /* ro */
191} ev_io;
192
193/* invoked when the given signal has been received */ 287/* invoked when the given signal has been received */
194/* revent EV_SIGNAL */ 288/* revent EV_SIGNAL */
195typedef struct ev_signal 289typedef struct ev_signal
196{ 290{
197 EV_WATCHER_LIST (ev_signal) 291 EV_WATCHER_LIST (ev_signal)
198 292
199 int signum; /* ro */ 293 int signum; /* ro */
200} ev_signal; 294} ev_signal;
201 295
296/* invoked when sigchld is received and waitpid indicates the given pid */
297/* revent EV_CHILD */
298/* does not support priorities */
299typedef struct ev_child
300{
301 EV_WATCHER_LIST (ev_child)
302
303 int flags; /* private */
304 int pid; /* ro */
305 int rpid; /* rw, holds the received pid */
306 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
307} ev_child;
308
309#if EV_STAT_ENABLE
310/* st_nlink = 0 means missing file or other error */
311# ifdef _WIN32
312typedef struct _stati64 ev_statdata;
313# else
314typedef struct stat ev_statdata;
315# endif
316
317/* invoked each time the stat data changes for a given path */
318/* revent EV_STAT */
319typedef struct ev_stat
320{
321 EV_WATCHER_LIST (ev_stat)
322
323 ev_timer timer; /* private */
324 ev_tstamp interval; /* ro */
325 const char *path; /* ro */
326 ev_statdata prev; /* ro */
327 ev_statdata attr; /* ro */
328
329 int wd; /* wd for inotify, fd for kqueue */
330} ev_stat;
331#endif
332
333#if EV_IDLE_ENABLE
202/* invoked when the nothing else needs to be done, keeps the process from blocking */ 334/* invoked when the nothing else needs to be done, keeps the process from blocking */
203/* revent EV_IDLE */ 335/* revent EV_IDLE */
204typedef struct ev_idle 336typedef struct ev_idle
205{ 337{
206 EV_WATCHER (ev_idle) 338 EV_WATCHER (ev_idle)
207} ev_idle; 339} ev_idle;
340#endif
208 341
209/* invoked for each run of the mainloop, just before the blocking call */ 342/* invoked for each run of the mainloop, just before the blocking call */
210/* you can still change events in any way you like */ 343/* you can still change events in any way you like */
211/* revent EV_PREPARE */ 344/* revent EV_PREPARE */
212typedef struct ev_prepare 345typedef struct ev_prepare
219typedef struct ev_check 352typedef struct ev_check
220{ 353{
221 EV_WATCHER (ev_check) 354 EV_WATCHER (ev_check)
222} ev_check; 355} ev_check;
223 356
224/* invoked when sigchld is received and waitpid indicates the given pid */ 357#if EV_FORK_ENABLE
225/* revent EV_CHILD */ 358/* the callback gets invoked before check in the child process when a fork was detected */
226/* does not support priorities */
227typedef struct ev_child 359typedef struct ev_fork
228{ 360{
229 EV_WATCHER_LIST (ev_child) 361 EV_WATCHER (ev_fork)
230 362} ev_fork;
231 int pid; /* ro */ 363#endif
232 int rpid; /* rw, holds the received pid */
233 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
234} ev_child;
235 364
236#if EV_EMBED_ENABLE 365#if EV_EMBED_ENABLE
237/* used to embed an event loop inside another */ 366/* used to embed an event loop inside another */
238/* the callback gets invoked when the event loop has handled events, and can be 0 */ 367/* the callback gets invoked when the event loop has handled events, and can be 0 */
239typedef struct ev_embed 368typedef struct ev_embed
240{ 369{
241 EV_WATCHER (ev_embed) 370 EV_WATCHER (ev_embed)
242 371
243 ev_io io; /* private */
244 struct ev_loop *loop; /* ro */ 372 struct ev_loop *other; /* ro */
373 ev_io io; /* private */
374 ev_prepare prepare; /* private */
375 ev_check check; /* unused */
376 ev_timer timer; /* unused */
377 ev_periodic periodic; /* unused */
378 ev_idle idle; /* unused */
379 ev_fork fork; /* private */
245} ev_embed; 380} ev_embed;
246#endif 381#endif
247 382
248#if EV_STAT_ENABLE 383#if EV_ASYNC_ENABLE
249/* st_nlink = 0 means missing file or other error */ 384/* invoked when somebody calls ev_async_send on the watcher */
250typedef struct stat ev_statdata;
251
252/* invoked each time the stat data changes for a given path */
253/* revent EV_STAT */ 385/* revent EV_ASYNC */
254typedef struct ev_stat 386typedef struct ev_async
255{ 387{
256 EV_WATCHER (ev_stat) 388 EV_WATCHER (ev_async)
257 389
258 ev_timer timer; /* private */ 390 EV_ATOMIC_T sent; /* private */
259 ev_tstamp interval; /* rw */ 391} ev_async;
260 const char *path; /* ro */ 392
261 ev_statdata prev; /* ro */ 393# define ev_async_pending(w) (+(w)->sent)
262 ev_statdata attr; /* ro */
263} ev_stat;
264#endif 394#endif
265 395
266/* the presence of this union forces similar struct layout */ 396/* the presence of this union forces similar struct layout */
267union ev_any_watcher 397union ev_any_watcher
268{ 398{
270 struct ev_watcher_list wl; 400 struct ev_watcher_list wl;
271 401
272 struct ev_io io; 402 struct ev_io io;
273 struct ev_timer timer; 403 struct ev_timer timer;
274 struct ev_periodic periodic; 404 struct ev_periodic periodic;
405 struct ev_signal signal;
406 struct ev_child child;
407#if EV_STAT_ENABLE
408 struct ev_stat stat;
409#endif
410#if EV_IDLE_ENABLE
275 struct ev_idle idle; 411 struct ev_idle idle;
412#endif
276 struct ev_prepare prepare; 413 struct ev_prepare prepare;
277 struct ev_check check; 414 struct ev_check check;
278 struct ev_signal signal; 415#if EV_FORK_ENABLE
279 struct ev_child child; 416 struct ev_fork fork;
417#endif
280#if EV_EMBED_ENABLE 418#if EV_EMBED_ENABLE
281 struct ev_embed embed; 419 struct ev_embed embed;
282#endif 420#endif
283#if EV_STAT_ENABLE 421#if EV_ASYNC_ENABLE
284 struct ev_stat stat; 422 struct ev_async async;
285#endif 423#endif
286}; 424};
287 425
288/* bits for ev_default_loop and ev_loop_new */ 426/* bits for ev_default_loop and ev_loop_new */
289/* the default */ 427/* the default */
290#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */ 428#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
291/* flag bits */ 429/* flag bits */
292#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */ 430#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
431#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
432/* debugging/feature disable */
433#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */
434#define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */
435#define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */
293/* method bits to be ored together */ 436/* method bits to be ored together */
294#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */ 437#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
295#define EVBACKEND_POLL 0x00000002UL /* !win */ 438#define EVBACKEND_POLL 0x00000002U /* !win */
296#define EVBACKEND_EPOLL 0x00000004UL /* linux */ 439#define EVBACKEND_EPOLL 0x00000004U /* linux */
297#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */ 440#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
298#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */ 441#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
299#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */ 442#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
443#define EVBACKEND_ALL 0x0000003FU
300 444
301#if EV_PROTOTYPES 445#if EV_PROTOTYPES
302int ev_version_major (void); 446int ev_version_major (void);
303int ev_version_minor (void); 447int ev_version_minor (void);
304 448
305unsigned int ev_supported_backends (void); 449unsigned int ev_supported_backends (void);
306unsigned int ev_recommended_backends (void); 450unsigned int ev_recommended_backends (void);
307unsigned int ev_embeddable_backends (void); 451unsigned int ev_embeddable_backends (void);
308 452
309ev_tstamp ev_time (void); 453ev_tstamp ev_time (void);
454void ev_sleep (ev_tstamp delay); /* sleep for a while */
310 455
311/* Sets the allocation function to use, works like realloc. 456/* Sets the allocation function to use, works like realloc.
312 * It is used to allocate and free memory. 457 * It is used to allocate and free memory.
313 * If it returns zero when memory needs to be allocated, the library might abort 458 * If it returns zero when memory needs to be allocated, the library might abort
314 * or take some potentially destructive action. 459 * or take some potentially destructive action.
320 * retryable syscall error 465 * retryable syscall error
321 * (such as failed select, poll, epoll_wait) 466 * (such as failed select, poll, epoll_wait)
322 */ 467 */
323void ev_set_syserr_cb (void (*cb)(const char *msg)); 468void ev_set_syserr_cb (void (*cb)(const char *msg));
324 469
325# if EV_MULTIPLICITY 470#if EV_MULTIPLICITY
471EV_INLINE struct ev_loop *
472ev_default_loop_uc (void)
473{
474 extern struct ev_loop *ev_default_loop_ptr;
475
476 return ev_default_loop_ptr;
477}
478
326/* the default loop is the only one that handles signals and child watchers */ 479/* the default loop is the only one that handles signals and child watchers */
327/* you can call this as often as you like */ 480/* you can call this as often as you like */
328static struct ev_loop * 481EV_INLINE struct ev_loop *
329ev_default_loop (unsigned int flags) 482ev_default_loop (unsigned int flags)
330{ 483{
331 extern struct ev_loop *ev_default_loop_ptr; 484 struct ev_loop *loop = ev_default_loop_uc ();
485
486 if (!loop)
487 {
332 extern struct ev_loop *ev_default_loop_init (unsigned int flags); 488 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
333 489
334 if (!ev_default_loop_ptr)
335 ev_default_loop_init (flags); 490 loop = ev_default_loop_init (flags);
491 }
336 492
337 return ev_default_loop_ptr; 493 return loop;
338} 494}
339 495
340/* create and destroy alternative loops that don't handle signals */ 496/* create and destroy alternative loops that don't handle signals */
341struct ev_loop *ev_loop_new (unsigned int flags); 497struct ev_loop *ev_loop_new (unsigned int flags);
342void ev_loop_destroy (EV_P); 498void ev_loop_destroy (EV_P);
343void ev_loop_fork (EV_P); 499void ev_loop_fork (EV_P);
344 500
345ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 501ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
346 502
347# else 503#else
348 504
349int ev_default_loop (unsigned int flags); /* returns true when successful */ 505int ev_default_loop (unsigned int flags); /* returns true when successful */
350 506
351static ev_tstamp 507EV_INLINE ev_tstamp
352ev_now (void) 508ev_now (void)
353{ 509{
354 extern ev_tstamp ev_rt_now; 510 extern ev_tstamp ev_rt_now;
355 511
356 return ev_rt_now; 512 return ev_rt_now;
357} 513}
514#endif /* multiplicity */
515
516EV_INLINE int
517ev_is_default_loop (EV_P)
518{
519#if EV_MULTIPLICITY
520 extern struct ev_loop *ev_default_loop_ptr;
521
522 return !!(EV_A == ev_default_loop_ptr);
523#else
524 return 1;
358# endif 525#endif
526}
359 527
360void ev_default_destroy (void); /* destroy the default loop */ 528void ev_default_destroy (void); /* destroy the default loop */
361/* this needs to be called after fork, to duplicate the default loop */ 529/* this needs to be called after fork, to duplicate the default loop */
362/* if you create alternative loops you have to call ev_loop_fork on them */ 530/* if you create alternative loops you have to call ev_loop_fork on them */
363/* you can call it in either the parent or the child */ 531/* you can call it in either the parent or the child */
364/* you can actually call it at any time, anywhere :) */ 532/* you can actually call it at any time, anywhere :) */
365void ev_default_fork (void); 533void ev_default_fork (void);
366 534
367unsigned int ev_backend (EV_P); 535unsigned int ev_backend (EV_P); /* backend in use by loop */
536
537void ev_now_update (EV_P); /* update event loop time */
538
539#if EV_WALK_ENABLE
540/* walk (almost) all watchers in the loop of a given type, invoking the */
541/* callback on every such watcher. The callback might stop the watcher, */
542/* but do nothing else with the loop */
543void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
368#endif 544#endif
545
546#endif /* prototypes */
369 547
370#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 548#define EVLOOP_NONBLOCK 1 /* do not block/wait */
371#define EVLOOP_ONESHOT 2 /* block *once* only */ 549#define EVLOOP_ONESHOT 2 /* block *once* only */
372#define EVUNLOOP_CANCEL 0 /* undo unloop */ 550#define EVUNLOOP_CANCEL 0 /* undo unloop */
373#define EVUNLOOP_ONE 1 /* unloop once */ 551#define EVUNLOOP_ONE 1 /* unloop once */
377void ev_loop (EV_P_ int flags); 555void ev_loop (EV_P_ int flags);
378void 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 */ 556void 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 */
379 557
380/* 558/*
381 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 559 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
382 * keeps one reference. if you have a long-runing watcher you never unregister that 560 * keeps one reference. if you have a long-running watcher you never unregister that
383 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 561 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
384 */ 562 */
385void ev_ref (EV_P); 563void ev_ref (EV_P);
386void ev_unref (EV_P); 564void ev_unref (EV_P);
387 565
566/*
388/* convinience function, wait for a single event, without registering an event watcher */ 567 * convenience function, wait for a single event, without registering an event watcher
389/* if timeout is < 0, do wait indefinitely */ 568 * if timeout is < 0, do wait indefinitely
569 */
390void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 570void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
571
572# if EV_MINIMAL < 2
573unsigned int ev_loop_count (EV_P); /* number of loop iterations */
574unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
575void ev_loop_verify (EV_P); /* abort if loop data corrupted */
576
577void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
578void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
579
580/* advanced stuff for threading etc. support, see docs */
581void ev_set_userdata (EV_P_ void *data);
582void *ev_userdata (EV_P);
583void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
584void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
585
586unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
587void ev_invoke_pending (EV_P); /* invoke all pending watchers */
588
589/*
590 * stop/start the timer handling.
591 */
592void ev_suspend (EV_P);
593void ev_resume (EV_P);
594#endif
595
391#endif 596#endif
392 597
393/* these may evaluate ev multiple times, and the other arguments at most once */ 598/* these may evaluate ev multiple times, and the other arguments at most once */
394/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 599/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
395#define ev_init(ev,cb_) do { \ 600#define ev_init(ev,cb_) do { \
396 ((ev_watcher *)(void *)(ev))->active = \ 601 ((ev_watcher *)(void *)(ev))->active = \
397 ((ev_watcher *)(void *)(ev))->pending = \ 602 ((ev_watcher *)(void *)(ev))->pending = 0; \
398 ((ev_watcher *)(void *)(ev))->priority = 0; \ 603 ev_set_priority ((ev), 0); \
399 ev_set_cb ((ev), cb_); \ 604 ev_set_cb ((ev), cb_); \
400} while (0) 605} while (0)
401 606
402#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 607#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
403#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 608#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
404#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 609#define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0)
405#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 610#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
611#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
612#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
406#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 613#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
407#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 614#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
408#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 615#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
409#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
410#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0) 616#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
411#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); } while (0) 617#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
618#define ev_async_set(ev) do { (ev)->sent = 0; } while (0)
412 619
413#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 620#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
414#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 621#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
415#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 622#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
416#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 623#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
624#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
625#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
417#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 626#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
418#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 627#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
419#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 628#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
420#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
421#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0) 629#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
422#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0) 630#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
631#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
423 632
424#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 633#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
425#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 634#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
426 635
427#define ev_priority(ev) ((ev_watcher *)(void *)(ev))->priority /* rw */
428#define ev_cb(ev) (ev)->cb /* rw */ 636#define ev_cb(ev) (ev)->cb /* rw */
637
638#if EV_MINPRI == EV_MAXPRI
639# define ev_priority(ev) ((ev), EV_MINPRI)
429#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) 640# define ev_set_priority(ev,pri) ((ev), (pri))
641#else
642# define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
643# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
644#endif
645
646#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
430 647
431#ifndef ev_set_cb 648#ifndef ev_set_cb
432# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 649# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
433#endif 650#endif
434 651
435/* stopping (enabling, adding) a watcher does nothing if it is already running */ 652/* stopping (enabling, adding) a watcher does nothing if it is already running */
436/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 653/* stopping (disabling, deleting) a watcher does nothing unless its already running */
437#if EV_PROTOTYPES 654#if EV_PROTOTYPES
438 655
439/* feeds an event into a watcher as if the event actually occured */ 656/* feeds an event into a watcher as if the event actually occured */
440/* accepts any ev_watcher type */ 657/* accepts any ev_watcher type */
441void ev_feed_event (EV_P_ void *w, int revents); 658void ev_feed_event (EV_P_ void *w, int revents);
442void ev_feed_fd_event (EV_P_ int fd, int revents); 659void ev_feed_fd_event (EV_P_ int fd, int revents);
660#if EV_SIGNAL_ENABLE
443void ev_feed_signal_event (EV_P_ int signum); 661void ev_feed_signal_event (EV_P_ int signum);
662#endif
663void ev_invoke (EV_P_ void *w, int revents);
664int ev_clear_pending (EV_P_ void *w);
444 665
445void ev_io_start (EV_P_ ev_io *w); 666void ev_io_start (EV_P_ ev_io *w);
446void ev_io_stop (EV_P_ ev_io *w); 667void ev_io_stop (EV_P_ ev_io *w);
447 668
448void ev_timer_start (EV_P_ ev_timer *w); 669void ev_timer_start (EV_P_ ev_timer *w);
449void ev_timer_stop (EV_P_ ev_timer *w); 670void ev_timer_stop (EV_P_ ev_timer *w);
450/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 671/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
451void ev_timer_again (EV_P_ ev_timer *w); 672void ev_timer_again (EV_P_ ev_timer *w);
673/* return remaining time */
674ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
452 675
453#if EV_PERIODIC_ENABLE 676#if EV_PERIODIC_ENABLE
454void ev_periodic_start (EV_P_ ev_periodic *w); 677void ev_periodic_start (EV_P_ ev_periodic *w);
455void ev_periodic_stop (EV_P_ ev_periodic *w); 678void ev_periodic_stop (EV_P_ ev_periodic *w);
456void ev_periodic_again (EV_P_ ev_periodic *w); 679void ev_periodic_again (EV_P_ ev_periodic *w);
457#endif 680#endif
458 681
682/* only supported in the default loop */
683#if EV_SIGNAL_ENABLE
684void ev_signal_start (EV_P_ ev_signal *w);
685void ev_signal_stop (EV_P_ ev_signal *w);
686#endif
687
688/* only supported in the default loop */
689# if EV_CHILD_ENABLE
690void ev_child_start (EV_P_ ev_child *w);
691void ev_child_stop (EV_P_ ev_child *w);
692# endif
693
694# if EV_STAT_ENABLE
695void ev_stat_start (EV_P_ ev_stat *w);
696void ev_stat_stop (EV_P_ ev_stat *w);
697void ev_stat_stat (EV_P_ ev_stat *w);
698# endif
699
700# if EV_IDLE_ENABLE
459void ev_idle_start (EV_P_ ev_idle *w); 701void ev_idle_start (EV_P_ ev_idle *w);
460void ev_idle_stop (EV_P_ ev_idle *w); 702void ev_idle_stop (EV_P_ ev_idle *w);
703# endif
461 704
705#if EV_PREPARE_ENABLE
462void ev_prepare_start (EV_P_ ev_prepare *w); 706void ev_prepare_start (EV_P_ ev_prepare *w);
463void ev_prepare_stop (EV_P_ ev_prepare *w); 707void ev_prepare_stop (EV_P_ ev_prepare *w);
708#endif
464 709
710#if EV_CHECK_ENABLE
465void ev_check_start (EV_P_ ev_check *w); 711void ev_check_start (EV_P_ ev_check *w);
466void ev_check_stop (EV_P_ ev_check *w); 712void ev_check_stop (EV_P_ ev_check *w);
713#endif
467 714
468/* only supported in the default loop */ 715# if EV_FORK_ENABLE
469void ev_signal_start (EV_P_ ev_signal *w);
470void ev_signal_stop (EV_P_ ev_signal *w);
471
472/* only supported in the default loop */
473void ev_child_start (EV_P_ ev_child *w); 716void ev_fork_start (EV_P_ ev_fork *w);
474void ev_child_stop (EV_P_ ev_child *w); 717void ev_fork_stop (EV_P_ ev_fork *w);
718# endif
475 719
476# if EV_EMBED_ENABLE 720# if EV_EMBED_ENABLE
477/* only supported when loop to be embedded is in fact embeddable */ 721/* only supported when loop to be embedded is in fact embeddable */
478void ev_embed_start (EV_P_ ev_embed *w); 722void ev_embed_start (EV_P_ ev_embed *w);
479void ev_embed_stop (EV_P_ ev_embed *w); 723void ev_embed_stop (EV_P_ ev_embed *w);
480void ev_embed_sweep (EV_P_ ev_embed *w); 724void ev_embed_sweep (EV_P_ ev_embed *w);
481# endif 725# endif
482 726
483# if EV_STAT_ENABLE 727# if EV_ASYNC_ENABLE
484void ev_stat_start (EV_P_ ev_stat *w); 728void ev_async_start (EV_P_ ev_async *w);
485void ev_stat_stop (EV_P_ ev_stat *w); 729void ev_async_stop (EV_P_ ev_async *w);
486void ev_stat_stat (EV_P_ ev_stat *w); 730void ev_async_send (EV_P_ ev_async *w);
487# endif 731# endif
488 732
489#endif 733#endif
490 734
491#ifdef __cplusplus 735#ifdef __cplusplus

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines