… | |
… | |
176 | =head2 I/O WATCHERS |
176 | =head2 I/O WATCHERS |
177 | |
177 | |
178 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
178 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
179 | with the following mandatory key-value pairs as arguments: |
179 | with the following mandatory key-value pairs as arguments: |
180 | |
180 | |
181 | C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch |
181 | C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch |
182 | for events (AnyEvent might or might not keep a reference to this file |
182 | for events (AnyEvent might or might not keep a reference to this file |
183 | handle). Note that only file handles pointing to things for which |
183 | handle). Note that only file handles pointing to things for which |
184 | non-blocking operation makes sense are allowed. This includes sockets, |
184 | non-blocking operation makes sense are allowed. This includes sockets, |
185 | most character devices, pipes, fifos and so on, but not for example files |
185 | most character devices, pipes, fifos and so on, but not for example files |
186 | or block devices. |
186 | or block devices. |
… | |
… | |
392 | |
392 | |
393 | There is a slight catch to child watchers, however: you usually start them |
393 | There is a slight catch to child watchers, however: you usually start them |
394 | I<after> the child process was created, and this means the process could |
394 | I<after> the child process was created, and this means the process could |
395 | have exited already (and no SIGCHLD will be sent anymore). |
395 | have exited already (and no SIGCHLD will be sent anymore). |
396 | |
396 | |
397 | Not all event models handle this correctly (POE doesn't), but even for |
397 | Not all event models handle this correctly (neither POE nor IO::Async do, |
|
|
398 | see their AnyEvent::Impl manpages for details), but even for event models |
398 | event models that I<do> handle this correctly, they usually need to be |
399 | that I<do> handle this correctly, they usually need to be loaded before |
399 | loaded before the process exits (i.e. before you fork in the first place). |
400 | the process exits (i.e. before you fork in the first place). AnyEvent's |
|
|
401 | pure perl event loop handles all cases correctly regardless of when you |
|
|
402 | start the watcher. |
400 | |
403 | |
401 | This means you cannot create a child watcher as the very first thing in an |
404 | This means you cannot create a child watcher as the very first |
402 | AnyEvent program, you I<have> to create at least one watcher before you |
405 | thing in an AnyEvent program, you I<have> to create at least one |
403 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
406 | watcher before you C<fork> the child (alternatively, you can call |
|
|
407 | C<AnyEvent::detect>). |
404 | |
408 | |
405 | Example: fork a process and wait for it |
409 | Example: fork a process and wait for it |
406 | |
410 | |
407 | my $done = AnyEvent->condvar; |
411 | my $done = AnyEvent->condvar; |
408 | |
412 | |
… | |
… | |
595 | |
599 | |
596 | =item $cv->begin ([group callback]) |
600 | =item $cv->begin ([group callback]) |
597 | |
601 | |
598 | =item $cv->end |
602 | =item $cv->end |
599 | |
603 | |
600 | These two methods are EXPERIMENTAL and MIGHT CHANGE. |
|
|
601 | |
|
|
602 | These two methods can be used to combine many transactions/events into |
604 | These two methods can be used to combine many transactions/events into |
603 | one. For example, a function that pings many hosts in parallel might want |
605 | one. For example, a function that pings many hosts in parallel might want |
604 | to use a condition variable for the whole process. |
606 | to use a condition variable for the whole process. |
605 | |
607 | |
606 | Every call to C<< ->begin >> will increment a counter, and every call to |
608 | Every call to C<< ->begin >> will increment a counter, and every call to |
607 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
609 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
608 | >>, the (last) callback passed to C<begin> will be executed. That callback |
610 | >>, the (last) callback passed to C<begin> will be executed. That callback |
609 | is I<supposed> to call C<< ->send >>, but that is not required. If no |
611 | is I<supposed> to call C<< ->send >>, but that is not required. If no |
610 | callback was set, C<send> will be called without any arguments. |
612 | callback was set, C<send> will be called without any arguments. |
611 | |
613 | |
612 | Let's clarify this with the ping example: |
614 | You can think of C<< $cv->send >> giving you an OR condition (one call |
|
|
615 | sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND |
|
|
616 | condition (all C<begin> calls must be C<end>'ed before the condvar sends). |
|
|
617 | |
|
|
618 | Let's start with a simple example: you have two I/O watchers (for example, |
|
|
619 | STDOUT and STDERR for a program), and you want to wait for both streams to |
|
|
620 | close before activating a condvar: |
|
|
621 | |
|
|
622 | my $cv = AnyEvent->condvar; |
|
|
623 | |
|
|
624 | $cv->begin; # first watcher |
|
|
625 | my $w1 = AnyEvent->io (fh => $fh1, cb => sub { |
|
|
626 | defined sysread $fh1, my $buf, 4096 |
|
|
627 | or $cv->end; |
|
|
628 | }); |
|
|
629 | |
|
|
630 | $cv->begin; # second watcher |
|
|
631 | my $w2 = AnyEvent->io (fh => $fh2, cb => sub { |
|
|
632 | defined sysread $fh2, my $buf, 4096 |
|
|
633 | or $cv->end; |
|
|
634 | }); |
|
|
635 | |
|
|
636 | $cv->recv; |
|
|
637 | |
|
|
638 | This works because for every event source (EOF on file handle), there is |
|
|
639 | one call to C<begin>, so the condvar waits for all calls to C<end> before |
|
|
640 | sending. |
|
|
641 | |
|
|
642 | The ping example mentioned above is slightly more complicated, as the |
|
|
643 | there are results to be passwd back, and the number of tasks that are |
|
|
644 | begung can potentially be zero: |
613 | |
645 | |
614 | my $cv = AnyEvent->condvar; |
646 | my $cv = AnyEvent->condvar; |
615 | |
647 | |
616 | my %result; |
648 | my %result; |
617 | $cv->begin (sub { $cv->send (\%result) }); |
649 | $cv->begin (sub { $cv->send (\%result) }); |
… | |
… | |
637 | loop, which serves two important purposes: first, it sets the callback |
669 | loop, which serves two important purposes: first, it sets the callback |
638 | to be called once the counter reaches C<0>, and second, it ensures that |
670 | to be called once the counter reaches C<0>, and second, it ensures that |
639 | C<send> is called even when C<no> hosts are being pinged (the loop |
671 | C<send> is called even when C<no> hosts are being pinged (the loop |
640 | doesn't execute once). |
672 | doesn't execute once). |
641 | |
673 | |
642 | This is the general pattern when you "fan out" into multiple subrequests: |
674 | This is the general pattern when you "fan out" into multiple (but |
643 | use an outer C<begin>/C<end> pair to set the callback and ensure C<end> |
675 | potentially none) subrequests: use an outer C<begin>/C<end> pair to set |
644 | is called at least once, and then, for each subrequest you start, call |
676 | the callback and ensure C<end> is called at least once, and then, for each |
645 | C<begin> and for each subrequest you finish, call C<end>. |
677 | subrequest you start, call C<begin> and for each subrequest you finish, |
|
|
678 | call C<end>. |
646 | |
679 | |
647 | =back |
680 | =back |
648 | |
681 | |
649 | =head3 METHODS FOR CONSUMERS |
682 | =head3 METHODS FOR CONSUMERS |
650 | |
683 | |
… | |
… | |
707 | variable itself. Calling C<recv> inside the callback or at any later time |
740 | variable itself. Calling C<recv> inside the callback or at any later time |
708 | is guaranteed not to block. |
741 | is guaranteed not to block. |
709 | |
742 | |
710 | =back |
743 | =back |
711 | |
744 | |
|
|
745 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
|
|
746 | |
|
|
747 | The available backend classes are (every class has its own manpage): |
|
|
748 | |
|
|
749 | =over 4 |
|
|
750 | |
|
|
751 | =item Backends that are autoprobed when no other event loop can be found. |
|
|
752 | |
|
|
753 | EV is the preferred backend when no other event loop seems to be in |
|
|
754 | use. If EV is not installed, then AnyEvent will try Event, and, failing |
|
|
755 | that, will fall back to its own pure-perl implementation, which is |
|
|
756 | available everywhere as it comes with AnyEvent itself. |
|
|
757 | |
|
|
758 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
|
|
759 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
|
|
760 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
|
|
761 | |
|
|
762 | =item Backends that are transparently being picked up when they are used. |
|
|
763 | |
|
|
764 | These will be used when they are currently loaded when the first watcher |
|
|
765 | is created, in which case it is assumed that the application is using |
|
|
766 | them. This means that AnyEvent will automatically pick the right backend |
|
|
767 | when the main program loads an event module before anything starts to |
|
|
768 | create watchers. Nothing special needs to be done by the main program. |
|
|
769 | |
|
|
770 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
|
|
771 | AnyEvent::Impl::Tk based on Tk, very broken. |
|
|
772 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
|
|
773 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
|
|
774 | |
|
|
775 | =item Backends with special needs. |
|
|
776 | |
|
|
777 | Qt requires the Qt::Application to be instantiated first, but will |
|
|
778 | otherwise be picked up automatically. As long as the main program |
|
|
779 | instantiates the application before any AnyEvent watchers are created, |
|
|
780 | everything should just work. |
|
|
781 | |
|
|
782 | AnyEvent::Impl::Qt based on Qt. |
|
|
783 | |
|
|
784 | Support for IO::Async can only be partial, as it is too broken and |
|
|
785 | architecturally limited to even support the AnyEvent API. It also |
|
|
786 | is the only event loop that needs the loop to be set explicitly, so |
|
|
787 | it can only be used by a main program knowing about AnyEvent. See |
|
|
788 | L<AnyEvent::Impl::Async> for the gory details. |
|
|
789 | |
|
|
790 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed. |
|
|
791 | |
|
|
792 | =item Event loops that are indirectly supported via other backends. |
|
|
793 | |
|
|
794 | Some event loops can be supported via other modules: |
|
|
795 | |
|
|
796 | There is no direct support for WxWidgets (L<Wx>) or L<Prima>. |
|
|
797 | |
|
|
798 | B<WxWidgets> has no support for watching file handles. However, you can |
|
|
799 | use WxWidgets through the POE adaptor, as POE has a Wx backend that simply |
|
|
800 | polls 20 times per second, which was considered to be too horrible to even |
|
|
801 | consider for AnyEvent. |
|
|
802 | |
|
|
803 | B<Prima> is not supported as nobody seems to be using it, but it has a POE |
|
|
804 | backend, so it can be supported through POE. |
|
|
805 | |
|
|
806 | AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to |
|
|
807 | load L<POE> when detecting them, in the hope that POE will pick them up, |
|
|
808 | in which case everything will be automatic. |
|
|
809 | |
|
|
810 | =back |
|
|
811 | |
712 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
812 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
713 | |
813 | |
|
|
814 | These are not normally required to use AnyEvent, but can be useful to |
|
|
815 | write AnyEvent extension modules. |
|
|
816 | |
714 | =over 4 |
817 | =over 4 |
715 | |
818 | |
716 | =item $AnyEvent::MODEL |
819 | =item $AnyEvent::MODEL |
717 | |
820 | |
718 | Contains C<undef> until the first watcher is being created. Then it |
821 | Contains C<undef> until the first watcher is being created, before the |
|
|
822 | backend has been autodetected. |
|
|
823 | |
719 | contains the event model that is being used, which is the name of the |
824 | Afterwards it contains the event model that is being used, which is the |
720 | Perl class implementing the model. This class is usually one of the |
825 | name of the Perl class implementing the model. This class is usually one |
721 | C<AnyEvent::Impl:xxx> modules, but can be any other class in the case |
826 | of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the |
722 | AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). |
827 | case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it |
723 | |
828 | will be C<urxvt::anyevent>). |
724 | The known classes so far are: |
|
|
725 | |
|
|
726 | AnyEvent::Impl::EV based on EV (an interface to libev, best choice). |
|
|
727 | AnyEvent::Impl::Event based on Event, second best choice. |
|
|
728 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
|
|
729 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
|
|
730 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
|
|
731 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
|
|
732 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
|
|
733 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
|
|
734 | |
|
|
735 | There is no support for WxWidgets, as WxWidgets has no support for |
|
|
736 | watching file handles. However, you can use WxWidgets through the |
|
|
737 | POE Adaptor, as POE has a Wx backend that simply polls 20 times per |
|
|
738 | second, which was considered to be too horrible to even consider for |
|
|
739 | AnyEvent. Likewise, other POE backends can be used by AnyEvent by using |
|
|
740 | it's adaptor. |
|
|
741 | |
|
|
742 | AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when |
|
|
743 | autodetecting them. |
|
|
744 | |
829 | |
745 | =item AnyEvent::detect |
830 | =item AnyEvent::detect |
746 | |
831 | |
747 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
832 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
748 | if necessary. You should only call this function right before you would |
833 | if necessary. You should only call this function right before you would |
749 | have created an AnyEvent watcher anyway, that is, as late as possible at |
834 | have created an AnyEvent watcher anyway, that is, as late as possible at |
750 | runtime. |
835 | runtime, and not e.g. while initialising of your module. |
|
|
836 | |
|
|
837 | If you need to do some initialisation before AnyEvent watchers are |
|
|
838 | created, use C<post_detect>. |
751 | |
839 | |
752 | =item $guard = AnyEvent::post_detect { BLOCK } |
840 | =item $guard = AnyEvent::post_detect { BLOCK } |
753 | |
841 | |
754 | Arranges for the code block to be executed as soon as the event model is |
842 | Arranges for the code block to be executed as soon as the event model is |
755 | autodetected (or immediately if this has already happened). |
843 | autodetected (or immediately if this has already happened). |
|
|
844 | |
|
|
845 | The block will be executed I<after> the actual backend has been detected |
|
|
846 | (C<$AnyEvent::MODEL> is set), but I<before> any watchers have been |
|
|
847 | created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do |
|
|
848 | other initialisations - see the sources of L<AnyEvent::Strict> or |
|
|
849 | L<AnyEvent::AIO> to see how this is used. |
|
|
850 | |
|
|
851 | The most common usage is to create some global watchers, without forcing |
|
|
852 | event module detection too early, for example, L<AnyEvent::AIO> creates |
|
|
853 | and installs the global L<IO::AIO> watcher in a C<post_detect> block to |
|
|
854 | avoid autodetecting the event module at load time. |
756 | |
855 | |
757 | If called in scalar or list context, then it creates and returns an object |
856 | If called in scalar or list context, then it creates and returns an object |
758 | that automatically removes the callback again when it is destroyed. See |
857 | that automatically removes the callback again when it is destroyed. See |
759 | L<Coro::BDB> for a case where this is useful. |
858 | L<Coro::BDB> for a case where this is useful. |
760 | |
859 | |
… | |
… | |
763 | If there are any code references in this array (you can C<push> to it |
862 | If there are any code references in this array (you can C<push> to it |
764 | before or after loading AnyEvent), then they will called directly after |
863 | before or after loading AnyEvent), then they will called directly after |
765 | the event loop has been chosen. |
864 | the event loop has been chosen. |
766 | |
865 | |
767 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
866 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
768 | if it contains a true value then the event loop has already been detected, |
867 | if it is defined then the event loop has already been detected, and the |
769 | and the array will be ignored. |
868 | array will be ignored. |
770 | |
869 | |
771 | Best use C<AnyEvent::post_detect { BLOCK }> instead. |
870 | Best use C<AnyEvent::post_detect { BLOCK }> when your application allows |
|
|
871 | it,as it takes care of these details. |
|
|
872 | |
|
|
873 | This variable is mainly useful for modules that can do something useful |
|
|
874 | when AnyEvent is used and thus want to know when it is initialised, but do |
|
|
875 | not need to even load it by default. This array provides the means to hook |
|
|
876 | into AnyEvent passively, without loading it. |
772 | |
877 | |
773 | =back |
878 | =back |
774 | |
879 | |
775 | =head1 WHAT TO DO IN A MODULE |
880 | =head1 WHAT TO DO IN A MODULE |
776 | |
881 | |
… | |
… | |
831 | |
936 | |
832 | |
937 | |
833 | =head1 OTHER MODULES |
938 | =head1 OTHER MODULES |
834 | |
939 | |
835 | The following is a non-exhaustive list of additional modules that use |
940 | The following is a non-exhaustive list of additional modules that use |
836 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
941 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
837 | in the same program. Some of the modules come with AnyEvent, some are |
942 | modules and other event loops in the same program. Some of the modules |
838 | available via CPAN. |
943 | come with AnyEvent, most are available via CPAN. |
839 | |
944 | |
840 | =over 4 |
945 | =over 4 |
841 | |
946 | |
842 | =item L<AnyEvent::Util> |
947 | =item L<AnyEvent::Util> |
843 | |
948 | |
… | |
… | |
852 | |
957 | |
853 | =item L<AnyEvent::Handle> |
958 | =item L<AnyEvent::Handle> |
854 | |
959 | |
855 | Provide read and write buffers, manages watchers for reads and writes, |
960 | Provide read and write buffers, manages watchers for reads and writes, |
856 | supports raw and formatted I/O, I/O queued and fully transparent and |
961 | supports raw and formatted I/O, I/O queued and fully transparent and |
857 | non-blocking SSL/TLS. |
962 | non-blocking SSL/TLS (via L<AnyEvent::TLS>. |
858 | |
963 | |
859 | =item L<AnyEvent::DNS> |
964 | =item L<AnyEvent::DNS> |
860 | |
965 | |
861 | Provides rich asynchronous DNS resolver capabilities. |
966 | Provides rich asynchronous DNS resolver capabilities. |
862 | |
967 | |
… | |
… | |
890 | |
995 | |
891 | =item L<AnyEvent::GPSD> |
996 | =item L<AnyEvent::GPSD> |
892 | |
997 | |
893 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
998 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
894 | |
999 | |
|
|
1000 | =item L<AnyEvent::IRC> |
|
|
1001 | |
|
|
1002 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
|
|
1003 | |
|
|
1004 | =item L<AnyEvent::XMPP> |
|
|
1005 | |
|
|
1006 | AnyEvent based XMPP (Jabber protocol) module family (replacing the older |
|
|
1007 | Net::XMPP2>. |
|
|
1008 | |
895 | =item L<AnyEvent::IGS> |
1009 | =item L<AnyEvent::IGS> |
896 | |
1010 | |
897 | A non-blocking interface to the Internet Go Server protocol (used by |
1011 | A non-blocking interface to the Internet Go Server protocol (used by |
898 | L<App::IGS>). |
1012 | L<App::IGS>). |
899 | |
1013 | |
900 | =item L<AnyEvent::IRC> |
|
|
901 | |
|
|
902 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
|
|
903 | |
|
|
904 | =item L<Net::XMPP2> |
|
|
905 | |
|
|
906 | AnyEvent based XMPP (Jabber protocol) module family. |
|
|
907 | |
|
|
908 | =item L<Net::FCP> |
1014 | =item L<Net::FCP> |
909 | |
1015 | |
910 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
1016 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
911 | of AnyEvent. |
1017 | of AnyEvent. |
912 | |
1018 | |
… | |
… | |
916 | |
1022 | |
917 | =item L<Coro> |
1023 | =item L<Coro> |
918 | |
1024 | |
919 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
1025 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
920 | |
1026 | |
921 | =item L<IO::Lambda> |
|
|
922 | |
|
|
923 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
|
|
924 | |
|
|
925 | =back |
1027 | =back |
926 | |
1028 | |
927 | =cut |
1029 | =cut |
928 | |
1030 | |
929 | package AnyEvent; |
1031 | package AnyEvent; |
… | |
… | |
931 | no warnings; |
1033 | no warnings; |
932 | use strict qw(vars subs); |
1034 | use strict qw(vars subs); |
933 | |
1035 | |
934 | use Carp; |
1036 | use Carp; |
935 | |
1037 | |
936 | our $VERSION = 4.411; |
1038 | our $VERSION = 4.81; |
937 | our $MODEL; |
1039 | our $MODEL; |
938 | |
1040 | |
939 | our $AUTOLOAD; |
1041 | our $AUTOLOAD; |
940 | our @ISA; |
1042 | our @ISA; |
941 | |
1043 | |
… | |
… | |
967 | [Event:: => AnyEvent::Impl::Event::], |
1069 | [Event:: => AnyEvent::Impl::Event::], |
968 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
1070 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
969 | # everything below here will not be autoprobed |
1071 | # everything below here will not be autoprobed |
970 | # as the pureperl backend should work everywhere |
1072 | # as the pureperl backend should work everywhere |
971 | # and is usually faster |
1073 | # and is usually faster |
972 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
|
|
973 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
1074 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
974 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1075 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
|
|
1076 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
|
|
1077 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
975 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1078 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
976 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
|
|
977 | [Wx:: => AnyEvent::Impl::POE::], |
1079 | [Wx:: => AnyEvent::Impl::POE::], |
978 | [Prima:: => AnyEvent::Impl::POE::], |
1080 | [Prima:: => AnyEvent::Impl::POE::], |
|
|
1081 | # IO::Async is just too broken - we would need workarounds for its |
|
|
1082 | # byzantine signal and broken child handling, among others. |
|
|
1083 | # IO::Async is rather hard to detect, as it doesn't have any |
|
|
1084 | # obvious default class. |
|
|
1085 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1086 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1087 | # [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
979 | ); |
1088 | ); |
980 | |
1089 | |
981 | our %method = map +($_ => 1), |
1090 | our %method = map +($_ => 1), |
982 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
1091 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
983 | |
1092 | |
… | |
… | |
1075 | } |
1184 | } |
1076 | |
1185 | |
1077 | # utility function to dup a filehandle. this is used by many backends |
1186 | # utility function to dup a filehandle. this is used by many backends |
1078 | # to support binding more than one watcher per filehandle (they usually |
1187 | # to support binding more than one watcher per filehandle (they usually |
1079 | # allow only one watcher per fd, so we dup it to get a different one). |
1188 | # allow only one watcher per fd, so we dup it to get a different one). |
1080 | sub _dupfh($$$$) { |
1189 | sub _dupfh($$;$$) { |
1081 | my ($poll, $fh, $r, $w) = @_; |
1190 | my ($poll, $fh, $r, $w) = @_; |
1082 | |
1191 | |
1083 | # cygwin requires the fh mode to be matching, unix doesn't |
1192 | # cygwin requires the fh mode to be matching, unix doesn't |
1084 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
1193 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") : ($w, ">"); |
1085 | : $poll eq "w" ? ($w, ">") |
|
|
1086 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
|
|
1087 | |
1194 | |
1088 | open my $fh2, "$mode&" . fileno $fh |
1195 | open my $fh2, "$mode&", $fh |
1089 | or die "cannot dup() filehandle: $!,"; |
1196 | or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,"; |
1090 | |
1197 | |
1091 | # we assume CLOEXEC is already set by perl in all important cases |
1198 | # we assume CLOEXEC is already set by perl in all important cases |
1092 | |
1199 | |
1093 | ($fh2, $rw) |
1200 | ($fh2, $rw) |
1094 | } |
1201 | } |
… | |
… | |
1366 | =item C<PERL_ANYEVENT_STRICT> |
1473 | =item C<PERL_ANYEVENT_STRICT> |
1367 | |
1474 | |
1368 | AnyEvent does not do much argument checking by default, as thorough |
1475 | AnyEvent does not do much argument checking by default, as thorough |
1369 | argument checking is very costly. Setting this variable to a true value |
1476 | argument checking is very costly. Setting this variable to a true value |
1370 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
1477 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
1371 | check the arguments passed to most method calls. If it finds any problems |
1478 | check the arguments passed to most method calls. If it finds any problems, |
1372 | it will croak. |
1479 | it will croak. |
1373 | |
1480 | |
1374 | In other words, enables "strict" mode. |
1481 | In other words, enables "strict" mode. |
1375 | |
1482 | |
1376 | Unlike C<use strict>, it is definitely recommended ot keep it off in |
1483 | Unlike C<use strict>, it is definitely recommended to keep it off in |
1377 | production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while |
1484 | production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while |
1378 | developing programs can be very useful, however. |
1485 | developing programs can be very useful, however. |
1379 | |
1486 | |
1380 | =item C<PERL_ANYEVENT_MODEL> |
1487 | =item C<PERL_ANYEVENT_MODEL> |
1381 | |
1488 | |
… | |
… | |
1426 | |
1533 | |
1427 | =item C<PERL_ANYEVENT_MAX_FORKS> |
1534 | =item C<PERL_ANYEVENT_MAX_FORKS> |
1428 | |
1535 | |
1429 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
1536 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
1430 | will create in parallel. |
1537 | will create in parallel. |
|
|
1538 | |
|
|
1539 | =item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS> |
|
|
1540 | |
|
|
1541 | The default value for the C<max_outstanding> parameter for the default DNS |
|
|
1542 | resolver - this is the maximum number of parallel DNS requests that are |
|
|
1543 | sent to the DNS server. |
|
|
1544 | |
|
|
1545 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
|
|
1546 | |
|
|
1547 | The file to use instead of F</etc/resolv.conf> (or OS-specific |
|
|
1548 | configuration) in the default resolver. When set to the empty string, no |
|
|
1549 | default config will be used. |
|
|
1550 | |
|
|
1551 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
|
|
1552 | |
|
|
1553 | When neither C<ca_file> nor C<ca_path> was specified during |
|
|
1554 | L<AnyEvent::TLS> context creation, and either of these environment |
|
|
1555 | variables exist, they will be used to specify CA certificate locations |
|
|
1556 | instead of a system-dependent default. |
1431 | |
1557 | |
1432 | =back |
1558 | =back |
1433 | |
1559 | |
1434 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1560 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1435 | |
1561 | |
… | |
… | |
1680 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
1806 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
1681 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
1807 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
1682 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
1808 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
1683 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
1809 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
1684 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
1810 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
|
|
1811 | IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll |
|
|
1812 | IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll |
1685 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
1813 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
1686 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
1814 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
1687 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
1815 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
1688 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
1816 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
1689 | |
1817 | |
… | |
… | |
1718 | performance becomes really bad with lots of file descriptors (and few of |
1846 | performance becomes really bad with lots of file descriptors (and few of |
1719 | them active), of course, but this was not subject of this benchmark. |
1847 | them active), of course, but this was not subject of this benchmark. |
1720 | |
1848 | |
1721 | The C<Event> module has a relatively high setup and callback invocation |
1849 | The C<Event> module has a relatively high setup and callback invocation |
1722 | cost, but overall scores in on the third place. |
1850 | cost, but overall scores in on the third place. |
|
|
1851 | |
|
|
1852 | C<IO::Async> performs admirably well, about on par with C<Event>, even |
|
|
1853 | when using its pure perl backend. |
1723 | |
1854 | |
1724 | C<Glib>'s memory usage is quite a bit higher, but it features a |
1855 | C<Glib>'s memory usage is quite a bit higher, but it features a |
1725 | faster callback invocation and overall ends up in the same class as |
1856 | faster callback invocation and overall ends up in the same class as |
1726 | C<Event>. However, Glib scales extremely badly, doubling the number of |
1857 | C<Event>. However, Glib scales extremely badly, doubling the number of |
1727 | watchers increases the processing time by more than a factor of four, |
1858 | watchers increases the processing time by more than a factor of four, |
… | |
… | |
1805 | it to another server. This includes deleting the old timeout and creating |
1936 | it to another server. This includes deleting the old timeout and creating |
1806 | a new one that moves the timeout into the future. |
1937 | a new one that moves the timeout into the future. |
1807 | |
1938 | |
1808 | =head3 Results |
1939 | =head3 Results |
1809 | |
1940 | |
1810 | name sockets create request |
1941 | name sockets create request |
1811 | EV 20000 69.01 11.16 |
1942 | EV 20000 69.01 11.16 |
1812 | Perl 20000 73.32 35.87 |
1943 | Perl 20000 73.32 35.87 |
|
|
1944 | IOAsync 20000 157.00 98.14 epoll |
|
|
1945 | IOAsync 20000 159.31 616.06 poll |
1813 | Event 20000 212.62 257.32 |
1946 | Event 20000 212.62 257.32 |
1814 | Glib 20000 651.16 1896.30 |
1947 | Glib 20000 651.16 1896.30 |
1815 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
1948 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
1816 | |
1949 | |
1817 | =head3 Discussion |
1950 | =head3 Discussion |
1818 | |
1951 | |
1819 | This benchmark I<does> measure scalability and overall performance of the |
1952 | This benchmark I<does> measure scalability and overall performance of the |
1820 | particular event loop. |
1953 | particular event loop. |
… | |
… | |
1822 | EV is again fastest. Since it is using epoll on my system, the setup time |
1955 | EV is again fastest. Since it is using epoll on my system, the setup time |
1823 | is relatively high, though. |
1956 | is relatively high, though. |
1824 | |
1957 | |
1825 | Perl surprisingly comes second. It is much faster than the C-based event |
1958 | Perl surprisingly comes second. It is much faster than the C-based event |
1826 | loops Event and Glib. |
1959 | loops Event and Glib. |
|
|
1960 | |
|
|
1961 | IO::Async performs very well when using its epoll backend, and still quite |
|
|
1962 | good compared to Glib when using its pure perl backend. |
1827 | |
1963 | |
1828 | Event suffers from high setup time as well (look at its code and you will |
1964 | Event suffers from high setup time as well (look at its code and you will |
1829 | understand why). Callback invocation also has a high overhead compared to |
1965 | understand why). Callback invocation also has a high overhead compared to |
1830 | the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event |
1966 | the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event |
1831 | uses select or poll in basically all documented configurations. |
1967 | uses select or poll in basically all documented configurations. |
… | |
… | |
1900 | |
2036 | |
1901 | Recently I was told about the benchmark in the IO::Lambda manpage, which |
2037 | Recently I was told about the benchmark in the IO::Lambda manpage, which |
1902 | could be misinterpreted to make AnyEvent look bad. In fact, the benchmark |
2038 | could be misinterpreted to make AnyEvent look bad. In fact, the benchmark |
1903 | simply compares IO::Lambda with POE, and IO::Lambda looks better (which |
2039 | simply compares IO::Lambda with POE, and IO::Lambda looks better (which |
1904 | shouldn't come as a surprise to anybody). As such, the benchmark is |
2040 | shouldn't come as a surprise to anybody). As such, the benchmark is |
1905 | fine, and shows that the AnyEvent backend from IO::Lambda isn't very |
2041 | fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't |
1906 | optimal. But how would AnyEvent compare when used without the extra |
2042 | very optimal. But how would AnyEvent compare when used without the extra |
1907 | baggage? To explore this, I wrote the equivalent benchmark for AnyEvent. |
2043 | baggage? To explore this, I wrote the equivalent benchmark for AnyEvent. |
1908 | |
2044 | |
1909 | The benchmark itself creates an echo-server, and then, for 500 times, |
2045 | The benchmark itself creates an echo-server, and then, for 500 times, |
1910 | connects to the echo server, sends a line, waits for the reply, and then |
2046 | connects to the echo server, sends a line, waits for the reply, and then |
1911 | creates the next connection. This is a rather bad benchmark, as it doesn't |
2047 | creates the next connection. This is a rather bad benchmark, as it doesn't |
1912 | test the efficiency of the framework, but it is a benchmark nevertheless. |
2048 | test the efficiency of the framework or much non-blocking I/O, but it is a |
|
|
2049 | benchmark nevertheless. |
1913 | |
2050 | |
1914 | name runtime |
2051 | name runtime |
1915 | Lambda/select 0.330 sec |
2052 | Lambda/select 0.330 sec |
1916 | + optimized 0.122 sec |
2053 | + optimized 0.122 sec |
1917 | Lambda/AnyEvent 0.327 sec |
2054 | Lambda/AnyEvent 0.327 sec |
… | |
… | |
1923 | |
2060 | |
1924 | AnyEvent/select/nb 0.085 sec |
2061 | AnyEvent/select/nb 0.085 sec |
1925 | AnyEvent/EV/nb 0.068 sec |
2062 | AnyEvent/EV/nb 0.068 sec |
1926 | +state machine 0.134 sec |
2063 | +state machine 0.134 sec |
1927 | |
2064 | |
1928 | The benchmark is also a bit unfair (my fault) - the IO::Lambda |
2065 | The benchmark is also a bit unfair (my fault): the IO::Lambda/POE |
1929 | benchmarks actually make blocking connects and use 100% blocking I/O, |
2066 | benchmarks actually make blocking connects and use 100% blocking I/O, |
1930 | defeating the purpose of an event-based solution. All of the newly |
2067 | defeating the purpose of an event-based solution. All of the newly |
1931 | written AnyEvent benchmarks use 100% non-blocking connects (using |
2068 | written AnyEvent benchmarks use 100% non-blocking connects (using |
1932 | AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS |
2069 | AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS |
1933 | resolver), so AnyEvent is at a disadvantage here as non-blocking connects |
2070 | resolver), so AnyEvent is at a disadvantage here, as non-blocking connects |
1934 | generally require a lot more bookkeeping and event handling than blocking |
2071 | generally require a lot more bookkeeping and event handling than blocking |
1935 | connects (which involve a single syscall only). |
2072 | connects (which involve a single syscall only). |
1936 | |
2073 | |
1937 | The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which |
2074 | The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which |
1938 | offers similar expressive power as POE and IO::Lambda (using conventional |
2075 | offers similar expressive power as POE and IO::Lambda, using conventional |
1939 | Perl syntax), which means both the echo server and the client are 100% |
2076 | Perl syntax. This means that both the echo server and the client are 100% |
1940 | non-blocking w.r.t. I/O, further placing it at a disadvantage. |
2077 | non-blocking, further placing it at a disadvantage. |
1941 | |
2078 | |
1942 | As you can see, AnyEvent + EV even beats the hand-optimised "raw sockets |
2079 | As you can see, the AnyEvent + EV combination even beats the |
1943 | benchmark", while AnyEvent + its pure perl backend easily beats |
2080 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
1944 | IO::Lambda and POE. |
2081 | backend easily beats IO::Lambda and POE. |
1945 | |
2082 | |
1946 | And even the 100% non-blocking version written using the high-level (and |
2083 | And even the 100% non-blocking version written using the high-level (and |
1947 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda, |
2084 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a |
1948 | even thought it does all of DNS, tcp-connect and socket I/O in a |
2085 | large margin, even though it does all of DNS, tcp-connect and socket I/O |
1949 | non-blocking way. |
2086 | in a non-blocking way. |
1950 | |
2087 | |
1951 | The two AnyEvent benchmarks can be found as F<eg/ae0.pl> and F<eg/ae2.pl> |
2088 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
1952 | in the AnyEvent distribution, the remaining benchmarks are part of the |
2089 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
1953 | IO::lambda distribution and were used without any changes. |
2090 | part of the IO::lambda distribution and were used without any changes. |
1954 | |
2091 | |
1955 | |
2092 | |
1956 | =head1 SIGNALS |
2093 | =head1 SIGNALS |
1957 | |
2094 | |
1958 | AnyEvent currently installs handlers for these signals: |
2095 | AnyEvent currently installs handlers for these signals: |
… | |
… | |
1962 | =item SIGCHLD |
2099 | =item SIGCHLD |
1963 | |
2100 | |
1964 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
2101 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
1965 | emulation for event loops that do not support them natively. Also, some |
2102 | emulation for event loops that do not support them natively. Also, some |
1966 | event loops install a similar handler. |
2103 | event loops install a similar handler. |
|
|
2104 | |
|
|
2105 | If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will |
|
|
2106 | reset it to default, to avoid losing child exit statuses. |
1967 | |
2107 | |
1968 | =item SIGPIPE |
2108 | =item SIGPIPE |
1969 | |
2109 | |
1970 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
2110 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
1971 | when AnyEvent gets loaded. |
2111 | when AnyEvent gets loaded. |
… | |
… | |
1983 | |
2123 | |
1984 | =back |
2124 | =back |
1985 | |
2125 | |
1986 | =cut |
2126 | =cut |
1987 | |
2127 | |
|
|
2128 | undef $SIG{CHLD} |
|
|
2129 | if $SIG{CHLD} eq 'IGNORE'; |
|
|
2130 | |
1988 | $SIG{PIPE} = sub { } |
2131 | $SIG{PIPE} = sub { } |
1989 | unless defined $SIG{PIPE}; |
2132 | unless defined $SIG{PIPE}; |
1990 | |
|
|
1991 | |
2133 | |
1992 | =head1 FORK |
2134 | =head1 FORK |
1993 | |
2135 | |
1994 | Most event libraries are not fork-safe. The ones who are usually are |
2136 | Most event libraries are not fork-safe. The ones who are usually are |
1995 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2137 | because they rely on inefficient but fork-safe C<select> or C<poll> |
… | |
… | |
2018 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
2160 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
2019 | be used to probe what backend is used and gain other information (which is |
2161 | be used to probe what backend is used and gain other information (which is |
2020 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and |
2162 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and |
2021 | $ENV{PERL_ANYEVENT_STRICT}. |
2163 | $ENV{PERL_ANYEVENT_STRICT}. |
2022 | |
2164 | |
|
|
2165 | Note that AnyEvent will remove I<all> environment variables starting with |
|
|
2166 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
|
|
2167 | enabled. |
|
|
2168 | |
2023 | |
2169 | |
2024 | =head1 BUGS |
2170 | =head1 BUGS |
2025 | |
2171 | |
2026 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
2172 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
2027 | to work around. If you suffer from memleaks, first upgrade to Perl 5.10 |
2173 | to work around. If you suffer from memleaks, first upgrade to Perl 5.10 |
… | |
… | |
2038 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2184 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2039 | |
2185 | |
2040 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2186 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2041 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2187 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2042 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2188 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2043 | L<AnyEvent::Impl::POE>. |
2189 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. |
2044 | |
2190 | |
2045 | Non-blocking file handles, sockets, TCP clients and |
2191 | Non-blocking file handles, sockets, TCP clients and |
2046 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. |
2192 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2047 | |
2193 | |
2048 | Asynchronous DNS: L<AnyEvent::DNS>. |
2194 | Asynchronous DNS: L<AnyEvent::DNS>. |
2049 | |
2195 | |
2050 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, |
2196 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, |
|
|
2197 | L<Coro::Event>, |
2051 | |
2198 | |
2052 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
2199 | Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, |
|
|
2200 | L<AnyEvent::HTTP>. |
2053 | |
2201 | |
2054 | |
2202 | |
2055 | =head1 AUTHOR |
2203 | =head1 AUTHOR |
2056 | |
2204 | |
2057 | Marc Lehmann <schmorp@schmorp.de> |
2205 | Marc Lehmann <schmorp@schmorp.de> |