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