ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
Revision: 1.171
Committed: Fri Mar 1 11:13:22 2013 UTC (11 years, 4 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-4_15
Changes since 1.170: +1 -1 lines
Log Message:
4.15

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