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.64 by root, Fri Nov 23 19:13:33 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#ifndef EV_PERIODICS
52# define EV_PERIODICS 1
53#endif
54
55/* support multiple event loops? */
56#if EV_MULTIPLICITY
57struct ev_loop;
58# define EV_P struct ev_loop *loop
59# define EV_P_ EV_P,
60# define EV_A loop
61# define EV_A_ EV_A,
62# define EV_DEFAULT_A ev_default_loop (0)
63# define EV_DEFAULT_A_ EV_DEFAULT_A,
64#else
65# define EV_P void
66# define EV_P_
67# define EV_A
68# define EV_A_
69# define EV_DEFAULT_A
70# define EV_DEFAULT_A_
71#endif
72
6/* eventmask, revents, events... */ 73/* eventmask, revents, events... */
7#define EV_UNDEF -1 /* guaranteed to be invalid */ 74#define EV_UNDEF -1L /* guaranteed to be invalid */
8#define EV_NONE 0 75#define EV_NONE 0x00L
9#define EV_READ 1 76#define EV_READ 0x01L /* io only */
10#define EV_WRITE 2 77#define EV_WRITE 0x02L /* io only */
11#define EV_TIMEOUT 4 78#define EV_TIMEOUT 0x000100L /* timer only */
12#define EV_SIGNAL 8 79#define EV_PERIODIC 0x000200L /* periodic timer only */
80#define EV_SIGNAL 0x000400L /* signal only */
81#define EV_IDLE 0x000800L /* idle only */
82#define EV_CHECK 0x001000L /* check only */
83#define EV_PREPARE 0x002000L /* prepare only */
84#define EV_CHILD 0x004000L /* child/pid only */
85#define EV_EMBED 0x008000L /* embedded event loop */
86#define EV_ERROR 0x800000L /* sent when an error occurs */
87
88/* can be used to add custom fields to all watchers, while losing binary compatibility */
89#ifndef EV_COMMON
90# define EV_COMMON void *data;
91#endif
92#ifndef EV_PROTOTYPES
93# define EV_PROTOTYPES 1
94#endif
95
96#define EV_VERSION_MAJOR 1
97#define EV_VERSION_MINOR 1
98
99#ifndef EV_CB_DECLARE
100# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
101#endif
102#ifndef EV_CB_INVOKE
103# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
104#endif
105
106/*
107 * struct member types:
108 * private: you can look at them, but not change them, and they might not mean anything to you.
109 * ro: can be read anytime, but only changed when the watcher isn't active
110 * rw: can be read and modified anytime, even when the watcher is active
111 */
13 112
14/* shared by all watchers */ 113/* shared by all watchers */
15#define EV_WATCHER(type) \ 114#define EV_WATCHER(type) \
16 int active; /* private */ \ 115 int active; /* private */ \
17 int pending; /* private */ \ 116 int pending; /* private */ \
18 void *data; /* rw */ \ 117 int priority; /* private */ \
19 void (*cb)(struct type *, int revents) /* rw */ 118 EV_COMMON /* rw */ \
119 EV_CB_DECLARE (type) /* private */
20 120
21#define EV_WATCHER_LIST(type) \ 121#define EV_WATCHER_LIST(type) \
22 EV_WATCHER (type); \ 122 EV_WATCHER (type) \
23 struct type *next /* private */ 123 struct ev_watcher_list *next; /* private */
24 124
125#define EV_WATCHER_TIME(type) \
126 EV_WATCHER (type) \
127 ev_tstamp at; /* private */
128
129/* base class, nothing to see here unless you subclass */
130struct ev_watcher
131{
132 EV_WATCHER (ev_watcher)
133};
134
135/* base class, nothing to see here unless you subclass */
136struct ev_watcher_list
137{
138 EV_WATCHER_LIST (ev_watcher_list)
139};
140
141/* base class, nothing to see here unless you subclass */
142struct ev_watcher_time
143{
144 EV_WATCHER_TIME (ev_watcher_time)
145};
146
147/* invoked after a specific time, repeatable (based on monotonic clock) */
148/* revent EV_TIMEOUT */
25struct ev_timer 149struct ev_timer
26{ 150{
27 EV_WATCHER_LIST (ev_timer); 151 EV_WATCHER_TIME (ev_timer)
28 152
29 ev_tstamp at; /* private */
30 ev_tstamp repeat; /* rw */ 153 ev_tstamp repeat; /* rw */
31 unsigned char is_abs; /* ro */
32}; 154};
33 155
156/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
157/* revent EV_PERIODIC */
158struct ev_periodic
159{
160 EV_WATCHER_TIME (ev_periodic)
161
162 ev_tstamp interval; /* rw */
163 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
164};
165
166/* invoked when fd is either EV_READable or EV_WRITEable */
167/* revent EV_READ, EV_WRITE */
34struct ev_io 168struct ev_io
35{ 169{
36 EV_WATCHER_LIST (ev_io); 170 EV_WATCHER_LIST (ev_io)
37 171
38 int fd; /* ro */ 172 int fd; /* ro */
39 int events; /* ro */ 173 int events; /* ro */
40}; 174};
41 175
176/* invoked when the given signal has been received */
177/* revent EV_SIGNAL */
42struct ev_signal 178struct ev_signal
43{ 179{
44 EV_WATCHER_LIST (ev_signal); 180 EV_WATCHER_LIST (ev_signal)
45 181
46 int signum; /* ro */ 182 int signum; /* ro */
47}; 183};
48 184
49#define EVMETHOD_NONE 0 185/* invoked when the nothing else needs to be done, keeps the process from blocking */
50#define EVMETHOD_SELECT 1 186/* revent EV_IDLE */
51#define EVMETHOD_EPOLL 2 187struct ev_idle
52int ev_init (int flags); 188{
53extern int ev_method; 189 EV_WATCHER (ev_idle)
190};
54 191
55void ev_prefork (void); 192/* invoked for each run of the mainloop, just before the blocking call */
56void ev_postfork_parent (void); 193/* you can still change events in any way you like */
57void ev_postfork_child (void); 194/* revent EV_PREPARE */
195struct ev_prepare
196{
197 EV_WATCHER (ev_prepare)
198};
58 199
59extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */ 200/* invoked for each run of the mainloop, just after the blocking call */
201/* revent EV_CHECK */
202struct ev_check
203{
204 EV_WATCHER (ev_check)
205};
206
207/* invoked when sigchld is received and waitpid indicates the given pid */
208/* revent EV_CHILD */
209/* does not support priorities */
210struct ev_child
211{
212 EV_WATCHER_LIST (ev_child)
213
214 int pid; /* ro */
215 int rpid; /* rw, holds the received pid */
216 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
217};
218
219#if EV_MULTIPLICITY
220/* used to embed an event loop inside another */
221/* the callback gets invoked when the event loop has handled events, and can be 0 */
222struct ev_embed
223{
224 EV_WATCHER (ev_embed)
225
226 struct ev_io io; /* private */
227 struct ev_loop *loop; /* ro */
228};
229#endif
230
231/* the presence of this union forces similar struct layout */
232union ev_any_watcher
233{
234 struct ev_watcher w;
235 struct ev_watcher_list wl;
236
237 struct ev_io io;
238 struct ev_timer timer;
239 struct ev_periodic periodic;
240 struct ev_idle idle;
241 struct ev_prepare prepare;
242 struct ev_check check;
243 struct ev_signal signal;
244 struct ev_child child;
245 struct ev_embed embed;
246};
247
248/* bits for ev_default_loop and ev_loop_new */
249/* the default */
250#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */
251/* flag bits */
252#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */
253/* method bits to be ored together */
254#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */
255#define EVBACKEND_POLL 0x00000002UL /* !win */
256#define EVBACKEND_EPOLL 0x00000004UL /* linux */
257#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */
258#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */
259#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */
260
261#if EV_PROTOTYPES
262int ev_version_major (void);
263int ev_version_minor (void);
264
265unsigned int ev_supported_backends (void);
266unsigned int ev_recommended_backends (void);
267unsigned int ev_embeddable_backends (void);
268
60ev_tstamp ev_time (void); 269ev_tstamp ev_time (void);
270
271/* Sets the allocation function to use, works like realloc.
272 * It is used to allocate and free memory.
273 * If it returns zero when memory needs to be allocated, the library might abort
274 * or take some potentially destructive action.
275 * The default is your system realloc function.
276 */
277void ev_set_allocator (void *(*cb)(void *ptr, long size));
278
279/* set the callback function to call on a
280 * retryable syscall error
281 * (such as failed select, poll, epoll_wait)
282 */
283void ev_set_syserr_cb (void (*cb)(const char *msg));
284
285# if EV_MULTIPLICITY
286/* the default loop is the only one that handles signals and child watchers */
287/* you can call this as often as you like */
288static struct ev_loop *
289ev_default_loop (unsigned int flags)
290{
291 extern struct ev_loop *ev_default_loop_ptr;
292 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
293
294 if (!ev_default_loop_ptr)
295 ev_default_loop_init (flags);
296
297 return ev_default_loop_ptr;
298}
299
300/* create and destroy alternative loops that don't handle signals */
301struct ev_loop *ev_loop_new (unsigned int flags);
302void ev_loop_destroy (EV_P);
303void ev_loop_fork (EV_P);
304
305ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
306
307# else
308
309int ev_default_loop (unsigned int flags); /* returns true when successful */
310
311static ev_tstamp
312ev_now (void)
313{
314 extern ev_tstamp ev_rt_now;
315
316 return ev_rt_now;
317}
318# endif
319
320void ev_default_destroy (void); /* destroy the default loop */
321/* this needs to be called after fork, to duplicate the default loop */
322/* if you create alternative loops you have to call ev_loop_fork on them */
323/* you can call it in either the parent or the child */
324/* you can actually call it at any time, anywhere :) */
325void ev_default_fork (void);
326
327unsigned int ev_backend (EV_P);
328#endif
61 329
62#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 330#define EVLOOP_NONBLOCK 1 /* do not block/wait */
63#define EVLOOP_ONESHOT 2 /* block *once* only */ 331#define EVLOOP_ONESHOT 2 /* block *once* only */
332#define EVUNLOOP_ONE 1 /* unloop once */
333#define EVUNLOOP_ALL 2 /* unloop all loops */
334
335#if EV_PROTOTYPES
64void ev_loop (int flags); 336void ev_loop (EV_P_ int flags);
65extern int ev_loop_done; /* set to 1 to break out of event loop */ 337void 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 */
338
339/*
340 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
341 * keeps one reference. if you have a long-runing watcher you never unregister that
342 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
343 */
344void ev_ref (EV_P);
345void ev_unref (EV_P);
346
347/* convinience function, wait for a single event, without registering an event watcher */
348/* if timeout is < 0, do wait indefinitely */
349void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
350#endif
66 351
67/* these may evaluate ev multiple times, and the other arguments at most once */ 352/* 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) 353/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
354#define ev_init(ev,cb_) do { \
355 ((struct ev_watcher *)(void *)(ev))->active = \
356 ((struct ev_watcher *)(void *)(ev))->pending = \
357 ((struct ev_watcher *)(void *)(ev))->priority = 0; \
358 ev_set_cb ((ev), cb_); \
359} while (0)
69 360
70#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 361#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) 362#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) 363#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) 364#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
365#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
366#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
367#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
368#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
369#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0)
74 370
371#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
372#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
373#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
374#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
375#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
376#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
377#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
378#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
379#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0)
380
381#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 */ 382#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
76 383
384#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
385#define ev_cb(ev) (ev)->cb /* rw */
386#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
387
388#ifndef ev_set_cb
389# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
390#endif
391
392/* stopping (enabling, adding) a watcher does nothing if it is already running */
393/* stopping (disabling, deleting) a watcher does nothing unless its already running */
394#if EV_PROTOTYPES
395
396/* feeds an event into a watcher as if the event actually occured */
397/* accepts any ev_watcher type */
398void ev_feed_event (EV_P_ void *w, int revents);
399void ev_feed_fd_event (EV_P_ int fd, int revents);
400void ev_feed_signal_event (EV_P_ int signum);
401
77void evio_start (struct ev_io *w); 402void ev_io_start (EV_P_ struct ev_io *w);
78void evio_stop (struct ev_io *w); 403void ev_io_stop (EV_P_ struct ev_io *w);
79 404
80void evtimer_start (struct ev_timer *w); 405void ev_timer_start (EV_P_ struct ev_timer *w);
81void evtimer_stop (struct ev_timer *w); 406void ev_timer_stop (EV_P_ struct ev_timer *w);
407/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
408void ev_timer_again (EV_P_ struct ev_timer *w);
82 409
410#if EV_PERIODICS
411void ev_periodic_start (EV_P_ struct ev_periodic *w);
412void ev_periodic_stop (EV_P_ struct ev_periodic *w);
413void ev_periodic_again (EV_P_ struct ev_periodic *w);
414#endif
415
416void ev_idle_start (EV_P_ struct ev_idle *w);
417void ev_idle_stop (EV_P_ struct ev_idle *w);
418
419void ev_prepare_start (EV_P_ struct ev_prepare *w);
420void ev_prepare_stop (EV_P_ struct ev_prepare *w);
421
422void ev_check_start (EV_P_ struct ev_check *w);
423void ev_check_stop (EV_P_ struct ev_check *w);
424
425/* only supported in the default loop */
83void evsignal_start (struct ev_signal *w); 426void ev_signal_start (EV_P_ struct ev_signal *w);
84void evsignal_stop (struct ev_signal *w); 427void ev_signal_stop (EV_P_ struct ev_signal *w);
85 428
429/* only supported in the default loop */
430void ev_child_start (EV_P_ struct ev_child *w);
431void ev_child_stop (EV_P_ struct ev_child *w);
432
433# if EV_MULTIPLICITY
434/* only supported when loop to be embedded is in fact embeddable */
435void ev_embed_start (EV_P_ struct ev_embed *w);
436void ev_embed_stop (EV_P_ struct ev_embed *w);
86#endif 437# endif
87 438
439#endif
440
441#ifdef __cplusplus
442}
443#endif
444
445#endif
446

Diff Legend

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