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