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

Comparing libev/ev.h (file contents):
Revision 1.97 by root, Wed Apr 9 14:39:28 2008 UTC vs.
Revision 1.113 by root, Wed Apr 15 17:49:27 2009 UTC

1/* 1/*
2 * libev native API header 2 * libev native API header
3 * 3 *
4 * Copyright (c) 2007,2008 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008,2009 Marc Alexander Lehmann <libev@schmorp.de>
5 * All rights reserved. 5 * All rights reserved.
6 * 6 *
7 * Redistribution and use in source and binary forms, with or without modifica- 7 * Redistribution and use in source and binary forms, with or without modifica-
8 * tion, are permitted provided that the following conditions are met: 8 * tion, are permitted provided that the following conditions are met:
9 * 9 *
… …
88#endif 88#endif
89 89
90/*****************************************************************************/ 90/*****************************************************************************/
91 91
92#if EV_STAT_ENABLE 92#if EV_STAT_ENABLE
93# ifdef _WIN32
94# include <time.h>
95# include <sys/types.h>
96# endif
93# include <sys/stat.h> 97# include <sys/stat.h>
94#endif 98#endif
95 99
96/* support multiple event loops? */ 100/* support multiple event loops? */
97#if EV_MULTIPLICITY 101#if EV_MULTIPLICITY
… …
123#endif 127#endif
124 128
125/*****************************************************************************/ 129/*****************************************************************************/
126 130
127/* eventmask, revents, events... */ 131/* eventmask, revents, events... */
128#define EV_UNDEF -1L /* guaranteed to be invalid */ 132#define EV_UNDEF -1 /* guaranteed to be invalid */
129#define EV_NONE 0x00L /* no events */ 133#define EV_NONE 0x00 /* no events */
130#define EV_READ 0x01L /* ev_io detected read will not block */ 134#define EV_READ 0x01 /* ev_io detected read will not block */
131#define EV_WRITE 0x02L /* ev_io detected write will not block */ 135#define EV_WRITE 0x02 /* ev_io detected write will not block */
132#define EV_IOFDSET 0x80L /* internal use only */ 136#define EV__IOFDSET 0x80 /* internal use only */
137#define EV_IO EV_READ /* alias for type-detection */
133#define EV_TIMEOUT 0x00000100L /* timer timed out */ 138#define EV_TIMEOUT 0x00000100 /* timer timed out */
139#define EV_TIMER EV_TIMEOUT /* alias for type-detection */
134#define EV_PERIODIC 0x00000200L /* periodic timer timed out */ 140#define EV_PERIODIC 0x00000200 /* periodic timer timed out */
135#define EV_SIGNAL 0x00000400L /* signal was received */ 141#define EV_SIGNAL 0x00000400 /* signal was received */
136#define EV_CHILD 0x00000800L /* child/pid had status change */ 142#define EV_CHILD 0x00000800 /* child/pid had status change */
137#define EV_STAT 0x00001000L /* stat data changed */ 143#define EV_STAT 0x00001000 /* stat data changed */
138#define EV_IDLE 0x00002000L /* event loop is idling */ 144#define EV_IDLE 0x00002000 /* event loop is idling */
139#define EV_PREPARE 0x00004000L /* event loop about to poll */ 145#define EV_PREPARE 0x00004000 /* event loop about to poll */
140#define EV_CHECK 0x00008000L /* event loop finished poll */ 146#define EV_CHECK 0x00008000 /* event loop finished poll */
141#define EV_EMBED 0x00010000L /* embedded event loop needs sweep */ 147#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
142#define EV_FORK 0x00020000L /* event loop resumed in child */ 148#define EV_FORK 0x00020000 /* event loop resumed in child */
143#define EV_ASYNC 0x00040000L /* async intra-loop signal */ 149#define EV_ASYNC 0x00040000 /* async intra-loop signal */
150#define EV_CUSTOM 0x01000000 /* for use by user code */
144#define EV_ERROR 0x80000000L /* sent when an error occurs */ 151#define EV_ERROR 0x80000000 /* sent when an error occurs */
145 152
146/* can be used to add custom fields to all watchers, while losing binary compatibility */ 153/* can be used to add custom fields to all watchers, while losing binary compatibility */
147#ifndef EV_COMMON 154#ifndef EV_COMMON
148# define EV_COMMON void *data; 155# define EV_COMMON void *data;
149#endif 156#endif
… …
161# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) 168# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
162#endif 169#endif
163 170
164/* 171/*
165 * struct member types: 172 * struct member types:
166 * private: you can look at them, but not change them, and they might not mean anything to you. 173 * private: you may look at them, but not change them,
174 * and they might not mean anything to you.
167 * ro: can be read anytime, but only changed when the watcher isn't active 175 * ro: can be read anytime, but only changed when the watcher isn't active.
168 * rw: can be read and modified anytime, even when the watcher is active 176 * rw: can be read and modified anytime, even when the watcher is active.
177 *
178 * some internal details that might be helpful for debugging:
179 *
180 * active is either 0, which means the watcher is not active,
181 * or the array index of the watcher (periodics, timers)
182 * or the array index + 1 (most other watchers)
183 * or simply 1 for watchers that aren't in some array.
184 * pending is either 0, in which case the watcher isn't,
185 * or the array index + 1 in the pendings array.
169 */ 186 */
170 187
171/* shared by all watchers */ 188/* shared by all watchers */
172#define EV_WATCHER(type) \ 189#define EV_WATCHER(type) \
173 int active; /* private */ \ 190 int active; /* private */ \
… …
322 ev_prepare prepare; /* private */ 339 ev_prepare prepare; /* private */
323 ev_check check; /* unused */ 340 ev_check check; /* unused */
324 ev_timer timer; /* unused */ 341 ev_timer timer; /* unused */
325 ev_periodic periodic; /* unused */ 342 ev_periodic periodic; /* unused */
326 ev_idle idle; /* unused */ 343 ev_idle idle; /* unused */
327 ev_fork fork; /* unused */ 344 ev_fork fork; /* private */
328} ev_embed; 345} ev_embed;
329#endif 346#endif
330 347
331#if EV_ASYNC_ENABLE 348#if EV_ASYNC_ENABLE
332/* invoked when somebody calls ev_async_send on the watcher */ 349/* invoked when somebody calls ev_async_send on the watcher */
… …
336 EV_WATCHER (ev_async) 353 EV_WATCHER (ev_async)
337 354
338 EV_ATOMIC_T sent; /* private */ 355 EV_ATOMIC_T sent; /* private */
339} ev_async; 356} ev_async;
340 357
341# define ev_async_pending(w) (((w)->sent + 0) 358# define ev_async_pending(w) ((w)->sent + 0)
342#endif 359#endif
343 360
344/* the presence of this union forces similar struct layout */ 361/* the presence of this union forces similar struct layout */
345union ev_any_watcher 362union ev_any_watcher
346{ 363{
… …
371#endif 388#endif
372}; 389};
373 390
374/* bits for ev_default_loop and ev_loop_new */ 391/* bits for ev_default_loop and ev_loop_new */
375/* the default */ 392/* the default */
376#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */ 393#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
377/* flag bits */ 394/* flag bits */
378#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */ 395#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
379#define EVFLAG_FORKCHECK 0x02000000UL /* check for a fork in each iteration */ 396#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
380/* method bits to be ored together */ 397/* method bits to be ored together */
381#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */ 398#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
382#define EVBACKEND_POLL 0x00000002UL /* !win */ 399#define EVBACKEND_POLL 0x00000002U /* !win */
383#define EVBACKEND_EPOLL 0x00000004UL /* linux */ 400#define EVBACKEND_EPOLL 0x00000004U /* linux */
384#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */ 401#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
385#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */ 402#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
386#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */ 403#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
387 404
388#if EV_PROTOTYPES 405#if EV_PROTOTYPES
389int ev_version_major (void); 406int ev_version_major (void);
390int ev_version_minor (void); 407int ev_version_minor (void);
391 408
… …
408 * retryable syscall error 425 * retryable syscall error
409 * (such as failed select, poll, epoll_wait) 426 * (such as failed select, poll, epoll_wait)
410 */ 427 */
411void ev_set_syserr_cb (void (*cb)(const char *msg)); 428void ev_set_syserr_cb (void (*cb)(const char *msg));
412 429
413# if EV_MULTIPLICITY 430#if EV_MULTIPLICITY
414EV_INLINE struct ev_loop * 431EV_INLINE struct ev_loop *
415ev_default_loop_uc (void) 432ev_default_loop_uc (void)
416{ 433{
417 extern struct ev_loop *ev_default_loop_ptr; 434 extern struct ev_loop *ev_default_loop_ptr;
418 435
… …
438 455
439/* create and destroy alternative loops that don't handle signals */ 456/* create and destroy alternative loops that don't handle signals */
440struct ev_loop *ev_loop_new (unsigned int flags); 457struct ev_loop *ev_loop_new (unsigned int flags);
441void ev_loop_destroy (EV_P); 458void ev_loop_destroy (EV_P);
442void ev_loop_fork (EV_P); 459void ev_loop_fork (EV_P);
460void ev_loop_verify (EV_P);
443 461
444ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 462ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
463void ev_now_update (EV_P);
445 464
446# else 465#else
447 466
448int ev_default_loop (unsigned int flags); /* returns true when successful */ 467int ev_default_loop (unsigned int flags); /* returns true when successful */
449 468
450EV_INLINE ev_tstamp 469EV_INLINE ev_tstamp
451ev_now (void) 470ev_now (void)
452{ 471{
453 extern ev_tstamp ev_rt_now; 472 extern ev_tstamp ev_rt_now;
454 473
455 return ev_rt_now; 474 return ev_rt_now;
456} 475}
457# endif 476#endif /* multiplicity */
458 477
459EV_INLINE int 478EV_INLINE int
460ev_is_default_loop (EV_P) 479ev_is_default_loop (EV_P)
461{ 480{
462#if EV_MULTIPLICITY 481#if EV_MULTIPLICITY
… …
473/* if you create alternative loops you have to call ev_loop_fork on them */ 492/* if you create alternative loops you have to call ev_loop_fork on them */
474/* you can call it in either the parent or the child */ 493/* you can call it in either the parent or the child */
475/* you can actually call it at any time, anywhere :) */ 494/* you can actually call it at any time, anywhere :) */
476void ev_default_fork (void); 495void ev_default_fork (void);
477 496
497#if 0
498/* walk (almost) all watchers in the loop of a given type, invoking the */
499/* callback on every such watcher. The callback might stop the watcher, */
500/* but do nothing else with the loop */
501void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
502#endif
503
478unsigned int ev_backend (EV_P); /* backend in use by loop */ 504unsigned int ev_backend (EV_P); /* backend in use by loop */
479unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 505unsigned int ev_loop_count (EV_P); /* number of loop iterations */
480#endif 506#endif /* prototypes */
481 507
482#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 508#define EVLOOP_NONBLOCK 1 /* do not block/wait */
483#define EVLOOP_ONESHOT 2 /* block *once* only */ 509#define EVLOOP_ONESHOT 2 /* block *once* only */
484#define EVUNLOOP_CANCEL 0 /* undo unloop */ 510#define EVUNLOOP_CANCEL 0 /* undo unloop */
485#define EVUNLOOP_ONE 1 /* unloop once */ 511#define EVUNLOOP_ONE 1 /* unloop once */
… …
498 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 524 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
499 */ 525 */
500void ev_ref (EV_P); 526void ev_ref (EV_P);
501void ev_unref (EV_P); 527void ev_unref (EV_P);
502 528
503/* convinience function, wait for a single event, without registering an event watcher */ 529/* convenience function, wait for a single event, without registering an event watcher */
504/* if timeout is < 0, do wait indefinitely */ 530/* if timeout is < 0, do wait indefinitely */
505void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 531void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
506#endif 532#endif
507 533
508/* these may evaluate ev multiple times, and the other arguments at most once */ 534/* these may evaluate ev multiple times, and the other arguments at most once */
… …
512 ((ev_watcher *)(void *)(ev))->pending = \ 538 ((ev_watcher *)(void *)(ev))->pending = \
513 ((ev_watcher *)(void *)(ev))->priority = 0; \ 539 ((ev_watcher *)(void *)(ev))->priority = 0; \
514 ev_set_cb ((ev), cb_); \ 540 ev_set_cb ((ev), cb_); \
515} while (0) 541} while (0)
516 542
517#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0) 543#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
518#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 544#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
519#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 545#define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0)
520#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 546#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
521#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0) 547#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
522#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0) 548#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
523#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 549#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
524#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 550#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
525#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 551#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
526#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 552#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
527#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 553#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
528#define ev_async_set(ev) do { (ev)->sent = 0; } while (0) 554#define ev_async_set(ev) do { (ev)->sent = 0; } while (0)
529 555
530#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 556#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
531#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 557#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
532#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 558#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
533#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 559#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
534#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0) 560#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
535#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0) 561#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
536#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 562#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
537#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 563#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
538#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 564#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
539#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) 565#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
540#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 566#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
541#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 567#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
542 568
543#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 569#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
544#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 570#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
545 571
546#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) 572#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
547#define ev_cb(ev) (ev)->cb /* rw */ 573#define ev_cb(ev) (ev)->cb /* rw */
548#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) 574#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri)
575
576#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)
549 577
550#ifndef ev_set_cb 578#ifndef ev_set_cb
551# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 579# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
552#endif 580#endif
553 581
554/* stopping (enabling, adding) a watcher does nothing if it is already running */ 582/* stopping (enabling, adding) a watcher does nothing if it is already running */
555/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 583/* stopping (disabling, deleting) a watcher does nothing unless its already running */
556#if EV_PROTOTYPES 584#if EV_PROTOTYPES

Diff Legend

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