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

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

Diff Legend

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