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

Comparing libev/ev.h (file contents):
Revision 1.43 by root, Fri Nov 9 17:10:57 2007 UTC vs.
Revision 1.49 by root, Sat Nov 10 21:19:30 2007 UTC

53struct ev_loop; 53struct ev_loop;
54# define EV_P struct ev_loop *loop 54# define EV_P struct ev_loop *loop
55# define EV_P_ EV_P, 55# define EV_P_ EV_P,
56# define EV_A loop 56# define EV_A loop
57# define EV_A_ EV_A, 57# define EV_A_ EV_A,
58# define EV_DEFAULT_A ev_default_loop (0)
59# define EV_DEFAULT_A_ EV_DEFAULT_A,
58#else 60#else
59# define EV_P void 61# define EV_P void
60# define EV_P_ 62# define EV_P_
61# define EV_A 63# define EV_A
62# define EV_A_ 64# define EV_A_
65# define EV_DEFAULT_A
66# define EV_DEFAULT_A_
63#endif 67#endif
64 68
65/* eventmask, revents, events... */ 69/* eventmask, revents, events... */
66#define EV_UNDEF -1 /* guaranteed to be invalid */ 70#define EV_UNDEF -1 /* guaranteed to be invalid */
67#define EV_NONE 0x00 71#define EV_NONE 0x00
85#endif 89#endif
86 90
87#define EV_VERSION_MAJOR 1 91#define EV_VERSION_MAJOR 1
88#define EV_VERSION_MINOR 1 92#define EV_VERSION_MINOR 1
89 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
90/* 101/*
91 * struct member types: 102 * struct member types:
92 * 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.
93 * 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
94 * 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
98#define EV_WATCHER(type) \ 109#define EV_WATCHER(type) \
99 int active; /* private */ \ 110 int active; /* private */ \
100 int pending; /* private */ \ 111 int pending; /* private */ \
101 int priority; /* private */ \ 112 int priority; /* private */ \
102 EV_COMMON; /* rw */ \ 113 EV_COMMON; /* rw */ \
103 void (*cb)(EV_P_ struct type *, int revents) /* private */ /* gets invoked with an eventmask */ 114 EV_CB_DECLARE (type) /* private */
104 115
105#define EV_WATCHER_LIST(type) \ 116#define EV_WATCHER_LIST(type) \
106 EV_WATCHER (type); \ 117 EV_WATCHER (type); \
107 struct ev_watcher_list *next /* private */ 118 struct ev_watcher_list *next /* private */
108 119
109#define EV_WATCHER_TIME(type) \ 120#define EV_WATCHER_TIME(type) \
110 EV_WATCHER (type); \ 121 EV_WATCHER (type); \
111 ev_tstamp at /* private */ 122 ev_tstamp at /* private */
112 123
113/* base class, nothing to see here unless you subclass */ 124/* base class, nothing to see here unless you subclass */
114struct ev_watcher { 125struct ev_watcher
126{
115 EV_WATCHER (ev_watcher); 127 EV_WATCHER (ev_watcher);
116}; 128};
117 129
118/* base class, nothing to see here unless you subclass */ 130/* base class, nothing to see here unless you subclass */
119struct ev_watcher_list { 131struct ev_watcher_list
132{
120 EV_WATCHER_LIST (ev_watcher_list); 133 EV_WATCHER_LIST (ev_watcher_list);
121}; 134};
122 135
123/* base class, nothing to see here unless you subclass */ 136/* base class, nothing to see here unless you subclass */
124struct ev_watcher_time { 137struct ev_watcher_time
138{
125 EV_WATCHER_TIME (ev_watcher_time); 139 EV_WATCHER_TIME (ev_watcher_time);
126}; 140};
127 141
128/* invoked after a specific time, repeatable (based on monotonic clock) */ 142/* invoked after a specific time, repeatable (based on monotonic clock) */
129/* revent EV_TIMEOUT */ 143/* revent EV_TIMEOUT */
200/* the presence of this union forces similar struct layout */ 214/* the presence of this union forces similar struct layout */
201union ev_any_watcher 215union ev_any_watcher
202{ 216{
203 struct ev_watcher w; 217 struct ev_watcher w;
204 struct ev_watcher_list wl; 218 struct ev_watcher_list wl;
219
205 struct ev_io io; 220 struct ev_io io;
206 struct ev_timer timer; 221 struct ev_timer timer;
207 struct ev_periodic periodic; 222 struct ev_periodic periodic;
208 struct ev_signal signal;
209 struct ev_idle idle; 223 struct ev_idle idle;
210 struct ev_child child;
211 struct ev_prepare prepare; 224 struct ev_prepare prepare;
212 struct ev_check check; 225 struct ev_check check;
226 struct ev_signal signal;
227 struct ev_child child;
213}; 228};
214 229
215#define EVMETHOD_AUTO 0 /* consults environment */ 230#define EVMETHOD_AUTO 0 /* consults environment */
216#define EVMETHOD_SELECT 1 231#define EVMETHOD_SELECT 1
217#define EVMETHOD_POLL 2 232#define EVMETHOD_POLL 2
249 264
250/* create and destroy alternative loops that don't handle signals */ 265/* create and destroy alternative loops that don't handle signals */
251struct ev_loop *ev_loop_new (int methods); 266struct ev_loop *ev_loop_new (int methods);
252void ev_loop_destroy (EV_P); 267void ev_loop_destroy (EV_P);
253void ev_loop_fork (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
254# else 272# else
273
255int ev_default_loop (int methods); /* returns true when successful */ 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}
256# endif 283# endif
257 284
258void ev_default_destroy (void); /* destroy the default loop */ 285void ev_default_destroy (void); /* destroy the default loop */
259/* this needs to be called after fork, to duplicate the default loop */ 286/* this needs to be called after fork, to duplicate the default loop */
260/* if you create alternative loops you have to call ev_loop_fork on them */ 287/* if you create alternative loops you have to call ev_loop_fork on them */
271#define EVUNLOOP_ALL 2 /* unloop all loops */ 298#define EVUNLOOP_ALL 2 /* unloop all loops */
272 299
273#if EV_PROTOTYPES 300#if EV_PROTOTYPES
274void ev_loop (EV_P_ int flags); 301void ev_loop (EV_P_ int flags);
275void 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 */ 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 */
276
277ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
278 303
279/* 304/*
280 * 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
281 * 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
282 * 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.
288/* if timeout is < 0, do wait indefinitely */ 313/* if timeout is < 0, do wait indefinitely */
289void 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);
290#endif 315#endif
291 316
292/* 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 */
293/* 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 */
294#define ev_watcher_init(ev,cb_) do { \ 319#define ev_init(ev,cb_) do { \
295 ((struct ev_watcher *)(void *)(ev))->active = \ 320 ((struct ev_watcher *)(void *)(ev))->active = \
296 ((struct ev_watcher *)(void *)(ev))->pending = \ 321 ((struct ev_watcher *)(void *)(ev))->pending = \
297 ((struct ev_watcher *)(void *)(ev))->priority = 0; \ 322 ((struct ev_watcher *)(void *)(ev))->priority = 0; \
298 (ev)->cb = (cb_); \ 323 ev_set_cb ((ev), cb_); \
299} while (0) 324} while (0)
300 325
301#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)
302#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)
303#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 328#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
305#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 */
306#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 */
307#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 */
308#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)
309 334
310#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)
311#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)
312#define ev_periodic_init(ev,cb,at,ival,res) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } 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)
313#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)
314#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)
315#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)
316#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)
317#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)
318 343
319#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 344#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
320#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, 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 */
321 346
322#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */ 347#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
323#define ev_cb(ev) (ev)->cb /* rw */ 348#define ev_cb(ev) (ev)->cb /* rw */
324#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) 349#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
350
351#ifndef ev_set_cb
325#define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 352# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
353#endif
326 354
327/* 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 */
328/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 356/* stopping (disabling, deleting) a watcher does nothing unless its already running */
329#if EV_PROTOTYPES 357#if EV_PROTOTYPES
330 358

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines