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

Comparing libev/ev.h (file contents):
Revision 1.116 by root, Wed Jul 8 02:46:05 2009 UTC vs.
Revision 1.124 by root, Sun Jul 19 06:35:25 2009 UTC

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 7
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
187 * or simply 1 for watchers that aren't in some array. 187 * or simply 1 for watchers that aren't in some array.
188 * pending is either 0, in which case the watcher isn't, 188 * pending is either 0, in which case the watcher isn't,
189 * or the array index + 1 in the pendings array. 189 * or the array index + 1 in the pendings array.
190 */ 190 */
191 191
192#if EV_MINPRI == EV_MAXPRI
193# define EV_DECL_PRIORITY
194#else
195# define EV_DECL_PRIORITY int priority;
196#endif
197
192/* shared by all watchers */ 198/* shared by all watchers */
193#define EV_WATCHER(type) \ 199#define EV_WATCHER(type) \
194 int active; /* private */ \ 200 int active; /* private */ \
195 int pending; /* private */ \ 201 int pending; /* private */ \
196 int priority; /* private */ \ 202 EV_DECL_PRIORITY /* private */ \
197 EV_COMMON /* rw */ \ 203 EV_COMMON /* rw */ \
198 EV_CB_DECLARE (type) /* private */ 204 EV_CB_DECLARE (type) /* private */
199 205
200#define EV_WATCHER_LIST(type) \ 206#define EV_WATCHER_LIST(type) \
201 EV_WATCHER (type) \ 207 EV_WATCHER (type) \
396/* the default */ 402/* the default */
397#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 403#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
398/* flag bits */ 404/* flag bits */
399#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 405#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
400#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 */
401/* method bits to be ored together */ 410/* method bits to be ored together */
402#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 411#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
403#define EVBACKEND_POLL 0x00000002U /* !win */ 412#define EVBACKEND_POLL 0x00000002U /* !win */
404#define EVBACKEND_EPOLL 0x00000004U /* linux */ 413#define EVBACKEND_EPOLL 0x00000004U /* linux */
405#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 414#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
461struct ev_loop *ev_loop_new (unsigned int flags); 470struct ev_loop *ev_loop_new (unsigned int flags);
462void ev_loop_destroy (EV_P); 471void ev_loop_destroy (EV_P);
463void ev_loop_fork (EV_P); 472void ev_loop_fork (EV_P);
464 473
465ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 474ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
466void ev_now_update (EV_P);
467 475
468#else 476#else
469 477
470int ev_default_loop (unsigned int flags); /* returns true when successful */ 478int ev_default_loop (unsigned int flags); /* returns true when successful */
471 479
495/* if you create alternative loops you have to call ev_loop_fork on them */ 503/* if you create alternative loops you have to call ev_loop_fork on them */
496/* you can call it in either the parent or the child */ 504/* you can call it in either the parent or the child */
497/* you can actually call it at any time, anywhere :) */ 505/* you can actually call it at any time, anywhere :) */
498void ev_default_fork (void); 506void ev_default_fork (void);
499 507
500unsigned int ev_backend (EV_P); /* backend in use by loop */ 508unsigned int ev_backend (EV_P); /* backend in use by loop */
501unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 509
502unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ 510void ev_now_update (EV_P); /* update event loop time */
503void ev_loop_verify (EV_P); /* abort if loop data corrupted */
504 511
505#if EV_WALK_ENABLE 512#if EV_WALK_ENABLE
506/* walk (almost) all watchers in the loop of a given type, invoking the */ 513/* walk (almost) all watchers in the loop of a given type, invoking the */
507/* callback on every such watcher. The callback might stop the watcher, */ 514/* callback on every such watcher. The callback might stop the watcher, */
508/* but do nothing else with the loop */ 515/* but do nothing else with the loop */
519 526
520#if EV_PROTOTYPES 527#if EV_PROTOTYPES
521void ev_loop (EV_P_ int flags); 528void ev_loop (EV_P_ int flags);
522void 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 */ 529void 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 */
523 530
524void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
525void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
526
527/* 531/*
528 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 532 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
529 * keeps one reference. if you have a long-runing watcher you never unregister that 533 * keeps one reference. if you have a long-running watcher you never unregister that
530 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 534 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
531 */ 535 */
532void ev_ref (EV_P); 536void ev_ref (EV_P);
533void ev_unref (EV_P); 537void ev_unref (EV_P);
538
539/*
540 * convenience function, wait for a single event, without registering an event watcher
541 * if timeout is < 0, do wait indefinitely
542 */
543void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
544
545# if EV_MINIMAL < 2
546unsigned int ev_loop_count (EV_P); /* number of loop iterations */
547unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
548void ev_loop_verify (EV_P); /* abort if loop data corrupted */
549
550void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
551void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
552
553/* advanced stuff for threading etc. support, see docs */
554void ev_set_userdata (EV_P_ void *data);
555void *ev_userdata (EV_P);
556void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
557void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
558
559unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
560void ev_invoke_pending (EV_P); /* invoke all pending watchers */
534 561
535/* 562/*
536 * stop/start the timer handling. 563 * stop/start the timer handling.
537 */ 564 */
538void ev_suspend (EV_P); 565void ev_suspend (EV_P);
539void ev_resume (EV_P); 566void ev_resume (EV_P);
567#endif
540 568
541/*
542 * convenience function, wait for a single event, without registering an event watcher
543 * if timeout is < 0, do wait indefinitely
544 */
545void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
546#endif 569#endif
547 570
548/* these may evaluate ev multiple times, and the other arguments at most once */ 571/* these may evaluate ev multiple times, and the other arguments at most once */
549/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 572/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
550#define ev_init(ev,cb_) do { \ 573#define ev_init(ev,cb_) do { \
551 ((ev_watcher *)(void *)(ev))->active = \ 574 ((ev_watcher *)(void *)(ev))->active = \
552 ((ev_watcher *)(void *)(ev))->pending = \ 575 ((ev_watcher *)(void *)(ev))->pending = 0; \
553 ((ev_watcher *)(void *)(ev))->priority = 0; \ 576 ev_set_priority ((ev), 0); \
554 ev_set_cb ((ev), cb_); \ 577 ev_set_cb ((ev), cb_); \
555} while (0) 578} while (0)
556 579
557#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0) 580#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
558#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0) 581#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
581#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 604#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
582 605
583#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 606#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
584#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 607#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
585 608
586#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
587#define ev_cb(ev) (ev)->cb /* rw */ 609#define ev_cb(ev) (ev)->cb /* rw */
610
611#if EV_MINPRI == EV_MAXPRI
612# define ev_priority(ev) ((ev), EV_MINPRI)
613# define ev_set_priority(ev,pri) ((ev), (pri))
614#else
615# define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
588#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) 616# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
617#endif
589 618
590#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 619#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)
591 620
592#ifndef ev_set_cb 621#ifndef ev_set_cb
593# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 622# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
610 639
611void ev_timer_start (EV_P_ ev_timer *w); 640void ev_timer_start (EV_P_ ev_timer *w);
612void ev_timer_stop (EV_P_ ev_timer *w); 641void ev_timer_stop (EV_P_ ev_timer *w);
613/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 642/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
614void ev_timer_again (EV_P_ ev_timer *w); 643void ev_timer_again (EV_P_ ev_timer *w);
644/* return remaining time */
645ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
615 646
616#if EV_PERIODIC_ENABLE 647#if EV_PERIODIC_ENABLE
617void ev_periodic_start (EV_P_ ev_periodic *w); 648void ev_periodic_start (EV_P_ ev_periodic *w);
618void ev_periodic_stop (EV_P_ ev_periodic *w); 649void ev_periodic_stop (EV_P_ ev_periodic *w);
619void ev_periodic_again (EV_P_ ev_periodic *w); 650void ev_periodic_again (EV_P_ ev_periodic *w);

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines