ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
Revision: 1.132
Committed: Wed Mar 10 08:19:39 2010 UTC (14 years, 2 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.131: +25 -2 lines
Log Message:
more minimal tuning, add truly minimal example

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