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