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

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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines