ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
Revision: 1.28
Committed: Sat Nov 3 22:10:39 2007 UTC (16 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.27: +14 -4 lines
Log Message:
*** empty log message ***

File Contents

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