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

Comparing libev/ev.h (file contents):
Revision 1.112 by root, Sat Mar 28 22:17:17 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
… …
78# define EV_EMBED_ENABLE 1 78# define EV_EMBED_ENABLE 1
79#endif 79#endif
80 80
81#ifndef EV_ASYNC_ENABLE 81#ifndef EV_ASYNC_ENABLE
82# define EV_ASYNC_ENABLE 1 82# define EV_ASYNC_ENABLE 1
83#endif
84
85#ifndef EV_WALK_ENABLE
86# define EV_WALK_ENABLE 0 /* not yet */
83#endif 87#endif
84 88
85#ifndef EV_ATOMIC_T 89#ifndef EV_ATOMIC_T
86# include <signal.h> 90# include <signal.h>
87# define EV_ATOMIC_T sig_atomic_t volatile 91# define EV_ATOMIC_T sig_atomic_t volatile
… …
145#define EV_PREPARE 0x00004000 /* event loop about to poll */ 149#define EV_PREPARE 0x00004000 /* event loop about to poll */
146#define EV_CHECK 0x00008000 /* event loop finished poll */ 150#define EV_CHECK 0x00008000 /* event loop finished poll */
147#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ 151#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
148#define EV_FORK 0x00020000 /* event loop resumed in child */ 152#define EV_FORK 0x00020000 /* event loop resumed in child */
149#define EV_ASYNC 0x00040000 /* async intra-loop signal */ 153#define EV_ASYNC 0x00040000 /* async intra-loop signal */
154#define EV_CUSTOM 0x01000000 /* for use by user code */
150#define EV_ERROR 0x80000000 /* sent when an error occurs */ 155#define EV_ERROR 0x80000000 /* sent when an error occurs */
151 156
152/* can be used to add custom fields to all watchers, while losing binary compatibility */ 157/* can be used to add custom fields to all watchers, while losing binary compatibility */
153#ifndef EV_COMMON 158#ifndef EV_COMMON
154# define EV_COMMON void *data; 159# define EV_COMMON void *data;
… …
156#ifndef EV_PROTOTYPES 161#ifndef EV_PROTOTYPES
157# define EV_PROTOTYPES 1 162# define EV_PROTOTYPES 1
158#endif 163#endif
159 164
160#define EV_VERSION_MAJOR 3 165#define EV_VERSION_MAJOR 3
161#define EV_VERSION_MINOR 0 166#define EV_VERSION_MINOR 8
162 167
163#ifndef EV_CB_DECLARE 168#ifndef EV_CB_DECLARE
164# 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);
165#endif 170#endif
166#ifndef EV_CB_INVOKE 171#ifndef EV_CB_INVOKE
… …
182 * or simply 1 for watchers that aren't in some array. 187 * or simply 1 for watchers that aren't in some array.
183 * pending is either 0, in which case the watcher isn't, 188 * pending is either 0, in which case the watcher isn't,
184 * or the array index + 1 in the pendings array. 189 * or the array index + 1 in the pendings array.
185 */ 190 */
186 191
192#if EV_MINPRI == EV_MAXPRI
193# define EV_DECL_PRIORITY
194#else
195# define EV_DECL_PRIORITY int priority;
196#endif
197
187/* shared by all watchers */ 198/* shared by all watchers */
188#define EV_WATCHER(type) \ 199#define EV_WATCHER(type) \
189 int active; /* private */ \ 200 int active; /* private */ \
190 int pending; /* private */ \ 201 int pending; /* private */ \
191 int priority; /* private */ \ 202 EV_DECL_PRIORITY /* private */ \
192 EV_COMMON /* rw */ \ 203 EV_COMMON /* rw */ \
193 EV_CB_DECLARE (type) /* private */ 204 EV_CB_DECLARE (type) /* private */
194 205
195#define EV_WATCHER_LIST(type) \ 206#define EV_WATCHER_LIST(type) \
196 EV_WATCHER (type) \ 207 EV_WATCHER (type) \
… …
352 EV_WATCHER (ev_async) 363 EV_WATCHER (ev_async)
353 364
354 EV_ATOMIC_T sent; /* private */ 365 EV_ATOMIC_T sent; /* private */
355} ev_async; 366} ev_async;
356 367
357# define ev_async_pending(w) ((w)->sent + 0) 368# define ev_async_pending(w) (+(w)->sent)
358#endif 369#endif
359 370
360/* the presence of this union forces similar struct layout */ 371/* the presence of this union forces similar struct layout */
361union ev_any_watcher 372union ev_any_watcher
362{ 373{
… …
391/* the default */ 402/* the default */
392#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 403#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
393/* flag bits */ 404/* flag bits */
394#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 405#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
395#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 */
396/* method bits to be ored together */ 410/* method bits to be ored together */
397#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 411#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
398#define EVBACKEND_POLL 0x00000002U /* !win */ 412#define EVBACKEND_POLL 0x00000002U /* !win */
399#define EVBACKEND_EPOLL 0x00000004U /* linux */ 413#define EVBACKEND_EPOLL 0x00000004U /* linux */
400#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 414#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
401#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 415#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
402#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 416#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
417#define EVBACKEND_ALL 0x0000003FU
403 418
404#if EV_PROTOTYPES 419#if EV_PROTOTYPES
405int ev_version_major (void); 420int ev_version_major (void);
406int ev_version_minor (void); 421int ev_version_minor (void);
407 422
… …
454 469
455/* create and destroy alternative loops that don't handle signals */ 470/* create and destroy alternative loops that don't handle signals */
456struct ev_loop *ev_loop_new (unsigned int flags); 471struct ev_loop *ev_loop_new (unsigned int flags);
457void ev_loop_destroy (EV_P); 472void ev_loop_destroy (EV_P);
458void ev_loop_fork (EV_P); 473void ev_loop_fork (EV_P);
459void ev_loop_verify (EV_P);
460 474
461ev_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 */
462void ev_now_update (EV_P);
463 476
464#else 477#else
465 478
466int ev_default_loop (unsigned int flags); /* returns true when successful */ 479int ev_default_loop (unsigned int flags); /* returns true when successful */
467 480
… …
491/* 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 */
492/* you can call it in either the parent or the child */ 505/* you can call it in either the parent or the child */
493/* you can actually call it at any time, anywhere :) */ 506/* you can actually call it at any time, anywhere :) */
494void ev_default_fork (void); 507void ev_default_fork (void);
495 508
496#if 0 509unsigned int ev_backend (EV_P); /* backend in use by loop */
510
511void ev_now_update (EV_P); /* update event loop time */
512
513#if EV_WALK_ENABLE
497/* 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 */
498/* callback on every such watcher. The callback might stop the watcher, */ 515/* callback on every such watcher. The callback might stop the watcher, */
499/* but do nothing else with the loop */ 516/* but do nothing else with the loop */
500void 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));
501#endif 518#endif
502 519
503unsigned int ev_backend (EV_P); /* backend in use by loop */
504unsigned int ev_loop_count (EV_P); /* number of loop iterations */
505#endif /* prototypes */ 520#endif /* prototypes */
506 521
507#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 522#define EVLOOP_NONBLOCK 1 /* do not block/wait */
508#define EVLOOP_ONESHOT 2 /* block *once* only */ 523#define EVLOOP_ONESHOT 2 /* block *once* only */
509#define EVUNLOOP_CANCEL 0 /* undo unloop */ 524#define EVUNLOOP_CANCEL 0 /* undo unloop */
… …
512 527
513#if EV_PROTOTYPES 528#if EV_PROTOTYPES
514void ev_loop (EV_P_ int flags); 529void ev_loop (EV_P_ int flags);
515void 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 */
516 531
517void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
518void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
519
520/* 532/*
521 * 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
522 * 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
523 * 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.
524 */ 536 */
525void ev_ref (EV_P); 537void ev_ref (EV_P);
526void ev_unref (EV_P); 538void ev_unref (EV_P);
527 539
540/*
528/* convenience function, wait for a single event, without registering an event watcher */ 541 * convenience function, wait for a single event, without registering an event watcher
529/* if timeout is < 0, do wait indefinitely */ 542 * if timeout is < 0, do wait indefinitely
543 */
530void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 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 */
562
563/*
564 * stop/start the timer handling.
565 */
566void ev_suspend (EV_P);
567void ev_resume (EV_P);
568#endif
569
531#endif 570#endif
532 571
533/* 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 */
534/* 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 */
535#define ev_init(ev,cb_) do { \ 574#define ev_init(ev,cb_) do { \
536 ((ev_watcher *)(void *)(ev))->active = \ 575 ((ev_watcher *)(void *)(ev))->active = \
537 ((ev_watcher *)(void *)(ev))->pending = \ 576 ((ev_watcher *)(void *)(ev))->pending = 0; \
538 ((ev_watcher *)(void *)(ev))->priority = 0; \ 577 ev_set_priority ((ev), 0); \
539 ev_set_cb ((ev), cb_); \ 578 ev_set_cb ((ev), cb_); \
540} while (0) 579} while (0)
541 580
542#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)
543#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)
… …
566#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)
567 606
568#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 */
569#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 */
570 609
571#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
572#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))
573#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
574 619
575#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 620#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
576 621
577#ifndef ev_set_cb 622#ifndef ev_set_cb
578# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 623# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
579#endif 624#endif
580 625
… …
595 640
596void ev_timer_start (EV_P_ ev_timer *w); 641void ev_timer_start (EV_P_ ev_timer *w);
597void ev_timer_stop (EV_P_ ev_timer *w); 642void ev_timer_stop (EV_P_ ev_timer *w);
598/* 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 */
599void 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);
600 647
601#if EV_PERIODIC_ENABLE 648#if EV_PERIODIC_ENABLE
602void ev_periodic_start (EV_P_ ev_periodic *w); 649void ev_periodic_start (EV_P_ ev_periodic *w);
603void ev_periodic_stop (EV_P_ ev_periodic *w); 650void ev_periodic_stop (EV_P_ ev_periodic *w);
604void 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