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

Comparing libev/ev.h (file contents):
Revision 1.9 by root, Wed Oct 31 13:57:34 2007 UTC vs.
Revision 1.44 by root, Fri Nov 9 20:55:09 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 0x00 67#define EV_NONE 0x00
9#define EV_READ 0x01 68#define EV_READ 0x01
10#define EV_WRITE 0x02 69#define EV_WRITE 0x02
11#define EV_TIMEOUT 0x04 70#define EV_TIMEOUT 0x000100
71#define EV_PERIODIC 0x000200
12#define EV_SIGNAL 0x08 72#define EV_SIGNAL 0x000400
13#define EV_IDLE 0x10 73#define EV_IDLE 0x000800
14#define EV_CHECK 0x20 74#define EV_CHECK 0x001000
15#define EV_ERROR (0x3f|0x80) 75#define EV_PREPARE 0x002000
76#define EV_CHILD 0x004000
77#define EV_ERROR 0x800000 /* sent when an error occurs */
16 78
17/* can be used to add custom fields to all watchers */ 79/* can be used to add custom fields to all watchers */
18#ifndef EV_COMMON 80#ifndef EV_COMMON
19# define EV_COMMON void *data 81# define EV_COMMON void *data
20#endif 82#endif
21#ifndef EV_PROTOTYPES 83#ifndef EV_PROTOTYPES
22# define EV_PROTOTYPES 1 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))
23#endif 95#endif
24 96
25/* 97/*
26 * struct member types: 98 * struct member types:
27 * private: you can look at them, but not change them, and they might not mean anything to you. 99 * private: you can look at them, but not change them, and they might not mean anything to you.
… …
31 103
32/* shared by all watchers */ 104/* shared by all watchers */
33#define EV_WATCHER(type) \ 105#define EV_WATCHER(type) \
34 int active; /* private */ \ 106 int active; /* private */ \
35 int pending; /* private */ \ 107 int pending; /* private */ \
108 int priority; /* private */ \
36 EV_COMMON; /* rw */ \ 109 EV_COMMON; /* rw */ \
37 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */ 110 EV_CB_DECLARE (type) /* private */
38 111
39#define EV_WATCHER_LIST(type) \ 112#define EV_WATCHER_LIST(type) \
40 EV_WATCHER (type); \ 113 EV_WATCHER (type); \
41 struct type *next /* private */ 114 struct ev_watcher_list *next /* private */
42 115
43#define EV_WATCHER_TIME(type) \ 116#define EV_WATCHER_TIME(type) \
44 EV_WATCHER (type); \ 117 EV_WATCHER (type); \
45 ev_tstamp at /* private */ 118 ev_tstamp at /* private */
46 119
47/* base class, nothing to see here unless you subclass */ 120/* base class, nothing to see here unless you subclass */
48struct ev_watcher { 121struct ev_watcher
122{
49 EV_WATCHER (ev_watcher); 123 EV_WATCHER (ev_watcher);
50}; 124};
51 125
52/* base class, nothing to see here unless you subclass */ 126/* base class, nothing to see here unless you subclass */
53struct ev_watcher_list { 127struct ev_watcher_list
128{
54 EV_WATCHER_LIST (ev_watcher_list); 129 EV_WATCHER_LIST (ev_watcher_list);
55}; 130};
56 131
57/* base class, nothing to see here unless you subclass */ 132/* base class, nothing to see here unless you subclass */
58struct ev_watcher_time { 133struct ev_watcher_time
134{
59 EV_WATCHER_TIME (ev_watcher_time); 135 EV_WATCHER_TIME (ev_watcher_time);
60}; 136};
61 137
62/* invoked after a specific time, repeatable (based on monotonic clock) */ 138/* invoked after a specific time, repeatable (based on monotonic clock) */
139/* revent EV_TIMEOUT */
63struct ev_timer 140struct ev_timer
64{ 141{
65 EV_WATCHER_TIME (ev_timer); 142 EV_WATCHER_TIME (ev_timer);
66 143
67 ev_tstamp repeat; /* rw */ 144 ev_tstamp repeat; /* rw */
68}; 145};
69 146
70/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 147/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
148/* revent EV_PERIODIC */
71struct ev_periodic 149struct ev_periodic
72{ 150{
73 EV_WATCHER_TIME (ev_periodic); 151 EV_WATCHER_TIME (ev_periodic);
74 152
75 ev_tstamp interval; /* rw */ 153 ev_tstamp interval; /* rw */
154 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
76}; 155};
77 156
78/* invoked when fd is either EV_READable or EV_WRITEable */ 157/* invoked when fd is either EV_READable or EV_WRITEable */
158/* revent EV_READ, EV_WRITE */
79struct ev_io 159struct ev_io
80{ 160{
81 EV_WATCHER_LIST (ev_io); 161 EV_WATCHER_LIST (ev_io);
82 162
83 int fd; /* ro */ 163 int fd; /* ro */
84 int events; /* ro */ 164 int events; /* ro */
85}; 165};
86 166
87/* invoked when the given signal has been received */ 167/* invoked when the given signal has been received */
168/* revent EV_SIGNAL */
88struct ev_signal 169struct ev_signal
89{ 170{
90 EV_WATCHER_LIST (ev_signal); 171 EV_WATCHER_LIST (ev_signal);
91 172
92 int signum; /* ro */ 173 int signum; /* ro */
93}; 174};
94 175
95/* invoked when the nothing else needs to be done, keeps the process from blocking */ 176/* invoked when the nothing else needs to be done, keeps the process from blocking */
177/* revent EV_IDLE */
96struct ev_idle 178struct ev_idle
97{ 179{
98 EV_WATCHER (ev_idle); 180 EV_WATCHER (ev_idle);
99}; 181};
100 182
101/* invoked for each run of the mainloop, just before the next blocking vall is initiated */ 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 */
102struct ev_check 193struct ev_check
103{ 194{
104 EV_WATCHER (ev_check); 195 EV_WATCHER (ev_check);
105}; 196};
106 197
107#define EVMETHOD_NONE 0 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 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#define EVMETHOD_AUTO 0 /* consults environment */
108#define EVMETHOD_SELECT 1 226#define EVMETHOD_SELECT 1
109#define EVMETHOD_EPOLL 2 227#define EVMETHOD_POLL 2
228#define EVMETHOD_EPOLL 4
229#define EVMETHOD_KQUEUE 8
230#define EVMETHOD_DEVPOLL 16 /* NYI */
231#define EVMETHOD_PORT 32 /* NYI */
232#define EVMETHOD_WIN32 64 /* NYI */
233#define EVMETHOD_ANY ~0 /* any method, do not consult env */
234
110#if EV_PROTOTYPES 235#if EV_PROTOTYPES
111extern int ev_method; 236int ev_version_major (void);
112int ev_init (int flags); /* returns ev_method */ 237int ev_version_minor (void);
113 238
114/* these three calls are suitable for plugging into pthread_atfork */
115void ev_prefork (void);
116void ev_postfork_parent (void);
117void ev_postfork_child (void);
118
119extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
120ev_tstamp ev_time (void); 239ev_tstamp ev_time (void);
240
241/* 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 */
247void 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 */
253void ev_set_syserr_cb (void (*cb)(const char *msg));
254
255# if EV_MULTIPLICITY
256/* the default loop is the only one that handles signals and child watchers */
257/* you can call this as often as you like */
258struct ev_loop *ev_default_loop (int methods); /* returns default loop */
259
260/* create and destroy alternative loops that don't handle signals */
261struct ev_loop *ev_loop_new (int methods);
262void ev_loop_destroy (EV_P);
263void ev_loop_fork (EV_P);
264# else
265int ev_default_loop (int methods); /* returns true when successful */
266# endif
267
268void 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 :) */
273void ev_default_fork (void);
274
275int ev_method (EV_P);
121#endif 276#endif
122 277
123#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 278#define EVLOOP_NONBLOCK 1 /* do not block/wait */
124#define EVLOOP_ONESHOT 2 /* block *once* only */ 279#define EVLOOP_ONESHOT 2 /* block *once* only */
280#define EVUNLOOP_ONCE 1 /* unloop once */
281#define EVUNLOOP_ALL 2 /* unloop all loops */
282
125#if EV_PROTOTYPES 283#if EV_PROTOTYPES
126void ev_loop (int flags); 284void ev_loop (EV_P_ int flags);
127extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ 285void 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
287ev_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 */
294void ev_ref (EV_P);
295void ev_unref (EV_P);
128 296
129/* convinience function, wait for a single event, without registering an event watcher */ 297/* convinience function, wait for a single event, without registering an event watcher */
130/* if timeout is < 0, do wait indefinitely */ 298/* if timeout is < 0, do wait indefinitely */
131void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 299void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
132#endif 300#endif
133 301
134/* these may evaluate ev multiple times, and the other arguments at most once */ 302/* these may evaluate ev multiple times, and the other arguments at most once */
135/* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */ 303/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
136#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0) 304#define ev_watcher_init(ev,cb_) do { \
305 ((struct ev_watcher *)(void *)(ev))->active = \
306 ((struct ev_watcher *)(void *)(ev))->pending = \
307 ((struct ev_watcher *)(void *)(ev))->priority = 0; \
308 (ev)->cb = (cb_); \
309} while (0)
137 310
138#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 311#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
139#define evtimer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 312#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
140#define evperiodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) 313#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
141#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 314#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
142#define evcheck_set(ev) /* nop, yes, this is a serious in-joke */
143#define evidle_set(ev) /* nop, yes, this is a serious in-joke */ 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)
144 319
145#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0) 320#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
146#define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0) 321#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
147#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0) 322#define ev_periodic_init(ev,cb,at,ival,res) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
148#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0) 323#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
324#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
325#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
149#define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0) 326#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
150#define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0) 327#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
151 328
329#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
152#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 330#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
331
332#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
333#define ev_cb(ev) (ev)->cb /* rw */
334#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
335#define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
153 336
154/* stopping (enabling, adding) a watcher does nothing if it is already running */ 337/* stopping (enabling, adding) a watcher does nothing if it is already running */
155/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 338/* stopping (disabling, deleting) a watcher does nothing unless its already running */
156#if EV_PROTOTYPES 339#if EV_PROTOTYPES
340
341/* feeds an event into a watcher as if the event actually occured */
342/* accepts any ev_watcher type */
343void ev_feed_event (EV_P_ void *w, int revents);
344void ev_feed_fd_event (EV_P_ int fd, int revents);
345void ev_feed_signal_event (EV_P_ int signum);
346
157void evio_start (struct ev_io *w); 347void ev_io_start (EV_P_ struct ev_io *w);
158void evio_stop (struct ev_io *w); 348void ev_io_stop (EV_P_ struct ev_io *w);
159 349
160void evtimer_start (struct ev_timer *w); 350void ev_timer_start (EV_P_ struct ev_timer *w);
161void evtimer_stop (struct ev_timer *w); 351void ev_timer_stop (EV_P_ struct ev_timer *w);
162void evtimer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 352/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
353void ev_timer_again (EV_P_ struct ev_timer *w);
163 354
164void evperiodic_start (struct ev_periodic *w); 355void ev_periodic_start (EV_P_ struct ev_periodic *w);
165void evperiodic_stop (struct ev_periodic *w); 356void ev_periodic_stop (EV_P_ struct ev_periodic *w);
357void ev_periodic_again (EV_P_ struct ev_periodic *w);
166 358
359void ev_idle_start (EV_P_ struct ev_idle *w);
360void ev_idle_stop (EV_P_ struct ev_idle *w);
361
362void ev_prepare_start (EV_P_ struct ev_prepare *w);
363void ev_prepare_stop (EV_P_ struct ev_prepare *w);
364
365void ev_check_start (EV_P_ struct ev_check *w);
366void ev_check_stop (EV_P_ struct ev_check *w);
367
368/* only supported in the default loop */
167void evsignal_start (struct ev_signal *w); 369void ev_signal_start (EV_P_ struct ev_signal *w);
168void evsignal_stop (struct ev_signal *w); 370void ev_signal_stop (EV_P_ struct ev_signal *w);
169 371
372/* only supported in the default loop */
170void evidle_start (struct ev_idle *w); 373void ev_child_start (EV_P_ struct ev_child *w);
171void evidle_stop (struct ev_idle *w); 374void ev_child_stop (EV_P_ struct ev_child *w);
172
173void evcheck_start (struct ev_check *w);
174void evcheck_stop (struct ev_check *w);
175#endif 375#endif
176 376
377#ifdef __cplusplus
378}
177#endif 379#endif
178 380
381#endif
382

Diff Legend

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