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

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

Diff Legend

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