… | |
… | |
48 | isn't itself. What's worse, all the potential users of your module are |
48 | isn't itself. What's worse, all the potential users of your module are |
49 | I<also> forced to use the same event loop you use. |
49 | I<also> forced to use the same event loop you use. |
50 | |
50 | |
51 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
51 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
52 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
52 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
53 | with the rest: POE + IO::Async? no go. Tk + Event? no go. Again: if |
53 | with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if |
54 | your module uses one of those, every user of your module has to use it, |
54 | your module uses one of those, every user of your module has to use it, |
55 | too. But if your module uses AnyEvent, it works transparently with all |
55 | too. But if your module uses AnyEvent, it works transparently with all |
56 | event models it supports (including stuff like POE and IO::Async, as long |
56 | event models it supports (including stuff like POE and IO::Async, as long |
57 | as those use one of the supported event loops. It is trivial to add new |
57 | as those use one of the supported event loops. It is trivial to add new |
58 | event loops to AnyEvent, too, so it is future-proof). |
58 | event loops to AnyEvent, too, so it is future-proof). |
… | |
… | |
62 | modules, you get an enormous amount of code and strict rules you have to |
62 | modules, you get an enormous amount of code and strict rules you have to |
63 | follow. AnyEvent, on the other hand, is lean and up to the point, by only |
63 | follow. AnyEvent, on the other hand, is lean and up to the point, by only |
64 | offering the functionality that is necessary, in as thin as a wrapper as |
64 | offering the functionality that is necessary, in as thin as a wrapper as |
65 | technically possible. |
65 | technically possible. |
66 | |
66 | |
|
|
67 | Of course, AnyEvent comes with a big (and fully optional!) toolbox |
|
|
68 | of useful functionality, such as an asynchronous DNS resolver, 100% |
|
|
69 | non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms |
|
|
70 | such as Windows) and lots of real-world knowledge and workarounds for |
|
|
71 | platform bugs and differences. |
|
|
72 | |
67 | Of course, if you want lots of policy (this can arguably be somewhat |
73 | Now, if you I<do want> lots of policy (this can arguably be somewhat |
68 | useful) and you want to force your users to use the one and only event |
74 | useful) and you want to force your users to use the one and only event |
69 | model, you should I<not> use this module. |
75 | model, you should I<not> use this module. |
70 | |
76 | |
71 | =head1 DESCRIPTION |
77 | =head1 DESCRIPTION |
72 | |
78 | |
… | |
… | |
102 | starts using it, all bets are off. Maybe you should tell their authors to |
108 | starts using it, all bets are off. Maybe you should tell their authors to |
103 | use AnyEvent so their modules work together with others seamlessly... |
109 | use AnyEvent so their modules work together with others seamlessly... |
104 | |
110 | |
105 | The pure-perl implementation of AnyEvent is called |
111 | The pure-perl implementation of AnyEvent is called |
106 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
112 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
107 | explicitly. |
113 | explicitly and enjoy the high availability of that event loop :) |
108 | |
114 | |
109 | =head1 WATCHERS |
115 | =head1 WATCHERS |
110 | |
116 | |
111 | AnyEvent has the central concept of a I<watcher>, which is an object that |
117 | AnyEvent has the central concept of a I<watcher>, which is an object that |
112 | stores relevant data for each kind of event you are waiting for, such as |
118 | stores relevant data for each kind of event you are waiting for, such as |
… | |
… | |
312 | C<cb>, which specifies a callback to be called when the condition variable |
318 | C<cb>, which specifies a callback to be called when the condition variable |
313 | becomes true. |
319 | becomes true. |
314 | |
320 | |
315 | After creation, the condition variable is "false" until it becomes "true" |
321 | After creation, the condition variable is "false" until it becomes "true" |
316 | by calling the C<send> method (or calling the condition variable as if it |
322 | by calling the C<send> method (or calling the condition variable as if it |
317 | were a callback). |
323 | were a callback, read about the caveats in the description for the C<< |
|
|
324 | ->send >> method). |
318 | |
325 | |
319 | Condition variables are similar to callbacks, except that you can |
326 | Condition variables are similar to callbacks, except that you can |
320 | optionally wait for them. They can also be called merge points - points |
327 | optionally wait for them. They can also be called merge points - points |
321 | in time where multiple outstanding events have been processed. And yet |
328 | in time where multiple outstanding events have been processed. And yet |
322 | another way to call them is transactions - each condition variable can be |
329 | another way to call them is transactions - each condition variable can be |
… | |
… | |
394 | immediately from within send. |
401 | immediately from within send. |
395 | |
402 | |
396 | Any arguments passed to the C<send> call will be returned by all |
403 | Any arguments passed to the C<send> call will be returned by all |
397 | future C<< ->recv >> calls. |
404 | future C<< ->recv >> calls. |
398 | |
405 | |
399 | Condition variables are overloaded so one can call them directly (as a |
406 | Condition variables are overloaded so one can call them directly |
400 | code reference). Calling them directly is the same as calling C<send>. |
407 | (as a code reference). Calling them directly is the same as calling |
|
|
408 | C<send>. Note, however, that many C-based event loops do not handle |
|
|
409 | overloading, so as tempting as it may be, passing a condition variable |
|
|
410 | instead of a callback does not work. Both the pure perl and EV loops |
|
|
411 | support overloading, however, as well as all functions that use perl to |
|
|
412 | invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for |
|
|
413 | example). |
401 | |
414 | |
402 | =item $cv->croak ($error) |
415 | =item $cv->croak ($error) |
403 | |
416 | |
404 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
417 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
405 | C<Carp::croak> with the given error message/object/scalar. |
418 | C<Carp::croak> with the given error message/object/scalar. |
… | |
… | |
724 | no warnings; |
737 | no warnings; |
725 | use strict; |
738 | use strict; |
726 | |
739 | |
727 | use Carp; |
740 | use Carp; |
728 | |
741 | |
729 | our $VERSION = '4.03'; |
742 | our $VERSION = '4.05'; |
730 | our $MODEL; |
743 | our $MODEL; |
731 | |
744 | |
732 | our $AUTOLOAD; |
745 | our $AUTOLOAD; |
733 | our @ISA; |
746 | our @ISA; |
734 | |
747 | |
|
|
748 | our @REGISTRY; |
|
|
749 | |
|
|
750 | our $WIN32; |
|
|
751 | |
|
|
752 | BEGIN { |
|
|
753 | my $win32 = ! ! ($^O =~ /mswin32/i); |
|
|
754 | eval "sub WIN32(){ $win32 }"; |
|
|
755 | } |
|
|
756 | |
735 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
757 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
736 | |
758 | |
737 | our @REGISTRY; |
759 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
738 | |
|
|
739 | our %PROTOCOL; # (ipv4|ipv6) => (1|2) |
|
|
740 | |
760 | |
741 | { |
761 | { |
742 | my $idx; |
762 | my $idx; |
743 | $PROTOCOL{$_} = ++$idx |
763 | $PROTOCOL{$_} = ++$idx |
|
|
764 | for reverse split /\s*,\s*/, |
744 | for split /\s*,\s*/, $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
765 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
745 | } |
766 | } |
746 | |
767 | |
747 | my @models = ( |
768 | my @models = ( |
748 | [EV:: => AnyEvent::Impl::EV::], |
769 | [EV:: => AnyEvent::Impl::EV::], |
749 | [Event:: => AnyEvent::Impl::Event::], |
770 | [Event:: => AnyEvent::Impl::Event::], |
750 | [Tk:: => AnyEvent::Impl::Tk::], |
|
|
751 | [Wx:: => AnyEvent::Impl::POE::], |
|
|
752 | [Prima:: => AnyEvent::Impl::POE::], |
|
|
753 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
771 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
754 | # everything below here will not be autoprobed as the pureperl backend should work everywhere |
772 | # everything below here will not be autoprobed |
755 | [Glib:: => AnyEvent::Impl::Glib::], |
773 | # as the pureperl backend should work everywhere |
|
|
774 | # and is usually faster |
|
|
775 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
|
|
776 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
756 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
777 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
757 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
778 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
758 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
779 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
|
|
780 | [Wx:: => AnyEvent::Impl::POE::], |
|
|
781 | [Prima:: => AnyEvent::Impl::POE::], |
759 | ); |
782 | ); |
760 | |
783 | |
761 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
784 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
762 | |
785 | |
763 | our @post_detect; |
786 | our @post_detect; |
… | |
… | |
783 | } |
806 | } |
784 | |
807 | |
785 | sub detect() { |
808 | sub detect() { |
786 | unless ($MODEL) { |
809 | unless ($MODEL) { |
787 | no strict 'refs'; |
810 | no strict 'refs'; |
|
|
811 | local $SIG{__DIE__}; |
788 | |
812 | |
789 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
813 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
790 | my $model = "AnyEvent::Impl::$1"; |
814 | my $model = "AnyEvent::Impl::$1"; |
791 | if (eval "require $model") { |
815 | if (eval "require $model") { |
792 | $MODEL = $model; |
816 | $MODEL = $model; |
… | |
… | |
915 | or Carp::croak "required option 'pid' is missing"; |
939 | or Carp::croak "required option 'pid' is missing"; |
916 | |
940 | |
917 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
941 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
918 | |
942 | |
919 | unless ($WNOHANG) { |
943 | unless ($WNOHANG) { |
920 | $WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1; |
944 | $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
921 | } |
945 | } |
922 | |
946 | |
923 | unless ($CHLD_W) { |
947 | unless ($CHLD_W) { |
924 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
948 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
925 | # child could be a zombie already, so make at least one round |
949 | # child could be a zombie already, so make at least one round |
… | |
… | |
1104 | some (broken) firewalls drop such DNS packets, which is why it is off by |
1128 | some (broken) firewalls drop such DNS packets, which is why it is off by |
1105 | default. |
1129 | default. |
1106 | |
1130 | |
1107 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
1131 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
1108 | EDNS0 in its DNS requests. |
1132 | EDNS0 in its DNS requests. |
|
|
1133 | |
|
|
1134 | =item C<PERL_ANYEVENT_MAX_FORKS> |
|
|
1135 | |
|
|
1136 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
|
|
1137 | will create in parallel. |
1109 | |
1138 | |
1110 | =back |
1139 | =back |
1111 | |
1140 | |
1112 | =head1 EXAMPLE PROGRAM |
1141 | =head1 EXAMPLE PROGRAM |
1113 | |
1142 | |