ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
Revision: 1.125
Committed: Mon Aug 3 12:12:40 2009 UTC (14 years, 9 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.124: +2 -2 lines
Log Message:
ansi c...

File Contents

# User Rev Content
1 root 1.10 /*
2 root 1.90 * libev native API header
3     *
4 root 1.109 * Copyright (c) 2007,2008,2009 Marc Alexander Lehmann <libev@schmorp.de>
5 root 1.10 * All rights reserved.
6     *
7 root 1.90 * Redistribution and use in source and binary forms, with or without modifica-
8     * tion, are permitted provided that the following conditions are 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.
27 root 1.10 *
28 root 1.90 * Alternatively, the contents of this file may be used under the terms of
29     * the GNU General Public License ("GPL") version 2 or any later version,
30     * in which case the provisions of the GPL are applicable instead of
31     * the above. If you wish to allow the use of your version of this file
32     * only under the terms of the GPL and not to allow others to use your
33     * version of this file under the BSD license, indicate your decision
34     * by deleting the provisions above and replace them with the notice
35     * and other provisions required by the GPL. If you do not delete the
36     * provisions above, a recipient may use your version of this file under
37     * either the BSD or the GPL.
38 root 1.10 */
39    
40 root 1.125 #ifndef EV_H_
41     #define EV_H_
42 root 1.1
43 root 1.19 #ifdef __cplusplus
44     extern "C" {
45     #endif
46    
47 root 1.1 typedef double ev_tstamp;
48    
49 root 1.21 /* these priorities are inclusive, higher priorities will be called earlier */
50     #ifndef EV_MINPRI
51     # define EV_MINPRI -2
52     #endif
53     #ifndef EV_MAXPRI
54     # define EV_MAXPRI +2
55     #endif
56    
57 root 1.29 #ifndef EV_MULTIPLICITY
58     # define EV_MULTIPLICITY 1
59     #endif
60    
61 root 1.69 #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 root 1.78 #ifndef EV_IDLE_ENABLE
70     # define EV_IDLE_ENABLE 1
71     #endif
72    
73 root 1.72 #ifndef EV_FORK_ENABLE
74     # define EV_FORK_ENABLE 1
75     #endif
76    
77 root 1.69 #ifndef EV_EMBED_ENABLE
78     # define EV_EMBED_ENABLE 1
79     #endif
80    
81 root 1.92 #ifndef EV_ASYNC_ENABLE
82     # define EV_ASYNC_ENABLE 1
83     #endif
84    
85 root 1.115 #ifndef EV_WALK_ENABLE
86     # define EV_WALK_ENABLE 0 /* not yet */
87     #endif
88    
89 root 1.92 #ifndef EV_ATOMIC_T
90     # include <signal.h>
91     # define EV_ATOMIC_T sig_atomic_t volatile
92     #endif
93    
94 root 1.69 /*****************************************************************************/
95    
96     #if EV_STAT_ENABLE
97 root 1.103 # ifdef _WIN32
98     # include <time.h>
99     # include <sys/types.h>
100     # endif
101 root 1.69 # include <sys/stat.h>
102 root 1.50 #endif
103    
104 root 1.28 /* support multiple event loops? */
105 root 1.29 #if EV_MULTIPLICITY
106 root 1.28 struct ev_loop;
107     # define EV_P struct ev_loop *loop
108     # define EV_P_ EV_P,
109     # define EV_A loop
110     # define EV_A_ EV_A,
111 root 1.96 # define EV_DEFAULT_UC ev_default_loop_uc ()
112     # define EV_DEFAULT_UC_ EV_DEFAULT_UC,
113 root 1.72 # define EV_DEFAULT ev_default_loop (0)
114     # define EV_DEFAULT_ EV_DEFAULT,
115 root 1.28 #else
116     # define EV_P void
117     # define EV_P_
118     # define EV_A
119     # define EV_A_
120 root 1.72 # define EV_DEFAULT
121     # define EV_DEFAULT_
122 root 1.96 # define EV_DEFAULT_UC
123     # define EV_DEFAULT_UC_
124     # undef EV_EMBED_ENABLE
125     #endif
126 root 1.69
127 root 1.96 #if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
128     # define EV_INLINE static inline
129     #else
130     # define EV_INLINE static
131 root 1.28 #endif
132 root 1.27
133 root 1.96 /*****************************************************************************/
134    
135 root 1.1 /* eventmask, revents, events... */
136 root 1.99 #define EV_UNDEF -1 /* guaranteed to be invalid */
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 */
140 root 1.111 #define EV__IOFDSET 0x80 /* internal use only */
141     #define EV_IO EV_READ /* alias for type-detection */
142 root 1.99 #define EV_TIMEOUT 0x00000100 /* timer timed out */
143 root 1.112 #define EV_TIMER EV_TIMEOUT /* alias for type-detection */
144 root 1.99 #define EV_PERIODIC 0x00000200 /* periodic timer timed out */
145     #define EV_SIGNAL 0x00000400 /* signal was received */
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 root 1.113 #define EV_CUSTOM 0x01000000 /* for use by user code */
155 root 1.99 #define EV_ERROR 0x80000000 /* sent when an error occurs */
156 root 1.1
157 root 1.51 /* can be used to add custom fields to all watchers, while losing binary compatibility */
158 root 1.6 #ifndef EV_COMMON
159 root 1.52 # define EV_COMMON void *data;
160 root 1.6 #endif
161 root 1.9 #ifndef EV_PROTOTYPES
162     # define EV_PROTOTYPES 1
163     #endif
164 root 1.6
165 root 1.91 #define EV_VERSION_MAJOR 3
166 root 1.121 #define EV_VERSION_MINOR 7
167 root 1.14
168 root 1.44 #ifndef EV_CB_DECLARE
169 root 1.46 # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
170 root 1.44 #endif
171     #ifndef EV_CB_INVOKE
172     # define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
173     #endif
174    
175 root 1.6 /*
176     * struct member types:
177 root 1.108 * private: you may look at them, but not change them,
178     * and they might not mean anything to you.
179     * ro: can be read anytime, but only changed when the watcher isn't active.
180     * rw: can be read and modified anytime, even when the watcher is active.
181 root 1.101 *
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 root 1.108 * or the array index + 1 in the pendings array.
190 root 1.6 */
191    
192 root 1.117 #if EV_MINPRI == EV_MAXPRI
193     # define EV_DECL_PRIORITY
194     #else
195     # define EV_DECL_PRIORITY int priority;
196     #endif
197    
198 root 1.1 /* shared by all watchers */
199     #define EV_WATCHER(type) \
200     int active; /* private */ \
201     int pending; /* private */ \
202 root 1.117 EV_DECL_PRIORITY /* private */ \
203 root 1.52 EV_COMMON /* rw */ \
204 root 1.44 EV_CB_DECLARE (type) /* private */
205 root 1.1
206     #define EV_WATCHER_LIST(type) \
207 root 1.52 EV_WATCHER (type) \
208     struct ev_watcher_list *next; /* private */
209 root 1.1
210 root 1.6 #define EV_WATCHER_TIME(type) \
211 root 1.52 EV_WATCHER (type) \
212     ev_tstamp at; /* private */
213 root 1.6
214 root 1.7 /* base class, nothing to see here unless you subclass */
215 root 1.66 typedef struct ev_watcher
216 root 1.44 {
217 root 1.52 EV_WATCHER (ev_watcher)
218 root 1.66 } ev_watcher;
219 root 1.7
220     /* base class, nothing to see here unless you subclass */
221 root 1.66 typedef struct ev_watcher_list
222 root 1.44 {
223 root 1.52 EV_WATCHER_LIST (ev_watcher_list)
224 root 1.66 } ev_watcher_list;
225 root 1.7
226     /* base class, nothing to see here unless you subclass */
227 root 1.66 typedef struct ev_watcher_time
228 root 1.44 {
229 root 1.52 EV_WATCHER_TIME (ev_watcher_time)
230 root 1.66 } ev_watcher_time;
231 root 1.7
232 root 1.70 /* invoked when fd is either EV_READable or EV_WRITEable */
233     /* revent EV_READ, EV_WRITE */
234     typedef struct ev_io
235     {
236     EV_WATCHER_LIST (ev_io)
237    
238     int fd; /* ro */
239     int events; /* ro */
240     } ev_io;
241    
242 root 1.6 /* invoked after a specific time, repeatable (based on monotonic clock) */
243 root 1.17 /* revent EV_TIMEOUT */
244 root 1.66 typedef struct ev_timer
245 root 1.1 {
246 root 1.52 EV_WATCHER_TIME (ev_timer)
247 root 1.1
248     ev_tstamp repeat; /* rw */
249 root 1.66 } ev_timer;
250 root 1.6
251     /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
252 root 1.17 /* revent EV_PERIODIC */
253 root 1.66 typedef struct ev_periodic
254 root 1.6 {
255 root 1.52 EV_WATCHER_TIME (ev_periodic)
256 root 1.6
257 root 1.82 ev_tstamp offset; /* rw */
258 root 1.6 ev_tstamp interval; /* rw */
259 root 1.40 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
260 root 1.66 } ev_periodic;
261 root 1.1
262 root 1.5 /* invoked when the given signal has been received */
263 root 1.17 /* revent EV_SIGNAL */
264 root 1.66 typedef struct ev_signal
265 root 1.1 {
266 root 1.52 EV_WATCHER_LIST (ev_signal)
267 root 1.1
268     int signum; /* ro */
269 root 1.66 } ev_signal;
270 root 1.1
271 root 1.70 /* invoked when sigchld is received and waitpid indicates the given pid */
272     /* revent EV_CHILD */
273     /* does not support priorities */
274     typedef struct ev_child
275     {
276     EV_WATCHER_LIST (ev_child)
277    
278 root 1.91 int flags; /* private */
279 root 1.70 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 root 1.74 # ifdef _WIN32
287 root 1.71 typedef struct _stati64 ev_statdata;
288 root 1.74 # else
289 root 1.70 typedef struct stat ev_statdata;
290 root 1.74 # endif
291 root 1.70
292     /* invoked each time the stat data changes for a given path */
293     /* revent EV_STAT */
294     typedef struct ev_stat
295     {
296 root 1.74 EV_WATCHER_LIST (ev_stat)
297 root 1.70
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 root 1.74
304     int wd; /* wd for inotify, fd for kqueue */
305 root 1.70 } ev_stat;
306     #endif
307    
308 root 1.78 #if EV_IDLE_ENABLE
309 root 1.5 /* invoked when the nothing else needs to be done, keeps the process from blocking */
310 root 1.17 /* revent EV_IDLE */
311 root 1.66 typedef struct ev_idle
312 root 1.5 {
313 root 1.52 EV_WATCHER (ev_idle)
314 root 1.66 } ev_idle;
315 root 1.78 #endif
316 root 1.5
317 root 1.11 /* invoked for each run of the mainloop, just before the blocking call */
318     /* you can still change events in any way you like */
319 root 1.17 /* revent EV_PREPARE */
320 root 1.66 typedef struct ev_prepare
321 root 1.11 {
322 root 1.52 EV_WATCHER (ev_prepare)
323 root 1.66 } ev_prepare;
324 root 1.11
325     /* invoked for each run of the mainloop, just after the blocking call */
326 root 1.17 /* revent EV_CHECK */
327 root 1.66 typedef struct ev_check
328 root 1.5 {
329 root 1.52 EV_WATCHER (ev_check)
330 root 1.66 } ev_check;
331 root 1.5
332 root 1.72 #if EV_FORK_ENABLE
333     /* the callback gets invoked before check in the child process when a fork was detected */
334     typedef struct ev_fork
335     {
336     EV_WATCHER (ev_fork)
337     } ev_fork;
338     #endif
339    
340 root 1.69 #if EV_EMBED_ENABLE
341 root 1.64 /* used to embed an event loop inside another */
342     /* the callback gets invoked when the event loop has handled events, and can be 0 */
343 root 1.66 typedef struct ev_embed
344 root 1.64 {
345     EV_WATCHER (ev_embed)
346    
347 root 1.86 struct ev_loop *other; /* ro */
348 root 1.87 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 root 1.106 ev_fork fork; /* private */
355 root 1.66 } ev_embed;
356 root 1.64 #endif
357    
358 root 1.92 #if EV_ASYNC_ENABLE
359     /* invoked when somebody calls ev_async_send on the watcher */
360     /* revent EV_ASYNC */
361     typedef struct ev_async
362     {
363     EV_WATCHER (ev_async)
364    
365     EV_ATOMIC_T sent; /* private */
366     } ev_async;
367 root 1.95
368 root 1.98 # define ev_async_pending(w) ((w)->sent + 0)
369 root 1.92 #endif
370    
371 root 1.41 /* the presence of this union forces similar struct layout */
372 root 1.35 union ev_any_watcher
373     {
374     struct ev_watcher w;
375     struct ev_watcher_list wl;
376 root 1.46
377 root 1.35 struct ev_io io;
378     struct ev_timer timer;
379     struct ev_periodic periodic;
380 root 1.72 struct ev_signal signal;
381 root 1.70 struct ev_child child;
382     #if EV_STAT_ENABLE
383     struct ev_stat stat;
384     #endif
385 root 1.78 #if EV_IDLE_ENABLE
386 root 1.35 struct ev_idle idle;
387 root 1.78 #endif
388 root 1.35 struct ev_prepare prepare;
389     struct ev_check check;
390 root 1.72 #if EV_FORK_ENABLE
391     struct ev_fork fork;
392     #endif
393 root 1.69 #if EV_EMBED_ENABLE
394 root 1.64 struct ev_embed embed;
395 root 1.67 #endif
396 root 1.97 #if EV_ASYNC_ENABLE
397 root 1.92 struct ev_async async;
398     #endif
399 root 1.35 };
400    
401 root 1.53 /* bits for ev_default_loop and ev_loop_new */
402     /* the default */
403 root 1.99 #define EVFLAG_AUTO 0x00000000U /* not quite a mask */
404 root 1.63 /* flag bits */
405 root 1.99 #define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
406     #define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
407 root 1.124 /* debugging/feature disable */
408     #define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */
409     #define EVFLAG_NOSIGFD 0x00200000U /* do not attempt to use signalfd */
410 root 1.53 /* method bits to be ored together */
411 root 1.99 #define EVBACKEND_SELECT 0x00000001U /* about anywhere */
412     #define EVBACKEND_POLL 0x00000002U /* !win */
413     #define EVBACKEND_EPOLL 0x00000004U /* linux */
414     #define EVBACKEND_KQUEUE 0x00000008U /* bsd */
415     #define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
416     #define EVBACKEND_PORT 0x00000020U /* solaris 10 */
417 root 1.29
418 root 1.9 #if EV_PROTOTYPES
419 root 1.14 int ev_version_major (void);
420     int ev_version_minor (void);
421 root 1.1
422 root 1.63 unsigned int ev_supported_backends (void);
423     unsigned int ev_recommended_backends (void);
424 root 1.64 unsigned int ev_embeddable_backends (void);
425 root 1.63
426 root 1.1 ev_tstamp ev_time (void);
427 root 1.88 void ev_sleep (ev_tstamp delay); /* sleep for a while */
428 root 1.29
429 root 1.36 /* Sets the allocation function to use, works like realloc.
430     * It is used to allocate and free memory.
431     * If it returns zero when memory needs to be allocated, the library might abort
432     * or take some potentially destructive action.
433     * The default is your system realloc function.
434     */
435 root 1.75 void ev_set_allocator (void *(*cb)(void *ptr, long size));
436 root 1.36
437     /* set the callback function to call on a
438     * retryable syscall error
439     * (such as failed select, poll, epoll_wait)
440     */
441 root 1.37 void ev_set_syserr_cb (void (*cb)(const char *msg));
442 root 1.36
443 root 1.102 #if EV_MULTIPLICITY
444 root 1.96 EV_INLINE struct ev_loop *
445     ev_default_loop_uc (void)
446     {
447     extern struct ev_loop *ev_default_loop_ptr;
448    
449     return ev_default_loop_ptr;
450     }
451    
452 root 1.30 /* the default loop is the only one that handles signals and child watchers */
453     /* you can call this as often as you like */
454 root 1.96 EV_INLINE struct ev_loop *
455 root 1.58 ev_default_loop (unsigned int flags)
456     {
457 root 1.96 struct ev_loop *loop = ev_default_loop_uc ();
458    
459     if (!loop)
460     {
461     extern struct ev_loop *ev_default_loop_init (unsigned int flags);
462 root 1.58
463 root 1.96 loop = ev_default_loop_init (flags);
464     }
465 root 1.58
466 root 1.96 return loop;
467 root 1.58 }
468 root 1.30
469     /* create and destroy alternative loops that don't handle signals */
470 root 1.53 struct ev_loop *ev_loop_new (unsigned int flags);
471 root 1.30 void ev_loop_destroy (EV_P);
472     void ev_loop_fork (EV_P);
473 root 1.47
474     ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
475    
476 root 1.102 #else
477 root 1.47
478 root 1.54 int ev_default_loop (unsigned int flags); /* returns true when successful */
479 root 1.47
480 root 1.96 EV_INLINE ev_tstamp
481 root 1.52 ev_now (void)
482 root 1.47 {
483 root 1.48 extern ev_tstamp ev_rt_now;
484 root 1.47
485     return ev_rt_now;
486     }
487 root 1.102 #endif /* multiplicity */
488 root 1.29
489 root 1.96 EV_INLINE int
490 root 1.94 ev_is_default_loop (EV_P)
491     {
492     #if EV_MULTIPLICITY
493     extern struct ev_loop *ev_default_loop_ptr;
494    
495     return !!(EV_A == ev_default_loop_ptr);
496     #else
497     return 1;
498     #endif
499     }
500    
501 root 1.30 void ev_default_destroy (void); /* destroy the default loop */
502     /* this needs to be called after fork, to duplicate the default loop */
503     /* if you create alternative loops you have to call ev_loop_fork on them */
504     /* you can call it in either the parent or the child */
505     /* you can actually call it at any time, anywhere :) */
506     void ev_default_fork (void);
507    
508 root 1.119 unsigned int ev_backend (EV_P); /* backend in use by loop */
509 root 1.116
510 root 1.119 void ev_now_update (EV_P); /* update event loop time */
511 root 1.118
512 root 1.115 #if EV_WALK_ENABLE
513 root 1.112 /* walk (almost) all watchers in the loop of a given type, invoking the */
514     /* callback on every such watcher. The callback might stop the watcher, */
515     /* but do nothing else with the loop */
516     void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
517     #endif
518    
519 root 1.102 #endif /* prototypes */
520 root 1.1
521     #define EVLOOP_NONBLOCK 1 /* do not block/wait */
522     #define EVLOOP_ONESHOT 2 /* block *once* only */
523 root 1.65 #define EVUNLOOP_CANCEL 0 /* undo unloop */
524 root 1.57 #define EVUNLOOP_ONE 1 /* unloop once */
525 root 1.29 #define EVUNLOOP_ALL 2 /* unloop all loops */
526    
527 root 1.9 #if EV_PROTOTYPES
528 root 1.27 void ev_loop (EV_P_ int flags);
529 root 1.29 void 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 */
530 root 1.27
531     /*
532     * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
533 root 1.119 * keeps one reference. if you have a long-running watcher you never unregister that
534 root 1.27 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
535     */
536     void ev_ref (EV_P);
537     void ev_unref (EV_P);
538 root 1.1
539 root 1.114 /*
540 root 1.119 * convenience function, wait for a single event, without registering an event watcher
541     * if timeout is < 0, do wait indefinitely
542     */
543     void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
544    
545     # if EV_MINIMAL < 2
546     unsigned int ev_loop_count (EV_P); /* number of loop iterations */
547     unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
548     void ev_loop_verify (EV_P); /* abort if loop data corrupted */
549    
550     void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
551     void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
552    
553 root 1.120 /* advanced stuff for threading etc. support, see docs */
554 root 1.119 void ev_set_userdata (EV_P_ void *data);
555     void *ev_userdata (EV_P);
556     void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
557 root 1.120 void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
558 root 1.119
559 root 1.122 unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
560 root 1.119 void ev_invoke_pending (EV_P); /* invoke all pending watchers */
561    
562     /*
563 root 1.114 * stop/start the timer handling.
564     */
565     void ev_suspend (EV_P);
566     void ev_resume (EV_P);
567 root 1.119 #endif
568 root 1.114
569 root 1.9 #endif
570    
571 root 1.2 /* these may evaluate ev multiple times, and the other arguments at most once */
572 root 1.45 /* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
573 root 1.78 #define ev_init(ev,cb_) do { \
574 root 1.117 ((ev_watcher *)(void *)(ev))->active = \
575     ((ev_watcher *)(void *)(ev))->pending = 0; \
576     ev_set_priority ((ev), 0); \
577 root 1.78 ev_set_cb ((ev), cb_); \
578 root 1.32 } while (0)
579 root 1.3
580 root 1.111 #define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
581 root 1.110 #define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
582     #define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0)
583     #define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
584     #define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
585     #define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
586     #define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
587     #define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
588     #define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
589     #define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
590     #define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
591     #define ev_async_set(ev) do { (ev)->sent = 0; } while (0)
592    
593     #define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
594     #define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
595     #define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
596     #define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
597     #define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
598     #define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
599     #define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
600     #define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
601     #define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
602     #define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
603     #define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
604     #define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
605    
606     #define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
607     #define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
608    
609     #define ev_cb(ev) (ev)->cb /* rw */
610 root 1.117
611     #if EV_MINPRI == EV_MAXPRI
612     # define ev_priority(ev) ((ev), EV_MINPRI)
613     # define ev_set_priority(ev,pri) ((ev), (pri))
614     #else
615     # define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
616     # define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
617     #endif
618 root 1.45
619 root 1.110 #define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)
620 root 1.100
621 root 1.45 #ifndef ev_set_cb
622 root 1.110 # define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
623 root 1.45 #endif
624 root 1.1
625 root 1.5 /* stopping (enabling, adding) a watcher does nothing if it is already running */
626     /* stopping (disabling, deleting) a watcher does nothing unless its already running */
627 root 1.9 #if EV_PROTOTYPES
628 root 1.41
629     /* feeds an event into a watcher as if the event actually occured */
630     /* accepts any ev_watcher type */
631     void ev_feed_event (EV_P_ void *w, int revents);
632 root 1.42 void ev_feed_fd_event (EV_P_ int fd, int revents);
633     void ev_feed_signal_event (EV_P_ int signum);
634 root 1.81 void ev_invoke (EV_P_ void *w, int revents);
635 root 1.80 int ev_clear_pending (EV_P_ void *w);
636 root 1.41
637 root 1.66 void ev_io_start (EV_P_ ev_io *w);
638     void ev_io_stop (EV_P_ ev_io *w);
639 root 1.6
640 root 1.66 void ev_timer_start (EV_P_ ev_timer *w);
641     void ev_timer_stop (EV_P_ ev_timer *w);
642 root 1.30 /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
643 root 1.66 void ev_timer_again (EV_P_ ev_timer *w);
644 root 1.123 /* return remaining time */
645     ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
646 root 1.1
647 root 1.69 #if EV_PERIODIC_ENABLE
648 root 1.66 void ev_periodic_start (EV_P_ ev_periodic *w);
649     void ev_periodic_stop (EV_P_ ev_periodic *w);
650     void ev_periodic_again (EV_P_ ev_periodic *w);
651 root 1.50 #endif
652 root 1.1
653 root 1.70 /* only supported in the default loop */
654     void ev_signal_start (EV_P_ ev_signal *w);
655     void ev_signal_stop (EV_P_ ev_signal *w);
656    
657     /* only supported in the default loop */
658     void ev_child_start (EV_P_ ev_child *w);
659     void ev_child_stop (EV_P_ ev_child *w);
660    
661     # if EV_STAT_ENABLE
662     void ev_stat_start (EV_P_ ev_stat *w);
663     void ev_stat_stop (EV_P_ ev_stat *w);
664     void ev_stat_stat (EV_P_ ev_stat *w);
665     # endif
666    
667 root 1.78 # if EV_IDLE_ENABLE
668 root 1.66 void ev_idle_start (EV_P_ ev_idle *w);
669     void ev_idle_stop (EV_P_ ev_idle *w);
670 root 1.78 # endif
671 root 1.5
672 root 1.66 void ev_prepare_start (EV_P_ ev_prepare *w);
673     void ev_prepare_stop (EV_P_ ev_prepare *w);
674 root 1.11
675 root 1.66 void ev_check_start (EV_P_ ev_check *w);
676     void ev_check_stop (EV_P_ ev_check *w);
677 root 1.12
678 root 1.72 # if EV_FORK_ENABLE
679     void ev_fork_start (EV_P_ ev_fork *w);
680     void ev_fork_stop (EV_P_ ev_fork *w);
681     # endif
682    
683 root 1.69 # if EV_EMBED_ENABLE
684 root 1.64 /* only supported when loop to be embedded is in fact embeddable */
685 root 1.66 void ev_embed_start (EV_P_ ev_embed *w);
686     void ev_embed_stop (EV_P_ ev_embed *w);
687 root 1.68 void ev_embed_sweep (EV_P_ ev_embed *w);
688 root 1.64 # endif
689    
690 root 1.92 # if EV_ASYNC_ENABLE
691     void ev_async_start (EV_P_ ev_async *w);
692     void ev_async_stop (EV_P_ ev_async *w);
693     void ev_async_send (EV_P_ ev_async *w);
694     # endif
695    
696 root 1.9 #endif
697 root 1.5
698 root 1.19 #ifdef __cplusplus
699     }
700     #endif
701    
702 root 1.1 #endif
703