ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
Revision: 1.136
Committed: Tue Mar 16 00:43:22 2010 UTC (14 years, 2 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.135: +8 -7 lines
Log Message:
*** empty log message ***

File Contents

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