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

Comparing libev/ev.h (file contents):
Revision 1.31 by root, Sun Nov 4 19:45:09 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
… …
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
… …
96 107
97/* shared by all watchers */ 108/* shared by all watchers */
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; /* ro */ \ 112 int priority; /* private */ \
102 EV_COMMON; /* rw */ \ 113 EV_COMMON; /* rw */ \
103 void (*cb)(EV_P_ struct type *, int revents); /* rw */ /* 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 */
… …
139struct ev_periodic 153struct ev_periodic
140{ 154{
141 EV_WATCHER_TIME (ev_periodic); 155 EV_WATCHER_TIME (ev_periodic);
142 156
143 ev_tstamp interval; /* rw */ 157 ev_tstamp interval; /* rw */
158 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
144}; 159};
145 160
146/* invoked when fd is either EV_READable or EV_WRITEable */ 161/* invoked when fd is either EV_READable or EV_WRITEable */
147/* revent EV_READ, EV_WRITE */ 162/* revent EV_READ, EV_WRITE */
148struct ev_io 163struct ev_io
… …
156/* invoked when the given signal has been received */ 171/* invoked when the given signal has been received */
157/* revent EV_SIGNAL */ 172/* revent EV_SIGNAL */
158struct ev_signal 173struct ev_signal
159{ 174{
160 EV_WATCHER_LIST (ev_signal); 175 EV_WATCHER_LIST (ev_signal);
161#if EV_MULTIPLICITY
162 struct ev_loop *loop;
163#endif
164 176
165 int signum; /* ro */ 177 int signum; /* ro */
166}; 178};
167 179
168/* invoked when the nothing else needs to be done, keeps the process from blocking */ 180/* invoked when the nothing else needs to be done, keeps the process from blocking */
… …
195 EV_WATCHER_LIST (ev_child); 207 EV_WATCHER_LIST (ev_child);
196 208
197 int pid; /* ro */ 209 int pid; /* ro */
198 int rpid; /* rw, holds the received pid */ 210 int rpid; /* rw, holds the received pid */
199 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;
200}; 228};
201 229
202#define EVMETHOD_AUTO 0 /* consults environment */ 230#define EVMETHOD_AUTO 0 /* consults environment */
203#define EVMETHOD_SELECT 1 231#define EVMETHOD_SELECT 1
204#define EVMETHOD_POLL 2 232#define EVMETHOD_POLL 2
205#define EVMETHOD_EPOLL 4 233#define EVMETHOD_EPOLL 4
206#define EVMETHOD_KQUEUE 8 234#define EVMETHOD_KQUEUE 8
207#define EVMETHOD_DEVPOLL 16 /* NYI */ 235#define EVMETHOD_DEVPOLL 16 /* NYI */
208#define EVMETHOD_PORT 32 /* NYI */ 236#define EVMETHOD_PORT 32 /* NYI */
237#define EVMETHOD_WIN32 64 /* NYI */
209#define EVMETHOD_ANY ~0 /* any method, do not consult env */ 238#define EVMETHOD_ANY ~0 /* any method, do not consult env */
210 239
211#if EV_PROTOTYPES 240#if EV_PROTOTYPES
212int ev_version_major (void); 241int ev_version_major (void);
213int ev_version_minor (void); 242int ev_version_minor (void);
214 243
215ev_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));
216 259
217# if EV_MULTIPLICITY 260# if EV_MULTIPLICITY
218/* the default loop is the only one that handles signals and child watchers */ 261/* the default loop is the only one that handles signals and child watchers */
219/* you can call this as often as you like */ 262/* you can call this as often as you like */
220struct ev_loop *ev_default_loop (int methods); /* returns default loop */ 263struct ev_loop *ev_default_loop (int methods); /* returns default loop */
221 264
222/* create and destroy alternative loops that don't handle signals */ 265/* create and destroy alternative loops that don't handle signals */
223struct ev_loop *ev_loop_new (int methods); 266struct ev_loop *ev_loop_new (int methods);
224void ev_loop_destroy (EV_P); 267void ev_loop_destroy (EV_P);
225void 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
226# else 272# else
273
227int 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}
228# endif 283# endif
229 284
230void ev_default_destroy (void); /* destroy the default loop */ 285void ev_default_destroy (void); /* destroy the default loop */
231/* 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 */
232/* 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 */
… …
243#define EVUNLOOP_ALL 2 /* unloop all loops */ 298#define EVUNLOOP_ALL 2 /* unloop all loops */
244 299
245#if EV_PROTOTYPES 300#if EV_PROTOTYPES
246void ev_loop (EV_P_ int flags); 301void ev_loop (EV_P_ int flags);
247void 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 */
248
249ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
250 303
251/* 304/*
252 * 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
253 * 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
254 * 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.
… …
260/* if timeout is < 0, do wait indefinitely */ 313/* if timeout is < 0, do wait indefinitely */
261void 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);
262#endif 315#endif
263 316
264/* 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 */
265/* 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 */
266#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)
267 325
268#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)
269#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)
270#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)
271#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)
272#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 */
273#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 */
274#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 */
275#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)
276 334
277#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)
278#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)
279#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)
280#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)
281#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)
282#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)
283#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)
284#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)
285 343
286#define ev_is_pending(ev) (0 + (ev)->pending) /* 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 */
287#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 */
288#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
289 354
290/* 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 */
291/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 356/* stopping (disabling, deleting) a watcher does nothing unless its already running */
292#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
293void ev_io_start (EV_P_ struct ev_io *w); 365void ev_io_start (EV_P_ struct ev_io *w);
294void ev_io_stop (EV_P_ struct ev_io *w); 366void ev_io_stop (EV_P_ struct ev_io *w);
295 367
296void ev_timer_start (EV_P_ struct ev_timer *w); 368void ev_timer_start (EV_P_ struct ev_timer *w);
297void ev_timer_stop (EV_P_ struct ev_timer *w); 369void ev_timer_stop (EV_P_ struct ev_timer *w);
298/* 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 */
299void ev_timer_again (EV_P_ struct ev_timer *w); 371void ev_timer_again (EV_P_ struct ev_timer *w);
300 372
301void ev_periodic_start (EV_P_ struct ev_periodic *w); 373void ev_periodic_start (EV_P_ struct ev_periodic *w);
302void 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);
303 376
304void ev_idle_start (EV_P_ struct ev_idle *w); 377void ev_idle_start (EV_P_ struct ev_idle *w);
305void ev_idle_stop (EV_P_ struct ev_idle *w); 378void ev_idle_stop (EV_P_ struct ev_idle *w);
306 379
307void ev_prepare_start (EV_P_ struct ev_prepare *w); 380void ev_prepare_start (EV_P_ struct ev_prepare *w);

Diff Legend

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