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 | |
48 | |
|
|
49 | #ifndef EV_FEATURES |
|
|
50 | # define EV_FEATURES 0x7f |
|
|
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) |
|
|
60 | |
49 | /* these priorities are inclusive, higher priorities will be called earlier */ |
61 | /* these priorities are inclusive, higher priorities will be invoked 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> |
… | |
… | |
128 | # define EV_INLINE static inline |
169 | # define EV_INLINE static inline |
129 | #else |
170 | #else |
130 | # define EV_INLINE static |
171 | # define EV_INLINE static |
131 | #endif |
172 | #endif |
132 | |
173 | |
|
|
174 | #ifndef EV_PROTOTYPES |
|
|
175 | # define EV_PROTOTYPES 1 |
|
|
176 | #endif |
|
|
177 | |
133 | /*****************************************************************************/ |
178 | /*****************************************************************************/ |
|
|
179 | |
|
|
180 | #define EV_VERSION_MAJOR 4 |
|
|
181 | #define EV_VERSION_MINOR 0 |
134 | |
182 | |
135 | /* eventmask, revents, events... */ |
183 | /* eventmask, revents, events... */ |
136 | #define EV_UNDEF -1 /* guaranteed to be invalid */ |
184 | #define EV_UNDEF -1 /* guaranteed to be invalid */ |
137 | #define EV_NONE 0x00 /* no events */ |
185 | #define EV_NONE 0x00 /* no events */ |
138 | #define EV_READ 0x01 /* ev_io detected read will not block */ |
186 | #define EV_READ 0x01 /* ev_io detected read will not block */ |
… | |
… | |
156 | |
204 | |
157 | /* can be used to add custom fields to all watchers, while losing binary compatibility */ |
205 | /* can be used to add custom fields to all watchers, while losing binary compatibility */ |
158 | #ifndef EV_COMMON |
206 | #ifndef EV_COMMON |
159 | # define EV_COMMON void *data; |
207 | # define EV_COMMON void *data; |
160 | #endif |
208 | #endif |
161 | #ifndef EV_PROTOTYPES |
|
|
162 | # define EV_PROTOTYPES 1 |
|
|
163 | #endif |
|
|
164 | |
|
|
165 | #define EV_VERSION_MAJOR 3 |
|
|
166 | #define EV_VERSION_MINOR 7 |
|
|
167 | |
209 | |
168 | #ifndef EV_CB_DECLARE |
210 | #ifndef EV_CB_DECLARE |
169 | # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); |
211 | # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); |
170 | #endif |
212 | #endif |
171 | #ifndef EV_CB_INVOKE |
213 | #ifndef EV_CB_INVOKE |
172 | # define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) |
214 | # define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) |
173 | #endif |
215 | #endif |
|
|
216 | |
|
|
217 | /* not official, do not use */ |
|
|
218 | #define EV_CB(type,name) void name (EV_P_ struct ev_ ## type *w, int revents) |
174 | |
219 | |
175 | /* |
220 | /* |
176 | * struct member types: |
221 | * struct member types: |
177 | * private: you may look at them, but not change them, |
222 | * private: you may look at them, but not change them, |
178 | * and they might not mean anything to you. |
223 | * and they might not mean anything to you. |
… | |
… | |
189 | * or the array index + 1 in the pendings array. |
234 | * or the array index + 1 in the pendings array. |
190 | */ |
235 | */ |
191 | |
236 | |
192 | #if EV_MINPRI == EV_MAXPRI |
237 | #if EV_MINPRI == EV_MAXPRI |
193 | # define EV_DECL_PRIORITY |
238 | # define EV_DECL_PRIORITY |
194 | #else |
239 | #elif !defined (EV_DECL_PRIORITY) |
195 | # define EV_DECL_PRIORITY int priority; |
240 | # define EV_DECL_PRIORITY int priority; |
196 | #endif |
241 | #endif |
197 | |
242 | |
198 | /* shared by all watchers */ |
243 | /* shared by all watchers */ |
199 | #define EV_WATCHER(type) \ |
244 | #define EV_WATCHER(type) \ |
… | |
… | |
363 | EV_WATCHER (ev_async) |
408 | EV_WATCHER (ev_async) |
364 | |
409 | |
365 | EV_ATOMIC_T sent; /* private */ |
410 | EV_ATOMIC_T sent; /* private */ |
366 | } ev_async; |
411 | } ev_async; |
367 | |
412 | |
368 | # define ev_async_pending(w) ((w)->sent + 0) |
413 | # define ev_async_pending(w) (+(w)->sent) |
369 | #endif |
414 | #endif |
370 | |
415 | |
371 | /* the presence of this union forces similar struct layout */ |
416 | /* the presence of this union forces similar struct layout */ |
372 | union ev_any_watcher |
417 | union ev_any_watcher |
373 | { |
418 | { |
… | |
… | |
402 | /* the default */ |
447 | /* the default */ |
403 | #define EVFLAG_AUTO 0x00000000U /* not quite a mask */ |
448 | #define EVFLAG_AUTO 0x00000000U /* not quite a mask */ |
404 | /* flag bits */ |
449 | /* flag bits */ |
405 | #define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ |
450 | #define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ |
406 | #define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ |
451 | #define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ |
|
|
452 | /* debugging/feature disable */ |
|
|
453 | #define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */ |
|
|
454 | #define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */ |
|
|
455 | #define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */ |
407 | /* method bits to be ored together */ |
456 | /* method bits to be ored together */ |
408 | #define EVBACKEND_SELECT 0x00000001U /* about anywhere */ |
457 | #define EVBACKEND_SELECT 0x00000001U /* about anywhere */ |
409 | #define EVBACKEND_POLL 0x00000002U /* !win */ |
458 | #define EVBACKEND_POLL 0x00000002U /* !win */ |
410 | #define EVBACKEND_EPOLL 0x00000004U /* linux */ |
459 | #define EVBACKEND_EPOLL 0x00000004U /* linux */ |
411 | #define EVBACKEND_KQUEUE 0x00000008U /* bsd */ |
460 | #define EVBACKEND_KQUEUE 0x00000008U /* bsd */ |
412 | #define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ |
461 | #define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ |
413 | #define EVBACKEND_PORT 0x00000020U /* solaris 10 */ |
462 | #define EVBACKEND_PORT 0x00000020U /* solaris 10 */ |
|
|
463 | #define EVBACKEND_ALL 0x0000003FU |
414 | |
464 | |
415 | #if EV_PROTOTYPES |
465 | #if EV_PROTOTYPES |
416 | int ev_version_major (void); |
466 | int ev_version_major (void); |
417 | int ev_version_minor (void); |
467 | int ev_version_minor (void); |
418 | |
468 | |
… | |
… | |
537 | * convenience function, wait for a single event, without registering an event watcher |
587 | * convenience function, wait for a single event, without registering an event watcher |
538 | * if timeout is < 0, do wait indefinitely |
588 | * if timeout is < 0, do wait indefinitely |
539 | */ |
589 | */ |
540 | void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); |
590 | void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); |
541 | |
591 | |
542 | # if EV_MINIMAL < 2 |
592 | # if EV_FEATURE_API |
543 | unsigned int ev_loop_count (EV_P); /* number of loop iterations */ |
593 | 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 */ |
594 | 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 */ |
595 | void ev_loop_verify (EV_P); /* abort if loop data corrupted */ |
546 | |
596 | |
547 | void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ |
597 | void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ |
… | |
… | |
607 | |
657 | |
608 | #if EV_MINPRI == EV_MAXPRI |
658 | #if EV_MINPRI == EV_MAXPRI |
609 | # define ev_priority(ev) ((ev), EV_MINPRI) |
659 | # define ev_priority(ev) ((ev), EV_MINPRI) |
610 | # define ev_set_priority(ev,pri) ((ev), (pri)) |
660 | # define ev_set_priority(ev,pri) ((ev), (pri)) |
611 | #else |
661 | #else |
612 | # define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) |
662 | # define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority)) |
613 | # define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri) |
663 | # define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri) |
614 | #endif |
664 | #endif |
615 | |
665 | |
616 | #define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) |
666 | #define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at) |
617 | |
667 | |
618 | #ifndef ev_set_cb |
668 | #ifndef ev_set_cb |
619 | # define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) |
669 | # define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) |
620 | #endif |
670 | #endif |
621 | |
671 | |
… | |
… | |
625 | |
675 | |
626 | /* feeds an event into a watcher as if the event actually occured */ |
676 | /* feeds an event into a watcher as if the event actually occured */ |
627 | /* accepts any ev_watcher type */ |
677 | /* accepts any ev_watcher type */ |
628 | void ev_feed_event (EV_P_ void *w, int revents); |
678 | void ev_feed_event (EV_P_ void *w, int revents); |
629 | void ev_feed_fd_event (EV_P_ int fd, int revents); |
679 | void ev_feed_fd_event (EV_P_ int fd, int revents); |
|
|
680 | #if EV_SIGNAL_ENABLE |
630 | void ev_feed_signal_event (EV_P_ int signum); |
681 | void ev_feed_signal_event (EV_P_ int signum); |
|
|
682 | #endif |
631 | void ev_invoke (EV_P_ void *w, int revents); |
683 | void ev_invoke (EV_P_ void *w, int revents); |
632 | int ev_clear_pending (EV_P_ void *w); |
684 | int ev_clear_pending (EV_P_ void *w); |
633 | |
685 | |
634 | void ev_io_start (EV_P_ ev_io *w); |
686 | void ev_io_start (EV_P_ ev_io *w); |
635 | void ev_io_stop (EV_P_ ev_io *w); |
687 | void ev_io_stop (EV_P_ ev_io *w); |
636 | |
688 | |
637 | void ev_timer_start (EV_P_ ev_timer *w); |
689 | void ev_timer_start (EV_P_ ev_timer *w); |
638 | void ev_timer_stop (EV_P_ ev_timer *w); |
690 | void ev_timer_stop (EV_P_ ev_timer *w); |
639 | /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ |
691 | /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ |
640 | void ev_timer_again (EV_P_ ev_timer *w); |
692 | void ev_timer_again (EV_P_ ev_timer *w); |
|
|
693 | /* return remaining time */ |
|
|
694 | ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w); |
641 | |
695 | |
642 | #if EV_PERIODIC_ENABLE |
696 | #if EV_PERIODIC_ENABLE |
643 | void ev_periodic_start (EV_P_ ev_periodic *w); |
697 | void ev_periodic_start (EV_P_ ev_periodic *w); |
644 | void ev_periodic_stop (EV_P_ ev_periodic *w); |
698 | void ev_periodic_stop (EV_P_ ev_periodic *w); |
645 | void ev_periodic_again (EV_P_ ev_periodic *w); |
699 | void ev_periodic_again (EV_P_ ev_periodic *w); |
646 | #endif |
700 | #endif |
647 | |
701 | |
648 | /* only supported in the default loop */ |
702 | /* only supported in the default loop */ |
|
|
703 | #if EV_SIGNAL_ENABLE |
649 | void ev_signal_start (EV_P_ ev_signal *w); |
704 | void ev_signal_start (EV_P_ ev_signal *w); |
650 | void ev_signal_stop (EV_P_ ev_signal *w); |
705 | void ev_signal_stop (EV_P_ ev_signal *w); |
|
|
706 | #endif |
651 | |
707 | |
652 | /* only supported in the default loop */ |
708 | /* only supported in the default loop */ |
|
|
709 | # if EV_CHILD_ENABLE |
653 | void ev_child_start (EV_P_ ev_child *w); |
710 | void ev_child_start (EV_P_ ev_child *w); |
654 | void ev_child_stop (EV_P_ ev_child *w); |
711 | void ev_child_stop (EV_P_ ev_child *w); |
|
|
712 | # endif |
655 | |
713 | |
656 | # if EV_STAT_ENABLE |
714 | # if EV_STAT_ENABLE |
657 | void ev_stat_start (EV_P_ ev_stat *w); |
715 | void ev_stat_start (EV_P_ ev_stat *w); |
658 | void ev_stat_stop (EV_P_ ev_stat *w); |
716 | void ev_stat_stop (EV_P_ ev_stat *w); |
659 | void ev_stat_stat (EV_P_ ev_stat *w); |
717 | void ev_stat_stat (EV_P_ ev_stat *w); |
… | |
… | |
662 | # if EV_IDLE_ENABLE |
720 | # if EV_IDLE_ENABLE |
663 | void ev_idle_start (EV_P_ ev_idle *w); |
721 | void ev_idle_start (EV_P_ ev_idle *w); |
664 | void ev_idle_stop (EV_P_ ev_idle *w); |
722 | void ev_idle_stop (EV_P_ ev_idle *w); |
665 | # endif |
723 | # endif |
666 | |
724 | |
|
|
725 | #if EV_PREPARE_ENABLE |
667 | void ev_prepare_start (EV_P_ ev_prepare *w); |
726 | void ev_prepare_start (EV_P_ ev_prepare *w); |
668 | void ev_prepare_stop (EV_P_ ev_prepare *w); |
727 | void ev_prepare_stop (EV_P_ ev_prepare *w); |
|
|
728 | #endif |
669 | |
729 | |
|
|
730 | #if EV_CHECK_ENABLE |
670 | void ev_check_start (EV_P_ ev_check *w); |
731 | void ev_check_start (EV_P_ ev_check *w); |
671 | void ev_check_stop (EV_P_ ev_check *w); |
732 | void ev_check_stop (EV_P_ ev_check *w); |
|
|
733 | #endif |
672 | |
734 | |
673 | # if EV_FORK_ENABLE |
735 | # if EV_FORK_ENABLE |
674 | void ev_fork_start (EV_P_ ev_fork *w); |
736 | void ev_fork_start (EV_P_ ev_fork *w); |
675 | void ev_fork_stop (EV_P_ ev_fork *w); |
737 | void ev_fork_stop (EV_P_ ev_fork *w); |
676 | # endif |
738 | # endif |