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

Comparing libev/ev.h (file contents):
Revision 1.166 by root, Mon Apr 2 23:46:11 2012 UTC vs.
Revision 1.167 by root, Wed Apr 18 05:44:42 2012 UTC

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

Diff Legend

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