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

Comparing libev/ev.h (file contents):
Revision 1.67 by root, Sat Nov 24 07:14:49 2007 UTC vs.
Revision 1.74 by root, Wed Nov 28 11:15:55 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_FORK_ENABLE
60# define EV_FORK_ENABLE 1
61#endif
62
63#ifndef EV_EMBED_ENABLE
64# define EV_EMBED_ENABLE 1
65#endif
66
67/*****************************************************************************/
68
69#include <stddef.h> /* for size_t */
70
71#if EV_STAT_ENABLE
72# include <sys/stat.h>
53#endif 73#endif
54 74
55/* support multiple event loops? */ 75/* support multiple event loops? */
56#if EV_MULTIPLICITY 76#if EV_MULTIPLICITY
57struct ev_loop; 77struct ev_loop;
58# define EV_P struct ev_loop *loop 78# define EV_P struct ev_loop *loop
59# define EV_P_ EV_P, 79# define EV_P_ EV_P,
60# define EV_A loop 80# define EV_A loop
61# define EV_A_ EV_A, 81# define EV_A_ EV_A,
62# define EV_DEFAULT_A ev_default_loop (0) 82# define EV_DEFAULT ev_default_loop (0)
63# define EV_DEFAULT_A_ EV_DEFAULT_A, 83# define EV_DEFAULT_ EV_DEFAULT,
64#else 84#else
65# define EV_P void 85# define EV_P void
66# define EV_P_ 86# define EV_P_
67# define EV_A 87# define EV_A
68# define EV_A_ 88# define EV_A_
89# define EV_DEFAULT
69# define EV_DEFAULT_A 90# define EV_DEFAULT_
70# define EV_DEFAULT_A_ 91
92# undef EV_EMBED_ENABLE
71#endif 93#endif
72 94
73/* eventmask, revents, events... */ 95/* eventmask, revents, events... */
74#define EV_UNDEF -1L /* guaranteed to be invalid */ 96#define EV_UNDEF -1L /* guaranteed to be invalid */
75#define EV_NONE 0x00L 97#define EV_NONE 0x00L /* no events */
76#define EV_READ 0x01L /* io only */ 98#define EV_READ 0x01L /* ev_io detected read will not block */
77#define EV_WRITE 0x02L /* io only */ 99#define EV_WRITE 0x02L /* ev_io detected write will not block */
78#define EV_TIMEOUT 0x000100L /* timer only */ 100#define EV_TIMEOUT 0x00000100L /* timer timed out */
79#define EV_PERIODIC 0x000200L /* periodic timer only */ 101#define EV_PERIODIC 0x00000200L /* periodic timer timed out */
80#define EV_SIGNAL 0x000400L /* signal only */ 102#define EV_SIGNAL 0x00000400L /* signal was received */
81#define EV_IDLE 0x000800L /* idle only */
82#define EV_CHECK 0x001000L /* check only */
83#define EV_PREPARE 0x002000L /* prepare only */
84#define EV_CHILD 0x004000L /* child/pid only */ 103#define EV_CHILD 0x00000800L /* child/pid had status change */
104#define EV_STAT 0x00001000L /* stat data changed */
105#define EV_IDLE 0x00002000L /* event loop is idling */
106#define EV_PREPARE 0x00004000L /* event loop about to poll */
107#define EV_CHECK 0x00008000L /* event loop finished poll */
85#define EV_EMBED 0x008000L /* embedded event loop */ 108#define EV_EMBED 0x00010000L /* embedded event loop needs sweep */
109#define EV_FORK 0x00020000L /* event loop resumed in child */
86#define EV_ERROR 0x800000L /* sent when an error occurs */ 110#define EV_ERROR 0x80000000L /* sent when an error occurs */
87 111
88/* can be used to add custom fields to all watchers, while losing binary compatibility */ 112/* can be used to add custom fields to all watchers, while losing binary compatibility */
89#ifndef EV_COMMON 113#ifndef EV_COMMON
90# define EV_COMMON void *data; 114# define EV_COMMON void *data;
91#endif 115#endif
… …
142typedef struct ev_watcher_time 166typedef struct ev_watcher_time
143{ 167{
144 EV_WATCHER_TIME (ev_watcher_time) 168 EV_WATCHER_TIME (ev_watcher_time)
145} ev_watcher_time; 169} ev_watcher_time;
146 170
171/* invoked when fd is either EV_READable or EV_WRITEable */
172/* revent EV_READ, EV_WRITE */
173typedef struct ev_io
174{
175 EV_WATCHER_LIST (ev_io)
176
177 int fd; /* ro */
178 int events; /* ro */
179} ev_io;
180
147/* invoked after a specific time, repeatable (based on monotonic clock) */ 181/* invoked after a specific time, repeatable (based on monotonic clock) */
148/* revent EV_TIMEOUT */ 182/* revent EV_TIMEOUT */
149typedef struct ev_timer 183typedef struct ev_timer
150{ 184{
151 EV_WATCHER_TIME (ev_timer) 185 EV_WATCHER_TIME (ev_timer)
… …
161 195
162 ev_tstamp interval; /* rw */ 196 ev_tstamp interval; /* rw */
163 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 197 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
164} ev_periodic; 198} ev_periodic;
165 199
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 */ 200/* invoked when the given signal has been received */
177/* revent EV_SIGNAL */ 201/* revent EV_SIGNAL */
178typedef struct ev_signal 202typedef struct ev_signal
179{ 203{
180 EV_WATCHER_LIST (ev_signal) 204 EV_WATCHER_LIST (ev_signal)
181 205
182 int signum; /* ro */ 206 int signum; /* ro */
183} ev_signal; 207} ev_signal;
208
209/* invoked when sigchld is received and waitpid indicates the given pid */
210/* revent EV_CHILD */
211/* does not support priorities */
212typedef struct ev_child
213{
214 EV_WATCHER_LIST (ev_child)
215
216 int pid; /* ro */
217 int rpid; /* rw, holds the received pid */
218 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
219} ev_child;
220
221#if EV_STAT_ENABLE
222/* st_nlink = 0 means missing file or other error */
223# ifdef _WIN32
224typedef struct _stati64 ev_statdata;
225# else
226typedef struct stat ev_statdata;
227# endif
228
229/* invoked each time the stat data changes for a given path */
230/* revent EV_STAT */
231typedef struct ev_stat
232{
233 EV_WATCHER_LIST (ev_stat)
234
235 ev_timer timer; /* private */
236 ev_tstamp interval; /* ro */
237 const char *path; /* ro */
238 ev_statdata prev; /* ro */
239 ev_statdata attr; /* ro */
240
241 int wd; /* wd for inotify, fd for kqueue */
242} ev_stat;
243#endif
184 244
185/* invoked when the nothing else needs to be done, keeps the process from blocking */ 245/* invoked when the nothing else needs to be done, keeps the process from blocking */
186/* revent EV_IDLE */ 246/* revent EV_IDLE */
187typedef struct ev_idle 247typedef struct ev_idle
188{ 248{
… …
202typedef struct ev_check 262typedef struct ev_check
203{ 263{
204 EV_WATCHER (ev_check) 264 EV_WATCHER (ev_check)
205} ev_check; 265} ev_check;
206 266
207/* invoked when sigchld is received and waitpid indicates the given pid */ 267#if EV_FORK_ENABLE
208/* revent EV_CHILD */ 268/* the callback gets invoked before check in the child process when a fork was detected */
209/* does not support priorities */
210typedef struct ev_child 269typedef struct ev_fork
211{ 270{
212 EV_WATCHER_LIST (ev_child) 271 EV_WATCHER (ev_fork)
272} ev_fork;
273#endif
213 274
214 int pid; /* ro */ 275#if EV_EMBED_ENABLE
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 */ 276/* used to embed an event loop inside another */
221/* the callback gets invoked when the event loop has handled events, and can be 0 */ 277/* the callback gets invoked when the event loop has handled events, and can be 0 */
222typedef struct ev_embed 278typedef struct ev_embed
223{ 279{
224 EV_WATCHER (ev_embed) 280 EV_WATCHER (ev_embed)
… …
235 struct ev_watcher_list wl; 291 struct ev_watcher_list wl;
236 292
237 struct ev_io io; 293 struct ev_io io;
238 struct ev_timer timer; 294 struct ev_timer timer;
239 struct ev_periodic periodic; 295 struct ev_periodic periodic;
296 struct ev_signal signal;
297 struct ev_child child;
298#if EV_STAT_ENABLE
299 struct ev_stat stat;
300#endif
240 struct ev_idle idle; 301 struct ev_idle idle;
241 struct ev_prepare prepare; 302 struct ev_prepare prepare;
242 struct ev_check check; 303 struct ev_check check;
243 struct ev_signal signal; 304#if EV_FORK_ENABLE
244 struct ev_child child; 305 struct ev_fork fork;
245#if EV_MULTIPLICITY 306#endif
307#if EV_EMBED_ENABLE
246 struct ev_embed embed; 308 struct ev_embed embed;
247#endif 309#endif
248}; 310};
249 311
250/* bits for ev_default_loop and ev_loop_new */ 312/* bits for ev_default_loop and ev_loop_new */
… …
274 * It is used to allocate and free memory. 336 * It is used to allocate and free memory.
275 * If it returns zero when memory needs to be allocated, the library might abort 337 * If it returns zero when memory needs to be allocated, the library might abort
276 * or take some potentially destructive action. 338 * or take some potentially destructive action.
277 * The default is your system realloc function. 339 * The default is your system realloc function.
278 */ 340 */
279void ev_set_allocator (void *(*cb)(void *ptr, long size)); 341void ev_set_allocator (void *(*cb)(void *ptr, size_t size));
280 342
281/* set the callback function to call on a 343/* set the callback function to call on a
282 * retryable syscall error 344 * retryable syscall error
283 * (such as failed select, poll, epoll_wait) 345 * (such as failed select, poll, epoll_wait)
284 */ 346 */
… …
363 425
364#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 426#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
365#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 427#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
366#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 428#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
367#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 429#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
430#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
431#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
368#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 432#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
369#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 433#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
370#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 434#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
371#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
372#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0) 435#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0)
436#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
373 437
374#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 438#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
375#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 439#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
376#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 440#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
377#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 441#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
442#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
443#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0)
378#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 444#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
379#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 445#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
380#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 446#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
381#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
382#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0) 447#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0)
448#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
383 449
384#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 450#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
385#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 451#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
386 452
387#define ev_priority(ev) ((ev_watcher *)(void *)(ev))->priority /* rw */ 453#define ev_priority(ev) ((ev_watcher *)(void *)(ev))->priority /* rw */
… …
408void ev_timer_start (EV_P_ ev_timer *w); 474void ev_timer_start (EV_P_ ev_timer *w);
409void ev_timer_stop (EV_P_ ev_timer *w); 475void ev_timer_stop (EV_P_ ev_timer *w);
410/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 476/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
411void ev_timer_again (EV_P_ ev_timer *w); 477void ev_timer_again (EV_P_ ev_timer *w);
412 478
413#if EV_PERIODICS 479#if EV_PERIODIC_ENABLE
414void ev_periodic_start (EV_P_ ev_periodic *w); 480void ev_periodic_start (EV_P_ ev_periodic *w);
415void ev_periodic_stop (EV_P_ ev_periodic *w); 481void ev_periodic_stop (EV_P_ ev_periodic *w);
416void ev_periodic_again (EV_P_ ev_periodic *w); 482void ev_periodic_again (EV_P_ ev_periodic *w);
417#endif 483#endif
418 484
419void ev_idle_start (EV_P_ ev_idle *w);
420void ev_idle_stop (EV_P_ ev_idle *w);
421
422void ev_prepare_start (EV_P_ ev_prepare *w);
423void ev_prepare_stop (EV_P_ ev_prepare *w);
424
425void ev_check_start (EV_P_ ev_check *w);
426void ev_check_stop (EV_P_ ev_check *w);
427
428/* only supported in the default loop */ 485/* only supported in the default loop */
429void ev_signal_start (EV_P_ ev_signal *w); 486void ev_signal_start (EV_P_ ev_signal *w);
430void ev_signal_stop (EV_P_ ev_signal *w); 487void ev_signal_stop (EV_P_ ev_signal *w);
431 488
432/* only supported in the default loop */ 489/* only supported in the default loop */
433void ev_child_start (EV_P_ ev_child *w); 490void ev_child_start (EV_P_ ev_child *w);
434void ev_child_stop (EV_P_ ev_child *w); 491void ev_child_stop (EV_P_ ev_child *w);
435 492
436# if EV_MULTIPLICITY 493# if EV_STAT_ENABLE
494void ev_stat_start (EV_P_ ev_stat *w);
495void ev_stat_stop (EV_P_ ev_stat *w);
496void ev_stat_stat (EV_P_ ev_stat *w);
497# endif
498
499void ev_idle_start (EV_P_ ev_idle *w);
500void ev_idle_stop (EV_P_ ev_idle *w);
501
502void ev_prepare_start (EV_P_ ev_prepare *w);
503void ev_prepare_stop (EV_P_ ev_prepare *w);
504
505void ev_check_start (EV_P_ ev_check *w);
506void ev_check_stop (EV_P_ ev_check *w);
507
508# if EV_FORK_ENABLE
509void ev_fork_start (EV_P_ ev_fork *w);
510void ev_fork_stop (EV_P_ ev_fork *w);
511# endif
512
513# if EV_EMBED_ENABLE
437/* only supported when loop to be embedded is in fact embeddable */ 514/* only supported when loop to be embedded is in fact embeddable */
438void ev_embed_start (EV_P_ ev_embed *w); 515void ev_embed_start (EV_P_ ev_embed *w);
439void ev_embed_stop (EV_P_ ev_embed *w); 516void ev_embed_stop (EV_P_ ev_embed *w);
440void ev_embed_loop (EV_P_ ev_embed *w); 517void ev_embed_sweep (EV_P_ ev_embed *w);
441# endif 518# endif
442 519
443#endif 520#endif
444 521
445#ifdef __cplusplus 522#ifdef __cplusplus

Diff Legend

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