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

Comparing libev/ev.h (file contents):
Revision 1.29 by root, Sun Nov 4 00:24:17 2007 UTC vs.
Revision 1.127 by root, Fri Sep 18 21:02:12 2009 UTC

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

Diff Legend

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