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.130 by root, Thu Dec 31 06:59: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 9
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 0 /* compatibility to pre-3.9 */
410#define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */
401/* method bits to be ored together */ 411/* method bits to be ored together */
402#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 412#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
403#define EVBACKEND_POLL 0x00000002U /* !win */ 413#define EVBACKEND_POLL 0x00000002U /* !win */
404#define EVBACKEND_EPOLL 0x00000004U /* linux */ 414#define EVBACKEND_EPOLL 0x00000004U /* linux */
405#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 415#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
406#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 416#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
407#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 417#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
418#define EVBACKEND_ALL 0x0000003FU
408 419
409#if EV_PROTOTYPES 420#if EV_PROTOTYPES
410int ev_version_major (void); 421int ev_version_major (void);
411int ev_version_minor (void); 422int ev_version_minor (void);
412 423
459 470
460/* create and destroy alternative loops that don't handle signals */ 471/* create and destroy alternative loops that don't handle signals */
461struct ev_loop *ev_loop_new (unsigned int flags); 472struct ev_loop *ev_loop_new (unsigned int flags);
462void ev_loop_destroy (EV_P); 473void ev_loop_destroy (EV_P);
463void ev_loop_fork (EV_P); 474void ev_loop_fork (EV_P);
464void ev_loop_verify (EV_P);
465 475
466ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 476ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
467void ev_now_update (EV_P);
468 477
469#else 478#else
470 479
471int ev_default_loop (unsigned int flags); /* returns true when successful */ 480int ev_default_loop (unsigned int flags); /* returns true when successful */
472 481
496/* if you create alternative loops you have to call ev_loop_fork on them */ 505/* 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 */ 506/* you can call it in either the parent or the child */
498/* you can actually call it at any time, anywhere :) */ 507/* you can actually call it at any time, anywhere :) */
499void ev_default_fork (void); 508void ev_default_fork (void);
500 509
510unsigned int ev_backend (EV_P); /* backend in use by loop */
511
512void ev_now_update (EV_P); /* update event loop time */
513
501#if EV_WALK_ENABLE 514#if EV_WALK_ENABLE
502/* walk (almost) all watchers in the loop of a given type, invoking the */ 515/* 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, */ 516/* callback on every such watcher. The callback might stop the watcher, */
504/* but do nothing else with the loop */ 517/* but do nothing else with the loop */
505void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 518void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
506#endif 519#endif
507 520
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 */ 521#endif /* prototypes */
511 522
512#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 523#define EVLOOP_NONBLOCK 1 /* do not block/wait */
513#define EVLOOP_ONESHOT 2 /* block *once* only */ 524#define EVLOOP_ONESHOT 2 /* block *once* only */
514#define EVUNLOOP_CANCEL 0 /* undo unloop */ 525#define EVUNLOOP_CANCEL 0 /* undo unloop */
517 528
518#if EV_PROTOTYPES 529#if EV_PROTOTYPES
519void ev_loop (EV_P_ int flags); 530void 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 */ 531void 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 532
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/* 533/*
526 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 534 * 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 535 * 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. 536 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
529 */ 537 */
530void ev_ref (EV_P); 538void ev_ref (EV_P);
531void ev_unref (EV_P); 539void ev_unref (EV_P);
540
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
547# if EV_MINIMAL < 2
548unsigned int ev_loop_count (EV_P); /* number of loop iterations */
549unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
550void ev_loop_verify (EV_P); /* abort if loop data corrupted */
551
552void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
553void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
554
555/* advanced stuff for threading etc. support, see docs */
556void ev_set_userdata (EV_P_ void *data);
557void *ev_userdata (EV_P);
558void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
559void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
560
561unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
562void ev_invoke_pending (EV_P); /* invoke all pending watchers */
532 563
533/* 564/*
534 * stop/start the timer handling. 565 * stop/start the timer handling.
535 */ 566 */
536void ev_suspend (EV_P); 567void ev_suspend (EV_P);
537void ev_resume (EV_P); 568void ev_resume (EV_P);
569#endif
538 570
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 571#endif
545 572
546/* these may evaluate ev multiple times, and the other arguments at most once */ 573/* 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 */ 574/* 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 { \ 575#define ev_init(ev,cb_) do { \
549 ((ev_watcher *)(void *)(ev))->active = \ 576 ((ev_watcher *)(void *)(ev))->active = \
550 ((ev_watcher *)(void *)(ev))->pending = \ 577 ((ev_watcher *)(void *)(ev))->pending = 0; \
551 ((ev_watcher *)(void *)(ev))->priority = 0; \ 578 ev_set_priority ((ev), 0); \
552 ev_set_cb ((ev), cb_); \ 579 ev_set_cb ((ev), cb_); \
553} while (0) 580} while (0)
554 581
555#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0) 582#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) 583#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) 606#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
580 607
581#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 608#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 */ 609#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
583 610
584#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
585#define ev_cb(ev) (ev)->cb /* rw */ 611#define ev_cb(ev) (ev)->cb /* rw */
612
613#if EV_MINPRI == EV_MAXPRI
614# define ev_priority(ev) ((ev), EV_MINPRI)
615# define ev_set_priority(ev,pri) ((ev), (pri))
616#else
617# define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
586#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) 618# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
619#endif
587 620
588#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 621#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
589 622
590#ifndef ev_set_cb 623#ifndef ev_set_cb
591# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 624# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
592#endif 625#endif
593 626
608 641
609void ev_timer_start (EV_P_ ev_timer *w); 642void ev_timer_start (EV_P_ ev_timer *w);
610void ev_timer_stop (EV_P_ ev_timer *w); 643void 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 */ 644/* 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); 645void ev_timer_again (EV_P_ ev_timer *w);
646/* return remaining time */
647ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
613 648
614#if EV_PERIODIC_ENABLE 649#if EV_PERIODIC_ENABLE
615void ev_periodic_start (EV_P_ ev_periodic *w); 650void ev_periodic_start (EV_P_ ev_periodic *w);
616void ev_periodic_stop (EV_P_ ev_periodic *w); 651void ev_periodic_stop (EV_P_ ev_periodic *w);
617void ev_periodic_again (EV_P_ ev_periodic *w); 652void ev_periodic_again (EV_P_ ev_periodic *w);

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines