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

Comparing libev/ev.h (file contents):
Revision 1.29 by root, Sun Nov 4 00:24:17 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
… …
44# define EV_MAXPRI +2 44# define EV_MAXPRI +2
45#endif 45#endif
46 46
47#ifndef EV_MULTIPLICITY 47#ifndef EV_MULTIPLICITY
48# define EV_MULTIPLICITY 1 48# define EV_MULTIPLICITY 1
49#endif
50
51#ifndef EV_PERIODICS
52# define EV_PERIODICS 1
49#endif 53#endif
50 54
51/* support multiple event loops? */ 55/* support multiple event loops? */
52#if EV_MULTIPLICITY 56#if EV_MULTIPLICITY
53struct ev_loop; 57struct ev_loop;
54# define EV_P struct ev_loop *loop 58# define EV_P struct ev_loop *loop
55# define EV_P_ EV_P, 59# define EV_P_ EV_P,
56# define EV_A loop 60# define EV_A loop
57# define EV_A_ EV_A, 61# define EV_A_ EV_A,
62# define EV_DEFAULT_A ev_default_loop (0)
63# define EV_DEFAULT_A_ EV_DEFAULT_A,
58#else 64#else
59# define EV_P void 65# define EV_P void
60# define EV_P_ 66# define EV_P_
61# define EV_A 67# define EV_A
62# define EV_A_ 68# define EV_A_
69# define EV_DEFAULT_A
70# define EV_DEFAULT_A_
63#endif 71#endif
64 72
65/* eventmask, revents, events... */ 73/* eventmask, revents, events... */
66#define EV_UNDEF -1 /* guaranteed to be invalid */ 74#define EV_UNDEF -1 /* guaranteed to be invalid */
67#define EV_NONE 0x00 75#define EV_NONE 0x00
… …
85#endif 93#endif
86 94
87#define EV_VERSION_MAJOR 1 95#define EV_VERSION_MAJOR 1
88#define EV_VERSION_MINOR 1 96#define EV_VERSION_MINOR 1
89 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
90/* 105/*
91 * struct member types: 106 * struct member types:
92 * 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.
93 * 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
94 * 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
… …
96 111
97/* shared by all watchers */ 112/* shared by all watchers */
98#define EV_WATCHER(type) \ 113#define EV_WATCHER(type) \
99 int active; /* private */ \ 114 int active; /* private */ \
100 int pending; /* private */ \ 115 int pending; /* private */ \
101 int priority; /* ro */ \ 116 int priority; /* private */ \
102 EV_COMMON; /* rw */ \ 117 EV_COMMON; /* rw */ \
103 void (*cb)(EV_P_ struct type *, int revents); /* rw */ /* gets invoked with an eventmask */ 118 EV_CB_DECLARE (type) /* private */
104 119
105#define EV_WATCHER_LIST(type) \ 120#define EV_WATCHER_LIST(type) \
106 EV_WATCHER (type); \ 121 EV_WATCHER (type); \
107 struct ev_watcher_list *next /* private */ 122 struct ev_watcher_list *next /* private */
108 123
109#define EV_WATCHER_TIME(type) \ 124#define EV_WATCHER_TIME(type) \
110 EV_WATCHER (type); \ 125 EV_WATCHER (type); \
111 ev_tstamp at /* private */ 126 ev_tstamp at /* private */
112 127
113/* base class, nothing to see here unless you subclass */ 128/* base class, nothing to see here unless you subclass */
114struct ev_watcher { 129struct ev_watcher
130{
115 EV_WATCHER (ev_watcher); 131 EV_WATCHER (ev_watcher);
116}; 132};
117 133
118/* base class, nothing to see here unless you subclass */ 134/* base class, nothing to see here unless you subclass */
119struct ev_watcher_list { 135struct ev_watcher_list
136{
120 EV_WATCHER_LIST (ev_watcher_list); 137 EV_WATCHER_LIST (ev_watcher_list);
121}; 138};
122 139
123/* base class, nothing to see here unless you subclass */ 140/* base class, nothing to see here unless you subclass */
124struct ev_watcher_time { 141struct ev_watcher_time
142{
125 EV_WATCHER_TIME (ev_watcher_time); 143 EV_WATCHER_TIME (ev_watcher_time);
126}; 144};
127 145
128/* invoked after a specific time, repeatable (based on monotonic clock) */ 146/* invoked after a specific time, repeatable (based on monotonic clock) */
129/* revent EV_TIMEOUT */ 147/* revent EV_TIMEOUT */
… …
139struct ev_periodic 157struct ev_periodic
140{ 158{
141 EV_WATCHER_TIME (ev_periodic); 159 EV_WATCHER_TIME (ev_periodic);
142 160
143 ev_tstamp interval; /* rw */ 161 ev_tstamp interval; /* rw */
162 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
144}; 163};
145 164
146/* invoked when fd is either EV_READable or EV_WRITEable */ 165/* invoked when fd is either EV_READable or EV_WRITEable */
147/* revent EV_READ, EV_WRITE */ 166/* revent EV_READ, EV_WRITE */
148struct ev_io 167struct ev_io
… …
156/* invoked when the given signal has been received */ 175/* invoked when the given signal has been received */
157/* revent EV_SIGNAL */ 176/* revent EV_SIGNAL */
158struct ev_signal 177struct ev_signal
159{ 178{
160 EV_WATCHER_LIST (ev_signal); 179 EV_WATCHER_LIST (ev_signal);
161#if EV_MULTIPLICITY
162 struct ev_loop *loop;
163#endif
164 180
165 int signum; /* ro */ 181 int signum; /* ro */
166}; 182};
167 183
168/* invoked when the nothing else needs to be done, keeps the process from blocking */ 184/* invoked when the nothing else needs to be done, keeps the process from blocking */
… …
195 EV_WATCHER_LIST (ev_child); 211 EV_WATCHER_LIST (ev_child);
196 212
197 int pid; /* ro */ 213 int pid; /* ro */
198 int rpid; /* rw, holds the received pid */ 214 int rpid; /* rw, holds the received pid */
199 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;
200}; 232};
201 233
202#define EVMETHOD_AUTO 0 /* consults environment */ 234#define EVMETHOD_AUTO 0 /* consults environment */
203#define EVMETHOD_SELECT 1 235#define EVMETHOD_SELECT 1
204#define EVMETHOD_POLL 2 236#define EVMETHOD_POLL 2
205#define EVMETHOD_EPOLL 4 237#define EVMETHOD_EPOLL 4
206#define EVMETHOD_KQUEUE 8 238#define EVMETHOD_KQUEUE 8
207#define EVMETHOD_DEVPOLL 16 /* NYI */ 239#define EVMETHOD_DEVPOLL 16 /* NYI */
208#define EVMETHOD_PORT 32 /* NYI */ 240#define EVMETHOD_PORT 32 /* NYI */
241#define EVMETHOD_WIN32 64 /* NYI */
209#define EVMETHOD_ANY ~0 /* any method, do not consult env */ 242#define EVMETHOD_ANY ~0 /* any method, do not consult env */
210 243
211#if EV_PROTOTYPES 244#if EV_PROTOTYPES
212int ev_version_major (void); 245int ev_version_major (void);
213int ev_version_minor (void); 246int ev_version_minor (void);
214 247
215/* these three calls are suitable for plugging into pthread_atfork */
216void ev_fork_prepare (void);
217void ev_fork_parent (void);
218void ev_fork_child (void);
219
220ev_tstamp ev_time (void); 248ev_tstamp ev_time (void);
221 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
222# if EV_MULTIPLICITY 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 */
223struct ev_loop *ev_loop_new (int methods); 270struct ev_loop *ev_loop_new (int methods);
224void ev_loop_delete (EV_P); 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
225# else 276# else
226int ev_init (int methods); /* returns ev_method */ 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}
227# endif 287# endif
228 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
229int ev_method (EV_P); 296int ev_method (EV_P);
230
231#endif 297#endif
232 298
233#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 299#define EVLOOP_NONBLOCK 1 /* do not block/wait */
234#define EVLOOP_ONESHOT 2 /* block *once* only */ 300#define EVLOOP_ONESHOT 2 /* block *once* only */
235#define EVUNLOOP_ONCE 1 /* unloop once */ 301#define EVUNLOOP_ONCE 1 /* unloop once */
236#define EVUNLOOP_ALL 2 /* unloop all loops */ 302#define EVUNLOOP_ALL 2 /* unloop all loops */
237 303
238#if EV_PROTOTYPES 304#if EV_PROTOTYPES
239void ev_loop (EV_P_ int flags); 305void ev_loop (EV_P_ int flags);
240void 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 */ 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 */
241
242ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
243 307
244/* 308/*
245 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 309 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
246 * keeps one reference. if you have a long-runing watcher you never unregister that 310 * keeps one reference. if you have a long-runing watcher you never unregister that
247 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 311 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
… …
253/* if timeout is < 0, do wait indefinitely */ 317/* if timeout is < 0, do wait indefinitely */
254void ev_once (EV_P_ 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);
255#endif 319#endif
256 320
257/* 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 */
258/* 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 */
259#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)
260 329
261#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)
262#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)
263#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)
264#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)
265#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 */
266#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 */
267#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 */
268#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)
269 338
270#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)
271#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)
272#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)
273#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)
274#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)
275#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)
276#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)
277#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)
278 347
348#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
279#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 */
280#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
281 358
282/* 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 */
283/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 360/* stopping (disabling, deleting) a watcher does nothing unless its already running */
284#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
285void ev_io_start (EV_P_ struct ev_io *w); 369void ev_io_start (EV_P_ struct ev_io *w);
286void ev_io_stop (EV_P_ struct ev_io *w); 370void ev_io_stop (EV_P_ struct ev_io *w);
287 371
288void ev_timer_start (EV_P_ struct ev_timer *w); 372void ev_timer_start (EV_P_ struct ev_timer *w);
289void ev_timer_stop (EV_P_ struct ev_timer *w); 373void ev_timer_stop (EV_P_ struct ev_timer *w);
290void 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 */ 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);
291 376
377#if EV_PERIODICS
292void ev_periodic_start (EV_P_ struct ev_periodic *w); 378void ev_periodic_start (EV_P_ struct ev_periodic *w);
293void ev_periodic_stop (EV_P_ 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
294 382
383void ev_idle_start (EV_P_ struct ev_idle *w);
384void ev_idle_stop (EV_P_ struct ev_idle *w);
385
386void ev_prepare_start (EV_P_ struct ev_prepare *w);
387void ev_prepare_stop (EV_P_ struct ev_prepare *w);
388
389void ev_check_start (EV_P_ struct ev_check *w);
390void ev_check_stop (EV_P_ struct ev_check *w);
391
392/* only supported in the default loop */
295void ev_signal_start (EV_P_ struct ev_signal *w); 393void ev_signal_start (EV_P_ struct ev_signal *w);
296void ev_signal_stop (EV_P_ struct ev_signal *w); 394void ev_signal_stop (EV_P_ struct ev_signal *w);
297 395
298void ev_idle_start (EV_P_ struct ev_idle *w); 396/* only supported in the default loop */
299void ev_idle_stop (EV_P_ struct ev_idle *w);
300
301void ev_prepare_start (EV_P_ struct ev_prepare *w);
302void ev_prepare_stop (EV_P_ struct ev_prepare *w);
303
304void ev_check_start (EV_P_ struct ev_check *w);
305void ev_check_stop (EV_P_ struct ev_check *w);
306
307void ev_child_start (EV_P_ struct ev_child *w); 397void ev_child_start (EV_P_ struct ev_child *w);
308void ev_child_stop (EV_P_ struct ev_child *w); 398void ev_child_stop (EV_P_ struct ev_child *w);
309#endif 399#endif
310 400
311#ifdef __cplusplus 401#ifdef __cplusplus

Diff Legend

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