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

Comparing libev/ev.h (file contents):
Revision 1.118 by root, Thu Jul 9 09:11:20 2009 UTC vs.
Revision 1.128 by root, Tue Oct 20 00:50:31 2009 UTC

… …
35 * and other provisions required by the GPL. If you do not delete the 35 * and other provisions required by the GPL. If you do not delete the
36 * provisions above, a recipient may use your version of this file under 36 * provisions above, a recipient may use your version of this file under
37 * either the BSD or the GPL. 37 * either the BSD or the GPL.
38 */ 38 */
39 39
40#ifndef EV_H__ 40#ifndef EV_H_
41#define EV_H__ 41#define EV_H_
42 42
43#ifdef __cplusplus 43#ifdef __cplusplus
44extern "C" { 44extern "C" {
45#endif 45#endif
46 46
… …
161#ifndef EV_PROTOTYPES 161#ifndef EV_PROTOTYPES
162# define EV_PROTOTYPES 1 162# define EV_PROTOTYPES 1
163#endif 163#endif
164 164
165#define EV_VERSION_MAJOR 3 165#define EV_VERSION_MAJOR 3
166#define EV_VERSION_MINOR 0 166#define EV_VERSION_MINOR 8
167 167
168#ifndef EV_CB_DECLARE 168#ifndef EV_CB_DECLARE
169# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 169# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
170#endif 170#endif
171#ifndef EV_CB_INVOKE 171#ifndef EV_CB_INVOKE
… …
363 EV_WATCHER (ev_async) 363 EV_WATCHER (ev_async)
364 364
365 EV_ATOMIC_T sent; /* private */ 365 EV_ATOMIC_T sent; /* private */
366} ev_async; 366} ev_async;
367 367
368# define ev_async_pending(w) ((w)->sent + 0) 368# define ev_async_pending(w) (+(w)->sent)
369#endif 369#endif
370 370
371/* the presence of this union forces similar struct layout */ 371/* the presence of this union forces similar struct layout */
372union ev_any_watcher 372union ev_any_watcher
373{ 373{
… …
402/* the default */ 402/* the default */
403#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 403#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
404/* flag bits */ 404/* flag bits */
405#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 405#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
406#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ 406#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
407/* debugging/feature disable */
408#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */
409#define EVFLAG_NOSIGFD 0x00200000U /* do not attempt to use signalfd */
407/* method bits to be ored together */ 410/* method bits to be ored together */
408#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 411#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
409#define EVBACKEND_POLL 0x00000002U /* !win */ 412#define EVBACKEND_POLL 0x00000002U /* !win */
410#define EVBACKEND_EPOLL 0x00000004U /* linux */ 413#define EVBACKEND_EPOLL 0x00000004U /* linux */
411#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 414#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
412#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 415#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
413#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 416#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
417#define EVBACKEND_ALL 0x0000003FU
414 418
415#if EV_PROTOTYPES 419#if EV_PROTOTYPES
416int ev_version_major (void); 420int ev_version_major (void);
417int ev_version_minor (void); 421int ev_version_minor (void);
418 422
… …
500/* if you create alternative loops you have to call ev_loop_fork on them */ 504/* if you create alternative loops you have to call ev_loop_fork on them */
501/* you can call it in either the parent or the child */ 505/* you can call it in either the parent or the child */
502/* you can actually call it at any time, anywhere :) */ 506/* you can actually call it at any time, anywhere :) */
503void ev_default_fork (void); 507void ev_default_fork (void);
504 508
505unsigned int ev_backend (EV_P); /* backend in use by loop */ 509unsigned int ev_backend (EV_P); /* backend in use by loop */
506unsigned int ev_loop_count (EV_P); /* number of loop iterations */
507unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
508void ev_loop_verify (EV_P); /* abort if loop data corrupted */
509 510
510void ev_now_update (EV_P); /* update event loop time */ 511void ev_now_update (EV_P); /* update event loop time */
511void ev_invoke_pending (EV_P); /* invoke all pending watchers */
512 512
513#if EV_WALK_ENABLE 513#if EV_WALK_ENABLE
514/* walk (almost) all watchers in the loop of a given type, invoking the */ 514/* walk (almost) all watchers in the loop of a given type, invoking the */
515/* callback on every such watcher. The callback might stop the watcher, */ 515/* callback on every such watcher. The callback might stop the watcher, */
516/* but do nothing else with the loop */ 516/* but do nothing else with the loop */
… …
527 527
528#if EV_PROTOTYPES 528#if EV_PROTOTYPES
529void ev_loop (EV_P_ int flags); 529void ev_loop (EV_P_ int flags);
530void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ 530void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
531 531
532void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
533void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
534
535/* 532/*
536 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 533 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
537 * keeps one reference. if you have a long-runing watcher you never unregister that 534 * keeps one reference. if you have a long-running watcher you never unregister that
538 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 535 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
539 */ 536 */
540void ev_ref (EV_P); 537void ev_ref (EV_P);
541void ev_unref (EV_P); 538void ev_unref (EV_P);
539
540/*
541 * convenience function, wait for a single event, without registering an event watcher
542 * if timeout is < 0, do wait indefinitely
543 */
544void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
545
546# if EV_MINIMAL < 2
547unsigned int ev_loop_count (EV_P); /* number of loop iterations */
548unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
549void ev_loop_verify (EV_P); /* abort if loop data corrupted */
550
551void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
552void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
553
554/* advanced stuff for threading etc. support, see docs */
555void ev_set_userdata (EV_P_ void *data);
556void *ev_userdata (EV_P);
557void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
558void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
559
560unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
561void ev_invoke_pending (EV_P); /* invoke all pending watchers */
542 562
543/* 563/*
544 * stop/start the timer handling. 564 * stop/start the timer handling.
545 */ 565 */
546void ev_suspend (EV_P); 566void ev_suspend (EV_P);
547void ev_resume (EV_P); 567void ev_resume (EV_P);
568#endif
548 569
549/*
550 * convenience function, wait for a single event, without registering an event watcher
551 * if timeout is < 0, do wait indefinitely
552 */
553void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
554#endif 570#endif
555 571
556/* these may evaluate ev multiple times, and the other arguments at most once */ 572/* these may evaluate ev multiple times, and the other arguments at most once */
557/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 573/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
558#define ev_init(ev,cb_) do { \ 574#define ev_init(ev,cb_) do { \
… …
595 611
596#if EV_MINPRI == EV_MAXPRI 612#if EV_MINPRI == EV_MAXPRI
597# define ev_priority(ev) ((ev), EV_MINPRI) 613# define ev_priority(ev) ((ev), EV_MINPRI)
598# define ev_set_priority(ev,pri) ((ev), (pri)) 614# define ev_set_priority(ev,pri) ((ev), (pri))
599#else 615#else
600# define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) 616# define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
601# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri) 617# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
602#endif 618#endif
603 619
604#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 620#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
605 621
606#ifndef ev_set_cb 622#ifndef ev_set_cb
607# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 623# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
608#endif 624#endif
609 625
… …
624 640
625void ev_timer_start (EV_P_ ev_timer *w); 641void ev_timer_start (EV_P_ ev_timer *w);
626void ev_timer_stop (EV_P_ ev_timer *w); 642void ev_timer_stop (EV_P_ ev_timer *w);
627/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 643/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
628void ev_timer_again (EV_P_ ev_timer *w); 644void ev_timer_again (EV_P_ ev_timer *w);
645/* return remaining time */
646ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
629 647
630#if EV_PERIODIC_ENABLE 648#if EV_PERIODIC_ENABLE
631void ev_periodic_start (EV_P_ ev_periodic *w); 649void ev_periodic_start (EV_P_ ev_periodic *w);
632void ev_periodic_stop (EV_P_ ev_periodic *w); 650void ev_periodic_stop (EV_P_ ev_periodic *w);
633void ev_periodic_again (EV_P_ ev_periodic *w); 651void ev_periodic_again (EV_P_ ev_periodic *w);

Diff Legend

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