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

Comparing libev/ev.h (file contents):
Revision 1.66 by root, Sat Nov 24 07:14:26 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
142typedef struct 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} ev_watcher_time; 162} ev_watcher_time;
146 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;
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 */
149typedef struct ev_timer 176typedef struct ev_timer
150{ 177{
151 EV_WATCHER_TIME (ev_timer) 178 EV_WATCHER_TIME (ev_timer)
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} ev_periodic; 191} ev_periodic;
165 192
166/* invoked when fd is either EV_READable or EV_WRITEable */
167/* revent EV_READ, EV_WRITE */
168typedef struct ev_io
169{
170 EV_WATCHER_LIST (ev_io)
171
172 int fd; /* ro */
173 int events; /* ro */
174} ev_io;
175
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 */
178typedef struct 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} ev_signal; 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 */
187typedef struct ev_idle 234typedef struct ev_idle
188{ 235{
202typedef struct ev_check 249typedef struct ev_check
203{ 250{
204 EV_WATCHER (ev_check) 251 EV_WATCHER (ev_check)
205} ev_check; 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 */
210typedef struct 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} ev_child;
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 */
222typedef struct ev_embed 257typedef struct ev_embed
223{ 258{
224 EV_WATCHER (ev_embed) 259 EV_WATCHER (ev_embed)
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 */
361 401
362#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)
363#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)
364#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)
365#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)
366#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 */
367#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 */
368#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 */
369#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
370#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)
371 412
372#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)
373#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)
374#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)
375#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)
376#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)
377#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)
378#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)
379#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
380#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)
381 423
382#define ev_is_pending(ev) (0 + ((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 */
383#define ev_is_active(ev) (0 + ((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 */
384 426
406void ev_timer_start (EV_P_ ev_timer *w); 448void ev_timer_start (EV_P_ ev_timer *w);
407void ev_timer_stop (EV_P_ ev_timer *w); 449void ev_timer_stop (EV_P_ ev_timer *w);
408/* 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 */
409void ev_timer_again (EV_P_ ev_timer *w); 451void ev_timer_again (EV_P_ ev_timer *w);
410 452
411#if EV_PERIODICS 453#if EV_PERIODIC_ENABLE
412void ev_periodic_start (EV_P_ ev_periodic *w); 454void ev_periodic_start (EV_P_ ev_periodic *w);
413void ev_periodic_stop (EV_P_ ev_periodic *w); 455void ev_periodic_stop (EV_P_ ev_periodic *w);
414void ev_periodic_again (EV_P_ ev_periodic *w); 456void ev_periodic_again (EV_P_ ev_periodic *w);
415#endif 457#endif
416 458
417void ev_idle_start (EV_P_ ev_idle *w);
418void ev_idle_stop (EV_P_ ev_idle *w);
419
420void ev_prepare_start (EV_P_ ev_prepare *w);
421void ev_prepare_stop (EV_P_ ev_prepare *w);
422
423void ev_check_start (EV_P_ ev_check *w);
424void ev_check_stop (EV_P_ ev_check *w);
425
426/* only supported in the default loop */ 459/* only supported in the default loop */
427void ev_signal_start (EV_P_ ev_signal *w); 460void ev_signal_start (EV_P_ ev_signal *w);
428void ev_signal_stop (EV_P_ ev_signal *w); 461void ev_signal_stop (EV_P_ ev_signal *w);
429 462
430/* only supported in the default loop */ 463/* only supported in the default loop */
431void ev_child_start (EV_P_ ev_child *w); 464void ev_child_start (EV_P_ ev_child *w);
432void ev_child_stop (EV_P_ ev_child *w); 465void ev_child_stop (EV_P_ ev_child *w);
433 466
434# 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
435/* only supported when loop to be embedded is in fact embeddable */ 483/* only supported when loop to be embedded is in fact embeddable */
436void ev_embed_start (EV_P_ ev_embed *w); 484void ev_embed_start (EV_P_ ev_embed *w);
437void ev_embed_stop (EV_P_ ev_embed *w); 485void ev_embed_stop (EV_P_ ev_embed *w);
438void ev_embed_loop (EV_P_ ev_embed *w); 486void ev_embed_sweep (EV_P_ ev_embed *w);
439# endif 487# endif
440 488
441#endif 489#endif
442 490
443#ifdef __cplusplus 491#ifdef __cplusplus

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines