|
|
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 0x00 |
37 | #define EV_NONE 0x00 |
9 | #define EV_READ 0x01 |
38 | #define EV_READ 0x01 |
10 | #define EV_WRITE 0x02 |
39 | #define EV_WRITE 0x02 |
11 | #define EV_TIMEOUT 0x04 |
40 | #define EV_TIMEOUT 0x000100 |
|
|
41 | #define EV_PERIODIC 0x000200 |
12 | #define EV_SIGNAL 0x08 |
42 | #define EV_SIGNAL 0x000400 |
13 | #define EV_IDLE 0x10 |
43 | #define EV_IDLE 0x000800 |
14 | #define EV_CHECK 0x20 |
44 | #define EV_CHECK 0x001000 |
|
|
45 | #define EV_PREPARE 0x002000 |
|
|
46 | #define EV_CHILD 0x004000 |
|
|
47 | #define EV_ERROR 0x800000 /* sent when an error occurs */ |
15 | |
48 | |
16 | /* can be used to add custom fields to all watchers */ |
49 | /* can be used to add custom fields to all watchers */ |
17 | #ifndef EV_COMMON |
50 | #ifndef EV_COMMON |
18 | # define EV_COMMON void *data |
51 | # define EV_COMMON void *data |
19 | #endif |
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 |
20 | |
59 | |
21 | /* |
60 | /* |
22 | * struct member types: |
61 | * struct member types: |
23 | * private: you can look at them, but not change them, and they might not mean anything to you. |
62 | * private: you can look at them, but not change them, and they might not mean anything to you. |
24 | * ro: can be read anytime, but only changed when the watcher isn't active |
63 | * ro: can be read anytime, but only changed when the watcher isn't active |
… | |
… | |
54 | struct ev_watcher_time { |
93 | struct ev_watcher_time { |
55 | EV_WATCHER_TIME (ev_watcher_time); |
94 | EV_WATCHER_TIME (ev_watcher_time); |
56 | }; |
95 | }; |
57 | |
96 | |
58 | /* invoked after a specific time, repeatable (based on monotonic clock) */ |
97 | /* invoked after a specific time, repeatable (based on monotonic clock) */ |
|
|
98 | /* revent EV_TIMEOUT */ |
59 | struct ev_timer |
99 | struct ev_timer |
60 | { |
100 | { |
61 | EV_WATCHER_TIME (ev_timer); |
101 | EV_WATCHER_TIME (ev_timer); |
62 | |
102 | |
63 | ev_tstamp repeat; /* rw */ |
103 | ev_tstamp repeat; /* rw */ |
64 | }; |
104 | }; |
65 | |
105 | |
66 | /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ |
106 | /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ |
|
|
107 | /* revent EV_PERIODIC */ |
67 | struct ev_periodic |
108 | struct ev_periodic |
68 | { |
109 | { |
69 | EV_WATCHER_TIME (ev_periodic); |
110 | EV_WATCHER_TIME (ev_periodic); |
70 | |
111 | |
71 | ev_tstamp interval; /* rw */ |
112 | ev_tstamp interval; /* rw */ |
72 | }; |
113 | }; |
73 | |
114 | |
74 | /* invoked when fd is either EV_READable or EV_WRITEable */ |
115 | /* invoked when fd is either EV_READable or EV_WRITEable */ |
|
|
116 | /* revent EV_READ, EV_WRITE */ |
75 | struct ev_io |
117 | struct ev_io |
76 | { |
118 | { |
77 | EV_WATCHER_LIST (ev_io); |
119 | EV_WATCHER_LIST (ev_io); |
78 | |
120 | |
79 | int fd; /* ro */ |
121 | int fd; /* ro */ |
80 | int events; /* ro */ |
122 | int events; /* ro */ |
81 | }; |
123 | }; |
82 | |
124 | |
83 | /* invoked when the given signal has been received */ |
125 | /* invoked when the given signal has been received */ |
|
|
126 | /* revent EV_SIGNAL */ |
84 | struct ev_signal |
127 | struct ev_signal |
85 | { |
128 | { |
86 | EV_WATCHER_LIST (ev_signal); |
129 | EV_WATCHER_LIST (ev_signal); |
87 | |
130 | |
88 | int signum; /* ro */ |
131 | int signum; /* ro */ |
89 | }; |
132 | }; |
90 | |
133 | |
91 | /* invoked when the nothing else needs to be done, keeps the process from blocking */ |
134 | /* invoked when the nothing else needs to be done, keeps the process from blocking */ |
|
|
135 | /* revent EV_IDLE */ |
92 | struct ev_idle |
136 | struct ev_idle |
93 | { |
137 | { |
94 | EV_WATCHER (ev_idle); |
138 | EV_WATCHER (ev_idle); |
95 | }; |
139 | }; |
96 | |
140 | |
97 | /* invoked for each run of the mainloop, just before the next blocking vall is initiated */ |
141 | /* invoked for each run of the mainloop, just before the blocking call */ |
|
|
142 | /* you can still change events in any way you like */ |
|
|
143 | /* revent EV_PREPARE */ |
|
|
144 | struct ev_prepare |
|
|
145 | { |
|
|
146 | EV_WATCHER (ev_prepare); |
|
|
147 | }; |
|
|
148 | |
|
|
149 | /* invoked for each run of the mainloop, just after the blocking call */ |
|
|
150 | /* revent EV_CHECK */ |
98 | struct ev_check |
151 | struct ev_check |
99 | { |
152 | { |
100 | EV_WATCHER (ev_check); |
153 | EV_WATCHER (ev_check); |
|
|
154 | }; |
|
|
155 | |
|
|
156 | /* invoked when sigchld is received and waitpid indicates the givne pid */ |
|
|
157 | /* revent EV_CHILD */ |
|
|
158 | struct ev_child |
|
|
159 | { |
|
|
160 | EV_WATCHER_LIST (ev_child); |
|
|
161 | |
|
|
162 | int pid; /* ro */ |
|
|
163 | int status; /* rw, holds the exit status, use the macros from sys/wait.h */ |
101 | }; |
164 | }; |
102 | |
165 | |
103 | #define EVMETHOD_NONE 0 |
166 | #define EVMETHOD_NONE 0 |
104 | #define EVMETHOD_SELECT 1 |
167 | #define EVMETHOD_SELECT 1 |
105 | #define EVMETHOD_EPOLL 2 |
168 | #define EVMETHOD_EPOLL 2 |
|
|
169 | #if EV_PROTOTYPES |
|
|
170 | extern int ev_method; |
106 | int ev_init (int flags); /* returns ev_method */ |
171 | int ev_init (int flags); /* returns ev_method */ |
107 | extern int ev_method; |
172 | int ev_version_major (void); |
|
|
173 | int ev_version_minor (void); |
108 | |
174 | |
109 | /* these three calls are suitable for plugging into pthread_atfork */ |
175 | /* these three calls are suitable for plugging into pthread_atfork */ |
110 | void ev_prefork (void); |
176 | void ev_fork_prepare (void); |
111 | void ev_postfork_parent (void); |
177 | void ev_fork_parent (void); |
112 | void ev_postfork_child (void); |
178 | void ev_fork_child (void); |
113 | |
179 | |
114 | extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */ |
180 | extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */ |
115 | ev_tstamp ev_time (void); |
181 | ev_tstamp ev_time (void); |
|
|
182 | #endif |
116 | |
183 | |
117 | #define EVLOOP_NONBLOCK 1 /* do not block/wait */ |
184 | #define EVLOOP_NONBLOCK 1 /* do not block/wait */ |
118 | #define EVLOOP_ONESHOT 2 /* block *once* only */ |
185 | #define EVLOOP_ONESHOT 2 /* block *once* only */ |
|
|
186 | #if EV_PROTOTYPES |
119 | void ev_loop (int flags); |
187 | void ev_loop (int flags); |
120 | extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ |
188 | extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ |
121 | |
189 | |
|
|
190 | /* convinience function, wait for a single event, without registering an event watcher */ |
|
|
191 | /* if timeout is < 0, do wait indefinitely */ |
|
|
192 | void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); |
|
|
193 | #endif |
|
|
194 | |
122 | /* these may evaluate ev multiple times, and the other arguments at most once */ |
195 | /* these may evaluate ev multiple times, and the other arguments at most once */ |
123 | /* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */ |
196 | /* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ |
124 | #define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->cb = (cb_); } while (0) |
197 | #define ev_watcher_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0) |
125 | |
198 | |
126 | #define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) |
199 | #define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) |
127 | #define evtimer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) |
200 | #define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) |
128 | #define evperiodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) |
201 | #define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) |
129 | #define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) |
202 | #define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) |
130 | #define evcheck_set(ev) /* nop, yes this is a serious in-joke */ |
|
|
131 | #define evidle_set(ev) /* nop, yes this is a serious in-joke */ |
203 | #define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ |
|
|
204 | #define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ |
|
|
205 | #define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ |
|
|
206 | #define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) |
132 | |
207 | |
133 | #define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0) |
208 | #define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) |
134 | #define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0) |
209 | #define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) |
135 | #define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0) |
210 | #define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0) |
136 | #define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0) |
211 | #define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) |
|
|
212 | #define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) |
|
|
213 | #define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) |
137 | #define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0) |
214 | #define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0) |
138 | #define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0) |
215 | #define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) |
139 | |
216 | |
140 | #define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ |
217 | #define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ |
141 | |
218 | |
142 | /* stopping (enabling, adding) a watcher does nothing if it is already running */ |
219 | /* stopping (enabling, adding) a watcher does nothing if it is already running */ |
143 | /* stopping (disabling, deleting) a watcher does nothing unless its already running */ |
220 | /* stopping (disabling, deleting) a watcher does nothing unless its already running */ |
|
|
221 | #if EV_PROTOTYPES |
144 | void evio_start (struct ev_io *w); |
222 | void ev_io_start (struct ev_io *w); |
145 | void evio_stop (struct ev_io *w); |
223 | void ev_io_stop (struct ev_io *w); |
146 | |
224 | |
147 | void evtimer_start (struct ev_timer *w); |
225 | void ev_timer_start (struct ev_timer *w); |
148 | void evtimer_stop (struct ev_timer *w); |
226 | void ev_timer_stop (struct ev_timer *w); |
|
|
227 | void ev_timer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ |
149 | |
228 | |
150 | void evperiodic_start (struct ev_periodic *w); |
229 | void ev_periodic_start (struct ev_periodic *w); |
151 | void evperiodic_stop (struct ev_periodic *w); |
230 | void ev_periodic_stop (struct ev_periodic *w); |
152 | |
231 | |
153 | void evsignal_start (struct ev_signal *w); |
232 | void ev_signal_start (struct ev_signal *w); |
154 | void evsignal_stop (struct ev_signal *w); |
233 | void ev_signal_stop (struct ev_signal *w); |
155 | |
234 | |
156 | void evidle_start (struct ev_idle *w); |
235 | void ev_idle_start (struct ev_idle *w); |
157 | void evidle_stop (struct ev_idle *w); |
236 | void ev_idle_stop (struct ev_idle *w); |
158 | |
237 | |
|
|
238 | void ev_prepare_start (struct ev_prepare *w); |
|
|
239 | void ev_prepare_stop (struct ev_prepare *w); |
|
|
240 | |
159 | void evcheck_start (struct ev_check *w); |
241 | void ev_check_start (struct ev_check *w); |
160 | void evcheck_stop (struct ev_check *w); |
242 | void ev_check_stop (struct ev_check *w); |
161 | |
243 | |
|
|
244 | void ev_child_start (struct ev_child *w); |
|
|
245 | void ev_child_stop (struct ev_child *w); |
162 | #endif |
246 | #endif |
163 | |
247 | |
|
|
248 | #endif |
|
|
249 | |