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

Comparing libev/ev.h (file contents):
Revision 1.64 by root, Fri Nov 23 19:13:33 2007 UTC vs.
Revision 1.70 by root, Tue Nov 27 08:11:52 2007 UTC

… …
46 46
47#ifndef EV_MULTIPLICITY 47#ifndef EV_MULTIPLICITY
48# define EV_MULTIPLICITY 1 48# define EV_MULTIPLICITY 1
49#endif 49#endif
50 50
51#ifndef EV_PERIODICS 51#ifndef EV_PERIODIC_ENABLE
52# define EV_PERIODICS 1 52# define EV_PERIODIC_ENABLE 1
53#endif
54
55#ifndef EV_STAT_ENABLE
56# define EV_STAT_ENABLE 1
57#endif
58
59#ifndef EV_EMBED_ENABLE
60# define EV_EMBED_ENABLE 1
61#endif
62
63/*****************************************************************************/
64
65#if EV_STAT_ENABLE
66# include <sys/stat.h>
53#endif 67#endif
54 68
55/* support multiple event loops? */ 69/* support multiple event loops? */
56#if EV_MULTIPLICITY 70#if EV_MULTIPLICITY
57struct ev_loop; 71struct ev_loop;
… …
66# define EV_P_ 80# define EV_P_
67# define EV_A 81# define EV_A
68# define EV_A_ 82# define EV_A_
69# define EV_DEFAULT_A 83# define EV_DEFAULT_A
70# define EV_DEFAULT_A_ 84# define EV_DEFAULT_A_
85
86# undef EV_EMBED_ENABLE
71#endif 87#endif
72 88
73/* eventmask, revents, events... */ 89/* eventmask, revents, events... */
74#define EV_UNDEF -1L /* guaranteed to be invalid */ 90#define EV_UNDEF -1L /* guaranteed to be invalid */
75#define EV_NONE 0x00L 91#define EV_NONE 0x00L /* no events */
76#define EV_READ 0x01L /* io only */ 92#define EV_READ 0x01L /* ev_io detected read will not block */
77#define EV_WRITE 0x02L /* io only */ 93#define EV_WRITE 0x02L /* ev_io detected write will not block */
78#define EV_TIMEOUT 0x000100L /* timer only */ 94#define EV_TIMEOUT 0x00000100L /* timer timed out */
79#define EV_PERIODIC 0x000200L /* periodic timer only */ 95#define EV_PERIODIC 0x00000200L /* periodic timer timed out */
80#define EV_SIGNAL 0x000400L /* signal only */ 96#define EV_SIGNAL 0x00000400L /* signal was received */
81#define EV_IDLE 0x000800L /* idle only */ 97#define EV_IDLE 0x00000800L /* event loop is idling */
82#define EV_CHECK 0x001000L /* check only */ 98#define EV_PREPARE 0x00001000L /* event loop about to poll */
83#define EV_PREPARE 0x002000L /* prepare only */ 99#define EV_CHECK 0x00002000L /* event loop finished poll */
84#define EV_CHILD 0x004000L /* child/pid only */ 100#define EV_CHILD 0x00004000L /* child/pid had status change */
85#define EV_EMBED 0x008000L /* embedded event loop */ 101#define EV_EMBED 0x00008000L /* embedded event loop needs sweep */
102#define EV_STAT 0x00010000L /* stat data changed */
86#define EV_ERROR 0x800000L /* sent when an error occurs */ 103#define EV_ERROR 0x80000000L /* sent when an error occurs */
87 104
88/* can be used to add custom fields to all watchers, while losing binary compatibility */ 105/* can be used to add custom fields to all watchers, while losing binary compatibility */
89#ifndef EV_COMMON 106#ifndef EV_COMMON
90# define EV_COMMON void *data; 107# define EV_COMMON void *data;
91#endif 108#endif
… …
125#define EV_WATCHER_TIME(type) \ 142#define EV_WATCHER_TIME(type) \
126 EV_WATCHER (type) \ 143 EV_WATCHER (type) \
127 ev_tstamp at; /* private */ 144 ev_tstamp at; /* private */
128 145
129/* base class, nothing to see here unless you subclass */ 146/* base class, nothing to see here unless you subclass */
130struct ev_watcher 147typedef struct ev_watcher
131{ 148{
132 EV_WATCHER (ev_watcher) 149 EV_WATCHER (ev_watcher)
133}; 150} ev_watcher;
134 151
135/* base class, nothing to see here unless you subclass */ 152/* base class, nothing to see here unless you subclass */
136struct ev_watcher_list 153typedef struct ev_watcher_list
137{ 154{
138 EV_WATCHER_LIST (ev_watcher_list) 155 EV_WATCHER_LIST (ev_watcher_list)
139}; 156} ev_watcher_list;
140 157
141/* base class, nothing to see here unless you subclass */ 158/* base class, nothing to see here unless you subclass */
142struct ev_watcher_time 159typedef struct ev_watcher_time
143{ 160{
144 EV_WATCHER_TIME (ev_watcher_time) 161 EV_WATCHER_TIME (ev_watcher_time)
145}; 162} ev_watcher_time;
163
164/* invoked when fd is either EV_READable or EV_WRITEable */
165/* revent EV_READ, EV_WRITE */
166typedef struct ev_io
167{
168 EV_WATCHER_LIST (ev_io)
169
170 int fd; /* ro */
171 int events; /* ro */
172} ev_io;
146 173
147/* invoked after a specific time, repeatable (based on monotonic clock) */ 174/* invoked after a specific time, repeatable (based on monotonic clock) */
148/* revent EV_TIMEOUT */ 175/* revent EV_TIMEOUT */
149struct ev_timer 176typedef struct ev_timer
150{ 177{
151 EV_WATCHER_TIME (ev_timer) 178 EV_WATCHER_TIME (ev_timer)
152 179
153 ev_tstamp repeat; /* rw */ 180 ev_tstamp repeat; /* rw */
154}; 181} ev_timer;
155 182
156/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 183/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
157/* revent EV_PERIODIC */ 184/* revent EV_PERIODIC */
158struct ev_periodic 185typedef struct ev_periodic
159{ 186{
160 EV_WATCHER_TIME (ev_periodic) 187 EV_WATCHER_TIME (ev_periodic)
161 188
162 ev_tstamp interval; /* rw */ 189 ev_tstamp interval; /* rw */
163 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 190 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
164}; 191} ev_periodic;
165
166/* invoked when fd is either EV_READable or EV_WRITEable */
167/* revent EV_READ, EV_WRITE */
168struct ev_io
169{
170 EV_WATCHER_LIST (ev_io)
171
172 int fd; /* ro */
173 int events; /* ro */
174};
175 192
176/* invoked when the given signal has been received */ 193/* invoked when the given signal has been received */
177/* revent EV_SIGNAL */ 194/* revent EV_SIGNAL */
178struct ev_signal 195typedef struct ev_signal
179{ 196{
180 EV_WATCHER_LIST (ev_signal) 197 EV_WATCHER_LIST (ev_signal)
181 198
182 int signum; /* ro */ 199 int signum; /* ro */
183}; 200} ev_signal;
201
202/* invoked when sigchld is received and waitpid indicates the given pid */
203/* revent EV_CHILD */
204/* does not support priorities */
205typedef struct ev_child
206{
207 EV_WATCHER_LIST (ev_child)
208
209 int pid; /* ro */
210 int rpid; /* rw, holds the received pid */
211 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
212} ev_child;
213
214#if EV_STAT_ENABLE
215/* st_nlink = 0 means missing file or other error */
216typedef struct stat ev_statdata;
217
218/* invoked each time the stat data changes for a given path */
219/* revent EV_STAT */
220typedef struct ev_stat
221{
222 EV_WATCHER (ev_stat)
223
224 ev_timer timer; /* private */
225 ev_tstamp interval; /* ro */
226 const char *path; /* ro */
227 ev_statdata prev; /* ro */
228 ev_statdata attr; /* ro */
229} ev_stat;
230#endif
184 231
185/* invoked when the nothing else needs to be done, keeps the process from blocking */ 232/* invoked when the nothing else needs to be done, keeps the process from blocking */
186/* revent EV_IDLE */ 233/* revent EV_IDLE */
187struct ev_idle 234typedef struct ev_idle
188{ 235{
189 EV_WATCHER (ev_idle) 236 EV_WATCHER (ev_idle)
190}; 237} ev_idle;
191 238
192/* invoked for each run of the mainloop, just before the blocking call */ 239/* invoked for each run of the mainloop, just before the blocking call */
193/* you can still change events in any way you like */ 240/* you can still change events in any way you like */
194/* revent EV_PREPARE */ 241/* revent EV_PREPARE */
195struct ev_prepare 242typedef struct ev_prepare
196{ 243{
197 EV_WATCHER (ev_prepare) 244 EV_WATCHER (ev_prepare)
198}; 245} ev_prepare;
199 246
200/* invoked for each run of the mainloop, just after the blocking call */ 247/* invoked for each run of the mainloop, just after the blocking call */
201/* revent EV_CHECK */ 248/* revent EV_CHECK */
202struct ev_check 249typedef struct ev_check
203{ 250{
204 EV_WATCHER (ev_check) 251 EV_WATCHER (ev_check)
205}; 252} ev_check;
206 253
207/* invoked when sigchld is received and waitpid indicates the given pid */ 254#if EV_EMBED_ENABLE
208/* revent EV_CHILD */
209/* does not support priorities */
210struct ev_child
211{
212 EV_WATCHER_LIST (ev_child)
213
214 int pid; /* ro */
215 int rpid; /* rw, holds the received pid */
216 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
217};
218
219#if EV_MULTIPLICITY
220/* used to embed an event loop inside another */ 255/* used to embed an event loop inside another */
221/* the callback gets invoked when the event loop has handled events, and can be 0 */ 256/* the callback gets invoked when the event loop has handled events, and can be 0 */
222struct ev_embed 257typedef struct ev_embed
223{ 258{
224 EV_WATCHER (ev_embed) 259 EV_WATCHER (ev_embed)
225 260
226 struct ev_io io; /* private */ 261 ev_io io; /* private */
227 struct ev_loop *loop; /* ro */ 262 struct ev_loop *loop; /* ro */
228}; 263} ev_embed;
229#endif 264#endif
230 265
231/* the presence of this union forces similar struct layout */ 266/* the presence of this union forces similar struct layout */
232union ev_any_watcher 267union ev_any_watcher
233{ 268{
… …
235 struct ev_watcher_list wl; 270 struct ev_watcher_list wl;
236 271
237 struct ev_io io; 272 struct ev_io io;
238 struct ev_timer timer; 273 struct ev_timer timer;
239 struct ev_periodic periodic; 274 struct ev_periodic periodic;
275 struct ev_child child;
276#if EV_STAT_ENABLE
277 struct ev_stat stat;
278#endif
240 struct ev_idle idle; 279 struct ev_idle idle;
241 struct ev_prepare prepare; 280 struct ev_prepare prepare;
242 struct ev_check check; 281 struct ev_check check;
243 struct ev_signal signal; 282 struct ev_signal signal;
244 struct ev_child child; 283#if EV_EMBED_ENABLE
245 struct ev_embed embed; 284 struct ev_embed embed;
285#endif
246}; 286};
247 287
248/* bits for ev_default_loop and ev_loop_new */ 288/* bits for ev_default_loop and ev_loop_new */
249/* the default */ 289/* the default */
250#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */ 290#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */
… …
327unsigned int ev_backend (EV_P); 367unsigned int ev_backend (EV_P);
328#endif 368#endif
329 369
330#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 370#define EVLOOP_NONBLOCK 1 /* do not block/wait */
331#define EVLOOP_ONESHOT 2 /* block *once* only */ 371#define EVLOOP_ONESHOT 2 /* block *once* only */
372#define EVUNLOOP_CANCEL 0 /* undo unloop */
332#define EVUNLOOP_ONE 1 /* unloop once */ 373#define EVUNLOOP_ONE 1 /* unloop once */
333#define EVUNLOOP_ALL 2 /* unloop all loops */ 374#define EVUNLOOP_ALL 2 /* unloop all loops */
334 375
335#if EV_PROTOTYPES 376#if EV_PROTOTYPES
336void ev_loop (EV_P_ int flags); 377void ev_loop (EV_P_ int flags);
… …
350#endif 391#endif
351 392
352/* these may evaluate ev multiple times, and the other arguments at most once */ 393/* these may evaluate ev multiple times, and the other arguments at most once */
353/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 394/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
354#define ev_init(ev,cb_) do { \ 395#define ev_init(ev,cb_) do { \
355 ((struct ev_watcher *)(void *)(ev))->active = \ 396 ((ev_watcher *)(void *)(ev))->active = \
356 ((struct ev_watcher *)(void *)(ev))->pending = \ 397 ((ev_watcher *)(void *)(ev))->pending = \
357 ((struct ev_watcher *)(void *)(ev))->priority = 0; \ 398 ((ev_watcher *)(void *)(ev))->priority = 0; \
358 ev_set_cb ((ev), cb_); \ 399 ev_set_cb ((ev), cb_); \
359} while (0) 400} while (0)
360 401
361#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 402#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
362#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 403#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
363#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 404#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
364#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 405#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
406#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
407#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); } while (0)
365#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 408#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
366#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 409#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
367#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 410#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
368#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
369#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0) 411#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0)
370 412
371#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 413#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
372#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 414#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
373#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 415#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
374#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 416#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
417#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
418#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0)
375#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 419#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
376#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 420#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
377#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 421#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
378#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
379#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0) 422#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0)
380 423
381#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 424#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
382#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 425#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
383 426
384#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */ 427#define ev_priority(ev) ((ev_watcher *)(void *)(ev))->priority /* rw */
385#define ev_cb(ev) (ev)->cb /* rw */ 428#define ev_cb(ev) (ev)->cb /* rw */
386#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) 429#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
387 430
388#ifndef ev_set_cb 431#ifndef ev_set_cb
389# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 432# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
… …
397/* accepts any ev_watcher type */ 440/* accepts any ev_watcher type */
398void ev_feed_event (EV_P_ void *w, int revents); 441void ev_feed_event (EV_P_ void *w, int revents);
399void ev_feed_fd_event (EV_P_ int fd, int revents); 442void ev_feed_fd_event (EV_P_ int fd, int revents);
400void ev_feed_signal_event (EV_P_ int signum); 443void ev_feed_signal_event (EV_P_ int signum);
401 444
402void ev_io_start (EV_P_ struct ev_io *w); 445void ev_io_start (EV_P_ ev_io *w);
403void ev_io_stop (EV_P_ struct ev_io *w); 446void ev_io_stop (EV_P_ ev_io *w);
404 447
405void ev_timer_start (EV_P_ struct ev_timer *w); 448void ev_timer_start (EV_P_ ev_timer *w);
406void ev_timer_stop (EV_P_ struct ev_timer *w); 449void ev_timer_stop (EV_P_ ev_timer *w);
407/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 450/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
408void ev_timer_again (EV_P_ struct ev_timer *w); 451void ev_timer_again (EV_P_ ev_timer *w);
409 452
410#if EV_PERIODICS 453#if EV_PERIODIC_ENABLE
411void ev_periodic_start (EV_P_ struct ev_periodic *w); 454void ev_periodic_start (EV_P_ ev_periodic *w);
412void ev_periodic_stop (EV_P_ struct ev_periodic *w); 455void ev_periodic_stop (EV_P_ ev_periodic *w);
413void ev_periodic_again (EV_P_ struct ev_periodic *w); 456void ev_periodic_again (EV_P_ ev_periodic *w);
414#endif 457#endif
415
416void ev_idle_start (EV_P_ struct ev_idle *w);
417void ev_idle_stop (EV_P_ struct ev_idle *w);
418
419void ev_prepare_start (EV_P_ struct ev_prepare *w);
420void ev_prepare_stop (EV_P_ struct ev_prepare *w);
421
422void ev_check_start (EV_P_ struct ev_check *w);
423void ev_check_stop (EV_P_ struct ev_check *w);
424 458
425/* only supported in the default loop */ 459/* only supported in the default loop */
426void ev_signal_start (EV_P_ struct ev_signal *w); 460void ev_signal_start (EV_P_ ev_signal *w);
427void ev_signal_stop (EV_P_ struct ev_signal *w); 461void ev_signal_stop (EV_P_ ev_signal *w);
428 462
429/* only supported in the default loop */ 463/* only supported in the default loop */
430void ev_child_start (EV_P_ struct ev_child *w); 464void ev_child_start (EV_P_ ev_child *w);
431void ev_child_stop (EV_P_ struct ev_child *w); 465void ev_child_stop (EV_P_ ev_child *w);
432 466
433# if EV_MULTIPLICITY 467# if EV_STAT_ENABLE
468void ev_stat_start (EV_P_ ev_stat *w);
469void ev_stat_stop (EV_P_ ev_stat *w);
470void ev_stat_stat (EV_P_ ev_stat *w);
471# endif
472
473void ev_idle_start (EV_P_ ev_idle *w);
474void ev_idle_stop (EV_P_ ev_idle *w);
475
476void ev_prepare_start (EV_P_ ev_prepare *w);
477void ev_prepare_stop (EV_P_ ev_prepare *w);
478
479void ev_check_start (EV_P_ ev_check *w);
480void ev_check_stop (EV_P_ ev_check *w);
481
482# if EV_EMBED_ENABLE
434/* only supported when loop to be embedded is in fact embeddable */ 483/* only supported when loop to be embedded is in fact embeddable */
435void ev_embed_start (EV_P_ struct ev_embed *w); 484void ev_embed_start (EV_P_ ev_embed *w);
436void ev_embed_stop (EV_P_ struct ev_embed *w); 485void ev_embed_stop (EV_P_ ev_embed *w);
486void ev_embed_sweep (EV_P_ ev_embed *w);
437# endif 487# endif
438 488
439#endif 489#endif
440 490
441#ifdef __cplusplus 491#ifdef __cplusplus

Diff Legend

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