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