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

Comparing libev/ev.h (file contents):
Revision 1.71 by root, Tue Nov 27 09:17:52 2007 UTC vs.
Revision 1.85 by root, Fri Dec 14 21:07:13 2007 UTC

54 54
55#ifndef EV_STAT_ENABLE 55#ifndef EV_STAT_ENABLE
56# define EV_STAT_ENABLE 1 56# define EV_STAT_ENABLE 1
57#endif 57#endif
58 58
59#ifndef EV_IDLE_ENABLE
60# define EV_IDLE_ENABLE 1
61#endif
62
63#ifndef EV_FORK_ENABLE
64# define EV_FORK_ENABLE 1
65#endif
66
59#ifndef EV_EMBED_ENABLE 67#ifndef EV_EMBED_ENABLE
60# define EV_EMBED_ENABLE 1 68# define EV_EMBED_ENABLE 1
61#endif 69#endif
62 70
63/*****************************************************************************/ 71/*****************************************************************************/
71struct ev_loop; 79struct ev_loop;
72# define EV_P struct ev_loop *loop 80# define EV_P struct ev_loop *loop
73# define EV_P_ EV_P, 81# define EV_P_ EV_P,
74# define EV_A loop 82# define EV_A loop
75# define EV_A_ EV_A, 83# define EV_A_ EV_A,
76# define EV_DEFAULT_A ev_default_loop (0) 84# define EV_DEFAULT ev_default_loop (0)
77# define EV_DEFAULT_A_ EV_DEFAULT_A, 85# define EV_DEFAULT_ EV_DEFAULT,
78#else 86#else
79# define EV_P void 87# define EV_P void
80# define EV_P_ 88# define EV_P_
81# define EV_A 89# define EV_A
82# define EV_A_ 90# define EV_A_
91# define EV_DEFAULT
83# define EV_DEFAULT_A 92# define EV_DEFAULT_
84# define EV_DEFAULT_A_
85 93
86# undef EV_EMBED_ENABLE 94# undef EV_EMBED_ENABLE
87#endif 95#endif
88 96
89/* eventmask, revents, events... */ 97/* eventmask, revents, events... */
90#define EV_UNDEF -1L /* guaranteed to be invalid */ 98#define EV_UNDEF -1L /* guaranteed to be invalid */
91#define EV_NONE 0x00L /* no events */ 99#define EV_NONE 0x00L /* no events */
92#define EV_READ 0x01L /* ev_io detected read will not block */ 100#define EV_READ 0x01L /* ev_io detected read will not block */
93#define EV_WRITE 0x02L /* ev_io detected write will not block */ 101#define EV_WRITE 0x02L /* ev_io detected write will not block */
102#define EV_IOFDSET 0x80L /* internal use only */
94#define EV_TIMEOUT 0x00000100L /* timer timed out */ 103#define EV_TIMEOUT 0x00000100L /* timer timed out */
95#define EV_PERIODIC 0x00000200L /* periodic timer timed out */ 104#define EV_PERIODIC 0x00000200L /* periodic timer timed out */
96#define EV_SIGNAL 0x00000400L /* signal was received */ 105#define EV_SIGNAL 0x00000400L /* signal was received */
97#define EV_IDLE 0x00000800L /* event loop is idling */
98#define EV_PREPARE 0x00001000L /* event loop about to poll */
99#define EV_CHECK 0x00002000L /* event loop finished poll */
100#define EV_CHILD 0x00004000L /* child/pid had status change */ 106#define EV_CHILD 0x00000800L /* child/pid had status change */
107#define EV_STAT 0x00001000L /* stat data changed */
108#define EV_IDLE 0x00002000L /* event loop is idling */
109#define EV_PREPARE 0x00004000L /* event loop about to poll */
110#define EV_CHECK 0x00008000L /* event loop finished poll */
101#define EV_EMBED 0x00008000L /* embedded event loop needs sweep */ 111#define EV_EMBED 0x00010000L /* embedded event loop needs sweep */
102#define EV_STAT 0x00010000L /* stat data changed */ 112#define EV_FORK 0x00020000L /* event loop resumed in child */
103#define EV_ERROR 0x80000000L /* sent when an error occurs */ 113#define EV_ERROR 0x80000000L /* sent when an error occurs */
104 114
105/* can be used to add custom fields to all watchers, while losing binary compatibility */ 115/* can be used to add custom fields to all watchers, while losing binary compatibility */
106#ifndef EV_COMMON 116#ifndef EV_COMMON
107# define EV_COMMON void *data; 117# define EV_COMMON void *data;
109#ifndef EV_PROTOTYPES 119#ifndef EV_PROTOTYPES
110# define EV_PROTOTYPES 1 120# define EV_PROTOTYPES 1
111#endif 121#endif
112 122
113#define EV_VERSION_MAJOR 1 123#define EV_VERSION_MAJOR 1
114#define EV_VERSION_MINOR 1 124#define EV_VERSION_MINOR 0
115 125
116#ifndef EV_CB_DECLARE 126#ifndef EV_CB_DECLARE
117# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 127# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
118#endif 128#endif
119#ifndef EV_CB_INVOKE 129#ifndef EV_CB_INVOKE
184/* revent EV_PERIODIC */ 194/* revent EV_PERIODIC */
185typedef struct ev_periodic 195typedef struct ev_periodic
186{ 196{
187 EV_WATCHER_TIME (ev_periodic) 197 EV_WATCHER_TIME (ev_periodic)
188 198
199 ev_tstamp offset; /* rw */
189 ev_tstamp interval; /* rw */ 200 ev_tstamp interval; /* rw */
190 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 201 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
191} ev_periodic; 202} ev_periodic;
192 203
193/* invoked when the given signal has been received */ 204/* invoked when the given signal has been received */
211 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 222 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
212} ev_child; 223} ev_child;
213 224
214#if EV_STAT_ENABLE 225#if EV_STAT_ENABLE
215/* st_nlink = 0 means missing file or other error */ 226/* st_nlink = 0 means missing file or other error */
216#ifdef _WIN32 227# ifdef _WIN32
217typedef struct _stati64 ev_statdata; 228typedef struct _stati64 ev_statdata;
218#else 229# else
219typedef struct stat ev_statdata; 230typedef struct stat ev_statdata;
220#endif 231# endif
221 232
222/* invoked each time the stat data changes for a given path */ 233/* invoked each time the stat data changes for a given path */
223/* revent EV_STAT */ 234/* revent EV_STAT */
224typedef struct ev_stat 235typedef struct ev_stat
225{ 236{
226 EV_WATCHER (ev_stat) 237 EV_WATCHER_LIST (ev_stat)
227 238
228 ev_timer timer; /* private */ 239 ev_timer timer; /* private */
229 ev_tstamp interval; /* ro */ 240 ev_tstamp interval; /* ro */
230 const char *path; /* ro */ 241 const char *path; /* ro */
231 ev_statdata prev; /* ro */ 242 ev_statdata prev; /* ro */
232 ev_statdata attr; /* ro */ 243 ev_statdata attr; /* ro */
244
245 int wd; /* wd for inotify, fd for kqueue */
233} ev_stat; 246} ev_stat;
234#endif 247#endif
235 248
249#if EV_IDLE_ENABLE
236/* invoked when the nothing else needs to be done, keeps the process from blocking */ 250/* invoked when the nothing else needs to be done, keeps the process from blocking */
237/* revent EV_IDLE */ 251/* revent EV_IDLE */
238typedef struct ev_idle 252typedef struct ev_idle
239{ 253{
240 EV_WATCHER (ev_idle) 254 EV_WATCHER (ev_idle)
241} ev_idle; 255} ev_idle;
256#endif
242 257
243/* invoked for each run of the mainloop, just before the blocking call */ 258/* invoked for each run of the mainloop, just before the blocking call */
244/* you can still change events in any way you like */ 259/* you can still change events in any way you like */
245/* revent EV_PREPARE */ 260/* revent EV_PREPARE */
246typedef struct ev_prepare 261typedef struct ev_prepare
253typedef struct ev_check 268typedef struct ev_check
254{ 269{
255 EV_WATCHER (ev_check) 270 EV_WATCHER (ev_check)
256} ev_check; 271} ev_check;
257 272
273#if EV_FORK_ENABLE
274/* the callback gets invoked before check in the child process when a fork was detected */
275typedef struct ev_fork
276{
277 EV_WATCHER (ev_fork)
278} ev_fork;
279#endif
280
258#if EV_EMBED_ENABLE 281#if EV_EMBED_ENABLE
259/* used to embed an event loop inside another */ 282/* used to embed an event loop inside another */
260/* the callback gets invoked when the event loop has handled events, and can be 0 */ 283/* the callback gets invoked when the event loop has handled events, and can be 0 */
261typedef struct ev_embed 284typedef struct ev_embed
262{ 285{
274 struct ev_watcher_list wl; 297 struct ev_watcher_list wl;
275 298
276 struct ev_io io; 299 struct ev_io io;
277 struct ev_timer timer; 300 struct ev_timer timer;
278 struct ev_periodic periodic; 301 struct ev_periodic periodic;
302 struct ev_signal signal;
279 struct ev_child child; 303 struct ev_child child;
280#if EV_STAT_ENABLE 304#if EV_STAT_ENABLE
281 struct ev_stat stat; 305 struct ev_stat stat;
282#endif 306#endif
307#if EV_IDLE_ENABLE
283 struct ev_idle idle; 308 struct ev_idle idle;
309#endif
284 struct ev_prepare prepare; 310 struct ev_prepare prepare;
285 struct ev_check check; 311 struct ev_check check;
286 struct ev_signal signal; 312#if EV_FORK_ENABLE
313 struct ev_fork fork;
314#endif
287#if EV_EMBED_ENABLE 315#if EV_EMBED_ENABLE
288 struct ev_embed embed; 316 struct ev_embed embed;
289#endif 317#endif
290}; 318};
291 319
292/* bits for ev_default_loop and ev_loop_new */ 320/* bits for ev_default_loop and ev_loop_new */
293/* the default */ 321/* the default */
294#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */ 322#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */
295/* flag bits */ 323/* flag bits */
296#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */ 324#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */
325#define EVFLAG_FORKCHECK 0x02000000UL /* check for a fork in each iteration */
297/* method bits to be ored together */ 326/* method bits to be ored together */
298#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */ 327#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */
299#define EVBACKEND_POLL 0x00000002UL /* !win */ 328#define EVBACKEND_POLL 0x00000002UL /* !win */
300#define EVBACKEND_EPOLL 0x00000004UL /* linux */ 329#define EVBACKEND_EPOLL 0x00000004UL /* linux */
301#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */ 330#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */
367/* you can call it in either the parent or the child */ 396/* you can call it in either the parent or the child */
368/* you can actually call it at any time, anywhere :) */ 397/* you can actually call it at any time, anywhere :) */
369void ev_default_fork (void); 398void ev_default_fork (void);
370 399
371unsigned int ev_backend (EV_P); 400unsigned int ev_backend (EV_P);
401unsigned int ev_loop_count (EV_P);
372#endif 402#endif
373 403
374#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 404#define EVLOOP_NONBLOCK 1 /* do not block/wait */
375#define EVLOOP_ONESHOT 2 /* block *once* only */ 405#define EVLOOP_ONESHOT 2 /* block *once* only */
376#define EVUNLOOP_CANCEL 0 /* undo unloop */ 406#define EVUNLOOP_CANCEL 0 /* undo unloop */
394void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 424void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
395#endif 425#endif
396 426
397/* these may evaluate ev multiple times, and the other arguments at most once */ 427/* these may evaluate ev multiple times, and the other arguments at most once */
398/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 428/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
399#define ev_init(ev,cb_) do { \ 429#define ev_init(ev,cb_) do { \
400 ((ev_watcher *)(void *)(ev))->active = \ 430 ((ev_watcher *)(void *)(ev))->active = \
401 ((ev_watcher *)(void *)(ev))->pending = \ 431 ((ev_watcher *)(void *)(ev))->pending = \
402 ((ev_watcher *)(void *)(ev))->priority = 0; \ 432 ((ev_watcher *)(void *)(ev))->priority = 0; \
403 ev_set_cb ((ev), cb_); \ 433 ev_set_cb ((ev), cb_); \
404} while (0) 434} while (0)
405 435
406#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 436#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0)
407#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 437#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
408#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 438#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
409#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 439#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
410#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 440#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
411#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); } while (0) 441#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
412#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 442#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
413#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 443#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
414#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 444#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
415#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0) 445#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0)
446#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
416 447
417#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 448#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
418#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 449#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
419#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 450#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
420#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 451#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
422#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0) 453#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0)
423#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 454#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
424#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 455#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
425#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 456#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
426#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0) 457#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0)
458#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
427 459
428#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 460#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
429#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 461#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
430 462
431#define ev_priority(ev) ((ev_watcher *)(void *)(ev))->priority /* rw */ 463#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
432#define ev_cb(ev) (ev)->cb /* rw */ 464#define ev_cb(ev) (ev)->cb /* rw */
433#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) 465#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri)
434 466
435#ifndef ev_set_cb 467#ifndef ev_set_cb
436# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 468# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
437#endif 469#endif
438 470
443/* feeds an event into a watcher as if the event actually occured */ 475/* feeds an event into a watcher as if the event actually occured */
444/* accepts any ev_watcher type */ 476/* accepts any ev_watcher type */
445void ev_feed_event (EV_P_ void *w, int revents); 477void ev_feed_event (EV_P_ void *w, int revents);
446void ev_feed_fd_event (EV_P_ int fd, int revents); 478void ev_feed_fd_event (EV_P_ int fd, int revents);
447void ev_feed_signal_event (EV_P_ int signum); 479void ev_feed_signal_event (EV_P_ int signum);
480void ev_invoke (EV_P_ void *w, int revents);
481int ev_clear_pending (EV_P_ void *w);
448 482
449void ev_io_start (EV_P_ ev_io *w); 483void ev_io_start (EV_P_ ev_io *w);
450void ev_io_stop (EV_P_ ev_io *w); 484void ev_io_stop (EV_P_ ev_io *w);
451 485
452void ev_timer_start (EV_P_ ev_timer *w); 486void ev_timer_start (EV_P_ ev_timer *w);
472void ev_stat_start (EV_P_ ev_stat *w); 506void ev_stat_start (EV_P_ ev_stat *w);
473void ev_stat_stop (EV_P_ ev_stat *w); 507void ev_stat_stop (EV_P_ ev_stat *w);
474void ev_stat_stat (EV_P_ ev_stat *w); 508void ev_stat_stat (EV_P_ ev_stat *w);
475# endif 509# endif
476 510
511# if EV_IDLE_ENABLE
477void ev_idle_start (EV_P_ ev_idle *w); 512void ev_idle_start (EV_P_ ev_idle *w);
478void ev_idle_stop (EV_P_ ev_idle *w); 513void ev_idle_stop (EV_P_ ev_idle *w);
514# endif
479 515
480void ev_prepare_start (EV_P_ ev_prepare *w); 516void ev_prepare_start (EV_P_ ev_prepare *w);
481void ev_prepare_stop (EV_P_ ev_prepare *w); 517void ev_prepare_stop (EV_P_ ev_prepare *w);
482 518
483void ev_check_start (EV_P_ ev_check *w); 519void ev_check_start (EV_P_ ev_check *w);
484void ev_check_stop (EV_P_ ev_check *w); 520void ev_check_stop (EV_P_ ev_check *w);
521
522# if EV_FORK_ENABLE
523void ev_fork_start (EV_P_ ev_fork *w);
524void ev_fork_stop (EV_P_ ev_fork *w);
525# endif
485 526
486# if EV_EMBED_ENABLE 527# if EV_EMBED_ENABLE
487/* only supported when loop to be embedded is in fact embeddable */ 528/* only supported when loop to be embedded is in fact embeddable */
488void ev_embed_start (EV_P_ ev_embed *w); 529void ev_embed_start (EV_P_ ev_embed *w);
489void ev_embed_stop (EV_P_ ev_embed *w); 530void ev_embed_stop (EV_P_ ev_embed *w);

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines