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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines