ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
(Generate patch)

Comparing libev/ev.h (file contents):
Revision 1.3 by root, Tue Oct 30 23:10:33 2007 UTC vs.
Revision 1.47 by root, Sat Nov 10 03:13:50 2007 UTC

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__
32
33#ifdef __cplusplus
34extern "C" {
35#endif
3 36
4typedef double ev_tstamp; 37typedef double ev_tstamp;
5 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#ifndef EV_MULTIPLICITY
48# define EV_MULTIPLICITY 1
49#endif
50
51/* support multiple event loops? */
52#if EV_MULTIPLICITY
53struct 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
6/* eventmask, revents, events... */ 65/* eventmask, revents, events... */
7#define EV_UNDEF -1 /* guaranteed to be invalid */ 66#define EV_UNDEF -1 /* guaranteed to be invalid */
8#define EV_NONE 0 67#define EV_NONE 0x00
9#define EV_READ 1 68#define EV_READ 0x01
10#define EV_WRITE 2 69#define EV_WRITE 0x02
11#define EV_TIMEOUT 4 70#define EV_TIMEOUT 0x000100
71#define EV_PERIODIC 0x000200
12#define EV_SIGNAL 8 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
79/* can be used to add custom fields to all watchers */
80#ifndef EV_COMMON
81# define EV_COMMON void *data
82#endif
83#ifndef EV_PROTOTYPES
84# define EV_PROTOTYPES 1
85#endif
86
87#define EV_VERSION_MAJOR 1
88#define EV_VERSION_MINOR 1
89
90#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/*
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 */
13 103
14/* shared by all watchers */ 104/* shared by all watchers */
15#define EV_WATCHER(type) \ 105#define EV_WATCHER(type) \
16 int active; /* private */ \ 106 int active; /* private */ \
17 int pending; /* private */ \ 107 int pending; /* private */ \
18 void *data; /* rw */ \ 108 int priority; /* private */ \
19 void (*cb)(struct type *, int revents) /* rw */ 109 EV_COMMON; /* rw */ \
110 EV_CB_DECLARE (type) /* private */
20 111
21#define EV_WATCHER_LIST(type) \ 112#define EV_WATCHER_LIST(type) \
22 EV_WATCHER (type); \ 113 EV_WATCHER (type); \
23 struct type *next /* private */ 114 struct ev_watcher_list *next /* private */
24 115
116#define EV_WATCHER_TIME(type) \
117 EV_WATCHER (type); \
118 ev_tstamp at /* private */
119
120/* base class, nothing to see here unless you subclass */
121struct ev_watcher
122{
123 EV_WATCHER (ev_watcher);
124};
125
126/* base class, nothing to see here unless you subclass */
127struct ev_watcher_list
128{
129 EV_WATCHER_LIST (ev_watcher_list);
130};
131
132/* base class, nothing to see here unless you subclass */
133struct ev_watcher_time
134{
135 EV_WATCHER_TIME (ev_watcher_time);
136};
137
138/* invoked after a specific time, repeatable (based on monotonic clock) */
139/* revent EV_TIMEOUT */
25struct ev_timer 140struct ev_timer
26{ 141{
27 EV_WATCHER_LIST (ev_timer); 142 EV_WATCHER_TIME (ev_timer);
28 143
29 ev_tstamp at; /* private */
30 ev_tstamp repeat; /* rw */ 144 ev_tstamp repeat; /* rw */
31 unsigned char is_abs; /* ro */
32}; 145};
33 146
147/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
148/* revent EV_PERIODIC */
149struct ev_periodic
150{
151 EV_WATCHER_TIME (ev_periodic);
152
153 ev_tstamp interval; /* rw */
154 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
155};
156
157/* invoked when fd is either EV_READable or EV_WRITEable */
158/* revent EV_READ, EV_WRITE */
34struct ev_io 159struct ev_io
35{ 160{
36 EV_WATCHER_LIST (ev_io); 161 EV_WATCHER_LIST (ev_io);
37 162
38 int fd; /* ro */ 163 int fd; /* ro */
39 int events; /* ro */ 164 int events; /* ro */
40}; 165};
41 166
167/* invoked when the given signal has been received */
168/* revent EV_SIGNAL */
42struct ev_signal 169struct ev_signal
43{ 170{
44 EV_WATCHER_LIST (ev_signal); 171 EV_WATCHER_LIST (ev_signal);
45 172
46 int signum; /* ro */ 173 int signum; /* ro */
47}; 174};
48 175
49#define EVMETHOD_NONE 0 176/* invoked when the nothing else needs to be done, keeps the process from blocking */
177/* revent EV_IDLE */
178struct ev_idle
179{
180 EV_WATCHER (ev_idle);
181};
182
183/* invoked for each run of the mainloop, just before the blocking call */
184/* you can still change events in any way you like */
185/* revent EV_PREPARE */
186struct ev_prepare
187{
188 EV_WATCHER (ev_prepare);
189};
190
191/* invoked for each run of the mainloop, just after the blocking call */
192/* revent EV_CHECK */
193struct ev_check
194{
195 EV_WATCHER (ev_check);
196};
197
198/* invoked when sigchld is received and waitpid indicates the givne pid */
199/* revent EV_CHILD */
200/* does not support priorities */
201struct ev_child
202{
203 EV_WATCHER_LIST (ev_child);
204
205 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};
209
210/* the presence of this union forces similar struct layout */
211union ev_any_watcher
212{
213 struct ev_watcher w;
214 struct ev_watcher_list wl;
215
216 struct ev_io io;
217 struct ev_timer timer;
218 struct ev_periodic periodic;
219 struct ev_idle idle;
220 struct ev_prepare prepare;
221 struct ev_check check;
222 struct ev_signal signal;
223 struct ev_child child;
224};
225
226#define EVMETHOD_AUTO 0 /* consults environment */
50#define EVMETHOD_SELECT 1 227#define EVMETHOD_SELECT 1
51#define EVMETHOD_EPOLL 2 228#define EVMETHOD_POLL 2
52int ev_init (int flags); 229#define EVMETHOD_EPOLL 4
53extern int ev_method; 230#define EVMETHOD_KQUEUE 8
231#define EVMETHOD_DEVPOLL 16 /* NYI */
232#define EVMETHOD_PORT 32 /* NYI */
233#define EVMETHOD_WIN32 64 /* NYI */
234#define EVMETHOD_ANY ~0 /* any method, do not consult env */
54 235
55void ev_prefork (void); 236#if EV_PROTOTYPES
56void ev_postfork_parent (void); 237int ev_version_major (void);
57void ev_postfork_child (void); 238int ev_version_minor (void);
58 239
59extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
60ev_tstamp ev_time (void); 240ev_tstamp ev_time (void);
241
242/* Sets the allocation function to use, works like realloc.
243 * It is used to allocate and free memory.
244 * If it returns zero when memory needs to be allocated, the library might abort
245 * or take some potentially destructive action.
246 * The default is your system realloc function.
247 */
248void ev_set_allocator (void *(*cb)(void *ptr, long size));
249
250/* set the callback function to call on a
251 * retryable syscall error
252 * (such as failed select, poll, epoll_wait)
253 */
254void ev_set_syserr_cb (void (*cb)(const char *msg));
255
256# if EV_MULTIPLICITY
257/* the default loop is the only one that handles signals and child watchers */
258/* you can call this as often as you like */
259struct ev_loop *ev_default_loop (int methods); /* returns default loop */
260
261/* create and destroy alternative loops that don't handle signals */
262struct ev_loop *ev_loop_new (int methods);
263void ev_loop_destroy (EV_P);
264void ev_loop_fork (EV_P);
265
266ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
267
268# else
269
270int ev_default_loop (int methods); /* returns true when successful */
271
272static ev_tstamp
273ev_now ()
274{
275 extern ev_rt_now;
276
277 return ev_rt_now;
278}
279# endif
280
281void ev_default_destroy (void); /* destroy the default loop */
282/* this needs to be called after fork, to duplicate the default loop */
283/* if you create alternative loops you have to call ev_loop_fork on them */
284/* you can call it in either the parent or the child */
285/* you can actually call it at any time, anywhere :) */
286void ev_default_fork (void);
287
288int ev_method (EV_P);
289#endif
61 290
62#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 291#define EVLOOP_NONBLOCK 1 /* do not block/wait */
63#define EVLOOP_ONESHOT 2 /* block *once* only */ 292#define EVLOOP_ONESHOT 2 /* block *once* only */
293#define EVUNLOOP_ONCE 1 /* unloop once */
294#define EVUNLOOP_ALL 2 /* unloop all loops */
295
296#if EV_PROTOTYPES
64void ev_loop (int flags); 297void ev_loop (EV_P_ int flags);
65extern int ev_loop_done; /* set to 1 to break out of event loop */ 298void 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 */
299
300/*
301 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
302 * keeps one reference. if you have a long-runing watcher you never unregister that
303 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
304 */
305void ev_ref (EV_P);
306void ev_unref (EV_P);
307
308/* convinience function, wait for a single event, without registering an event watcher */
309/* if timeout is < 0, do wait indefinitely */
310void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
311#endif
66 312
67/* these may evaluate ev multiple times, and the other arguments at most once */ 313/* these may evaluate ev multiple times, and the other arguments at most once */
68#define evw_init(ev,cb_,data_) do { (ev)->active = 0; (ev)->cb = (cb_); (ev)->data = (void *)data_; } while (0) 314/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
315#define ev_init(ev,cb_) do { \
316 ((struct ev_watcher *)(void *)(ev))->active = \
317 ((struct ev_watcher *)(void *)(ev))->pending = \
318 ((struct ev_watcher *)(void *)(ev))->priority = 0; \
319 ev_set_cb ((ev), cb_); \
320} while (0)
69 321
70#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 322#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
71#define evtimer_set_rel(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); (ev)->is_abs = 0; } while (0) 323#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
72#define evtimer_set_abs(ev,at_,repeat_) do { (ev)->at = (at_); (ev)->repeat = (repeat_); (ev)->is_abs = 1; } while (0) 324#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
73#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 325#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
326#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
327#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
328#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
329#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
74 330
331#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
332#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
333#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
334#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
335#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
336#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
337#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
338#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
339
340#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
75#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 341#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
76 342
343#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
344#define ev_cb(ev) (ev)->cb /* rw */
345#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
346
347#ifndef ev_set_cb
348# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
349#endif
350
351/* stopping (enabling, adding) a watcher does nothing if it is already running */
352/* stopping (disabling, deleting) a watcher does nothing unless its already running */
353#if EV_PROTOTYPES
354
355/* feeds an event into a watcher as if the event actually occured */
356/* accepts any ev_watcher type */
357void ev_feed_event (EV_P_ void *w, int revents);
358void ev_feed_fd_event (EV_P_ int fd, int revents);
359void ev_feed_signal_event (EV_P_ int signum);
360
77void evio_start (struct ev_io *w); 361void ev_io_start (EV_P_ struct ev_io *w);
78void evio_stop (struct ev_io *w); 362void ev_io_stop (EV_P_ struct ev_io *w);
79 363
80void evtimer_start (struct ev_timer *w); 364void ev_timer_start (EV_P_ struct ev_timer *w);
81void evtimer_stop (struct ev_timer *w); 365void ev_timer_stop (EV_P_ struct ev_timer *w);
366/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
367void ev_timer_again (EV_P_ struct ev_timer *w);
82 368
369void ev_periodic_start (EV_P_ struct ev_periodic *w);
370void ev_periodic_stop (EV_P_ struct ev_periodic *w);
371void ev_periodic_again (EV_P_ struct ev_periodic *w);
372
373void ev_idle_start (EV_P_ struct ev_idle *w);
374void ev_idle_stop (EV_P_ struct ev_idle *w);
375
376void ev_prepare_start (EV_P_ struct ev_prepare *w);
377void ev_prepare_stop (EV_P_ struct ev_prepare *w);
378
379void ev_check_start (EV_P_ struct ev_check *w);
380void ev_check_stop (EV_P_ struct ev_check *w);
381
382/* only supported in the default loop */
83void evsignal_start (struct ev_signal *w); 383void ev_signal_start (EV_P_ struct ev_signal *w);
84void evsignal_stop (struct ev_signal *w); 384void ev_signal_stop (EV_P_ struct ev_signal *w);
85 385
386/* only supported in the default loop */
387void ev_child_start (EV_P_ struct ev_child *w);
388void ev_child_stop (EV_P_ struct ev_child *w);
86#endif 389#endif
87 390
391#ifdef __cplusplus
392}
393#endif
394
395#endif
396

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines