ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
Revision: 1.45
Committed: Fri Nov 9 21:48:23 2007 UTC (16 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.44: +15 -12 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.43 #ifndef EV_H__
31     #define EV_H__
32 root 1.1
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.44 #ifndef EV_CB_DECLARE
91     # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents)
92     #endif
93     #ifndef EV_CB_INVOKE
94     # define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
95     #endif
96    
97 root 1.6 /*
98     * struct member types:
99     * private: you can look at them, but not change them, and they might not mean anything to you.
100     * ro: can be read anytime, but only changed when the watcher isn't active
101     * rw: can be read and modified anytime, even when the watcher is active
102     */
103    
104 root 1.1 /* shared by all watchers */
105     #define EV_WATCHER(type) \
106     int active; /* private */ \
107     int pending; /* private */ \
108 root 1.32 int priority; /* private */ \
109 root 1.6 EV_COMMON; /* rw */ \
110 root 1.44 EV_CB_DECLARE (type) /* private */
111 root 1.1
112     #define EV_WATCHER_LIST(type) \
113     EV_WATCHER (type); \
114 root 1.26 struct ev_watcher_list *next /* private */
115 root 1.1
116 root 1.6 #define EV_WATCHER_TIME(type) \
117     EV_WATCHER (type); \
118     ev_tstamp at /* private */
119    
120 root 1.7 /* base class, nothing to see here unless you subclass */
121 root 1.44 struct ev_watcher
122     {
123 root 1.7 EV_WATCHER (ev_watcher);
124     };
125    
126     /* base class, nothing to see here unless you subclass */
127 root 1.44 struct ev_watcher_list
128     {
129 root 1.7 EV_WATCHER_LIST (ev_watcher_list);
130     };
131    
132     /* base class, nothing to see here unless you subclass */
133 root 1.44 struct ev_watcher_time
134     {
135 root 1.7 EV_WATCHER_TIME (ev_watcher_time);
136     };
137    
138 root 1.6 /* invoked after a specific time, repeatable (based on monotonic clock) */
139 root 1.17 /* revent EV_TIMEOUT */
140 root 1.1 struct ev_timer
141     {
142 root 1.6 EV_WATCHER_TIME (ev_timer);
143 root 1.1
144     ev_tstamp repeat; /* rw */
145 root 1.6 };
146    
147     /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
148 root 1.17 /* revent EV_PERIODIC */
149 root 1.6 struct ev_periodic
150     {
151     EV_WATCHER_TIME (ev_periodic);
152    
153     ev_tstamp interval; /* rw */
154 root 1.40 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
155 root 1.1 };
156    
157 root 1.5 /* invoked when fd is either EV_READable or EV_WRITEable */
158 root 1.17 /* revent EV_READ, EV_WRITE */
159 root 1.1 struct ev_io
160     {
161     EV_WATCHER_LIST (ev_io);
162    
163     int fd; /* ro */
164     int events; /* ro */
165     };
166    
167 root 1.5 /* invoked when the given signal has been received */
168 root 1.17 /* revent EV_SIGNAL */
169 root 1.1 struct ev_signal
170     {
171     EV_WATCHER_LIST (ev_signal);
172    
173     int signum; /* ro */
174     };
175    
176 root 1.5 /* invoked when the nothing else needs to be done, keeps the process from blocking */
177 root 1.17 /* revent EV_IDLE */
178 root 1.5 struct ev_idle
179     {
180     EV_WATCHER (ev_idle);
181     };
182    
183 root 1.11 /* invoked for each run of the mainloop, just before the blocking call */
184     /* you can still change events in any way you like */
185 root 1.17 /* revent EV_PREPARE */
186 root 1.11 struct ev_prepare
187     {
188     EV_WATCHER (ev_prepare);
189     };
190    
191     /* invoked for each run of the mainloop, just after the blocking call */
192 root 1.17 /* revent EV_CHECK */
193 root 1.5 struct ev_check
194     {
195     EV_WATCHER (ev_check);
196     };
197    
198 root 1.12 /* invoked when sigchld is received and waitpid indicates the givne pid */
199 root 1.17 /* revent EV_CHILD */
200 root 1.25 /* does not support priorities */
201 root 1.12 struct ev_child
202     {
203     EV_WATCHER_LIST (ev_child);
204    
205 root 1.24 int pid; /* ro */
206     int rpid; /* rw, holds the received pid */
207     int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
208 root 1.12 };
209    
210 root 1.41 /* the presence of this union forces similar struct layout */
211 root 1.35 union ev_any_watcher
212     {
213     struct ev_watcher w;
214     struct ev_watcher_list wl;
215     struct ev_io io;
216     struct ev_timer timer;
217     struct ev_periodic periodic;
218     struct ev_signal signal;
219     struct ev_idle idle;
220     struct ev_child child;
221     struct ev_prepare prepare;
222     struct ev_check check;
223     };
224    
225 root 1.22 #define EVMETHOD_AUTO 0 /* consults environment */
226     #define EVMETHOD_SELECT 1
227     #define EVMETHOD_POLL 2
228     #define EVMETHOD_EPOLL 4
229     #define EVMETHOD_KQUEUE 8
230 root 1.23 #define EVMETHOD_DEVPOLL 16 /* NYI */
231     #define EVMETHOD_PORT 32 /* NYI */
232 root 1.32 #define EVMETHOD_WIN32 64 /* NYI */
233 root 1.22 #define EVMETHOD_ANY ~0 /* any method, do not consult env */
234 root 1.29
235 root 1.9 #if EV_PROTOTYPES
236 root 1.14 int ev_version_major (void);
237     int ev_version_minor (void);
238 root 1.1
239     ev_tstamp ev_time (void);
240 root 1.29
241 root 1.36 /* Sets the allocation function to use, works like realloc.
242     * It is used to allocate and free memory.
243     * If it returns zero when memory needs to be allocated, the library might abort
244     * or take some potentially destructive action.
245     * The default is your system realloc function.
246     */
247     void ev_set_allocator (void *(*cb)(void *ptr, long size));
248    
249     /* set the callback function to call on a
250     * retryable syscall error
251     * (such as failed select, poll, epoll_wait)
252     */
253 root 1.37 void ev_set_syserr_cb (void (*cb)(const char *msg));
254 root 1.36
255 root 1.29 # if EV_MULTIPLICITY
256 root 1.30 /* the default loop is the only one that handles signals and child watchers */
257     /* you can call this as often as you like */
258     struct ev_loop *ev_default_loop (int methods); /* returns default loop */
259    
260     /* create and destroy alternative loops that don't handle signals */
261 root 1.29 struct ev_loop *ev_loop_new (int methods);
262 root 1.30 void ev_loop_destroy (EV_P);
263     void ev_loop_fork (EV_P);
264 root 1.29 # else
265 root 1.30 int ev_default_loop (int methods); /* returns true when successful */
266 root 1.29 # endif
267    
268 root 1.30 void ev_default_destroy (void); /* destroy the default loop */
269     /* this needs to be called after fork, to duplicate the default loop */
270     /* if you create alternative loops you have to call ev_loop_fork on them */
271     /* you can call it in either the parent or the child */
272     /* you can actually call it at any time, anywhere :) */
273     void ev_default_fork (void);
274    
275 root 1.29 int ev_method (EV_P);
276 root 1.9 #endif
277 root 1.1
278     #define EVLOOP_NONBLOCK 1 /* do not block/wait */
279     #define EVLOOP_ONESHOT 2 /* block *once* only */
280 root 1.29 #define EVUNLOOP_ONCE 1 /* unloop once */
281     #define EVUNLOOP_ALL 2 /* unloop all loops */
282    
283 root 1.9 #if EV_PROTOTYPES
284 root 1.27 void ev_loop (EV_P_ int flags);
285 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 */
286 root 1.27
287     ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
288    
289     /*
290     * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
291     * keeps one reference. if you have a long-runing watcher you never unregister that
292     * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
293     */
294     void ev_ref (EV_P);
295     void ev_unref (EV_P);
296 root 1.1
297 root 1.9 /* convinience function, wait for a single event, without registering an event watcher */
298     /* if timeout is < 0, do wait indefinitely */
299 root 1.27 void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
300 root 1.9 #endif
301    
302 root 1.2 /* these may evaluate ev multiple times, and the other arguments at most once */
303 root 1.45 /* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
304     #define ev_init(ev,cb_) do { \
305 root 1.34 ((struct ev_watcher *)(void *)(ev))->active = \
306     ((struct ev_watcher *)(void *)(ev))->pending = \
307     ((struct ev_watcher *)(void *)(ev))->priority = 0; \
308 root 1.45 ev_set_cb ((ev), cb_); \
309 root 1.32 } while (0)
310 root 1.3
311 root 1.16 #define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
312     #define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
313 root 1.40 #define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
314 root 1.16 #define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
315     #define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
316     #define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
317     #define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
318     #define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
319    
320 root 1.45 #define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
321     #define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
322     #define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
323     #define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
324     #define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
325     #define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
326     #define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
327     #define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
328 root 1.1
329 root 1.34 #define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
330     #define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
331 root 1.32
332 root 1.34 #define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
333 root 1.33 #define ev_cb(ev) (ev)->cb /* rw */
334 root 1.32 #define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
335 root 1.45
336     #ifndef ev_set_cb
337     # define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
338     #endif
339 root 1.1
340 root 1.5 /* stopping (enabling, adding) a watcher does nothing if it is already running */
341     /* stopping (disabling, deleting) a watcher does nothing unless its already running */
342 root 1.9 #if EV_PROTOTYPES
343 root 1.41
344     /* feeds an event into a watcher as if the event actually occured */
345     /* accepts any ev_watcher type */
346     void ev_feed_event (EV_P_ void *w, int revents);
347 root 1.42 void ev_feed_fd_event (EV_P_ int fd, int revents);
348     void ev_feed_signal_event (EV_P_ int signum);
349 root 1.41
350 root 1.27 void ev_io_start (EV_P_ struct ev_io *w);
351     void ev_io_stop (EV_P_ struct ev_io *w);
352 root 1.6
353 root 1.27 void ev_timer_start (EV_P_ struct ev_timer *w);
354     void ev_timer_stop (EV_P_ struct ev_timer *w);
355 root 1.30 /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
356     void ev_timer_again (EV_P_ struct ev_timer *w);
357 root 1.1
358 root 1.27 void ev_periodic_start (EV_P_ struct ev_periodic *w);
359     void ev_periodic_stop (EV_P_ struct ev_periodic *w);
360 root 1.40 void ev_periodic_again (EV_P_ struct ev_periodic *w);
361 root 1.1
362 root 1.27 void ev_idle_start (EV_P_ struct ev_idle *w);
363     void ev_idle_stop (EV_P_ struct ev_idle *w);
364 root 1.5
365 root 1.27 void ev_prepare_start (EV_P_ struct ev_prepare *w);
366     void ev_prepare_stop (EV_P_ struct ev_prepare *w);
367 root 1.11
368 root 1.27 void ev_check_start (EV_P_ struct ev_check *w);
369     void ev_check_stop (EV_P_ struct ev_check *w);
370 root 1.12
371 root 1.30 /* only supported in the default loop */
372     void ev_signal_start (EV_P_ struct ev_signal *w);
373     void ev_signal_stop (EV_P_ struct ev_signal *w);
374    
375     /* only supported in the default loop */
376 root 1.27 void ev_child_start (EV_P_ struct ev_child *w);
377     void ev_child_stop (EV_P_ struct ev_child *w);
378 root 1.9 #endif
379 root 1.5
380 root 1.19 #ifdef __cplusplus
381     }
382     #endif
383    
384 root 1.1 #endif
385