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.126 by root, Sun Aug 9 12:34:47 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
… …
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 */
… …
500/* 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 */
501/* you can call it in either the parent or the child */ 504/* you can call it in either the parent or the child */
502/* you can actually call it at any time, anywhere :) */ 505/* you can actually call it at any time, anywhere :) */
503void ev_default_fork (void); 506void ev_default_fork (void);
504 507
505unsigned int ev_backend (EV_P); /* backend in use by loop */ 508unsigned 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 509
510void ev_now_update (EV_P); /* update event loop time */ 510void ev_now_update (EV_P); /* update event loop time */
511void ev_invoke_pending (EV_P); /* invoke all pending watchers */
512 511
513#if EV_WALK_ENABLE 512#if EV_WALK_ENABLE
514/* 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 */
515/* callback on every such watcher. The callback might stop the watcher, */ 514/* callback on every such watcher. The callback might stop the watcher, */
516/* but do nothing else with the loop */ 515/* but do nothing else with the loop */
… …
527 526
528#if EV_PROTOTYPES 527#if EV_PROTOTYPES
529void ev_loop (EV_P_ int flags); 528void 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 */ 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 */
531 530
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/* 531/*
536 * 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
537 * 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
538 * 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.
539 */ 535 */
540void ev_ref (EV_P); 536void ev_ref (EV_P);
541void 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 */
542 561
543/* 562/*
544 * stop/start the timer handling. 563 * stop/start the timer handling.
545 */ 564 */
546void ev_suspend (EV_P); 565void ev_suspend (EV_P);
547void ev_resume (EV_P); 566void ev_resume (EV_P);
567#endif
548 568
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 569#endif
555 570
556/* 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 */
557/* 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 */
558#define ev_init(ev,cb_) do { \ 573#define ev_init(ev,cb_) do { \
… …
624 639
625void ev_timer_start (EV_P_ ev_timer *w); 640void ev_timer_start (EV_P_ ev_timer *w);
626void ev_timer_stop (EV_P_ ev_timer *w); 641void 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 */ 642/* 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); 643void ev_timer_again (EV_P_ ev_timer *w);
644/* return remaining time */
645ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
629 646
630#if EV_PERIODIC_ENABLE 647#if EV_PERIODIC_ENABLE
631void ev_periodic_start (EV_P_ ev_periodic *w); 648void ev_periodic_start (EV_P_ ev_periodic *w);
632void ev_periodic_stop (EV_P_ ev_periodic *w); 649void ev_periodic_stop (EV_P_ ev_periodic *w);
633void 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