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

Comparing libev/ev.h (file contents):
Revision 1.23 by root, Fri Nov 2 22:03:00 2007 UTC vs.
Revision 1.46 by root, Sat Nov 10 00:55:27 2007 UTC

… …
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 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. 27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */ 28 */
29 29
30#ifndef EV_H 30#ifndef EV_H__
31#define EV_H 31#define EV_H__
32 32
33#ifdef __cplusplus 33#ifdef __cplusplus
34extern "C" { 34extern "C" {
35#endif 35#endif
36 36
… …
40#ifndef EV_MINPRI 40#ifndef EV_MINPRI
41# define EV_MINPRI -2 41# define EV_MINPRI -2
42#endif 42#endif
43#ifndef EV_MAXPRI 43#ifndef EV_MAXPRI
44# define EV_MAXPRI +2 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_
45#endif 63#endif
46 64
47/* eventmask, revents, events... */ 65/* eventmask, revents, events... */
48#define EV_UNDEF -1 /* guaranteed to be invalid */ 66#define EV_UNDEF -1 /* guaranteed to be invalid */
49#define EV_NONE 0x00 67#define EV_NONE 0x00
… …
67#endif 85#endif
68 86
69#define EV_VERSION_MAJOR 1 87#define EV_VERSION_MAJOR 1
70#define EV_VERSION_MINOR 1 88#define EV_VERSION_MINOR 1
71 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
72/* 97/*
73 * struct member types: 98 * struct member types:
74 * 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.
75 * ro: can be read anytime, but only changed when the watcher isn't active 100 * ro: can be read anytime, but only changed when the watcher isn't active
76 * rw: can be read and modified anytime, even when the watcher is active 101 * rw: can be read and modified anytime, even when the watcher is active
… …
78 103
79/* shared by all watchers */ 104/* shared by all watchers */
80#define EV_WATCHER(type) \ 105#define EV_WATCHER(type) \
81 int active; /* private */ \ 106 int active; /* private */ \
82 int pending; /* private */ \ 107 int pending; /* private */ \
83 int priority; /* ro */ \ 108 int priority; /* private */ \
84 EV_COMMON; /* rw */ \ 109 EV_COMMON; /* rw */ \
85 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */ 110 EV_CB_DECLARE (type) /* private */
86 111
87#define EV_WATCHER_LIST(type) \ 112#define EV_WATCHER_LIST(type) \
88 EV_WATCHER (type); \ 113 EV_WATCHER (type); \
89 struct type *next /* private */ 114 struct ev_watcher_list *next /* private */
90 115
91#define EV_WATCHER_TIME(type) \ 116#define EV_WATCHER_TIME(type) \
92 EV_WATCHER (type); \ 117 EV_WATCHER (type); \
93 ev_tstamp at /* private */ 118 ev_tstamp at /* private */
94 119
95/* base class, nothing to see here unless you subclass */ 120/* base class, nothing to see here unless you subclass */
96struct ev_watcher { 121struct ev_watcher
122{
97 EV_WATCHER (ev_watcher); 123 EV_WATCHER (ev_watcher);
98}; 124};
99 125
100/* base class, nothing to see here unless you subclass */ 126/* base class, nothing to see here unless you subclass */
101struct ev_watcher_list { 127struct ev_watcher_list
128{
102 EV_WATCHER_LIST (ev_watcher_list); 129 EV_WATCHER_LIST (ev_watcher_list);
103}; 130};
104 131
105/* base class, nothing to see here unless you subclass */ 132/* base class, nothing to see here unless you subclass */
106struct ev_watcher_time { 133struct ev_watcher_time
134{
107 EV_WATCHER_TIME (ev_watcher_time); 135 EV_WATCHER_TIME (ev_watcher_time);
108}; 136};
109 137
110/* invoked after a specific time, repeatable (based on monotonic clock) */ 138/* invoked after a specific time, repeatable (based on monotonic clock) */
111/* revent EV_TIMEOUT */ 139/* revent EV_TIMEOUT */
… …
121struct ev_periodic 149struct ev_periodic
122{ 150{
123 EV_WATCHER_TIME (ev_periodic); 151 EV_WATCHER_TIME (ev_periodic);
124 152
125 ev_tstamp interval; /* rw */ 153 ev_tstamp interval; /* rw */
154 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
126}; 155};
127 156
128/* invoked when fd is either EV_READable or EV_WRITEable */ 157/* invoked when fd is either EV_READable or EV_WRITEable */
129/* revent EV_READ, EV_WRITE */ 158/* revent EV_READ, EV_WRITE */
130struct ev_io 159struct ev_io
… …
166 EV_WATCHER (ev_check); 195 EV_WATCHER (ev_check);
167}; 196};
168 197
169/* invoked when sigchld is received and waitpid indicates the givne pid */ 198/* invoked when sigchld is received and waitpid indicates the givne pid */
170/* revent EV_CHILD */ 199/* revent EV_CHILD */
200/* does not support priorities */
171struct ev_child 201struct ev_child
172{ 202{
173 EV_WATCHER_LIST (ev_child); 203 EV_WATCHER_LIST (ev_child);
174 204
175 int pid; /* ro */ 205 int pid; /* ro */
206 int rpid; /* rw, holds the received pid */
176 int status; /* rw, holds the exit status, use the macros from sys/wait.h */ 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;
177}; 224};
178 225
179#define EVMETHOD_AUTO 0 /* consults environment */ 226#define EVMETHOD_AUTO 0 /* consults environment */
180#define EVMETHOD_SELECT 1 227#define EVMETHOD_SELECT 1
181#define EVMETHOD_POLL 2 228#define EVMETHOD_POLL 2
182#define EVMETHOD_EPOLL 4 229#define EVMETHOD_EPOLL 4
183#define EVMETHOD_KQUEUE 8 230#define EVMETHOD_KQUEUE 8
184#define EVMETHOD_DEVPOLL 16 /* NYI */ 231#define EVMETHOD_DEVPOLL 16 /* NYI */
185#define EVMETHOD_PORT 32 /* NYI */ 232#define EVMETHOD_PORT 32 /* NYI */
233#define EVMETHOD_WIN32 64 /* NYI */
186#define EVMETHOD_ANY ~0 /* any method, do not consult env */ 234#define EVMETHOD_ANY ~0 /* any method, do not consult env */
235
187#if EV_PROTOTYPES 236#if EV_PROTOTYPES
188extern int ev_method;
189int ev_init (int methods); /* returns ev_method */
190int ev_version_major (void); 237int ev_version_major (void);
191int ev_version_minor (void); 238int ev_version_minor (void);
192 239
193/* these three calls are suitable for plugging into pthread_atfork */
194void ev_fork_prepare (void);
195void ev_fork_parent (void);
196void ev_fork_child (void);
197
198extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
199ev_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# else
266int ev_default_loop (int methods); /* returns true when successful */
267# endif
268
269void ev_default_destroy (void); /* destroy the default loop */
270/* this needs to be called after fork, to duplicate the default loop */
271/* if you create alternative loops you have to call ev_loop_fork on them */
272/* you can call it in either the parent or the child */
273/* you can actually call it at any time, anywhere :) */
274void ev_default_fork (void);
275
276int ev_method (EV_P);
200#endif 277#endif
201 278
202#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 279#define EVLOOP_NONBLOCK 1 /* do not block/wait */
203#define EVLOOP_ONESHOT 2 /* block *once* only */ 280#define EVLOOP_ONESHOT 2 /* block *once* only */
281#define EVUNLOOP_ONCE 1 /* unloop once */
282#define EVUNLOOP_ALL 2 /* unloop all loops */
283
204#if EV_PROTOTYPES 284#if EV_PROTOTYPES
205void ev_loop (int flags); 285void ev_loop (EV_P_ int flags);
206extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ 286void 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 */
287
288ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
289
290/*
291 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
292 * keeps one reference. if you have a long-runing watcher you never unregister that
293 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
294 */
295void ev_ref (EV_P);
296void ev_unref (EV_P);
207 297
208/* convinience function, wait for a single event, without registering an event watcher */ 298/* convinience function, wait for a single event, without registering an event watcher */
209/* if timeout is < 0, do wait indefinitely */ 299/* if timeout is < 0, do wait indefinitely */
210void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 300void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
211#endif 301#endif
212 302
213/* these may evaluate ev multiple times, and the other arguments at most once */ 303/* these may evaluate ev multiple times, and the other arguments at most once */
214/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 304/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
215#define ev_watcher_init(ev,cb_) do { (ev)->active = (ev)->pending = (ev)->priority = 0; (ev)->cb = (cb_); } while (0) 305#define ev_init(ev,cb_) do { \
306 ((struct ev_watcher *)(void *)(ev))->active = \
307 ((struct ev_watcher *)(void *)(ev))->pending = \
308 ((struct ev_watcher *)(void *)(ev))->priority = 0; \
309 ev_set_cb ((ev), cb_); \
310} while (0)
216 311
217#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 312#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
218#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 313#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
219#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) 314#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
220#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 315#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
221#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 316#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
222#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 317#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
223#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 318#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
224#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 319#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
225 320
226#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 321#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
227#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 322#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
228#define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0) 323#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
229#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 324#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
230#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 325#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
231#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 326#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
232#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 327#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
233#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 328#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
234 329
330#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
235#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 331#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
332
333#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
334#define ev_cb(ev) (ev)->cb /* rw */
236#define ev_set_priority(ev,pri) (ev)->priority = pri 335#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
336
337#ifndef ev_set_cb
338# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
339#endif
237 340
238/* stopping (enabling, adding) a watcher does nothing if it is already running */ 341/* stopping (enabling, adding) a watcher does nothing if it is already running */
239/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 342/* stopping (disabling, deleting) a watcher does nothing unless its already running */
240#if EV_PROTOTYPES 343#if EV_PROTOTYPES
344
345/* feeds an event into a watcher as if the event actually occured */
346/* accepts any ev_watcher type */
347void ev_feed_event (EV_P_ void *w, int revents);
348void ev_feed_fd_event (EV_P_ int fd, int revents);
349void ev_feed_signal_event (EV_P_ int signum);
350
241void ev_io_start (struct ev_io *w); 351void ev_io_start (EV_P_ struct ev_io *w);
242void ev_io_stop (struct ev_io *w); 352void ev_io_stop (EV_P_ struct ev_io *w);
243 353
244void ev_timer_start (struct ev_timer *w); 354void ev_timer_start (EV_P_ struct ev_timer *w);
245void ev_timer_stop (struct ev_timer *w); 355void ev_timer_stop (EV_P_ struct ev_timer *w);
246void ev_timer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 356/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
357void ev_timer_again (EV_P_ struct ev_timer *w);
247 358
248void ev_periodic_start (struct ev_periodic *w); 359void ev_periodic_start (EV_P_ struct ev_periodic *w);
249void ev_periodic_stop (struct ev_periodic *w); 360void ev_periodic_stop (EV_P_ struct ev_periodic *w);
361void ev_periodic_again (EV_P_ struct ev_periodic *w);
250 362
251void ev_signal_start (struct ev_signal *w);
252void ev_signal_stop (struct ev_signal *w);
253
254void ev_idle_start (struct ev_idle *w); 363void ev_idle_start (EV_P_ struct ev_idle *w);
255void ev_idle_stop (struct ev_idle *w); 364void ev_idle_stop (EV_P_ struct ev_idle *w);
256 365
257void ev_prepare_start (struct ev_prepare *w); 366void ev_prepare_start (EV_P_ struct ev_prepare *w);
258void ev_prepare_stop (struct ev_prepare *w); 367void ev_prepare_stop (EV_P_ struct ev_prepare *w);
259 368
260void ev_check_start (struct ev_check *w); 369void ev_check_start (EV_P_ struct ev_check *w);
261void ev_check_stop (struct ev_check *w); 370void ev_check_stop (EV_P_ struct ev_check *w);
262 371
372/* only supported in the default loop */
373void ev_signal_start (EV_P_ struct ev_signal *w);
374void ev_signal_stop (EV_P_ struct ev_signal *w);
375
376/* only supported in the default loop */
263void ev_child_start (struct ev_child *w); 377void ev_child_start (EV_P_ struct ev_child *w);
264void ev_child_stop (struct ev_child *w); 378void ev_child_stop (EV_P_ struct ev_child *w);
265#endif 379#endif
266 380
267#ifdef __cplusplus 381#ifdef __cplusplus
268} 382}
269#endif 383#endif

Diff Legend

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