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

Comparing libev/ev.h (file contents):
Revision 1.115 by root, Sat Apr 25 14:12:48 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
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) \
357 EV_WATCHER (ev_async) 363 EV_WATCHER (ev_async)
358 364
359 EV_ATOMIC_T sent; /* private */ 365 EV_ATOMIC_T sent; /* private */
360} ev_async; 366} ev_async;
361 367
362# define ev_async_pending(w) ((w)->sent + 0) 368# define ev_async_pending(w) (+(w)->sent)
363#endif 369#endif
364 370
365/* the presence of this union forces similar struct layout */ 371/* the presence of this union forces similar struct layout */
366union ev_any_watcher 372union ev_any_watcher
367{ 373{
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 */
406#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 415#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
407#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 416#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
417#define EVBACKEND_ALL 0x0000003FU
408 418
409#if EV_PROTOTYPES 419#if EV_PROTOTYPES
410int ev_version_major (void); 420int ev_version_major (void);
411int ev_version_minor (void); 421int ev_version_minor (void);
412 422
459 469
460/* create and destroy alternative loops that don't handle signals */ 470/* create and destroy alternative loops that don't handle signals */
461struct ev_loop *ev_loop_new (unsigned int flags); 471struct ev_loop *ev_loop_new (unsigned int flags);
462void ev_loop_destroy (EV_P); 472void ev_loop_destroy (EV_P);
463void ev_loop_fork (EV_P); 473void ev_loop_fork (EV_P);
464void ev_loop_verify (EV_P);
465 474
466ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 475ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
467void ev_now_update (EV_P);
468 476
469#else 477#else
470 478
471int ev_default_loop (unsigned int flags); /* returns true when successful */ 479int ev_default_loop (unsigned int flags); /* returns true when successful */
472 480
496/* 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 */
497/* you can call it in either the parent or the child */ 505/* you can call it in either the parent or the child */
498/* you can actually call it at any time, anywhere :) */ 506/* you can actually call it at any time, anywhere :) */
499void ev_default_fork (void); 507void ev_default_fork (void);
500 508
509unsigned int ev_backend (EV_P); /* backend in use by loop */
510
511void ev_now_update (EV_P); /* update event loop time */
512
501#if EV_WALK_ENABLE 513#if EV_WALK_ENABLE
502/* 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 */
503/* callback on every such watcher. The callback might stop the watcher, */ 515/* callback on every such watcher. The callback might stop the watcher, */
504/* but do nothing else with the loop */ 516/* but do nothing else with the loop */
505void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 517void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
506#endif 518#endif
507 519
508unsigned int ev_backend (EV_P); /* backend in use by loop */
509unsigned int ev_loop_count (EV_P); /* number of loop iterations */
510#endif /* prototypes */ 520#endif /* prototypes */
511 521
512#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 522#define EVLOOP_NONBLOCK 1 /* do not block/wait */
513#define EVLOOP_ONESHOT 2 /* block *once* only */ 523#define EVLOOP_ONESHOT 2 /* block *once* only */
514#define EVUNLOOP_CANCEL 0 /* undo unloop */ 524#define EVUNLOOP_CANCEL 0 /* undo unloop */
517 527
518#if EV_PROTOTYPES 528#if EV_PROTOTYPES
519void ev_loop (EV_P_ int flags); 529void ev_loop (EV_P_ int flags);
520void 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 */
521 531
522void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
523void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
524
525/* 532/*
526 * 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
527 * 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
528 * 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.
529 */ 536 */
530void ev_ref (EV_P); 537void ev_ref (EV_P);
531void 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 */
532 562
533/* 563/*
534 * stop/start the timer handling. 564 * stop/start the timer handling.
535 */ 565 */
536void ev_suspend (EV_P); 566void ev_suspend (EV_P);
537void ev_resume (EV_P); 567void ev_resume (EV_P);
568#endif
538 569
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#endif 570#endif
545 571
546/* 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 */
547/* 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 */
548#define ev_init(ev,cb_) do { \ 574#define ev_init(ev,cb_) do { \
549 ((ev_watcher *)(void *)(ev))->active = \ 575 ((ev_watcher *)(void *)(ev))->active = \
550 ((ev_watcher *)(void *)(ev))->pending = \ 576 ((ev_watcher *)(void *)(ev))->pending = 0; \
551 ((ev_watcher *)(void *)(ev))->priority = 0; \ 577 ev_set_priority ((ev), 0); \
552 ev_set_cb ((ev), cb_); \ 578 ev_set_cb ((ev), cb_); \
553} while (0) 579} while (0)
554 580
555#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0) 581#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
556#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0) 582#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
579#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 605#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
580 606
581#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 607#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
582#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 608#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
583 609
584#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
585#define ev_cb(ev) (ev)->cb /* rw */ 610#define ev_cb(ev) (ev)->cb /* rw */
611
612#if EV_MINPRI == EV_MAXPRI
613# define ev_priority(ev) ((ev), EV_MINPRI)
614# define ev_set_priority(ev,pri) ((ev), (pri))
615#else
616# define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
586#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)
618#endif
587 619
588#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 620#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
589 621
590#ifndef ev_set_cb 622#ifndef ev_set_cb
591# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 623# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
592#endif 624#endif
593 625
608 640
609void ev_timer_start (EV_P_ ev_timer *w); 641void ev_timer_start (EV_P_ ev_timer *w);
610void ev_timer_stop (EV_P_ ev_timer *w); 642void ev_timer_stop (EV_P_ ev_timer *w);
611/* 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 */
612void 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);
613 647
614#if EV_PERIODIC_ENABLE 648#if EV_PERIODIC_ENABLE
615void ev_periodic_start (EV_P_ ev_periodic *w); 649void ev_periodic_start (EV_P_ ev_periodic *w);
616void ev_periodic_stop (EV_P_ ev_periodic *w); 650void ev_periodic_stop (EV_P_ ev_periodic *w);
617void 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