ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
Revision: 1.165
Committed: Mon Apr 2 23:14:41 2012 UTC (12 years, 1 month ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.164: +1 -1 lines
Log Message:
*** empty log message ***

File Contents

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