1 | /* |
1 | /* |
2 | * libev native API header |
2 | * libev native API header |
3 | * |
3 | * |
4 | * Copyright (c) 2007,2008,2009 Marc Alexander Lehmann <libev@schmorp.de> |
4 | * Copyright (c) 2007,2008,2009,2010 Marc Alexander Lehmann <libev@schmorp.de> |
5 | * All rights reserved. |
5 | * All rights reserved. |
6 | * |
6 | * |
7 | * Redistribution and use in source and binary forms, with or without modifica- |
7 | * Redistribution and use in source and binary forms, with or without modifica- |
8 | * tion, are permitted provided that the following conditions are met: |
8 | * tion, are permitted provided that the following conditions are met: |
9 | * |
9 | * |
… | |
… | |
35 | * and other provisions required by the GPL. If you do not delete the |
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 |
36 | * provisions above, a recipient may use your version of this file under |
37 | * either the BSD or the GPL. |
37 | * either the BSD or the GPL. |
38 | */ |
38 | */ |
39 | |
39 | |
40 | #ifndef EV_H__ |
40 | #ifndef EV_H_ |
41 | #define EV_H__ |
41 | #define EV_H_ |
42 | |
42 | |
43 | #ifdef __cplusplus |
43 | #ifdef __cplusplus |
44 | extern "C" { |
44 | extern "C" { |
45 | #endif |
45 | #endif |
46 | |
46 | |
47 | typedef double ev_tstamp; |
47 | /*****************************************************************************/ |
|
|
48 | |
|
|
49 | #ifndef EV_FEATURES |
|
|
50 | # define EV_FEATURES 0x3f |
|
|
51 | #endif |
|
|
52 | |
|
|
53 | #define EV_FEATURE_CODE ((EV_FEATURES) & 1) |
|
|
54 | #define EV_FEATURE_DATA ((EV_FEATURES) & 2) |
|
|
55 | #define EV_FEATURE_CONFIG ((EV_FEATURES) & 4) |
|
|
56 | #define EV_FEATURE_API ((EV_FEATURES) & 8) |
|
|
57 | #define EV_FEATURE_WATCHERS ((EV_FEATURES) & 16) |
|
|
58 | #define EV_FEATURE_BACKENDS ((EV_FEATURES) & 32) |
|
|
59 | #define EV_FEATURE_OS ((EV_FEATURES) & 64) |
48 | |
60 | |
49 | /* these priorities are inclusive, higher priorities will be called earlier */ |
61 | /* these priorities are inclusive, higher priorities will be called earlier */ |
50 | #ifndef EV_MINPRI |
62 | #ifndef EV_MINPRI |
51 | # define EV_MINPRI -2 |
63 | # define EV_MINPRI (EV_FEATURE_CONFIG ? -2 : 0) |
52 | #endif |
64 | #endif |
53 | #ifndef EV_MAXPRI |
65 | #ifndef EV_MAXPRI |
54 | # define EV_MAXPRI +2 |
66 | # define EV_MAXPRI (EV_FEATURE_CONFIG ? +2 : 0) |
55 | #endif |
67 | #endif |
56 | |
68 | |
57 | #ifndef EV_MULTIPLICITY |
69 | #ifndef EV_MULTIPLICITY |
58 | # define EV_MULTIPLICITY 1 |
70 | # define EV_MULTIPLICITY EV_FEATURE_CONFIG |
59 | #endif |
71 | #endif |
60 | |
72 | |
61 | #ifndef EV_PERIODIC_ENABLE |
73 | #ifndef EV_PERIODIC_ENABLE |
62 | # define EV_PERIODIC_ENABLE 1 |
74 | # define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS |
63 | #endif |
75 | #endif |
64 | |
76 | |
65 | #ifndef EV_STAT_ENABLE |
77 | #ifndef EV_STAT_ENABLE |
66 | # define EV_STAT_ENABLE 1 |
78 | # define EV_STAT_ENABLE EV_FEATURE_WATCHERS |
|
|
79 | #endif |
|
|
80 | |
|
|
81 | #ifndef EV_PREPARE_ENABLE |
|
|
82 | # define EV_PREPARE_ENABLE EV_FEATURE_WATCHERS |
|
|
83 | #endif |
|
|
84 | |
|
|
85 | #ifndef EV_CHECK_ENABLE |
|
|
86 | # define EV_CHECK_ENABLE EV_FEATURE_WATCHERS |
67 | #endif |
87 | #endif |
68 | |
88 | |
69 | #ifndef EV_IDLE_ENABLE |
89 | #ifndef EV_IDLE_ENABLE |
70 | # define EV_IDLE_ENABLE 1 |
90 | # define EV_IDLE_ENABLE EV_FEATURE_WATCHERS |
71 | #endif |
91 | #endif |
72 | |
92 | |
73 | #ifndef EV_FORK_ENABLE |
93 | #ifndef EV_FORK_ENABLE |
|
|
94 | # define EV_FORK_ENABLE EV_FEATURE_WATCHERS |
|
|
95 | #endif |
|
|
96 | |
|
|
97 | #ifndef EV_SIGNAL_ENABLE |
|
|
98 | # define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS |
|
|
99 | #endif |
|
|
100 | |
|
|
101 | #ifndef EV_CHILD_ENABLE |
|
|
102 | # ifdef _WIN32 |
74 | # define EV_FORK_ENABLE 1 |
103 | # define EV_CHILD_ENABLE 0 |
|
|
104 | # else |
|
|
105 | # define EV_CHILD_ENABLE EV_FEATURE_WATCHERS |
|
|
106 | #endif |
|
|
107 | #endif |
|
|
108 | |
|
|
109 | #ifndef EV_ASYNC_ENABLE |
|
|
110 | # define EV_ASYNC_ENABLE EV_FEATURE_WATCHERS |
75 | #endif |
111 | #endif |
76 | |
112 | |
77 | #ifndef EV_EMBED_ENABLE |
113 | #ifndef EV_EMBED_ENABLE |
78 | # define EV_EMBED_ENABLE 1 |
114 | # define EV_EMBED_ENABLE EV_FEATURE_WATCHERS |
79 | #endif |
|
|
80 | |
|
|
81 | #ifndef EV_ASYNC_ENABLE |
|
|
82 | # define EV_ASYNC_ENABLE 1 |
|
|
83 | #endif |
115 | #endif |
84 | |
116 | |
85 | #ifndef EV_WALK_ENABLE |
117 | #ifndef EV_WALK_ENABLE |
86 | # define EV_WALK_ENABLE 0 /* not yet */ |
118 | # define EV_WALK_ENABLE 0 /* not yet */ |
87 | #endif |
119 | #endif |
|
|
120 | |
|
|
121 | /*****************************************************************************/ |
|
|
122 | |
|
|
123 | #if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE |
|
|
124 | # undef EV_SIGNAL_ENABLE |
|
|
125 | # define EV_SIGNAL_ENABLE 1 |
|
|
126 | #endif |
|
|
127 | |
|
|
128 | /*****************************************************************************/ |
|
|
129 | |
|
|
130 | typedef double ev_tstamp; |
88 | |
131 | |
89 | #ifndef EV_ATOMIC_T |
132 | #ifndef EV_ATOMIC_T |
90 | # include <signal.h> |
133 | # include <signal.h> |
91 | # define EV_ATOMIC_T sig_atomic_t volatile |
134 | # define EV_ATOMIC_T sig_atomic_t volatile |
92 | #endif |
135 | #endif |
93 | |
|
|
94 | /*****************************************************************************/ |
|
|
95 | |
136 | |
96 | #if EV_STAT_ENABLE |
137 | #if EV_STAT_ENABLE |
97 | # ifdef _WIN32 |
138 | # ifdef _WIN32 |
98 | # include <time.h> |
139 | # include <time.h> |
99 | # include <sys/types.h> |
140 | # include <sys/types.h> |
… | |
… | |
161 | #ifndef EV_PROTOTYPES |
202 | #ifndef EV_PROTOTYPES |
162 | # define EV_PROTOTYPES 1 |
203 | # define EV_PROTOTYPES 1 |
163 | #endif |
204 | #endif |
164 | |
205 | |
165 | #define EV_VERSION_MAJOR 3 |
206 | #define EV_VERSION_MAJOR 3 |
166 | #define EV_VERSION_MINOR 0 |
207 | #define EV_VERSION_MINOR 9 |
167 | |
208 | |
168 | #ifndef EV_CB_DECLARE |
209 | #ifndef EV_CB_DECLARE |
169 | # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); |
210 | # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); |
170 | #endif |
211 | #endif |
171 | #ifndef EV_CB_INVOKE |
212 | #ifndef EV_CB_INVOKE |
… | |
… | |
363 | EV_WATCHER (ev_async) |
404 | EV_WATCHER (ev_async) |
364 | |
405 | |
365 | EV_ATOMIC_T sent; /* private */ |
406 | EV_ATOMIC_T sent; /* private */ |
366 | } ev_async; |
407 | } ev_async; |
367 | |
408 | |
368 | # define ev_async_pending(w) ((w)->sent + 0) |
409 | # define ev_async_pending(w) (+(w)->sent) |
369 | #endif |
410 | #endif |
370 | |
411 | |
371 | /* the presence of this union forces similar struct layout */ |
412 | /* the presence of this union forces similar struct layout */ |
372 | union ev_any_watcher |
413 | union ev_any_watcher |
373 | { |
414 | { |
… | |
… | |
402 | /* the default */ |
443 | /* the default */ |
403 | #define EVFLAG_AUTO 0x00000000U /* not quite a mask */ |
444 | #define EVFLAG_AUTO 0x00000000U /* not quite a mask */ |
404 | /* flag bits */ |
445 | /* flag bits */ |
405 | #define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ |
446 | #define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ |
406 | #define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ |
447 | #define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ |
|
|
448 | /* debugging/feature disable */ |
|
|
449 | #define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */ |
|
|
450 | #define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */ |
|
|
451 | #define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */ |
407 | /* method bits to be ored together */ |
452 | /* method bits to be ored together */ |
408 | #define EVBACKEND_SELECT 0x00000001U /* about anywhere */ |
453 | #define EVBACKEND_SELECT 0x00000001U /* about anywhere */ |
409 | #define EVBACKEND_POLL 0x00000002U /* !win */ |
454 | #define EVBACKEND_POLL 0x00000002U /* !win */ |
410 | #define EVBACKEND_EPOLL 0x00000004U /* linux */ |
455 | #define EVBACKEND_EPOLL 0x00000004U /* linux */ |
411 | #define EVBACKEND_KQUEUE 0x00000008U /* bsd */ |
456 | #define EVBACKEND_KQUEUE 0x00000008U /* bsd */ |
412 | #define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ |
457 | #define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ |
413 | #define EVBACKEND_PORT 0x00000020U /* solaris 10 */ |
458 | #define EVBACKEND_PORT 0x00000020U /* solaris 10 */ |
|
|
459 | #define EVBACKEND_ALL 0x0000003FU |
414 | |
460 | |
415 | #if EV_PROTOTYPES |
461 | #if EV_PROTOTYPES |
416 | int ev_version_major (void); |
462 | int ev_version_major (void); |
417 | int ev_version_minor (void); |
463 | int ev_version_minor (void); |
418 | |
464 | |
… | |
… | |
537 | * convenience function, wait for a single event, without registering an event watcher |
583 | * convenience function, wait for a single event, without registering an event watcher |
538 | * if timeout is < 0, do wait indefinitely |
584 | * if timeout is < 0, do wait indefinitely |
539 | */ |
585 | */ |
540 | void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); |
586 | void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); |
541 | |
587 | |
542 | # if EV_MINIMAL < 2 |
588 | # if EV_FEATURE_API |
543 | unsigned int ev_loop_count (EV_P); /* number of loop iterations */ |
589 | unsigned int ev_loop_count (EV_P); /* number of loop iterations */ |
544 | unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ |
590 | unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ |
545 | void ev_loop_verify (EV_P); /* abort if loop data corrupted */ |
591 | void ev_loop_verify (EV_P); /* abort if loop data corrupted */ |
546 | |
592 | |
547 | void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ |
593 | void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ |
548 | void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ |
594 | void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ |
549 | |
595 | |
550 | /* |
596 | /* advanced stuff for threading etc. support, see docs */ |
551 | * a single void * can be attached to each loop. this is intended |
|
|
552 | * to aid the invoke_pending/blocking callbacks. |
|
|
553 | */ |
|
|
554 | void ev_set_userdata (EV_P_ void *data); |
597 | void ev_set_userdata (EV_P_ void *data); |
555 | void *ev_userdata (EV_P); |
598 | void *ev_userdata (EV_P); |
556 | |
|
|
557 | /* |
|
|
558 | * hooks to overide how and when libev invokes callbacks, |
|
|
559 | * and hooks that wrap the actual eventloop blocking call. |
|
|
560 | */ |
|
|
561 | void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P)); |
599 | void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P)); |
562 | void ev_set_blocking_cb (EV_P_ void (*suspend_cb_)(EV_P), void (*resume_cb_)(EV_P)); |
600 | void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P)); |
563 | |
601 | |
|
|
602 | unsigned int ev_pending_count (EV_P); /* number of pending events, if any */ |
564 | void ev_invoke_pending (EV_P); /* invoke all pending watchers */ |
603 | void ev_invoke_pending (EV_P); /* invoke all pending watchers */ |
565 | |
604 | |
566 | /* |
605 | /* |
567 | * stop/start the timer handling. |
606 | * stop/start the timer handling. |
568 | */ |
607 | */ |
… | |
… | |
614 | |
653 | |
615 | #if EV_MINPRI == EV_MAXPRI |
654 | #if EV_MINPRI == EV_MAXPRI |
616 | # define ev_priority(ev) ((ev), EV_MINPRI) |
655 | # define ev_priority(ev) ((ev), EV_MINPRI) |
617 | # define ev_set_priority(ev,pri) ((ev), (pri)) |
656 | # define ev_set_priority(ev,pri) ((ev), (pri)) |
618 | #else |
657 | #else |
619 | # define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) |
658 | # define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority)) |
620 | # define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri) |
659 | # define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri) |
621 | #endif |
660 | #endif |
622 | |
661 | |
623 | #define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) |
662 | #define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at) |
624 | |
663 | |
625 | #ifndef ev_set_cb |
664 | #ifndef ev_set_cb |
626 | # define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) |
665 | # define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) |
627 | #endif |
666 | #endif |
628 | |
667 | |
… | |
… | |
632 | |
671 | |
633 | /* feeds an event into a watcher as if the event actually occured */ |
672 | /* feeds an event into a watcher as if the event actually occured */ |
634 | /* accepts any ev_watcher type */ |
673 | /* accepts any ev_watcher type */ |
635 | void ev_feed_event (EV_P_ void *w, int revents); |
674 | void ev_feed_event (EV_P_ void *w, int revents); |
636 | void ev_feed_fd_event (EV_P_ int fd, int revents); |
675 | void ev_feed_fd_event (EV_P_ int fd, int revents); |
|
|
676 | #if EV_SIGNAL_ENABLE |
637 | void ev_feed_signal_event (EV_P_ int signum); |
677 | void ev_feed_signal_event (EV_P_ int signum); |
|
|
678 | #endif |
638 | void ev_invoke (EV_P_ void *w, int revents); |
679 | void ev_invoke (EV_P_ void *w, int revents); |
639 | int ev_clear_pending (EV_P_ void *w); |
680 | int ev_clear_pending (EV_P_ void *w); |
640 | |
681 | |
641 | void ev_io_start (EV_P_ ev_io *w); |
682 | void ev_io_start (EV_P_ ev_io *w); |
642 | void ev_io_stop (EV_P_ ev_io *w); |
683 | void ev_io_stop (EV_P_ ev_io *w); |
643 | |
684 | |
644 | void ev_timer_start (EV_P_ ev_timer *w); |
685 | void ev_timer_start (EV_P_ ev_timer *w); |
645 | void ev_timer_stop (EV_P_ ev_timer *w); |
686 | void ev_timer_stop (EV_P_ ev_timer *w); |
646 | /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ |
687 | /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ |
647 | void ev_timer_again (EV_P_ ev_timer *w); |
688 | void ev_timer_again (EV_P_ ev_timer *w); |
|
|
689 | /* return remaining time */ |
|
|
690 | ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w); |
648 | |
691 | |
649 | #if EV_PERIODIC_ENABLE |
692 | #if EV_PERIODIC_ENABLE |
650 | void ev_periodic_start (EV_P_ ev_periodic *w); |
693 | void ev_periodic_start (EV_P_ ev_periodic *w); |
651 | void ev_periodic_stop (EV_P_ ev_periodic *w); |
694 | void ev_periodic_stop (EV_P_ ev_periodic *w); |
652 | void ev_periodic_again (EV_P_ ev_periodic *w); |
695 | void ev_periodic_again (EV_P_ ev_periodic *w); |
653 | #endif |
696 | #endif |
654 | |
697 | |
655 | /* only supported in the default loop */ |
698 | /* only supported in the default loop */ |
|
|
699 | #if EV_SIGNAL_ENABLE |
656 | void ev_signal_start (EV_P_ ev_signal *w); |
700 | void ev_signal_start (EV_P_ ev_signal *w); |
657 | void ev_signal_stop (EV_P_ ev_signal *w); |
701 | void ev_signal_stop (EV_P_ ev_signal *w); |
|
|
702 | #endif |
658 | |
703 | |
659 | /* only supported in the default loop */ |
704 | /* only supported in the default loop */ |
|
|
705 | # if EV_CHILD_ENABLE |
660 | void ev_child_start (EV_P_ ev_child *w); |
706 | void ev_child_start (EV_P_ ev_child *w); |
661 | void ev_child_stop (EV_P_ ev_child *w); |
707 | void ev_child_stop (EV_P_ ev_child *w); |
|
|
708 | # endif |
662 | |
709 | |
663 | # if EV_STAT_ENABLE |
710 | # if EV_STAT_ENABLE |
664 | void ev_stat_start (EV_P_ ev_stat *w); |
711 | void ev_stat_start (EV_P_ ev_stat *w); |
665 | void ev_stat_stop (EV_P_ ev_stat *w); |
712 | void ev_stat_stop (EV_P_ ev_stat *w); |
666 | void ev_stat_stat (EV_P_ ev_stat *w); |
713 | void ev_stat_stat (EV_P_ ev_stat *w); |
… | |
… | |
669 | # if EV_IDLE_ENABLE |
716 | # if EV_IDLE_ENABLE |
670 | void ev_idle_start (EV_P_ ev_idle *w); |
717 | void ev_idle_start (EV_P_ ev_idle *w); |
671 | void ev_idle_stop (EV_P_ ev_idle *w); |
718 | void ev_idle_stop (EV_P_ ev_idle *w); |
672 | # endif |
719 | # endif |
673 | |
720 | |
|
|
721 | #if EV_PREPARE_ENABLE |
674 | void ev_prepare_start (EV_P_ ev_prepare *w); |
722 | void ev_prepare_start (EV_P_ ev_prepare *w); |
675 | void ev_prepare_stop (EV_P_ ev_prepare *w); |
723 | void ev_prepare_stop (EV_P_ ev_prepare *w); |
|
|
724 | #endif |
676 | |
725 | |
|
|
726 | #if EV_CHECK_ENABLE |
677 | void ev_check_start (EV_P_ ev_check *w); |
727 | void ev_check_start (EV_P_ ev_check *w); |
678 | void ev_check_stop (EV_P_ ev_check *w); |
728 | void ev_check_stop (EV_P_ ev_check *w); |
|
|
729 | #endif |
679 | |
730 | |
680 | # if EV_FORK_ENABLE |
731 | # if EV_FORK_ENABLE |
681 | void ev_fork_start (EV_P_ ev_fork *w); |
732 | void ev_fork_start (EV_P_ ev_fork *w); |
682 | void ev_fork_stop (EV_P_ ev_fork *w); |
733 | void ev_fork_stop (EV_P_ ev_fork *w); |
683 | # endif |
734 | # endif |