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

Comparing libev/ev.h (file contents):
Revision 1.23 by root, Fri Nov 2 22:03:00 2007 UTC vs.
Revision 1.42 by root, Fri Nov 9 15:15:21 2007 UTC

… …
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#else
59# define EV_P void
60# define EV_P_
61# define EV_A
62# define EV_A_
63#endif
64
47/* eventmask, revents, events... */ 65/* eventmask, revents, events... */
48#define EV_UNDEF -1 /* guaranteed to be invalid */ 66#define EV_UNDEF -1 /* guaranteed to be invalid */
49#define EV_NONE 0x00 67#define EV_NONE 0x00
50#define EV_READ 0x01 68#define EV_READ 0x01
51#define EV_WRITE 0x02 69#define EV_WRITE 0x02
… …
78 96
79/* shared by all watchers */ 97/* shared by all watchers */
80#define EV_WATCHER(type) \ 98#define EV_WATCHER(type) \
81 int active; /* private */ \ 99 int active; /* private */ \
82 int pending; /* private */ \ 100 int pending; /* private */ \
83 int priority; /* ro */ \ 101 int priority; /* private */ \
84 EV_COMMON; /* rw */ \ 102 EV_COMMON; /* rw */ \
85 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */ 103 void (*cb)(EV_P_ struct type *, int revents) /* private */ /* gets invoked with an eventmask */
86 104
87#define EV_WATCHER_LIST(type) \ 105#define EV_WATCHER_LIST(type) \
88 EV_WATCHER (type); \ 106 EV_WATCHER (type); \
89 struct type *next /* private */ 107 struct ev_watcher_list *next /* private */
90 108
91#define EV_WATCHER_TIME(type) \ 109#define EV_WATCHER_TIME(type) \
92 EV_WATCHER (type); \ 110 EV_WATCHER (type); \
93 ev_tstamp at /* private */ 111 ev_tstamp at /* private */
94 112
… …
121struct ev_periodic 139struct ev_periodic
122{ 140{
123 EV_WATCHER_TIME (ev_periodic); 141 EV_WATCHER_TIME (ev_periodic);
124 142
125 ev_tstamp interval; /* rw */ 143 ev_tstamp interval; /* rw */
144 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
126}; 145};
127 146
128/* invoked when fd is either EV_READable or EV_WRITEable */ 147/* invoked when fd is either EV_READable or EV_WRITEable */
129/* revent EV_READ, EV_WRITE */ 148/* revent EV_READ, EV_WRITE */
130struct ev_io 149struct ev_io
… …
166 EV_WATCHER (ev_check); 185 EV_WATCHER (ev_check);
167}; 186};
168 187
169/* invoked when sigchld is received and waitpid indicates the givne pid */ 188/* invoked when sigchld is received and waitpid indicates the givne pid */
170/* revent EV_CHILD */ 189/* revent EV_CHILD */
190/* does not support priorities */
171struct ev_child 191struct ev_child
172{ 192{
173 EV_WATCHER_LIST (ev_child); 193 EV_WATCHER_LIST (ev_child);
174 194
175 int pid; /* ro */ 195 int pid; /* ro */
196 int rpid; /* rw, holds the received pid */
176 int status; /* rw, holds the exit status, use the macros from sys/wait.h */ 197 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
198};
199
200/* the presence of this union forces similar struct layout */
201union ev_any_watcher
202{
203 struct ev_watcher w;
204 struct ev_watcher_list wl;
205 struct ev_io io;
206 struct ev_timer timer;
207 struct ev_periodic periodic;
208 struct ev_signal signal;
209 struct ev_idle idle;
210 struct ev_child child;
211 struct ev_prepare prepare;
212 struct ev_check check;
177}; 213};
178 214
179#define EVMETHOD_AUTO 0 /* consults environment */ 215#define EVMETHOD_AUTO 0 /* consults environment */
180#define EVMETHOD_SELECT 1 216#define EVMETHOD_SELECT 1
181#define EVMETHOD_POLL 2 217#define EVMETHOD_POLL 2
182#define EVMETHOD_EPOLL 4 218#define EVMETHOD_EPOLL 4
183#define EVMETHOD_KQUEUE 8 219#define EVMETHOD_KQUEUE 8
184#define EVMETHOD_DEVPOLL 16 /* NYI */ 220#define EVMETHOD_DEVPOLL 16 /* NYI */
185#define EVMETHOD_PORT 32 /* NYI */ 221#define EVMETHOD_PORT 32 /* NYI */
222#define EVMETHOD_WIN32 64 /* NYI */
186#define EVMETHOD_ANY ~0 /* any method, do not consult env */ 223#define EVMETHOD_ANY ~0 /* any method, do not consult env */
224
187#if EV_PROTOTYPES 225#if EV_PROTOTYPES
188extern int ev_method;
189int ev_init (int methods); /* returns ev_method */
190int ev_version_major (void); 226int ev_version_major (void);
191int ev_version_minor (void); 227int ev_version_minor (void);
192 228
193/* these three calls are suitable for plugging into pthread_atfork */
194void ev_fork_prepare (void);
195void ev_fork_parent (void);
196void ev_fork_child (void);
197
198extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
199ev_tstamp ev_time (void); 229ev_tstamp ev_time (void);
230
231/* Sets the allocation function to use, works like realloc.
232 * It is used to allocate and free memory.
233 * If it returns zero when memory needs to be allocated, the library might abort
234 * or take some potentially destructive action.
235 * The default is your system realloc function.
236 */
237void ev_set_allocator (void *(*cb)(void *ptr, long size));
238
239/* set the callback function to call on a
240 * retryable syscall error
241 * (such as failed select, poll, epoll_wait)
242 */
243void ev_set_syserr_cb (void (*cb)(const char *msg));
244
245# if EV_MULTIPLICITY
246/* the default loop is the only one that handles signals and child watchers */
247/* you can call this as often as you like */
248struct ev_loop *ev_default_loop (int methods); /* returns default loop */
249
250/* create and destroy alternative loops that don't handle signals */
251struct ev_loop *ev_loop_new (int methods);
252void ev_loop_destroy (EV_P);
253void ev_loop_fork (EV_P);
254# else
255int ev_default_loop (int methods); /* returns true when successful */
256# endif
257
258void ev_default_destroy (void); /* destroy the default loop */
259/* 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 */
261/* you can call it in either the parent or the child */
262/* you can actually call it at any time, anywhere :) */
263void ev_default_fork (void);
264
265int ev_method (EV_P);
200#endif 266#endif
201 267
202#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 268#define EVLOOP_NONBLOCK 1 /* do not block/wait */
203#define EVLOOP_ONESHOT 2 /* block *once* only */ 269#define EVLOOP_ONESHOT 2 /* block *once* only */
270#define EVUNLOOP_ONCE 1 /* unloop once */
271#define EVUNLOOP_ALL 2 /* unloop all loops */
272
204#if EV_PROTOTYPES 273#if EV_PROTOTYPES
205void ev_loop (int flags); 274void ev_loop (EV_P_ int flags);
206extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ 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 */
276
277ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
278
279/*
280 * 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
282 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
283 */
284void ev_ref (EV_P);
285void ev_unref (EV_P);
207 286
208/* convinience function, wait for a single event, without registering an event watcher */ 287/* convinience function, wait for a single event, without registering an event watcher */
209/* if timeout is < 0, do wait indefinitely */ 288/* if timeout is < 0, do wait indefinitely */
210void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 289void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
211#endif 290#endif
212 291
213/* these may evaluate ev multiple times, and the other arguments at most once */ 292/* these may evaluate ev multiple times, and the other arguments at most once */
214/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 293/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
215#define ev_watcher_init(ev,cb_) do { (ev)->active = (ev)->pending = (ev)->priority = 0; (ev)->cb = (cb_); } while (0) 294#define ev_watcher_init(ev,cb_) do { \
295 ((struct ev_watcher *)(void *)(ev))->active = \
296 ((struct ev_watcher *)(void *)(ev))->pending = \
297 ((struct ev_watcher *)(void *)(ev))->priority = 0; \
298 (ev)->cb = (cb_); \
299} while (0)
216 300
217#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 301#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
218#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 302#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
219#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) 303#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
220#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 304#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
221#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 305#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
222#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 306#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
223#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 307#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
224#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 308#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
225 309
226#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 310#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
227#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } 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)
228#define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } 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)
229#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 313#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
230#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 314#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
231#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 315#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
232#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 316#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
233#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 317#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
234 318
319#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
235#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 320#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
321
322#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
323#define ev_cb(ev) (ev)->cb /* rw */
236#define ev_set_priority(ev,pri) (ev)->priority = pri 324#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
325#define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
237 326
238/* stopping (enabling, adding) a watcher does nothing if it is already running */ 327/* stopping (enabling, adding) a watcher does nothing if it is already running */
239/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 328/* stopping (disabling, deleting) a watcher does nothing unless its already running */
240#if EV_PROTOTYPES 329#if EV_PROTOTYPES
330
331/* feeds an event into a watcher as if the event actually occured */
332/* accepts any ev_watcher type */
333void ev_feed_event (EV_P_ void *w, int revents);
334void ev_feed_fd_event (EV_P_ int fd, int revents);
335void ev_feed_signal_event (EV_P_ int signum);
336
241void ev_io_start (struct ev_io *w); 337void ev_io_start (EV_P_ struct ev_io *w);
242void ev_io_stop (struct ev_io *w); 338void ev_io_stop (EV_P_ struct ev_io *w);
243 339
244void ev_timer_start (struct ev_timer *w); 340void ev_timer_start (EV_P_ struct ev_timer *w);
245void ev_timer_stop (struct ev_timer *w); 341void ev_timer_stop (EV_P_ struct ev_timer *w);
246void ev_timer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 342/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
343void ev_timer_again (EV_P_ struct ev_timer *w);
247 344
248void ev_periodic_start (struct ev_periodic *w); 345void ev_periodic_start (EV_P_ struct ev_periodic *w);
249void ev_periodic_stop (struct ev_periodic *w); 346void ev_periodic_stop (EV_P_ struct ev_periodic *w);
347void ev_periodic_again (EV_P_ struct ev_periodic *w);
250 348
251void ev_signal_start (struct ev_signal *w);
252void ev_signal_stop (struct ev_signal *w);
253
254void ev_idle_start (struct ev_idle *w); 349void ev_idle_start (EV_P_ struct ev_idle *w);
255void ev_idle_stop (struct ev_idle *w); 350void ev_idle_stop (EV_P_ struct ev_idle *w);
256 351
257void ev_prepare_start (struct ev_prepare *w); 352void ev_prepare_start (EV_P_ struct ev_prepare *w);
258void ev_prepare_stop (struct ev_prepare *w); 353void ev_prepare_stop (EV_P_ struct ev_prepare *w);
259 354
260void ev_check_start (struct ev_check *w); 355void ev_check_start (EV_P_ struct ev_check *w);
261void ev_check_stop (struct ev_check *w); 356void ev_check_stop (EV_P_ struct ev_check *w);
262 357
358/* only supported in the default loop */
359void ev_signal_start (EV_P_ struct ev_signal *w);
360void ev_signal_stop (EV_P_ struct ev_signal *w);
361
362/* only supported in the default loop */
263void ev_child_start (struct ev_child *w); 363void ev_child_start (EV_P_ struct ev_child *w);
264void ev_child_stop (struct ev_child *w); 364void ev_child_stop (EV_P_ struct ev_child *w);
265#endif 365#endif
266 366
267#ifdef __cplusplus 367#ifdef __cplusplus
268} 368}
269#endif 369#endif

Diff Legend

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