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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines