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

Comparing libev/ev.h (file contents):
Revision 1.28 by root, Sat Nov 3 22:10:39 2007 UTC vs.
Revision 1.34 by root, Sun Nov 4 23:29:48 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
47/* support multiple event loops? */ 51/* support multiple event loops? */
48#ifdef EV_MULTIPLICITY 52#if EV_MULTIPLICITY
49struct ev_loop; 53struct ev_loop;
50# define EV_P struct ev_loop *loop 54# define EV_P struct ev_loop *loop
51# define EV_P_ EV_P, 55# define EV_P_ EV_P,
52# define EV_A loop 56# define EV_A loop
53# define EV_A_ EV_A, 57# define EV_A_ EV_A,
54#else 58#else
55# define EV_P void 59# define EV_P void
56# define EV_P_ 60# define EV_P_
57# define EV_A 61# define EV_A
58# define EV_A_ 62# define EV_A_
59
60#endif 63#endif
61 64
62/* eventmask, revents, events... */ 65/* eventmask, revents, events... */
63#define EV_UNDEF -1 /* guaranteed to be invalid */ 66#define EV_UNDEF -1 /* guaranteed to be invalid */
64#define EV_NONE 0x00 67#define EV_NONE 0x00
93 96
94/* shared by all watchers */ 97/* shared by all watchers */
95#define EV_WATCHER(type) \ 98#define EV_WATCHER(type) \
96 int active; /* private */ \ 99 int active; /* private */ \
97 int pending; /* private */ \ 100 int pending; /* private */ \
98 int priority; /* ro */ \ 101 int priority; /* private */ \
99 EV_COMMON; /* rw */ \ 102 EV_COMMON; /* rw */ \
100 void (*cb)(EV_P_ 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 */
101 104
102#define EV_WATCHER_LIST(type) \ 105#define EV_WATCHER_LIST(type) \
103 EV_WATCHER (type); \ 106 EV_WATCHER (type); \
104 struct ev_watcher_list *next /* private */ 107 struct ev_watcher_list *next /* private */
105 108
153/* invoked when the given signal has been received */ 156/* invoked when the given signal has been received */
154/* revent EV_SIGNAL */ 157/* revent EV_SIGNAL */
155struct ev_signal 158struct ev_signal
156{ 159{
157 EV_WATCHER_LIST (ev_signal); 160 EV_WATCHER_LIST (ev_signal);
161#if EV_MULTIPLICITY
162 struct ev_loop *loop;
163#endif
158 164
159 int signum; /* ro */ 165 int signum; /* ro */
160}; 166};
161 167
162/* invoked when the nothing else needs to be done, keeps the process from blocking */ 168/* invoked when the nothing else needs to be done, keeps the process from blocking */
198#define EVMETHOD_POLL 2 204#define EVMETHOD_POLL 2
199#define EVMETHOD_EPOLL 4 205#define EVMETHOD_EPOLL 4
200#define EVMETHOD_KQUEUE 8 206#define EVMETHOD_KQUEUE 8
201#define EVMETHOD_DEVPOLL 16 /* NYI */ 207#define EVMETHOD_DEVPOLL 16 /* NYI */
202#define EVMETHOD_PORT 32 /* NYI */ 208#define EVMETHOD_PORT 32 /* NYI */
209#define EVMETHOD_WIN32 64 /* NYI */
203#define EVMETHOD_ANY ~0 /* any method, do not consult env */ 210#define EVMETHOD_ANY ~0 /* any method, do not consult env */
211
204#if EV_PROTOTYPES 212#if EV_PROTOTYPES
205int ev_method (EV_P);
206int ev_init (EV_P_ int methods); /* returns ev_method */
207int ev_version_major (void); 213int ev_version_major (void);
208int ev_version_minor (void); 214int ev_version_minor (void);
209 215
210/* these three calls are suitable for plugging into pthread_atfork */
211void ev_fork_prepare (void);
212void ev_fork_parent (void);
213void ev_fork_child (void);
214
215ev_tstamp ev_time (void); 216ev_tstamp ev_time (void);
217
218# if EV_MULTIPLICITY
219/* the default loop is the only one that handles signals and child watchers */
220/* you can call this as often as you like */
221struct ev_loop *ev_default_loop (int methods); /* returns default loop */
222
223/* create and destroy alternative loops that don't handle signals */
224struct ev_loop *ev_loop_new (int methods);
225void ev_loop_destroy (EV_P);
226void ev_loop_fork (EV_P);
227# else
228int ev_default_loop (int methods); /* returns true when successful */
229# endif
230
231void ev_default_destroy (void); /* destroy the default loop */
232/* this needs to be called after fork, to duplicate the default loop */
233/* if you create alternative loops you have to call ev_loop_fork on them */
234/* you can call it in either the parent or the child */
235/* you can actually call it at any time, anywhere :) */
236void ev_default_fork (void);
237
238int ev_method (EV_P);
216#endif 239#endif
217 240
218#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 241#define EVLOOP_NONBLOCK 1 /* do not block/wait */
219#define EVLOOP_ONESHOT 2 /* block *once* only */ 242#define EVLOOP_ONESHOT 2 /* block *once* only */
243#define EVUNLOOP_ONCE 1 /* unloop once */
244#define EVUNLOOP_ALL 2 /* unloop all loops */
245
220#if EV_PROTOTYPES 246#if EV_PROTOTYPES
221void ev_loop (EV_P_ int flags); 247void ev_loop (EV_P_ int flags);
222void 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 */ 248void 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 */
223 249
224ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 250ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
225 251
226/* 252/*
227 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 253 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
236void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 262void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
237#endif 263#endif
238 264
239/* these may evaluate ev multiple times, and the other arguments at most once */ 265/* these may evaluate ev multiple times, and the other arguments at most once */
240/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 266/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
241#define ev_watcher_init(ev,cb_) do { (ev)->active = (ev)->pending = (ev)->priority = 0; (ev)->cb = (cb_); } while (0) 267#define ev_watcher_init(ev,cb_) do { \
268 ((struct ev_watcher *)(void *)(ev))->active = \
269 ((struct ev_watcher *)(void *)(ev))->pending = \
270 ((struct ev_watcher *)(void *)(ev))->priority = 0; \
271 (ev)->cb = (cb_); \
272} while (0)
242 273
243#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 274#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
244#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 275#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
245#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) 276#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
246#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 277#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
256#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 287#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
257#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 288#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
258#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 289#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
259#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 290#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
260 291
292#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
261#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 293#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
294
295#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
296#define ev_cb(ev) (ev)->cb /* rw */
262#define ev_set_priority(ev,pri) (ev)->priority = pri 297#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
298#define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
263 299
264/* stopping (enabling, adding) a watcher does nothing if it is already running */ 300/* stopping (enabling, adding) a watcher does nothing if it is already running */
265/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 301/* stopping (disabling, deleting) a watcher does nothing unless its already running */
266#if EV_PROTOTYPES 302#if EV_PROTOTYPES
267void ev_io_start (EV_P_ struct ev_io *w); 303void ev_io_start (EV_P_ struct ev_io *w);
268void ev_io_stop (EV_P_ struct ev_io *w); 304void ev_io_stop (EV_P_ struct ev_io *w);
269 305
270void ev_timer_start (EV_P_ struct ev_timer *w); 306void ev_timer_start (EV_P_ struct ev_timer *w);
271void ev_timer_stop (EV_P_ struct ev_timer *w); 307void ev_timer_stop (EV_P_ struct ev_timer *w);
272void 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 */ 308/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
309void ev_timer_again (EV_P_ struct ev_timer *w);
273 310
274void ev_periodic_start (EV_P_ struct ev_periodic *w); 311void ev_periodic_start (EV_P_ struct ev_periodic *w);
275void ev_periodic_stop (EV_P_ struct ev_periodic *w); 312void ev_periodic_stop (EV_P_ struct ev_periodic *w);
276 313
314void ev_idle_start (EV_P_ struct ev_idle *w);
315void ev_idle_stop (EV_P_ struct ev_idle *w);
316
317void ev_prepare_start (EV_P_ struct ev_prepare *w);
318void ev_prepare_stop (EV_P_ struct ev_prepare *w);
319
320void ev_check_start (EV_P_ struct ev_check *w);
321void ev_check_stop (EV_P_ struct ev_check *w);
322
323/* only supported in the default loop */
277void ev_signal_start (EV_P_ struct ev_signal *w); 324void ev_signal_start (EV_P_ struct ev_signal *w);
278void ev_signal_stop (EV_P_ struct ev_signal *w); 325void ev_signal_stop (EV_P_ struct ev_signal *w);
279 326
280void ev_idle_start (EV_P_ struct ev_idle *w); 327/* only supported in the default loop */
281void ev_idle_stop (EV_P_ struct ev_idle *w);
282
283void ev_prepare_start (EV_P_ struct ev_prepare *w);
284void ev_prepare_stop (EV_P_ struct ev_prepare *w);
285
286void ev_check_start (EV_P_ struct ev_check *w);
287void ev_check_stop (EV_P_ struct ev_check *w);
288
289void ev_child_start (EV_P_ struct ev_child *w); 328void ev_child_start (EV_P_ struct ev_child *w);
290void ev_child_stop (EV_P_ struct ev_child *w); 329void ev_child_stop (EV_P_ struct ev_child *w);
291#endif 330#endif
292 331
293#ifdef __cplusplus 332#ifdef __cplusplus

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines