ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
Revision: 1.31
Committed: Sun Nov 4 19:45:09 2007 UTC (16 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.30: +1 -0 lines
Log Message:
*** empty log message ***

File Contents

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