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

Comparing libev/ev.h (file contents):
Revision 1.27 by root, Sat Nov 3 21:58:51 2007 UTC vs.
Revision 1.49 by root, Sat Nov 10 21:19:30 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
… …
42#endif 42#endif
43#ifndef EV_MAXPRI 43#ifndef EV_MAXPRI
44# define EV_MAXPRI +2 44# define EV_MAXPRI +2
45#endif 45#endif
46 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# define EV_DEFAULT_A ev_default_loop (0)
59# define EV_DEFAULT_A_ EV_DEFAULT_A,
60#else
47#define EV_P void 61# define EV_P void
48#define EV_P_ 62# define EV_P_
49#define EV_A 63# define EV_A
50#define EV_A_ 64# define EV_A_
65# define EV_DEFAULT_A
66# define EV_DEFAULT_A_
67#endif
51 68
52/* eventmask, revents, events... */ 69/* eventmask, revents, events... */
53#define EV_UNDEF -1 /* guaranteed to be invalid */ 70#define EV_UNDEF -1 /* guaranteed to be invalid */
54#define EV_NONE 0x00 71#define EV_NONE 0x00
55#define EV_READ 0x01 72#define EV_READ 0x01
… …
72#endif 89#endif
73 90
74#define EV_VERSION_MAJOR 1 91#define EV_VERSION_MAJOR 1
75#define EV_VERSION_MINOR 1 92#define EV_VERSION_MINOR 1
76 93
94#ifndef EV_CB_DECLARE
95# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
96#endif
97#ifndef EV_CB_INVOKE
98# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
99#endif
100
77/* 101/*
78 * struct member types: 102 * struct member types:
79 * private: you can look at them, but not change them, and they might not mean anything to you. 103 * private: you can look at them, but not change them, and they might not mean anything to you.
80 * ro: can be read anytime, but only changed when the watcher isn't active 104 * ro: can be read anytime, but only changed when the watcher isn't active
81 * rw: can be read and modified anytime, even when the watcher is active 105 * rw: can be read and modified anytime, even when the watcher is active
… …
83 107
84/* shared by all watchers */ 108/* shared by all watchers */
85#define EV_WATCHER(type) \ 109#define EV_WATCHER(type) \
86 int active; /* private */ \ 110 int active; /* private */ \
87 int pending; /* private */ \ 111 int pending; /* private */ \
88 int priority; /* ro */ \ 112 int priority; /* private */ \
89 EV_COMMON; /* rw */ \ 113 EV_COMMON; /* rw */ \
90 void (*cb)(EV_P_ struct type *, int revents); /* rw */ /* gets invoked with an eventmask */ 114 EV_CB_DECLARE (type) /* private */
91 115
92#define EV_WATCHER_LIST(type) \ 116#define EV_WATCHER_LIST(type) \
93 EV_WATCHER (type); \ 117 EV_WATCHER (type); \
94 struct ev_watcher_list *next /* private */ 118 struct ev_watcher_list *next /* private */
95 119
96#define EV_WATCHER_TIME(type) \ 120#define EV_WATCHER_TIME(type) \
97 EV_WATCHER (type); \ 121 EV_WATCHER (type); \
98 ev_tstamp at /* private */ 122 ev_tstamp at /* private */
99 123
100/* base class, nothing to see here unless you subclass */ 124/* base class, nothing to see here unless you subclass */
101struct ev_watcher { 125struct ev_watcher
126{
102 EV_WATCHER (ev_watcher); 127 EV_WATCHER (ev_watcher);
103}; 128};
104 129
105/* base class, nothing to see here unless you subclass */ 130/* base class, nothing to see here unless you subclass */
106struct ev_watcher_list { 131struct ev_watcher_list
132{
107 EV_WATCHER_LIST (ev_watcher_list); 133 EV_WATCHER_LIST (ev_watcher_list);
108}; 134};
109 135
110/* base class, nothing to see here unless you subclass */ 136/* base class, nothing to see here unless you subclass */
111struct ev_watcher_time { 137struct ev_watcher_time
138{
112 EV_WATCHER_TIME (ev_watcher_time); 139 EV_WATCHER_TIME (ev_watcher_time);
113}; 140};
114 141
115/* invoked after a specific time, repeatable (based on monotonic clock) */ 142/* invoked after a specific time, repeatable (based on monotonic clock) */
116/* revent EV_TIMEOUT */ 143/* revent EV_TIMEOUT */
… …
126struct ev_periodic 153struct ev_periodic
127{ 154{
128 EV_WATCHER_TIME (ev_periodic); 155 EV_WATCHER_TIME (ev_periodic);
129 156
130 ev_tstamp interval; /* rw */ 157 ev_tstamp interval; /* rw */
158 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
131}; 159};
132 160
133/* invoked when fd is either EV_READable or EV_WRITEable */ 161/* invoked when fd is either EV_READable or EV_WRITEable */
134/* revent EV_READ, EV_WRITE */ 162/* revent EV_READ, EV_WRITE */
135struct ev_io 163struct ev_io
… …
179 EV_WATCHER_LIST (ev_child); 207 EV_WATCHER_LIST (ev_child);
180 208
181 int pid; /* ro */ 209 int pid; /* ro */
182 int rpid; /* rw, holds the received pid */ 210 int rpid; /* rw, holds the received pid */
183 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 211 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
212};
213
214/* the presence of this union forces similar struct layout */
215union ev_any_watcher
216{
217 struct ev_watcher w;
218 struct ev_watcher_list wl;
219
220 struct ev_io io;
221 struct ev_timer timer;
222 struct ev_periodic periodic;
223 struct ev_idle idle;
224 struct ev_prepare prepare;
225 struct ev_check check;
226 struct ev_signal signal;
227 struct ev_child child;
184}; 228};
185 229
186#define EVMETHOD_AUTO 0 /* consults environment */ 230#define EVMETHOD_AUTO 0 /* consults environment */
187#define EVMETHOD_SELECT 1 231#define EVMETHOD_SELECT 1
188#define EVMETHOD_POLL 2 232#define EVMETHOD_POLL 2
189#define EVMETHOD_EPOLL 4 233#define EVMETHOD_EPOLL 4
190#define EVMETHOD_KQUEUE 8 234#define EVMETHOD_KQUEUE 8
191#define EVMETHOD_DEVPOLL 16 /* NYI */ 235#define EVMETHOD_DEVPOLL 16 /* NYI */
192#define EVMETHOD_PORT 32 /* NYI */ 236#define EVMETHOD_PORT 32 /* NYI */
237#define EVMETHOD_WIN32 64 /* NYI */
193#define EVMETHOD_ANY ~0 /* any method, do not consult env */ 238#define EVMETHOD_ANY ~0 /* any method, do not consult env */
239
194#if EV_PROTOTYPES 240#if EV_PROTOTYPES
195int ev_method (EV_P);
196int ev_init (EV_P_ int methods); /* returns ev_method */
197int ev_version_major (void); 241int ev_version_major (void);
198int ev_version_minor (void); 242int ev_version_minor (void);
199 243
200/* these three calls are suitable for plugging into pthread_atfork */
201void ev_fork_prepare (void);
202void ev_fork_parent (void);
203void ev_fork_child (void);
204
205ev_tstamp ev_time (void); 244ev_tstamp ev_time (void);
245
246/* Sets the allocation function to use, works like realloc.
247 * It is used to allocate and free memory.
248 * If it returns zero when memory needs to be allocated, the library might abort
249 * or take some potentially destructive action.
250 * The default is your system realloc function.
251 */
252void ev_set_allocator (void *(*cb)(void *ptr, long size));
253
254/* set the callback function to call on a
255 * retryable syscall error
256 * (such as failed select, poll, epoll_wait)
257 */
258void ev_set_syserr_cb (void (*cb)(const char *msg));
259
260# if EV_MULTIPLICITY
261/* the default loop is the only one that handles signals and child watchers */
262/* you can call this as often as you like */
263struct ev_loop *ev_default_loop (int methods); /* returns default loop */
264
265/* create and destroy alternative loops that don't handle signals */
266struct ev_loop *ev_loop_new (int methods);
267void ev_loop_destroy (EV_P);
268void ev_loop_fork (EV_P);
269
270ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
271
272# else
273
274int ev_default_loop (int methods); /* returns true when successful */
275
276static ev_tstamp
277ev_now ()
278{
279 extern ev_tstamp ev_rt_now;
280
281 return ev_rt_now;
282}
283# endif
284
285void ev_default_destroy (void); /* destroy the default loop */
286/* this needs to be called after fork, to duplicate the default loop */
287/* if you create alternative loops you have to call ev_loop_fork on them */
288/* you can call it in either the parent or the child */
289/* you can actually call it at any time, anywhere :) */
290void ev_default_fork (void);
291
292int ev_method (EV_P);
206#endif 293#endif
207 294
208#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 295#define EVLOOP_NONBLOCK 1 /* do not block/wait */
209#define EVLOOP_ONESHOT 2 /* block *once* only */ 296#define EVLOOP_ONESHOT 2 /* block *once* only */
297#define EVUNLOOP_ONCE 1 /* unloop once */
298#define EVUNLOOP_ALL 2 /* unloop all loops */
299
210#if EV_PROTOTYPES 300#if EV_PROTOTYPES
211void ev_loop (EV_P_ int flags); 301void ev_loop (EV_P_ int flags);
212void ev_unloop (EV_P_ int status); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ 302void 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 */
213
214ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
215 303
216/* 304/*
217 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 305 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
218 * keeps one reference. if you have a long-runing watcher you never unregister that 306 * keeps one reference. if you have a long-runing watcher you never unregister that
219 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 307 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
… …
225/* if timeout is < 0, do wait indefinitely */ 313/* if timeout is < 0, do wait indefinitely */
226void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 314void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
227#endif 315#endif
228 316
229/* these may evaluate ev multiple times, and the other arguments at most once */ 317/* these may evaluate ev multiple times, and the other arguments at most once */
230/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 318/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
231#define ev_watcher_init(ev,cb_) do { (ev)->active = (ev)->pending = (ev)->priority = 0; (ev)->cb = (cb_); } while (0) 319#define ev_init(ev,cb_) do { \
320 ((struct ev_watcher *)(void *)(ev))->active = \
321 ((struct ev_watcher *)(void *)(ev))->pending = \
322 ((struct ev_watcher *)(void *)(ev))->priority = 0; \
323 ev_set_cb ((ev), cb_); \
324} while (0)
232 325
233#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 326#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
234#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 327#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
235#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) 328#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
236#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 329#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
237#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 330#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
238#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 331#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
239#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 332#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
240#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 333#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
241 334
242#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 335#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
243#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 336#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
244#define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0) 337#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
245#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 338#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
246#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 339#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
247#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 340#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
248#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 341#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
249#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 342#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
250 343
344#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
251#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 345#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
346
347#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
348#define ev_cb(ev) (ev)->cb /* rw */
252#define ev_set_priority(ev,pri) (ev)->priority = pri 349#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
350
351#ifndef ev_set_cb
352# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
353#endif
253 354
254/* stopping (enabling, adding) a watcher does nothing if it is already running */ 355/* stopping (enabling, adding) a watcher does nothing if it is already running */
255/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 356/* stopping (disabling, deleting) a watcher does nothing unless its already running */
256#if EV_PROTOTYPES 357#if EV_PROTOTYPES
358
359/* feeds an event into a watcher as if the event actually occured */
360/* accepts any ev_watcher type */
361void ev_feed_event (EV_P_ void *w, int revents);
362void ev_feed_fd_event (EV_P_ int fd, int revents);
363void ev_feed_signal_event (EV_P_ int signum);
364
257void ev_io_start (EV_P_ struct ev_io *w); 365void ev_io_start (EV_P_ struct ev_io *w);
258void ev_io_stop (EV_P_ struct ev_io *w); 366void ev_io_stop (EV_P_ struct ev_io *w);
259 367
260void ev_timer_start (EV_P_ struct ev_timer *w); 368void ev_timer_start (EV_P_ struct ev_timer *w);
261void ev_timer_stop (EV_P_ struct ev_timer *w); 369void ev_timer_stop (EV_P_ struct ev_timer *w);
262void ev_timer_again (EV_P_ struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 370/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
371void ev_timer_again (EV_P_ struct ev_timer *w);
263 372
264void ev_periodic_start (EV_P_ struct ev_periodic *w); 373void ev_periodic_start (EV_P_ struct ev_periodic *w);
265void ev_periodic_stop (EV_P_ struct ev_periodic *w); 374void ev_periodic_stop (EV_P_ struct ev_periodic *w);
375void ev_periodic_again (EV_P_ struct ev_periodic *w);
266 376
377void ev_idle_start (EV_P_ struct ev_idle *w);
378void ev_idle_stop (EV_P_ struct ev_idle *w);
379
380void ev_prepare_start (EV_P_ struct ev_prepare *w);
381void ev_prepare_stop (EV_P_ struct ev_prepare *w);
382
383void ev_check_start (EV_P_ struct ev_check *w);
384void ev_check_stop (EV_P_ struct ev_check *w);
385
386/* only supported in the default loop */
267void ev_signal_start (EV_P_ struct ev_signal *w); 387void ev_signal_start (EV_P_ struct ev_signal *w);
268void ev_signal_stop (EV_P_ struct ev_signal *w); 388void ev_signal_stop (EV_P_ struct ev_signal *w);
269 389
270void ev_idle_start (EV_P_ struct ev_idle *w); 390/* only supported in the default loop */
271void ev_idle_stop (EV_P_ struct ev_idle *w);
272
273void ev_prepare_start (EV_P_ struct ev_prepare *w);
274void ev_prepare_stop (EV_P_ struct ev_prepare *w);
275
276void ev_check_start (EV_P_ struct ev_check *w);
277void ev_check_stop (EV_P_ struct ev_check *w);
278
279void ev_child_start (EV_P_ struct ev_child *w); 391void ev_child_start (EV_P_ struct ev_child *w);
280void ev_child_stop (EV_P_ struct ev_child *w); 392void ev_child_stop (EV_P_ struct ev_child *w);
281#endif 393#endif
282 394
283#ifdef __cplusplus 395#ifdef __cplusplus

Diff Legend

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