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