|
|
1 | /* |
|
|
2 | * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de> |
|
|
3 | * All rights reserved. |
|
|
4 | * |
|
|
5 | * Redistribution and use in source and binary forms, with or without |
|
|
6 | * modification, are permitted provided that the following conditions are |
|
|
7 | * met: |
|
|
8 | * |
|
|
9 | * * Redistributions of source code must retain the above copyright |
|
|
10 | * notice, this list of conditions and the following disclaimer. |
|
|
11 | * |
|
|
12 | * * Redistributions in binary form must reproduce the above |
|
|
13 | * copyright notice, this list of conditions and the following |
|
|
14 | * disclaimer in the documentation and/or other materials provided |
|
|
15 | * with the distribution. |
|
|
16 | * |
|
|
17 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
|
|
18 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
|
|
19 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
|
|
20 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
|
|
21 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
|
|
22 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
|
|
23 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
|
|
24 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
|
|
25 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
|
|
26 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
|
|
27 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
|
28 | */ |
|
|
29 | |
1 | #ifndef EV_H |
30 | #ifndef EV_H |
2 | #define EV_H |
31 | #define EV_H |
3 | |
32 | |
4 | typedef double ev_tstamp; |
33 | typedef double ev_tstamp; |
5 | |
34 | |
6 | /* eventmask, revents, events... */ |
35 | /* eventmask, revents, events... */ |
7 | #define EV_UNDEF -1 /* guaranteed to be invalid */ |
36 | #define EV_UNDEF -1 /* guaranteed to be invalid */ |
8 | #define EV_NONE 0 |
37 | #define EV_NONE 0x00 |
9 | #define EV_READ 1 |
38 | #define EV_READ 0x01 |
10 | #define EV_WRITE 2 |
39 | #define EV_WRITE 0x02 |
|
|
40 | #define EV_REIFY 0x04 /* private */ |
11 | #define EV_TIMEOUT 4 |
41 | #define EV_TIMEOUT 0x000100 |
12 | #define EV_SIGNAL 8 |
42 | #define EV_SIGNAL 0x000200 |
|
|
43 | #define EV_IDLE 0x000400 |
|
|
44 | #define EV_CHECK 0x000800 |
|
|
45 | #define EV_PREPARE 0x001000 |
|
|
46 | #define EV_CHILD 0x002000 |
|
|
47 | #define EV_ERROR 0x800000 /* sent when an error occurs */ |
|
|
48 | |
|
|
49 | /* can be used to add custom fields to all watchers */ |
|
|
50 | #ifndef EV_COMMON |
|
|
51 | # define EV_COMMON void *data |
|
|
52 | #endif |
|
|
53 | #ifndef EV_PROTOTYPES |
|
|
54 | # define EV_PROTOTYPES 1 |
|
|
55 | #endif |
|
|
56 | |
|
|
57 | #define EV_VERSION_MAJOR 1 |
|
|
58 | #define EV_VERSION_MINOR 1 |
|
|
59 | |
|
|
60 | /* |
|
|
61 | * struct member types: |
|
|
62 | * private: you can look at them, but not change them, and they might not mean anything to you. |
|
|
63 | * ro: can be read anytime, but only changed when the watcher isn't active |
|
|
64 | * rw: can be read and modified anytime, even when the watcher is active |
|
|
65 | */ |
13 | |
66 | |
14 | /* shared by all watchers */ |
67 | /* shared by all watchers */ |
15 | #define EV_WATCHER(type) \ |
68 | #define EV_WATCHER(type) \ |
16 | int active; /* private */ \ |
69 | int active; /* private */ \ |
17 | int pending; /* private */ \ |
70 | int pending; /* private */ \ |
18 | void *data; /* rw */ \ |
71 | EV_COMMON; /* rw */ \ |
19 | void (*cb)(struct type *, int revents) /* rw */ |
72 | void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */ |
20 | |
73 | |
21 | #define EV_WATCHER_LIST(type) \ |
74 | #define EV_WATCHER_LIST(type) \ |
22 | EV_WATCHER (type); \ |
75 | EV_WATCHER (type); \ |
23 | struct type *next /* private */ |
76 | struct type *next /* private */ |
24 | |
77 | |
|
|
78 | #define EV_WATCHER_TIME(type) \ |
|
|
79 | EV_WATCHER (type); \ |
|
|
80 | ev_tstamp at /* private */ |
|
|
81 | |
|
|
82 | /* base class, nothing to see here unless you subclass */ |
|
|
83 | struct ev_watcher { |
|
|
84 | EV_WATCHER (ev_watcher); |
|
|
85 | }; |
|
|
86 | |
|
|
87 | /* base class, nothing to see here unless you subclass */ |
|
|
88 | struct ev_watcher_list { |
|
|
89 | EV_WATCHER_LIST (ev_watcher_list); |
|
|
90 | }; |
|
|
91 | |
|
|
92 | /* base class, nothing to see here unless you subclass */ |
|
|
93 | struct ev_watcher_time { |
|
|
94 | EV_WATCHER_TIME (ev_watcher_time); |
|
|
95 | }; |
|
|
96 | |
|
|
97 | /* invoked after a specific time, repeatable (based on monotonic clock) */ |
25 | struct ev_timer |
98 | struct ev_timer |
26 | { |
99 | { |
27 | EV_WATCHER_LIST (ev_timer); |
100 | EV_WATCHER_TIME (ev_timer); |
28 | |
101 | |
29 | ev_tstamp at; /* ro */ |
|
|
30 | ev_tstamp repeat; /* rw */ |
102 | ev_tstamp repeat; /* rw */ |
31 | unsigned char is_abs; /* rw */ |
|
|
32 | }; |
103 | }; |
33 | |
104 | |
|
|
105 | /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ |
|
|
106 | struct ev_periodic |
|
|
107 | { |
|
|
108 | EV_WATCHER_TIME (ev_periodic); |
|
|
109 | |
|
|
110 | ev_tstamp interval; /* rw */ |
|
|
111 | }; |
|
|
112 | |
|
|
113 | /* invoked when fd is either EV_READable or EV_WRITEable */ |
34 | struct ev_io |
114 | struct ev_io |
35 | { |
115 | { |
36 | EV_WATCHER_LIST (ev_io); |
116 | EV_WATCHER_LIST (ev_io); |
37 | |
117 | |
38 | int fd; /* ro */ |
118 | int fd; /* ro */ |
39 | int events; /* ro */ |
119 | int events; /* ro */ |
40 | }; |
120 | }; |
41 | |
121 | |
|
|
122 | /* invoked when the given signal has been received */ |
42 | struct ev_signal |
123 | struct ev_signal |
43 | { |
124 | { |
44 | EV_WATCHER_LIST (ev_signal); |
125 | EV_WATCHER_LIST (ev_signal); |
45 | |
126 | |
46 | int signum; /* ro */ |
127 | int signum; /* ro */ |
|
|
128 | }; |
|
|
129 | |
|
|
130 | /* invoked when the nothing else needs to be done, keeps the process from blocking */ |
|
|
131 | struct ev_idle |
|
|
132 | { |
|
|
133 | EV_WATCHER (ev_idle); |
|
|
134 | }; |
|
|
135 | |
|
|
136 | /* invoked for each run of the mainloop, just before the blocking call */ |
|
|
137 | /* you can still change events in any way you like */ |
|
|
138 | struct ev_prepare |
|
|
139 | { |
|
|
140 | EV_WATCHER (ev_prepare); |
|
|
141 | }; |
|
|
142 | |
|
|
143 | /* invoked for each run of the mainloop, just after the blocking call */ |
|
|
144 | struct ev_check |
|
|
145 | { |
|
|
146 | EV_WATCHER (ev_check); |
|
|
147 | }; |
|
|
148 | |
|
|
149 | /* invoked when sigchld is received and waitpid indicates the givne pid */ |
|
|
150 | struct ev_child |
|
|
151 | { |
|
|
152 | EV_WATCHER_LIST (ev_child); |
|
|
153 | |
|
|
154 | int pid; /* ro */ |
|
|
155 | int status; /* rw, holds the exit status, use the macros from sys/wait.h */ |
47 | }; |
156 | }; |
48 | |
157 | |
49 | #define EVMETHOD_NONE 0 |
158 | #define EVMETHOD_NONE 0 |
50 | #define EVMETHOD_SELECT 1 |
159 | #define EVMETHOD_SELECT 1 |
51 | #define EVMETHOD_EPOLL 2 |
160 | #define EVMETHOD_EPOLL 2 |
52 | int ev_init (int flags); |
161 | #if EV_PROTOTYPES |
53 | extern int ev_method; |
162 | extern int ev_method; |
|
|
163 | int ev_init (int flags); /* returns ev_method */ |
|
|
164 | int ev_version_major (void); |
|
|
165 | int ev_version_minor (void); |
54 | |
166 | |
|
|
167 | /* these three calls are suitable for plugging into pthread_atfork */ |
55 | void ev_prefork (void); |
168 | void ev_prefork (void); |
56 | void ev_postfork_parent (void); |
169 | void ev_postfork_parent (void); |
57 | void ev_postfork_child (void); |
170 | void ev_postfork_child (void); |
58 | |
171 | |
59 | extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */ |
172 | extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */ |
60 | ev_tstamp ev_time (void); |
173 | ev_tstamp ev_time (void); |
|
|
174 | #endif |
61 | |
175 | |
62 | #define EVLOOP_NONBLOCK 1 /* do not block/wait */ |
176 | #define EVLOOP_NONBLOCK 1 /* do not block/wait */ |
63 | #define EVLOOP_ONESHOT 2 /* block *once* only */ |
177 | #define EVLOOP_ONESHOT 2 /* block *once* only */ |
|
|
178 | #if EV_PROTOTYPES |
64 | int ev_loop (int flags); |
179 | void ev_loop (int flags); |
65 | extern int ev_loop_done; /* set to 1 to break out of event loop */ |
180 | extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ |
66 | |
181 | |
|
|
182 | /* convinience function, wait for a single event, without registering an event watcher */ |
|
|
183 | /* if timeout is < 0, do wait indefinitely */ |
|
|
184 | void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); |
|
|
185 | #endif |
|
|
186 | |
|
|
187 | /* these may evaluate ev multiple times, and the other arguments at most once */ |
|
|
188 | /* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */ |
67 | #define evw_init(ev,cb_,data_) do { (ev)->active = 0; (ev)->cb = (cb_); (ev)->data = (void *)data_; } while (0) |
189 | #define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0) |
|
|
190 | |
68 | #define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) |
191 | #define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) |
69 | #define evtimer_set_rel(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); (ev)->is_abs = 0; } while (0) |
192 | #define evtimer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) |
70 | #define evtimer_set_abs(ev,at_,repeat_) do { (ev)->at = (at_); (ev)->repeat = (repeat_); (ev)->is_abs = 1; } while (0) |
193 | #define evperiodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) |
71 | #define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) |
194 | #define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) |
|
|
195 | #define evidle_set(ev) /* nop, yes, this is a serious in-joke */ |
|
|
196 | #define evprepare_set(ev) /* nop, yes, this is a serious in-joke */ |
|
|
197 | #define evcheck_set(ev) /* nop, yes, this is a serious in-joke */ |
|
|
198 | #define evchild_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) |
72 | |
199 | |
|
|
200 | #define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0) |
|
|
201 | #define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0) |
|
|
202 | #define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0) |
|
|
203 | #define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0) |
|
|
204 | #define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0) |
|
|
205 | #define evprepare_init(ev,cb) do { evw_init ((ev), (cb)); evprepare_set ((ev)); } while (0) |
|
|
206 | #define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0) |
|
|
207 | #define evchild_init(ev,cb,pid) do { evw_init ((ev), (cb)); evchild_set ((ev),(pid)); } while (0) |
|
|
208 | |
73 | #define ev_is_active(ev) (0 + (ev)->active) /* wether the watcher has been started */ |
209 | #define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ |
74 | |
210 | |
|
|
211 | /* stopping (enabling, adding) a watcher does nothing if it is already running */ |
|
|
212 | /* stopping (disabling, deleting) a watcher does nothing unless its already running */ |
|
|
213 | #if EV_PROTOTYPES |
75 | void evio_start (struct ev_io *w); |
214 | void evio_start (struct ev_io *w); |
76 | void evio_stop (struct ev_io *w); |
215 | void evio_stop (struct ev_io *w); |
77 | |
216 | |
78 | void evtimer_start (struct ev_timer *w); |
217 | void evtimer_start (struct ev_timer *w); |
79 | void evtimer_stop (struct ev_timer *w); |
218 | void evtimer_stop (struct ev_timer *w); |
|
|
219 | void evtimer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ |
80 | |
220 | |
|
|
221 | void evperiodic_start (struct ev_periodic *w); |
|
|
222 | void evperiodic_stop (struct ev_periodic *w); |
|
|
223 | |
81 | void evsignal_start (struct ev_signal *w); |
224 | void evsignal_start (struct ev_signal *w); |
82 | void evsignal_stop (struct ev_signal *w); |
225 | void evsignal_stop (struct ev_signal *w); |
83 | |
226 | |
84 | #endif |
227 | void evidle_start (struct ev_idle *w); |
|
|
228 | void evidle_stop (struct ev_idle *w); |
85 | |
229 | |
|
|
230 | void evprepare_start (struct ev_prepare *w); |
|
|
231 | void evprepare_stop (struct ev_prepare *w); |
|
|
232 | |
|
|
233 | void evcheck_start (struct ev_check *w); |
|
|
234 | void evcheck_stop (struct ev_check *w); |
|
|
235 | |
|
|
236 | void evchild_start (struct ev_child *w); |
|
|
237 | void evchild_stop (struct ev_child *w); |
|
|
238 | #endif |
|
|
239 | |
|
|
240 | #endif |
|
|
241 | |