ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
Revision: 1.142
Committed: Thu Oct 21 14:50:58 2010 UTC (13 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.141: +63 -52 lines
Log Message:
enum

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