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

Comparing libev/ev.h (file contents):
Revision 1.161 by root, Sat Oct 15 09:05:03 2011 UTC vs.
Revision 1.162 by root, Tue Dec 20 04:08:35 2011 UTC

… …
183# define EV_INLINE static inline 183# define EV_INLINE static inline
184#else 184#else
185# define EV_INLINE static 185# define EV_INLINE static
186#endif 186#endif
187 187
188#ifdef EV_API_STATIC
189# define EV_API_DECL static
190#else
191# define EV_API_DECL extern
192#endif
193
188/* EV_PROTOTYPES can be used to switch of prototype declarations */ 194/* EV_PROTOTYPES can be used to switch of prototype declarations */
189#ifndef EV_PROTOTYPES 195#ifndef EV_PROTOTYPES
190# define EV_PROTOTYPES 1 196# define EV_PROTOTYPES 1
191#endif 197#endif
192 198
… …
506 EVBACKEND_ALL = 0x0000003FU, /* all known backends */ 512 EVBACKEND_ALL = 0x0000003FU, /* all known backends */
507 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */ 513 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
508}; 514};
509 515
510#if EV_PROTOTYPES 516#if EV_PROTOTYPES
511int ev_version_major (void); 517EV_API_DECL int ev_version_major (void);
512int ev_version_minor (void); 518EV_API_DECL int ev_version_minor (void);
513 519
514unsigned int ev_supported_backends (void); 520EV_API_DECL unsigned int ev_supported_backends (void);
515unsigned int ev_recommended_backends (void); 521EV_API_DECL unsigned int ev_recommended_backends (void);
516unsigned int ev_embeddable_backends (void); 522EV_API_DECL unsigned int ev_embeddable_backends (void);
517 523
518ev_tstamp ev_time (void); 524EV_API_DECL ev_tstamp ev_time (void);
519void ev_sleep (ev_tstamp delay); /* sleep for a while */ 525EV_API_DECL void ev_sleep (ev_tstamp delay); /* sleep for a while */
520 526
521/* Sets the allocation function to use, works like realloc. 527/* Sets the allocation function to use, works like realloc.
522 * It is used to allocate and free memory. 528 * It is used to allocate and free memory.
523 * If it returns zero when memory needs to be allocated, the library might abort 529 * If it returns zero when memory needs to be allocated, the library might abort
524 * or take some potentially destructive action. 530 * or take some potentially destructive action.
525 * The default is your system realloc function. 531 * The default is your system realloc function.
526 */ 532 */
527void ev_set_allocator (void *(*cb)(void *ptr, long size)); 533EV_API_DECL void ev_set_allocator (void *(*cb)(void *ptr, long size));
528 534
529/* set the callback function to call on a 535/* set the callback function to call on a
530 * retryable syscall error 536 * retryable syscall error
531 * (such as failed select, poll, epoll_wait) 537 * (such as failed select, poll, epoll_wait)
532 */ 538 */
533void ev_set_syserr_cb (void (*cb)(const char *msg)); 539EV_API_DECL void ev_set_syserr_cb (void (*cb)(const char *msg));
534 540
535#if EV_MULTIPLICITY 541#if EV_MULTIPLICITY
536 542
537/* the default loop is the only one that handles signals and child watchers */ 543/* the default loop is the only one that handles signals and child watchers */
538/* you can call this as often as you like */ 544/* you can call this as often as you like */
539struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0)); 545EV_API_DECL struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0));
546
547EV_API_DECL struct ev_loop *ev_default_loop_ptr;
540 548
541EV_INLINE struct ev_loop * 549EV_INLINE struct ev_loop *
542ev_default_loop_uc_ (void) 550ev_default_loop_uc_ (void)
543{ 551{
544 extern struct ev_loop *ev_default_loop_ptr; 552 extern struct ev_loop *ev_default_loop_ptr;
… …
551{ 559{
552 return EV_A == EV_DEFAULT_UC; 560 return EV_A == EV_DEFAULT_UC;
553} 561}
554 562
555/* create and destroy alternative loops that don't handle signals */ 563/* create and destroy alternative loops that don't handle signals */
556struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0)); 564EV_API_DECL struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
557 565
558ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 566EV_API_DECL ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
559 567
560#else 568#else
561 569
562int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */ 570EV_API_DECL int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */
571
572EV_API_DECL ev_tstamp ev_rt_now;
563 573
564EV_INLINE ev_tstamp 574EV_INLINE ev_tstamp
565ev_now (void) 575ev_now (void)
566{ 576{
567 extern ev_tstamp ev_rt_now;
568
569 return ev_rt_now; 577 return ev_rt_now;
570} 578}
571 579
572/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */ 580/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
573EV_INLINE int 581EV_INLINE int
… …
577} 585}
578 586
579#endif /* multiplicity */ 587#endif /* multiplicity */
580 588
581/* destroy event loops, also works for the default loop */ 589/* destroy event loops, also works for the default loop */
582void ev_loop_destroy (EV_P); 590EV_API_DECL void ev_loop_destroy (EV_P);
583 591
584/* this needs to be called after fork, to duplicate the loop */ 592/* this needs to be called after fork, to duplicate the loop */
585/* when you want to re-use it in the child */ 593/* when you want to re-use it in the child */
586/* you can call it in either the parent or the child */ 594/* you can call it in either the parent or the child */
587/* you can actually call it at any time, anywhere :) */ 595/* you can actually call it at any time, anywhere :) */
588void ev_loop_fork (EV_P); 596EV_API_DECL void ev_loop_fork (EV_P);
589 597
590unsigned int ev_backend (EV_P); /* backend in use by loop */ 598EV_API_DECL unsigned int ev_backend (EV_P); /* backend in use by loop */
591 599
592void ev_now_update (EV_P); /* update event loop time */ 600EV_API_DECL void ev_now_update (EV_P); /* update event loop time */
593 601
594#if EV_WALK_ENABLE 602#if EV_WALK_ENABLE
595/* walk (almost) all watchers in the loop of a given type, invoking the */ 603/* walk (almost) all watchers in the loop of a given type, invoking the */
596/* callback on every such watcher. The callback might stop the watcher, */ 604/* callback on every such watcher. The callback might stop the watcher, */
597/* but do nothing else with the loop */ 605/* but do nothing else with the loop */
598void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 606EV_API_DECL void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
599#endif 607#endif
600 608
601#endif /* prototypes */ 609#endif /* prototypes */
602 610
603/* ev_run flags values */ 611/* ev_run flags values */
… …
612 EVBREAK_ONE = 1, /* unloop once */ 620 EVBREAK_ONE = 1, /* unloop once */
613 EVBREAK_ALL = 2 /* unloop all loops */ 621 EVBREAK_ALL = 2 /* unloop all loops */
614}; 622};
615 623
616#if EV_PROTOTYPES 624#if EV_PROTOTYPES
617void ev_run (EV_P_ int flags EV_CPP (= 0)); 625EV_API_DECL void ev_run (EV_P_ int flags EV_CPP (= 0));
618void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */ 626EV_API_DECL void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */
619 627
620/* 628/*
621 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 629 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
622 * keeps one reference. if you have a long-running watcher you never unregister that 630 * keeps one reference. if you have a long-running watcher you never unregister that
623 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 631 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
624 */ 632 */
625void ev_ref (EV_P); 633EV_API_DECL void ev_ref (EV_P);
626void ev_unref (EV_P); 634EV_API_DECL void ev_unref (EV_P);
627 635
628/* 636/*
629 * convenience function, wait for a single event, without registering an event watcher 637 * convenience function, wait for a single event, without registering an event watcher
630 * if timeout is < 0, do wait indefinitely 638 * if timeout is < 0, do wait indefinitely
631 */ 639 */
632void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 640EV_API_DECL void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
633 641
634# if EV_FEATURE_API 642# if EV_FEATURE_API
635unsigned int ev_iteration (EV_P); /* number of loop iterations */ 643EV_API_DECL unsigned int ev_iteration (EV_P); /* number of loop iterations */
636unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ 644EV_API_DECL unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
637void ev_verify (EV_P); /* abort if loop data corrupted */ 645EV_API_DECL void ev_verify (EV_P); /* abort if loop data corrupted */
638 646
639void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 647EV_API_DECL void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
640void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 648EV_API_DECL void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
641 649
642/* advanced stuff for threading etc. support, see docs */ 650/* advanced stuff for threading etc. support, see docs */
643void ev_set_userdata (EV_P_ void *data); 651EV_API_DECL void ev_set_userdata (EV_P_ void *data);
644void *ev_userdata (EV_P); 652EV_API_DECL void *ev_userdata (EV_P);
645void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P)); 653EV_API_DECL void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
646void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P)); 654EV_API_DECL void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
647 655
648unsigned int ev_pending_count (EV_P); /* number of pending events, if any */ 656EV_API_DECL unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
649void ev_invoke_pending (EV_P); /* invoke all pending watchers */ 657EV_API_DECL void ev_invoke_pending (EV_P); /* invoke all pending watchers */
650 658
651/* 659/*
652 * stop/start the timer handling. 660 * stop/start the timer handling.
653 */ 661 */
654void ev_suspend (EV_P); 662EV_API_DECL void ev_suspend (EV_P);
655void ev_resume (EV_P); 663EV_API_DECL void ev_resume (EV_P);
656#endif 664#endif
657 665
658#endif 666#endif
659 667
660/* these may evaluate ev multiple times, and the other arguments at most once */ 668/* these may evaluate ev multiple times, and the other arguments at most once */
… …
717/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 725/* stopping (disabling, deleting) a watcher does nothing unless its already running */
718#if EV_PROTOTYPES 726#if EV_PROTOTYPES
719 727
720/* feeds an event into a watcher as if the event actually occurred */ 728/* feeds an event into a watcher as if the event actually occurred */
721/* accepts any ev_watcher type */ 729/* accepts any ev_watcher type */
722void ev_feed_event (EV_P_ void *w, int revents); 730EV_API_DECL void ev_feed_event (EV_P_ void *w, int revents);
723void ev_feed_fd_event (EV_P_ int fd, int revents); 731EV_API_DECL void ev_feed_fd_event (EV_P_ int fd, int revents);
724#if EV_SIGNAL_ENABLE 732#if EV_SIGNAL_ENABLE
725void ev_feed_signal (int signum); 733EV_API_DECL void ev_feed_signal (int signum);
726void ev_feed_signal_event (EV_P_ int signum); 734EV_API_DECL void ev_feed_signal_event (EV_P_ int signum);
727#endif 735#endif
728void ev_invoke (EV_P_ void *w, int revents); 736EV_API_DECL void ev_invoke (EV_P_ void *w, int revents);
729int ev_clear_pending (EV_P_ void *w); 737EV_API_DECL int ev_clear_pending (EV_P_ void *w);
730 738
731void ev_io_start (EV_P_ ev_io *w); 739EV_API_DECL void ev_io_start (EV_P_ ev_io *w);
732void ev_io_stop (EV_P_ ev_io *w); 740EV_API_DECL void ev_io_stop (EV_P_ ev_io *w);
733 741
734void ev_timer_start (EV_P_ ev_timer *w); 742EV_API_DECL void ev_timer_start (EV_P_ ev_timer *w);
735void ev_timer_stop (EV_P_ ev_timer *w); 743EV_API_DECL void ev_timer_stop (EV_P_ ev_timer *w);
736/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 744/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
737void ev_timer_again (EV_P_ ev_timer *w); 745EV_API_DECL void ev_timer_again (EV_P_ ev_timer *w);
738/* return remaining time */ 746/* return remaining time */
739ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w); 747EV_API_DECL ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
740 748
741#if EV_PERIODIC_ENABLE 749#if EV_PERIODIC_ENABLE
742void ev_periodic_start (EV_P_ ev_periodic *w); 750EV_API_DECL void ev_periodic_start (EV_P_ ev_periodic *w);
743void ev_periodic_stop (EV_P_ ev_periodic *w); 751EV_API_DECL void ev_periodic_stop (EV_P_ ev_periodic *w);
744void ev_periodic_again (EV_P_ ev_periodic *w); 752EV_API_DECL void ev_periodic_again (EV_P_ ev_periodic *w);
745#endif 753#endif
746 754
747/* only supported in the default loop */ 755/* only supported in the default loop */
748#if EV_SIGNAL_ENABLE 756#if EV_SIGNAL_ENABLE
749void ev_signal_start (EV_P_ ev_signal *w); 757EV_API_DECL void ev_signal_start (EV_P_ ev_signal *w);
750void ev_signal_stop (EV_P_ ev_signal *w); 758EV_API_DECL void ev_signal_stop (EV_P_ ev_signal *w);
751#endif 759#endif
752 760
753/* only supported in the default loop */ 761/* only supported in the default loop */
754# if EV_CHILD_ENABLE 762# if EV_CHILD_ENABLE
755void ev_child_start (EV_P_ ev_child *w); 763EV_API_DECL void ev_child_start (EV_P_ ev_child *w);
756void ev_child_stop (EV_P_ ev_child *w); 764EV_API_DECL void ev_child_stop (EV_P_ ev_child *w);
757# endif 765# endif
758 766
759# if EV_STAT_ENABLE 767# if EV_STAT_ENABLE
760void ev_stat_start (EV_P_ ev_stat *w); 768EV_API_DECL void ev_stat_start (EV_P_ ev_stat *w);
761void ev_stat_stop (EV_P_ ev_stat *w); 769EV_API_DECL void ev_stat_stop (EV_P_ ev_stat *w);
762void ev_stat_stat (EV_P_ ev_stat *w); 770EV_API_DECL void ev_stat_stat (EV_P_ ev_stat *w);
763# endif 771# endif
764 772
765# if EV_IDLE_ENABLE 773# if EV_IDLE_ENABLE
766void ev_idle_start (EV_P_ ev_idle *w); 774EV_API_DECL void ev_idle_start (EV_P_ ev_idle *w);
767void ev_idle_stop (EV_P_ ev_idle *w); 775EV_API_DECL void ev_idle_stop (EV_P_ ev_idle *w);
768# endif 776# endif
769 777
770#if EV_PREPARE_ENABLE 778#if EV_PREPARE_ENABLE
771void ev_prepare_start (EV_P_ ev_prepare *w); 779EV_API_DECL void ev_prepare_start (EV_P_ ev_prepare *w);
772void ev_prepare_stop (EV_P_ ev_prepare *w); 780EV_API_DECL void ev_prepare_stop (EV_P_ ev_prepare *w);
773#endif 781#endif
774 782
775#if EV_CHECK_ENABLE 783#if EV_CHECK_ENABLE
776void ev_check_start (EV_P_ ev_check *w); 784EV_API_DECL void ev_check_start (EV_P_ ev_check *w);
777void ev_check_stop (EV_P_ ev_check *w); 785EV_API_DECL void ev_check_stop (EV_P_ ev_check *w);
778#endif 786#endif
779 787
780# if EV_FORK_ENABLE 788# if EV_FORK_ENABLE
781void ev_fork_start (EV_P_ ev_fork *w); 789EV_API_DECL void ev_fork_start (EV_P_ ev_fork *w);
782void ev_fork_stop (EV_P_ ev_fork *w); 790EV_API_DECL void ev_fork_stop (EV_P_ ev_fork *w);
783# endif 791# endif
784 792
785# if EV_CLEANUP_ENABLE 793# if EV_CLEANUP_ENABLE
786void ev_cleanup_start (EV_P_ ev_cleanup *w); 794EV_API_DECL void ev_cleanup_start (EV_P_ ev_cleanup *w);
787void ev_cleanup_stop (EV_P_ ev_cleanup *w); 795EV_API_DECL void ev_cleanup_stop (EV_P_ ev_cleanup *w);
788# endif 796# endif
789 797
790# if EV_EMBED_ENABLE 798# if EV_EMBED_ENABLE
791/* only supported when loop to be embedded is in fact embeddable */ 799/* only supported when loop to be embedded is in fact embeddable */
792void ev_embed_start (EV_P_ ev_embed *w); 800EV_API_DECL void ev_embed_start (EV_P_ ev_embed *w);
793void ev_embed_stop (EV_P_ ev_embed *w); 801EV_API_DECL void ev_embed_stop (EV_P_ ev_embed *w);
794void ev_embed_sweep (EV_P_ ev_embed *w); 802EV_API_DECL void ev_embed_sweep (EV_P_ ev_embed *w);
795# endif 803# endif
796 804
797# if EV_ASYNC_ENABLE 805# if EV_ASYNC_ENABLE
798void ev_async_start (EV_P_ ev_async *w); 806EV_API_DECL void ev_async_start (EV_P_ ev_async *w);
799void ev_async_stop (EV_P_ ev_async *w); 807EV_API_DECL void ev_async_stop (EV_P_ ev_async *w);
800void ev_async_send (EV_P_ ev_async *w); 808EV_API_DECL void ev_async_send (EV_P_ ev_async *w);
801# endif 809# endif
802 810
803#if EV_COMPAT3 811#if EV_COMPAT3
804 #define EVLOOP_NONBLOCK EVRUN_NOWAIT 812 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
805 #define EVLOOP_ONESHOT EVRUN_ONCE 813 #define EVLOOP_ONESHOT EVRUN_ONCE

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines