ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.228 by root, Wed Jul 8 01:11:12 2009 UTC vs.
Revision 1.242 by root, Fri Jul 17 22:05:12 2009 UTC

176=head2 I/O WATCHERS 176=head2 I/O WATCHERS
177 177
178You can create an I/O watcher by calling the C<< AnyEvent->io >> method 178You can create an I/O watcher by calling the C<< AnyEvent->io >> method
179with the following mandatory key-value pairs as arguments: 179with the following mandatory key-value pairs as arguments:
180 180
181C<fh> is the Perl I<file handle> (I<not> file descriptor, see below) to 181C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
182watch for events (AnyEvent might or might not keep a reference to this 182for events (AnyEvent might or might not keep a reference to this file
183file handle). Note that only file handles pointing to things for which 183handle). Note that only file handles pointing to things for which
184non-blocking operation makes sense are allowed. This includes sockets, 184non-blocking operation makes sense are allowed. This includes sockets,
185most character devices, pipes, fifos and so on, but not for example files 185most character devices, pipes, fifos and so on, but not for example files
186or block devices. 186or block devices.
187 187
188C<poll> must be a string that is either C<r> or C<w>, which creates a 188C<poll> must be a string that is either C<r> or C<w>, which creates a
209 chomp (my $input = <STDIN>); 209 chomp (my $input = <STDIN>);
210 warn "read: $input\n"; 210 warn "read: $input\n";
211 undef $w; 211 undef $w;
212 }); 212 });
213 213
214=head3 GETTING A FILE HANDLE FROM A FILE DESCRIPTOR
215
216It is not uncommon to only have a file descriptor, while AnyEvent requires
217a Perl file handle.
218
219There are basically two methods to convert a file descriptor into a file handle. If you own
220the file descriptor, you can open it with C<&=>, as in:
221
222 open my $fh, "<&=$fileno" or die "xxx: ยง!";
223
224This will "own" the file descriptor, meaning that when C<$fh> is
225destroyed, it will automatically close the C<$fileno>. Also, note that
226the open mode (read, write, read/write) must correspond with how the
227underlying file descriptor was opened.
228
229In many cases, taking over the file descriptor is now what you want, in
230which case the only alternative is to dup the file descriptor:
231
232 open my $fh, "<&$fileno" or die "xxx: $!";
233
234This has the advantage of not closing the file descriptor and the
235disadvantage of making a slow copy.
236
237=head2 TIME WATCHERS 214=head2 TIME WATCHERS
238 215
239You can create a time watcher by calling the C<< AnyEvent->timer >> 216You can create a time watcher by calling the C<< AnyEvent->timer >>
240method with the following mandatory arguments: 217method with the following mandatory arguments:
241 218
384invocation, and callback invocation will be synchronous. Synchronous means 361invocation, and callback invocation will be synchronous. Synchronous means
385that it might take a while until the signal gets handled by the process, 362that it might take a while until the signal gets handled by the process,
386but it is guaranteed not to interrupt any other callbacks. 363but it is guaranteed not to interrupt any other callbacks.
387 364
388The main advantage of using these watchers is that you can share a signal 365The main advantage of using these watchers is that you can share a signal
389between multiple watchers. 366between multiple watchers, and AnyEvent will ensure that signals will not
367interrupt your program at bad times.
390 368
391This watcher might use C<%SIG>, so programs overwriting those signals 369This watcher might use C<%SIG> (depending on the event loop used),
392directly will likely not work correctly. 370so programs overwriting those signals directly will likely not work
371correctly.
372
373Also note that many event loops (e.g. Glib, Tk, Qt, IO::Async) do not
374support attaching callbacks to signals, which is a pity, as you cannot do
375race-free signal handling in perl. AnyEvent will try to do it's best, but
376in some cases, signals will be delayed. The maximum time a signal might
377be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10
378seconds). This variable can be changed only before the first signal
379watcher is created, and should be left alone otherwise. Higher values
380will cause fewer spurious wake-ups, which is better for power and CPU
381saving. All these problems can be avoided by installing the optional
382L<Async::Interrupt> module.
393 383
394Example: exit on SIGINT 384Example: exit on SIGINT
395 385
396 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 386 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
397 387
426 416
427This means you cannot create a child watcher as the very first 417This means you cannot create a child watcher as the very first
428thing in an AnyEvent program, you I<have> to create at least one 418thing in an AnyEvent program, you I<have> to create at least one
429watcher before you C<fork> the child (alternatively, you can call 419watcher before you C<fork> the child (alternatively, you can call
430C<AnyEvent::detect>). 420C<AnyEvent::detect>).
421
422As most event loops do not support waiting for child events, they will be
423emulated by AnyEvent in most cases, in which the latency and race problems
424mentioned in the description of signal watchers apply.
431 425
432Example: fork a process and wait for it 426Example: fork a process and wait for it
433 427
434 my $done = AnyEvent->condvar; 428 my $done = AnyEvent->condvar;
435 429
486 480
487If you are familiar with some event loops you will know that all of them 481If you are familiar with some event loops you will know that all of them
488require you to run some blocking "loop", "run" or similar function that 482require you to run some blocking "loop", "run" or similar function that
489will actively watch for new events and call your callbacks. 483will actively watch for new events and call your callbacks.
490 484
491AnyEvent is different, it expects somebody else to run the event loop and 485AnyEvent is slightly different: it expects somebody else to run the event
492will only block when necessary (usually when told by the user). 486loop and will only block when necessary (usually when told by the user).
493 487
494The instrument to do that is called a "condition variable", so called 488The instrument to do that is called a "condition variable", so called
495because they represent a condition that must become true. 489because they represent a condition that must become true.
496 490
491Now is probably a good time to look at the examples further below.
492
497Condition variables can be created by calling the C<< AnyEvent->condvar 493Condition variables can be created by calling the C<< AnyEvent->condvar
498>> method, usually without arguments. The only argument pair allowed is 494>> method, usually without arguments. The only argument pair allowed is
499
500C<cb>, which specifies a callback to be called when the condition variable 495C<cb>, which specifies a callback to be called when the condition variable
501becomes true, with the condition variable as the first argument (but not 496becomes true, with the condition variable as the first argument (but not
502the results). 497the results).
503 498
504After creation, the condition variable is "false" until it becomes "true" 499After creation, the condition variable is "false" until it becomes "true"
553 after => 1, 548 after => 1,
554 cb => sub { $result_ready->send }, 549 cb => sub { $result_ready->send },
555 ); 550 );
556 551
557 # this "blocks" (while handling events) till the callback 552 # this "blocks" (while handling events) till the callback
558 # calls send 553 # calls -<send
559 $result_ready->recv; 554 $result_ready->recv;
560 555
561Example: wait for a timer, but take advantage of the fact that 556Example: wait for a timer, but take advantage of the fact that condition
562condition variables are also code references. 557variables are also callable directly.
563 558
564 my $done = AnyEvent->condvar; 559 my $done = AnyEvent->condvar;
565 my $delay = AnyEvent->timer (after => 5, cb => $done); 560 my $delay = AnyEvent->timer (after => 5, cb => $done);
566 $done->recv; 561 $done->recv;
567 562
573 568
574 ... 569 ...
575 570
576 my @info = $couchdb->info->recv; 571 my @info = $couchdb->info->recv;
577 572
578And this is how you would just ste a callback to be called whenever the 573And this is how you would just set a callback to be called whenever the
579results are available: 574results are available:
580 575
581 $couchdb->info->cb (sub { 576 $couchdb->info->cb (sub {
582 my @info = $_[0]->recv; 577 my @info = $_[0]->recv;
583 }); 578 });
601immediately from within send. 596immediately from within send.
602 597
603Any arguments passed to the C<send> call will be returned by all 598Any arguments passed to the C<send> call will be returned by all
604future C<< ->recv >> calls. 599future C<< ->recv >> calls.
605 600
606Condition variables are overloaded so one can call them directly 601Condition variables are overloaded so one can call them directly (as if
607(as a code reference). Calling them directly is the same as calling 602they were a code reference). Calling them directly is the same as calling
608C<send>. Note, however, that many C-based event loops do not handle 603C<send>.
609overloading, so as tempting as it may be, passing a condition variable
610instead of a callback does not work. Both the pure perl and EV loops
611support overloading, however, as well as all functions that use perl to
612invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
613example).
614 604
615=item $cv->croak ($error) 605=item $cv->croak ($error)
616 606
617Similar to send, but causes all call's to C<< ->recv >> to invoke 607Similar to send, but causes all call's to C<< ->recv >> to invoke
618C<Carp::croak> with the given error message/object/scalar. 608C<Carp::croak> with the given error message/object/scalar.
619 609
620This can be used to signal any errors to the condition variable 610This can be used to signal any errors to the condition variable
621user/consumer. 611user/consumer. Doing it this way instead of calling C<croak> directly
612delays the error detetcion, but has the overwhelmign advantage that it
613diagnoses the error at the place where the result is expected, and not
614deep in some event clalback without connection to the actual code causing
615the problem.
622 616
623=item $cv->begin ([group callback]) 617=item $cv->begin ([group callback])
624 618
625=item $cv->end 619=item $cv->end
626 620
722function will call C<croak>. 716function will call C<croak>.
723 717
724In list context, all parameters passed to C<send> will be returned, 718In list context, all parameters passed to C<send> will be returned,
725in scalar context only the first one will be returned. 719in scalar context only the first one will be returned.
726 720
721Note that doing a blocking wait in a callback is not supported by any
722event loop, that is, recursive invocation of a blocking C<< ->recv
723>> is not allowed, and the C<recv> call will C<croak> if such a
724condition is detected. This condition can be slightly loosened by using
725L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
726any thread that doesn't run the event loop itself.
727
727Not all event models support a blocking wait - some die in that case 728Not all event models support a blocking wait - some die in that case
728(programs might want to do that to stay interactive), so I<if you are 729(programs might want to do that to stay interactive), so I<if you are
729using this from a module, never require a blocking wait>, but let the 730using this from a module, never require a blocking wait>. Instead, let the
730caller decide whether the call will block or not (for example, by coupling 731caller decide whether the call will block or not (for example, by coupling
731condition variables with some kind of request results and supporting 732condition variables with some kind of request results and supporting
732callbacks so the caller knows that getting the result will not block, 733callbacks so the caller knows that getting the result will not block,
733while still supporting blocking waits if the caller so desires). 734while still supporting blocking waits if the caller so desires).
734 735
735Another reason I<never> to C<< ->recv >> in a module is that you cannot
736sensibly have two C<< ->recv >>'s in parallel, as that would require
737multiple interpreters or coroutines/threads, none of which C<AnyEvent>
738can supply.
739
740The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
741fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
742versions and also integrates coroutines into AnyEvent, making blocking
743C<< ->recv >> calls perfectly safe as long as they are done from another
744coroutine (one that doesn't run the event loop).
745
746You can ensure that C<< -recv >> never blocks by setting a callback and 736You can ensure that C<< -recv >> never blocks by setting a callback and
747only calling C<< ->recv >> from within that callback (or at a later 737only calling C<< ->recv >> from within that callback (or at a later
748time). This will work even when the event loop does not support blocking 738time). This will work even when the event loop does not support blocking
749waits otherwise. 739waits otherwise.
750 740
763variable itself. Calling C<recv> inside the callback or at any later time 753variable itself. Calling C<recv> inside the callback or at any later time
764is guaranteed not to block. 754is guaranteed not to block.
765 755
766=back 756=back
767 757
758=head1 SUPPORTED EVENT LOOPS/BACKENDS
759
760The available backend classes are (every class has its own manpage):
761
762=over 4
763
764=item Backends that are autoprobed when no other event loop can be found.
765
766EV is the preferred backend when no other event loop seems to be in
767use. If EV is not installed, then AnyEvent will try Event, and, failing
768that, will fall back to its own pure-perl implementation, which is
769available everywhere as it comes with AnyEvent itself.
770
771 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
772 AnyEvent::Impl::Event based on Event, very stable, few glitches.
773 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
774
775=item Backends that are transparently being picked up when they are used.
776
777These will be used when they are currently loaded when the first watcher
778is created, in which case it is assumed that the application is using
779them. This means that AnyEvent will automatically pick the right backend
780when the main program loads an event module before anything starts to
781create watchers. Nothing special needs to be done by the main program.
782
783 AnyEvent::Impl::Glib based on Glib, slow but very stable.
784 AnyEvent::Impl::Tk based on Tk, very broken.
785 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
786 AnyEvent::Impl::POE based on POE, very slow, some limitations.
787
788=item Backends with special needs.
789
790Qt requires the Qt::Application to be instantiated first, but will
791otherwise be picked up automatically. As long as the main program
792instantiates the application before any AnyEvent watchers are created,
793everything should just work.
794
795 AnyEvent::Impl::Qt based on Qt.
796
797Support for IO::Async can only be partial, as it is too broken and
798architecturally limited to even support the AnyEvent API. It also
799is the only event loop that needs the loop to be set explicitly, so
800it can only be used by a main program knowing about AnyEvent. See
801L<AnyEvent::Impl::Async> for the gory details.
802
803 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
804
805=item Event loops that are indirectly supported via other backends.
806
807Some event loops can be supported via other modules:
808
809There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
810
811B<WxWidgets> has no support for watching file handles. However, you can
812use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
813polls 20 times per second, which was considered to be too horrible to even
814consider for AnyEvent.
815
816B<Prima> is not supported as nobody seems to be using it, but it has a POE
817backend, so it can be supported through POE.
818
819AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
820load L<POE> when detecting them, in the hope that POE will pick them up,
821in which case everything will be automatic.
822
823=back
824
768=head1 GLOBAL VARIABLES AND FUNCTIONS 825=head1 GLOBAL VARIABLES AND FUNCTIONS
769 826
827These are not normally required to use AnyEvent, but can be useful to
828write AnyEvent extension modules.
829
770=over 4 830=over 4
771 831
772=item $AnyEvent::MODEL 832=item $AnyEvent::MODEL
773 833
774Contains C<undef> until the first watcher is being created. Then it 834Contains C<undef> until the first watcher is being created, before the
835backend has been autodetected.
836
775contains the event model that is being used, which is the name of the 837Afterwards it contains the event model that is being used, which is the
776Perl class implementing the model. This class is usually one of the 838name of the Perl class implementing the model. This class is usually one
777C<AnyEvent::Impl:xxx> modules, but can be any other class in the case 839of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
778AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). 840case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
779 841will be C<urxvt::anyevent>).
780The known classes so far are:
781
782 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
783 AnyEvent::Impl::Event based on Event, second best choice.
784 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
785 AnyEvent::Impl::Glib based on Glib, third-best choice.
786 AnyEvent::Impl::Tk based on Tk, very bad choice.
787 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
788 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
789 AnyEvent::Impl::POE based on POE, not generic enough for full support.
790
791 # warning, support for IO::Async is only partial, as it is too broken
792 # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
793 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
794
795There is no support for WxWidgets, as WxWidgets has no support for
796watching file handles. However, you can use WxWidgets through the
797POE Adaptor, as POE has a Wx backend that simply polls 20 times per
798second, which was considered to be too horrible to even consider for
799AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
800it's adaptor.
801
802AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
803autodetecting them.
804 842
805=item AnyEvent::detect 843=item AnyEvent::detect
806 844
807Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 845Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
808if necessary. You should only call this function right before you would 846if necessary. You should only call this function right before you would
809have created an AnyEvent watcher anyway, that is, as late as possible at 847have created an AnyEvent watcher anyway, that is, as late as possible at
810runtime. 848runtime, and not e.g. while initialising of your module.
849
850If you need to do some initialisation before AnyEvent watchers are
851created, use C<post_detect>.
811 852
812=item $guard = AnyEvent::post_detect { BLOCK } 853=item $guard = AnyEvent::post_detect { BLOCK }
813 854
814Arranges for the code block to be executed as soon as the event model is 855Arranges for the code block to be executed as soon as the event model is
815autodetected (or immediately if this has already happened). 856autodetected (or immediately if this has already happened).
857
858The block will be executed I<after> the actual backend has been detected
859(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
860created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
861other initialisations - see the sources of L<AnyEvent::Strict> or
862L<AnyEvent::AIO> to see how this is used.
863
864The most common usage is to create some global watchers, without forcing
865event module detection too early, for example, L<AnyEvent::AIO> creates
866and installs the global L<IO::AIO> watcher in a C<post_detect> block to
867avoid autodetecting the event module at load time.
816 868
817If called in scalar or list context, then it creates and returns an object 869If called in scalar or list context, then it creates and returns an object
818that automatically removes the callback again when it is destroyed. See 870that automatically removes the callback again when it is destroyed. See
819L<Coro::BDB> for a case where this is useful. 871L<Coro::BDB> for a case where this is useful.
820 872
823If there are any code references in this array (you can C<push> to it 875If there are any code references in this array (you can C<push> to it
824before or after loading AnyEvent), then they will called directly after 876before or after loading AnyEvent), then they will called directly after
825the event loop has been chosen. 877the event loop has been chosen.
826 878
827You should check C<$AnyEvent::MODEL> before adding to this array, though: 879You should check C<$AnyEvent::MODEL> before adding to this array, though:
828if it contains a true value then the event loop has already been detected, 880if it is defined then the event loop has already been detected, and the
829and the array will be ignored. 881array will be ignored.
830 882
831Best use C<AnyEvent::post_detect { BLOCK }> instead. 883Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
884it,as it takes care of these details.
885
886This variable is mainly useful for modules that can do something useful
887when AnyEvent is used and thus want to know when it is initialised, but do
888not need to even load it by default. This array provides the means to hook
889into AnyEvent passively, without loading it.
832 890
833=back 891=back
834 892
835=head1 WHAT TO DO IN A MODULE 893=head1 WHAT TO DO IN A MODULE
836 894
891 949
892 950
893=head1 OTHER MODULES 951=head1 OTHER MODULES
894 952
895The following is a non-exhaustive list of additional modules that use 953The following is a non-exhaustive list of additional modules that use
896AnyEvent and can therefore be mixed easily with other AnyEvent modules 954AnyEvent as a client and can therefore be mixed easily with other AnyEvent
897in the same program. Some of the modules come with AnyEvent, some are 955modules and other event loops in the same program. Some of the modules
898available via CPAN. 956come with AnyEvent, most are available via CPAN.
899 957
900=over 4 958=over 4
901 959
902=item L<AnyEvent::Util> 960=item L<AnyEvent::Util>
903 961
912 970
913=item L<AnyEvent::Handle> 971=item L<AnyEvent::Handle>
914 972
915Provide read and write buffers, manages watchers for reads and writes, 973Provide read and write buffers, manages watchers for reads and writes,
916supports raw and formatted I/O, I/O queued and fully transparent and 974supports raw and formatted I/O, I/O queued and fully transparent and
917non-blocking SSL/TLS. 975non-blocking SSL/TLS (via L<AnyEvent::TLS>.
918 976
919=item L<AnyEvent::DNS> 977=item L<AnyEvent::DNS>
920 978
921Provides rich asynchronous DNS resolver capabilities. 979Provides rich asynchronous DNS resolver capabilities.
922 980
950 1008
951=item L<AnyEvent::GPSD> 1009=item L<AnyEvent::GPSD>
952 1010
953A non-blocking interface to gpsd, a daemon delivering GPS information. 1011A non-blocking interface to gpsd, a daemon delivering GPS information.
954 1012
1013=item L<AnyEvent::IRC>
1014
1015AnyEvent based IRC client module family (replacing the older Net::IRC3).
1016
1017=item L<AnyEvent::XMPP>
1018
1019AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1020Net::XMPP2>.
1021
955=item L<AnyEvent::IGS> 1022=item L<AnyEvent::IGS>
956 1023
957A non-blocking interface to the Internet Go Server protocol (used by 1024A non-blocking interface to the Internet Go Server protocol (used by
958L<App::IGS>). 1025L<App::IGS>).
959 1026
960=item L<AnyEvent::IRC>
961
962AnyEvent based IRC client module family (replacing the older Net::IRC3).
963
964=item L<Net::XMPP2>
965
966AnyEvent based XMPP (Jabber protocol) module family.
967
968=item L<Net::FCP> 1027=item L<Net::FCP>
969 1028
970AnyEvent-based implementation of the Freenet Client Protocol, birthplace 1029AnyEvent-based implementation of the Freenet Client Protocol, birthplace
971of AnyEvent. 1030of AnyEvent.
972 1031
976 1035
977=item L<Coro> 1036=item L<Coro>
978 1037
979Has special support for AnyEvent via L<Coro::AnyEvent>. 1038Has special support for AnyEvent via L<Coro::AnyEvent>.
980 1039
981=item L<IO::Lambda>
982
983The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
984
985=back 1040=back
986 1041
987=cut 1042=cut
988 1043
989package AnyEvent; 1044package AnyEvent;
990 1045
991no warnings; 1046no warnings;
992use strict qw(vars subs); 1047use strict qw(vars subs);
993 1048
994use Carp; 1049use Carp ();
995 1050
996our $VERSION = 4.8; 1051our $VERSION = 4.83;
997our $MODEL; 1052our $MODEL;
998 1053
999our $AUTOLOAD; 1054our $AUTOLOAD;
1000our @ISA; 1055our @ISA;
1001 1056
1002our @REGISTRY; 1057our @REGISTRY;
1003 1058
1004our $WIN32; 1059our $WIN32;
1060
1061our $VERBOSE;
1005 1062
1006BEGIN { 1063BEGIN {
1007 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1064 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
1008 eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; 1065 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
1009 1066
1010 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1067 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1011 if ${^TAINT}; 1068 if ${^TAINT};
1012}
1013 1069
1014our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1070 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1071
1072}
1073
1074our $MAX_SIGNAL_LATENCY = 10;
1015 1075
1016our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1076our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1017 1077
1018{ 1078{
1019 my $idx; 1079 my $idx;
1027 [Event:: => AnyEvent::Impl::Event::], 1087 [Event:: => AnyEvent::Impl::Event::],
1028 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1088 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
1029 # everything below here will not be autoprobed 1089 # everything below here will not be autoprobed
1030 # as the pureperl backend should work everywhere 1090 # as the pureperl backend should work everywhere
1031 # and is usually faster 1091 # and is usually faster
1032 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1033 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1092 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1034 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1093 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1094 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1035 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1095 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1036 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1096 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1037 [Wx:: => AnyEvent::Impl::POE::], 1097 [Wx:: => AnyEvent::Impl::POE::],
1038 [Prima:: => AnyEvent::Impl::POE::], 1098 [Prima:: => AnyEvent::Impl::POE::],
1039 # IO::Async is just too broken - we would need workaorunds for its 1099 # IO::Async is just too broken - we would need workarounds for its
1040 # byzantine signal and broken child handling, among others. 1100 # byzantine signal and broken child handling, among others.
1041 # IO::Async is rather hard to detect, as it doesn't have any 1101 # IO::Async is rather hard to detect, as it doesn't have any
1042 # obvious default class. 1102 # obvious default class.
1043# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1103# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1044# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1104# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1077 1137
1078 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1138 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1079 my $model = "AnyEvent::Impl::$1"; 1139 my $model = "AnyEvent::Impl::$1";
1080 if (eval "require $model") { 1140 if (eval "require $model") {
1081 $MODEL = $model; 1141 $MODEL = $model;
1082 warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; 1142 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1083 } else { 1143 } else {
1084 warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; 1144 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1085 } 1145 }
1086 } 1146 }
1087 1147
1088 # check for already loaded models 1148 # check for already loaded models
1089 unless ($MODEL) { 1149 unless ($MODEL) {
1090 for (@REGISTRY, @models) { 1150 for (@REGISTRY, @models) {
1091 my ($package, $model) = @$_; 1151 my ($package, $model) = @$_;
1092 if (${"$package\::VERSION"} > 0) { 1152 if (${"$package\::VERSION"} > 0) {
1093 if (eval "require $model") { 1153 if (eval "require $model") {
1094 $MODEL = $model; 1154 $MODEL = $model;
1095 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; 1155 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1096 last; 1156 last;
1097 } 1157 }
1098 } 1158 }
1099 } 1159 }
1100 1160
1105 my ($package, $model) = @$_; 1165 my ($package, $model) = @$_;
1106 if (eval "require $package" 1166 if (eval "require $package"
1107 and ${"$package\::VERSION"} > 0 1167 and ${"$package\::VERSION"} > 0
1108 and eval "require $model") { 1168 and eval "require $model") {
1109 $MODEL = $model; 1169 $MODEL = $model;
1110 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; 1170 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
1111 last; 1171 last;
1112 } 1172 }
1113 } 1173 }
1114 1174
1115 $MODEL 1175 $MODEL
1131 1191
1132sub AUTOLOAD { 1192sub AUTOLOAD {
1133 (my $func = $AUTOLOAD) =~ s/.*://; 1193 (my $func = $AUTOLOAD) =~ s/.*://;
1134 1194
1135 $method{$func} 1195 $method{$func}
1136 or croak "$func: not a valid method for AnyEvent objects"; 1196 or Carp::croak "$func: not a valid method for AnyEvent objects";
1137 1197
1138 detect unless $MODEL; 1198 detect unless $MODEL;
1139 1199
1140 my $class = shift; 1200 my $class = shift;
1141 $class->$func (@_); 1201 $class->$func (@_);
1146# allow only one watcher per fd, so we dup it to get a different one). 1206# allow only one watcher per fd, so we dup it to get a different one).
1147sub _dupfh($$;$$) { 1207sub _dupfh($$;$$) {
1148 my ($poll, $fh, $r, $w) = @_; 1208 my ($poll, $fh, $r, $w) = @_;
1149 1209
1150 # cygwin requires the fh mode to be matching, unix doesn't 1210 # cygwin requires the fh mode to be matching, unix doesn't
1151 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1211 my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1152 : $poll eq "w" ? ($w, ">")
1153 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1154 1212
1155 open my $fh2, "$mode&" . fileno $fh 1213 open my $fh2, $mode, $fh
1156 or die "cannot dup() filehandle: $!,"; 1214 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1157 1215
1158 # we assume CLOEXEC is already set by perl in all important cases 1216 # we assume CLOEXEC is already set by perl in all important cases
1159 1217
1160 ($fh2, $rw) 1218 ($fh2, $rw)
1161} 1219}
1162 1220
1163package AnyEvent::Base; 1221package AnyEvent::Base;
1164 1222
1165# default implementations for many methods 1223# default implementations for many methods
1166 1224
1167BEGIN { 1225sub _time {
1226 # probe for availability of Time::HiRes
1168 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1227 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1228 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1169 *_time = \&Time::HiRes::time; 1229 *_time = \&Time::HiRes::time;
1170 # if (eval "use POSIX (); (POSIX::times())... 1230 # if (eval "use POSIX (); (POSIX::times())...
1171 } else { 1231 } else {
1232 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1172 *_time = sub { time }; # epic fail 1233 *_time = sub { time }; # epic fail
1173 } 1234 }
1235
1236 &_time
1174} 1237}
1175 1238
1176sub time { _time } 1239sub time { _time }
1177sub now { _time } 1240sub now { _time }
1178sub now_update { } 1241sub now_update { }
1183 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1246 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1184} 1247}
1185 1248
1186# default implementation for ->signal 1249# default implementation for ->signal
1187 1250
1251our $HAVE_ASYNC_INTERRUPT;
1188our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1252our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1253our (%SIG_ASY, %SIG_ASY_W);
1254our ($SIG_COUNT, $SIG_TW);
1189 1255
1190sub _signal_exec { 1256sub _signal_exec {
1257 $HAVE_ASYNC_INTERRUPT
1258 ? $SIGPIPE_R->drain
1191 sysread $SIGPIPE_R, my $dummy, 4; 1259 : sysread $SIGPIPE_R, my $dummy, 9;
1192 1260
1193 while (%SIG_EV) { 1261 while (%SIG_EV) {
1194 for (keys %SIG_EV) { 1262 for (keys %SIG_EV) {
1195 delete $SIG_EV{$_}; 1263 delete $SIG_EV{$_};
1196 $_->() for values %{ $SIG_CB{$_} || {} }; 1264 $_->() for values %{ $SIG_CB{$_} || {} };
1197 } 1265 }
1198 } 1266 }
1199} 1267}
1200 1268
1269sub _signal {
1270 my (undef, %arg) = @_;
1271
1272 my $signal = uc $arg{signal}
1273 or Carp::croak "required option 'signal' is missing";
1274
1275 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1276
1277 if ($HAVE_ASYNC_INTERRUPT) {
1278 # async::interrupt
1279
1280 $SIG_ASY{$signal} ||= do {
1281 my $asy = new Async::Interrupt
1282 cb => sub { undef $SIG_EV{$signal} },
1283 signal => $signal,
1284 pipe => [$SIGPIPE_R->filenos],
1285 ;
1286 $asy->pipe_autodrain (0);
1287
1288 $asy
1289 };
1290
1291 } else {
1292 # pure perl
1293
1294 $SIG{$signal} ||= sub {
1295 local $!;
1296 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1297 undef $SIG_EV{$signal};
1298 };
1299
1300 # can't do signal processing without introducing races in pure perl,
1301 # so limit the signal latency.
1302 ++$SIG_COUNT;
1303 $SIG_TW ||= AnyEvent->timer (
1304 after => $MAX_SIGNAL_LATENCY,
1305 interval => $MAX_SIGNAL_LATENCY,
1306 cb => sub { }, # just for the PERL_ASYNC_CHECK
1307 );
1308 }
1309
1310 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1311}
1312
1201sub signal { 1313sub signal {
1202 my (undef, %arg) = @_; 1314 # probe for availability of Async::Interrupt
1315 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1316 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1203 1317
1204 unless ($SIGPIPE_R) { 1318 $HAVE_ASYNC_INTERRUPT = 1;
1319 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1320 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1321
1322 } else {
1323 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1324
1205 require Fcntl; 1325 require Fcntl;
1206 1326
1207 if (AnyEvent::WIN32) { 1327 if (AnyEvent::WIN32) {
1208 require AnyEvent::Util; 1328 require AnyEvent::Util;
1209 1329
1224 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1344 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1225 1345
1226 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1346 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1227 } 1347 }
1228 1348
1229 my $signal = uc $arg{signal} 1349 *signal = \&_signal;
1230 or Carp::croak "required option 'signal' is missing"; 1350 &signal
1231
1232 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1233 $SIG{$signal} ||= sub {
1234 local $!;
1235 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1236 undef $SIG_EV{$signal};
1237 };
1238
1239 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1240} 1351}
1241 1352
1242sub AnyEvent::Base::signal::DESTROY { 1353sub AnyEvent::Base::signal::DESTROY {
1243 my ($signal, $cb) = @{$_[0]}; 1354 my ($signal, $cb) = @{$_[0]};
1355
1356 undef $SIG_TW
1357 unless --$SIG_COUNT;
1244 1358
1245 delete $SIG_CB{$signal}{$cb}; 1359 delete $SIG_CB{$signal}{$cb};
1246 1360
1247 # delete doesn't work with older perls - they then 1361 # delete doesn't work with older perls - they then
1248 # print weird messages, or just unconditionally exit 1362 # print weird messages, or just unconditionally exit
1249 # instead of getting the default action. 1363 # instead of getting the default action.
1364 undef $SIG{$signal}
1250 undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; 1365 unless keys %{ $SIG_CB{$signal} };
1251} 1366}
1252 1367
1253# default implementation for ->child 1368# default implementation for ->child
1254 1369
1255our %PID_CB; 1370our %PID_CB;
1257our $CHLD_DELAY_W; 1372our $CHLD_DELAY_W;
1258our $WNOHANG; 1373our $WNOHANG;
1259 1374
1260sub _sigchld { 1375sub _sigchld {
1261 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1376 while (0 < (my $pid = waitpid -1, $WNOHANG)) {
1377 $_->($pid, $?)
1262 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1378 for values %{ $PID_CB{$pid} || {} },
1263 (values %{ $PID_CB{0} || {} }); 1379 values %{ $PID_CB{0} || {} };
1264 } 1380 }
1265} 1381}
1266 1382
1267sub child { 1383sub child {
1268 my (undef, %arg) = @_; 1384 my (undef, %arg) = @_;
1336 1452
1337use overload 1453use overload
1338 '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1454 '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1339 fallback => 1; 1455 fallback => 1;
1340 1456
1457our $WAITING;
1458
1341sub _send { 1459sub _send {
1342 # nop 1460 # nop
1343} 1461}
1344 1462
1345sub send { 1463sub send {
1357sub ready { 1475sub ready {
1358 $_[0]{_ae_sent} 1476 $_[0]{_ae_sent}
1359} 1477}
1360 1478
1361sub _wait { 1479sub _wait {
1480 $WAITING
1481 and !$_[0]{_ae_sent}
1482 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1483
1484 local $WAITING = 1;
1362 AnyEvent->one_event while !$_[0]{_ae_sent}; 1485 AnyEvent->one_event while !$_[0]{_ae_sent};
1363} 1486}
1364 1487
1365sub recv { 1488sub recv {
1366 $_[0]->_wait; 1489 $_[0]->_wait;
2060 2183
2061A handler for C<SIGCHLD> is installed by AnyEvent's child watcher 2184A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2062emulation for event loops that do not support them natively. Also, some 2185emulation for event loops that do not support them natively. Also, some
2063event loops install a similar handler. 2186event loops install a similar handler.
2064 2187
2065If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will 2188Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2066reset it to default, to avoid losing child exit statuses. 2189AnyEvent will reset it to default, to avoid losing child exit statuses.
2067 2190
2068=item SIGPIPE 2191=item SIGPIPE
2069 2192
2070A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> 2193A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2071when AnyEvent gets loaded. 2194when AnyEvent gets loaded.
2089 if $SIG{CHLD} eq 'IGNORE'; 2212 if $SIG{CHLD} eq 'IGNORE';
2090 2213
2091$SIG{PIPE} = sub { } 2214$SIG{PIPE} = sub { }
2092 unless defined $SIG{PIPE}; 2215 unless defined $SIG{PIPE};
2093 2216
2217=head1 RECOMMENDED/OPTIONAL MODULES
2218
2219One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2220it's built-in modules) are required to use it.
2221
2222That does not mean that AnyEvent won't take advantage of some additional
2223modules if they are installed.
2224
2225This section epxlains which additional modules will be used, and how they
2226affect AnyEvent's operetion.
2227
2228=over 4
2229
2230=item L<Async::Interrupt>
2231
2232This slightly arcane module is used to implement fast signal handling: To
2233my knowledge, there is no way to do completely race-free and quick
2234signal handling in pure perl. To ensure that signals still get
2235delivered, AnyEvent will start an interval timer to wake up perl (and
2236catch the signals) with soemd elay (default is 10 seconds, look for
2237C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2238
2239If this module is available, then it will be used to implement signal
2240catching, which means that signals will not be delayed, and the event loop
2241will not be interrupted regularly, which is more efficient (And good for
2242battery life on laptops).
2243
2244This affects not just the pure-perl event loop, but also other event loops
2245that have no signal handling on their own (e.g. Glib, Tk, Qt).
2246
2247=item L<EV>
2248
2249This module isn't really "optional", as it is simply one of the backend
2250event loops that AnyEvent can use. However, it is simply the best event
2251loop available in terms of features, speed and stability: It supports
2252the AnyEvent API optimally, implements all the watcher types in XS, does
2253automatic timer adjustments even when no monotonic clock is available,
2254can take avdantage of advanced kernel interfaces such as C<epoll> and
2255C<kqueue>, and is the fastest backend I<by far>. You can even embed
2256L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2257
2258=item L<Guard>
2259
2260The guard module, when used, will be used to implement
2261C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2262lot less memory), but otherwise doesn't affect guard operation much. It is
2263purely used for performance.
2264
2265=item L<JSON> and L<JSON::XS>
2266
2267This module is required when you want to read or write JSON data via
2268L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2269advantage of the ulta-high-speed L<JSON::XS> module when it is installed.
2270
2271In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2272installed.
2273
2274=item L<Net::SSLeay>
2275
2276Implementing TLS/SSL in Perl is certainly interesting, but not very
2277worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2278the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2279
2280=item L<Time::HiRes>
2281
2282This module is part of perl since release 5.008. It will be used when the
2283chosen event library does not come with a timing source on it's own. The
2284pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2285try to use a monotonic clock for timing stability.
2286
2287=back
2288
2289
2094=head1 FORK 2290=head1 FORK
2095 2291
2096Most event libraries are not fork-safe. The ones who are usually are 2292Most event libraries are not fork-safe. The ones who are usually are
2097because they rely on inefficient but fork-safe C<select> or C<poll> 2293because they rely on inefficient but fork-safe C<select> or C<poll>
2098calls. Only L<EV> is fully fork-aware. 2294calls. Only L<EV> is fully fork-aware.
2099 2295
2100If you have to fork, you must either do so I<before> creating your first 2296If you have to fork, you must either do so I<before> creating your first
2101watcher OR you must not use AnyEvent at all in the child. 2297watcher OR you must not use AnyEvent at all in the child OR you must do
2298something completely out of the scope of AnyEvent.
2102 2299
2103 2300
2104=head1 SECURITY CONSIDERATIONS 2301=head1 SECURITY CONSIDERATIONS
2105 2302
2106AnyEvent can be forced to load any event model via 2303AnyEvent can be forced to load any event model via
2144L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2341L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2145 2342
2146Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2343Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2147L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2344L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2148L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2345L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2149L<AnyEvent::Impl::POE>. 2346L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.
2150 2347
2151Non-blocking file handles, sockets, TCP clients and 2348Non-blocking file handles, sockets, TCP clients and
2152servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. 2349servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2153 2350
2154Asynchronous DNS: L<AnyEvent::DNS>. 2351Asynchronous DNS: L<AnyEvent::DNS>.
2155 2352
2156Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 2353Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
2354L<Coro::Event>,
2157 2355
2158Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 2356Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
2357L<AnyEvent::HTTP>.
2159 2358
2160 2359
2161=head1 AUTHOR 2360=head1 AUTHOR
2162 2361
2163 Marc Lehmann <schmorp@schmorp.de> 2362 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines