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.208 by root, Sun Apr 26 18:12:53 2009 UTC vs.
Revision 1.244 by root, Fri Jul 17 23:15:57 2009 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - provide framework for multiple event loops
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops 5EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported
6event loops.
6 7
7=head1 SYNOPSIS 8=head1 SYNOPSIS
8 9
9 use AnyEvent; 10 use AnyEvent;
10 11
175=head2 I/O WATCHERS 176=head2 I/O WATCHERS
176 177
177You 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
178with the following mandatory key-value pairs as arguments: 179with the following mandatory key-value pairs as arguments:
179 180
180C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch 181C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
181for events (AnyEvent might or might not keep a reference to this file 182for events (AnyEvent might or might not keep a reference to this file
182handle). Note that only file handles pointing to things for which 183handle). Note that only file handles pointing to things for which
183non-blocking operation makes sense are allowed. This includes sockets, 184non-blocking operation makes sense are allowed. This includes sockets,
184most 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
185or block devices. 186or block devices.
360invocation, and callback invocation will be synchronous. Synchronous means 361invocation, and callback invocation will be synchronous. Synchronous means
361that 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,
362but it is guaranteed not to interrupt any other callbacks. 363but it is guaranteed not to interrupt any other callbacks.
363 364
364The 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
365between multiple watchers. 366between multiple watchers, and AnyEvent will ensure that signals will not
367interrupt your program at bad times.
366 368
367This watcher might use C<%SIG>, so programs overwriting those signals 369This watcher might use C<%SIG> (depending on the event loop used),
368directly 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.
369 383
370Example: exit on SIGINT 384Example: exit on SIGINT
371 385
372 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 386 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
373 387
391 405
392There is a slight catch to child watchers, however: you usually start them 406There is a slight catch to child watchers, however: you usually start them
393I<after> the child process was created, and this means the process could 407I<after> the child process was created, and this means the process could
394have exited already (and no SIGCHLD will be sent anymore). 408have exited already (and no SIGCHLD will be sent anymore).
395 409
396Not all event models handle this correctly (POE doesn't), but even for 410Not all event models handle this correctly (neither POE nor IO::Async do,
411see their AnyEvent::Impl manpages for details), but even for event models
397event models that I<do> handle this correctly, they usually need to be 412that I<do> handle this correctly, they usually need to be loaded before
398loaded before the process exits (i.e. before you fork in the first place). 413the process exits (i.e. before you fork in the first place). AnyEvent's
414pure perl event loop handles all cases correctly regardless of when you
415start the watcher.
399 416
400This means you cannot create a child watcher as the very first thing in an 417This means you cannot create a child watcher as the very first
401AnyEvent program, you I<have> to create at least one watcher before you 418thing in an AnyEvent program, you I<have> to create at least one
402C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 419watcher before you C<fork> the child (alternatively, you can call
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.
403 425
404Example: fork a process and wait for it 426Example: fork a process and wait for it
405 427
406 my $done = AnyEvent->condvar; 428 my $done = AnyEvent->condvar;
407 429
458 480
459If 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
460require you to run some blocking "loop", "run" or similar function that 482require you to run some blocking "loop", "run" or similar function that
461will actively watch for new events and call your callbacks. 483will actively watch for new events and call your callbacks.
462 484
463AnyEvent is different, it expects somebody else to run the event loop and 485AnyEvent is slightly different: it expects somebody else to run the event
464will only block when necessary (usually when told by the user). 486loop and will only block when necessary (usually when told by the user).
465 487
466The instrument to do that is called a "condition variable", so called 488The instrument to do that is called a "condition variable", so called
467because they represent a condition that must become true. 489because they represent a condition that must become true.
468 490
491Now is probably a good time to look at the examples further below.
492
469Condition variables can be created by calling the C<< AnyEvent->condvar 493Condition variables can be created by calling the C<< AnyEvent->condvar
470>> method, usually without arguments. The only argument pair allowed is 494>> method, usually without arguments. The only argument pair allowed is
471
472C<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
473becomes true, with the condition variable as the first argument (but not 496becomes true, with the condition variable as the first argument (but not
474the results). 497the results).
475 498
476After creation, the condition variable is "false" until it becomes "true" 499After creation, the condition variable is "false" until it becomes "true"
525 after => 1, 548 after => 1,
526 cb => sub { $result_ready->send }, 549 cb => sub { $result_ready->send },
527 ); 550 );
528 551
529 # this "blocks" (while handling events) till the callback 552 # this "blocks" (while handling events) till the callback
530 # calls send 553 # calls -<send
531 $result_ready->recv; 554 $result_ready->recv;
532 555
533Example: wait for a timer, but take advantage of the fact that 556Example: wait for a timer, but take advantage of the fact that condition
534condition variables are also code references. 557variables are also callable directly.
535 558
536 my $done = AnyEvent->condvar; 559 my $done = AnyEvent->condvar;
537 my $delay = AnyEvent->timer (after => 5, cb => $done); 560 my $delay = AnyEvent->timer (after => 5, cb => $done);
538 $done->recv; 561 $done->recv;
539 562
545 568
546 ... 569 ...
547 570
548 my @info = $couchdb->info->recv; 571 my @info = $couchdb->info->recv;
549 572
550And 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
551results are available: 574results are available:
552 575
553 $couchdb->info->cb (sub { 576 $couchdb->info->cb (sub {
554 my @info = $_[0]->recv; 577 my @info = $_[0]->recv;
555 }); 578 });
573immediately from within send. 596immediately from within send.
574 597
575Any 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
576future C<< ->recv >> calls. 599future C<< ->recv >> calls.
577 600
578Condition variables are overloaded so one can call them directly 601Condition variables are overloaded so one can call them directly (as if
579(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
580C<send>. Note, however, that many C-based event loops do not handle 603C<send>.
581overloading, so as tempting as it may be, passing a condition variable
582instead of a callback does not work. Both the pure perl and EV loops
583support overloading, however, as well as all functions that use perl to
584invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
585example).
586 604
587=item $cv->croak ($error) 605=item $cv->croak ($error)
588 606
589Similar 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
590C<Carp::croak> with the given error message/object/scalar. 608C<Carp::croak> with the given error message/object/scalar.
591 609
592This can be used to signal any errors to the condition variable 610This can be used to signal any errors to the condition variable
593user/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.
594 616
595=item $cv->begin ([group callback]) 617=item $cv->begin ([group callback])
596 618
597=item $cv->end 619=item $cv->end
598
599These two methods are EXPERIMENTAL and MIGHT CHANGE.
600 620
601These two methods can be used to combine many transactions/events into 621These two methods can be used to combine many transactions/events into
602one. For example, a function that pings many hosts in parallel might want 622one. For example, a function that pings many hosts in parallel might want
603to use a condition variable for the whole process. 623to use a condition variable for the whole process.
604 624
606C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 626C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
607>>, the (last) callback passed to C<begin> will be executed. That callback 627>>, the (last) callback passed to C<begin> will be executed. That callback
608is I<supposed> to call C<< ->send >>, but that is not required. If no 628is I<supposed> to call C<< ->send >>, but that is not required. If no
609callback was set, C<send> will be called without any arguments. 629callback was set, C<send> will be called without any arguments.
610 630
611Let's clarify this with the ping example: 631You can think of C<< $cv->send >> giving you an OR condition (one call
632sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
633condition (all C<begin> calls must be C<end>'ed before the condvar sends).
634
635Let's start with a simple example: you have two I/O watchers (for example,
636STDOUT and STDERR for a program), and you want to wait for both streams to
637close before activating a condvar:
638
639 my $cv = AnyEvent->condvar;
640
641 $cv->begin; # first watcher
642 my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
643 defined sysread $fh1, my $buf, 4096
644 or $cv->end;
645 });
646
647 $cv->begin; # second watcher
648 my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
649 defined sysread $fh2, my $buf, 4096
650 or $cv->end;
651 });
652
653 $cv->recv;
654
655This works because for every event source (EOF on file handle), there is
656one call to C<begin>, so the condvar waits for all calls to C<end> before
657sending.
658
659The ping example mentioned above is slightly more complicated, as the
660there are results to be passwd back, and the number of tasks that are
661begung can potentially be zero:
612 662
613 my $cv = AnyEvent->condvar; 663 my $cv = AnyEvent->condvar;
614 664
615 my %result; 665 my %result;
616 $cv->begin (sub { $cv->send (\%result) }); 666 $cv->begin (sub { $cv->send (\%result) });
636loop, which serves two important purposes: first, it sets the callback 686loop, which serves two important purposes: first, it sets the callback
637to be called once the counter reaches C<0>, and second, it ensures that 687to be called once the counter reaches C<0>, and second, it ensures that
638C<send> is called even when C<no> hosts are being pinged (the loop 688C<send> is called even when C<no> hosts are being pinged (the loop
639doesn't execute once). 689doesn't execute once).
640 690
641This is the general pattern when you "fan out" into multiple subrequests: 691This is the general pattern when you "fan out" into multiple (but
642use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 692potentially none) subrequests: use an outer C<begin>/C<end> pair to set
643is called at least once, and then, for each subrequest you start, call 693the callback and ensure C<end> is called at least once, and then, for each
644C<begin> and for each subrequest you finish, call C<end>. 694subrequest you start, call C<begin> and for each subrequest you finish,
695call C<end>.
645 696
646=back 697=back
647 698
648=head3 METHODS FOR CONSUMERS 699=head3 METHODS FOR CONSUMERS
649 700
665function will call C<croak>. 716function will call C<croak>.
666 717
667In list context, all parameters passed to C<send> will be returned, 718In list context, all parameters passed to C<send> will be returned,
668in scalar context only the first one will be returned. 719in scalar context only the first one will be returned.
669 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
670Not 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
671(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
672using 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
673caller 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
674condition variables with some kind of request results and supporting 732condition variables with some kind of request results and supporting
675callbacks so the caller knows that getting the result will not block, 733callbacks so the caller knows that getting the result will not block,
676while still supporting blocking waits if the caller so desires). 734while still supporting blocking waits if the caller so desires).
677 735
678Another reason I<never> to C<< ->recv >> in a module is that you cannot
679sensibly have two C<< ->recv >>'s in parallel, as that would require
680multiple interpreters or coroutines/threads, none of which C<AnyEvent>
681can supply.
682
683The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
684fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
685versions and also integrates coroutines into AnyEvent, making blocking
686C<< ->recv >> calls perfectly safe as long as they are done from another
687coroutine (one that doesn't run the event loop).
688
689You 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
690only calling C<< ->recv >> from within that callback (or at a later 737only calling C<< ->recv >> from within that callback (or at a later
691time). 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
692waits otherwise. 739waits otherwise.
693 740
706variable 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
707is guaranteed not to block. 754is guaranteed not to block.
708 755
709=back 756=back
710 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
711=head1 GLOBAL VARIABLES AND FUNCTIONS 825=head1 GLOBAL VARIABLES AND FUNCTIONS
712 826
827These are not normally required to use AnyEvent, but can be useful to
828write AnyEvent extension modules.
829
713=over 4 830=over 4
714 831
715=item $AnyEvent::MODEL 832=item $AnyEvent::MODEL
716 833
717Contains 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
718contains 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
719Perl class implementing the model. This class is usually one of the 838name of the Perl class implementing the model. This class is usually one
720C<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
721AnyEvent 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
722 841will be C<urxvt::anyevent>).
723The known classes so far are:
724
725 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
726 AnyEvent::Impl::Event based on Event, second best choice.
727 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
728 AnyEvent::Impl::Glib based on Glib, third-best choice.
729 AnyEvent::Impl::Tk based on Tk, very bad choice.
730 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
731 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
732 AnyEvent::Impl::POE based on POE, not generic enough for full support.
733
734There is no support for WxWidgets, as WxWidgets has no support for
735watching file handles. However, you can use WxWidgets through the
736POE Adaptor, as POE has a Wx backend that simply polls 20 times per
737second, which was considered to be too horrible to even consider for
738AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
739it's adaptor.
740
741AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
742autodetecting them.
743 842
744=item AnyEvent::detect 843=item AnyEvent::detect
745 844
746Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 845Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
747if necessary. You should only call this function right before you would 846if necessary. You should only call this function right before you would
748have 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
749runtime. 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>.
750 852
751=item $guard = AnyEvent::post_detect { BLOCK } 853=item $guard = AnyEvent::post_detect { BLOCK }
752 854
753Arranges 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
754autodetected (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.
755 868
756If 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
757that automatically removes the callback again when it is destroyed. See 870that automatically removes the callback again when it is destroyed. See
758L<Coro::BDB> for a case where this is useful. 871L<Coro::BDB> for a case where this is useful.
759 872
762If 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
763before or after loading AnyEvent), then they will called directly after 876before or after loading AnyEvent), then they will called directly after
764the event loop has been chosen. 877the event loop has been chosen.
765 878
766You should check C<$AnyEvent::MODEL> before adding to this array, though: 879You should check C<$AnyEvent::MODEL> before adding to this array, though:
767if 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
768and the array will be ignored. 881array will be ignored.
769 882
770Best 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.
771 890
772=back 891=back
773 892
774=head1 WHAT TO DO IN A MODULE 893=head1 WHAT TO DO IN A MODULE
775 894
830 949
831 950
832=head1 OTHER MODULES 951=head1 OTHER MODULES
833 952
834The following is a non-exhaustive list of additional modules that use 953The following is a non-exhaustive list of additional modules that use
835AnyEvent and can therefore be mixed easily with other AnyEvent modules 954AnyEvent as a client and can therefore be mixed easily with other AnyEvent
836in 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
837available via CPAN. 956come with AnyEvent, most are available via CPAN.
838 957
839=over 4 958=over 4
840 959
841=item L<AnyEvent::Util> 960=item L<AnyEvent::Util>
842 961
851 970
852=item L<AnyEvent::Handle> 971=item L<AnyEvent::Handle>
853 972
854Provide read and write buffers, manages watchers for reads and writes, 973Provide read and write buffers, manages watchers for reads and writes,
855supports 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
856non-blocking SSL/TLS. 975non-blocking SSL/TLS (via L<AnyEvent::TLS>.
857 976
858=item L<AnyEvent::DNS> 977=item L<AnyEvent::DNS>
859 978
860Provides rich asynchronous DNS resolver capabilities. 979Provides rich asynchronous DNS resolver capabilities.
861 980
889 1008
890=item L<AnyEvent::GPSD> 1009=item L<AnyEvent::GPSD>
891 1010
892A non-blocking interface to gpsd, a daemon delivering GPS information. 1011A non-blocking interface to gpsd, a daemon delivering GPS information.
893 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
894=item L<AnyEvent::IGS> 1022=item L<AnyEvent::IGS>
895 1023
896A non-blocking interface to the Internet Go Server protocol (used by 1024A non-blocking interface to the Internet Go Server protocol (used by
897L<App::IGS>). 1025L<App::IGS>).
898 1026
899=item L<AnyEvent::IRC>
900
901AnyEvent based IRC client module family (replacing the older Net::IRC3).
902
903=item L<Net::XMPP2>
904
905AnyEvent based XMPP (Jabber protocol) module family.
906
907=item L<Net::FCP> 1027=item L<Net::FCP>
908 1028
909AnyEvent-based implementation of the Freenet Client Protocol, birthplace 1029AnyEvent-based implementation of the Freenet Client Protocol, birthplace
910of AnyEvent. 1030of AnyEvent.
911 1031
915 1035
916=item L<Coro> 1036=item L<Coro>
917 1037
918Has special support for AnyEvent via L<Coro::AnyEvent>. 1038Has special support for AnyEvent via L<Coro::AnyEvent>.
919 1039
920=item L<IO::Lambda>
921
922The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
923
924=back 1040=back
925 1041
926=cut 1042=cut
927 1043
928package AnyEvent; 1044package AnyEvent;
929 1045
1046# basically a tuned-down version of common::sense
1047sub common_sense {
930no warnings; 1048 # no warnings
1049 ${^WARNING_BITS} ^= ${^WARNING_BITS};
931use strict qw(vars subs); 1050 # use strict vars subs
1051 $^H |= 0x00000600;
1052}
932 1053
1054BEGIN { AnyEvent::common_sense }
1055
933use Carp; 1056use Carp ();
934 1057
935our $VERSION = 4.4; 1058our $VERSION = 4.83;
936our $MODEL; 1059our $MODEL;
937 1060
938our $AUTOLOAD; 1061our $AUTOLOAD;
939our @ISA; 1062our @ISA;
940 1063
941our @REGISTRY; 1064our @REGISTRY;
942 1065
943our $WIN32; 1066our $WIN32;
944 1067
1068our $VERBOSE;
1069
945BEGIN { 1070BEGIN {
946 my $win32 = ! ! ($^O =~ /mswin32/i); 1071 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
947 eval "sub WIN32(){ $win32 }"; 1072 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
948}
949 1073
1074 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1075 if ${^TAINT};
1076
950our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1077 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1078
1079}
1080
1081our $MAX_SIGNAL_LATENCY = 10;
951 1082
952our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1083our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
953 1084
954{ 1085{
955 my $idx; 1086 my $idx;
963 [Event:: => AnyEvent::Impl::Event::], 1094 [Event:: => AnyEvent::Impl::Event::],
964 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1095 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
965 # everything below here will not be autoprobed 1096 # everything below here will not be autoprobed
966 # as the pureperl backend should work everywhere 1097 # as the pureperl backend should work everywhere
967 # and is usually faster 1098 # and is usually faster
968 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
969 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1099 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
970 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1100 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1101 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
971 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1102 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
972 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1103 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
973 [Wx:: => AnyEvent::Impl::POE::], 1104 [Wx:: => AnyEvent::Impl::POE::],
974 [Prima:: => AnyEvent::Impl::POE::], 1105 [Prima:: => AnyEvent::Impl::POE::],
1106 # IO::Async is just too broken - we would need workarounds for its
1107 # byzantine signal and broken child handling, among others.
1108 # IO::Async is rather hard to detect, as it doesn't have any
1109 # obvious default class.
1110# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1111# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1112# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
975); 1113);
976 1114
977our %method = map +($_ => 1), 1115our %method = map +($_ => 1),
978 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1116 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
979 1117
999 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1137 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1000} 1138}
1001 1139
1002sub detect() { 1140sub detect() {
1003 unless ($MODEL) { 1141 unless ($MODEL) {
1004 no strict 'refs';
1005 local $SIG{__DIE__}; 1142 local $SIG{__DIE__};
1006 1143
1007 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1144 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1008 my $model = "AnyEvent::Impl::$1"; 1145 my $model = "AnyEvent::Impl::$1";
1009 if (eval "require $model") { 1146 if (eval "require $model") {
1010 $MODEL = $model; 1147 $MODEL = $model;
1011 warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; 1148 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1012 } else { 1149 } else {
1013 warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; 1150 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1014 } 1151 }
1015 } 1152 }
1016 1153
1017 # check for already loaded models 1154 # check for already loaded models
1018 unless ($MODEL) { 1155 unless ($MODEL) {
1019 for (@REGISTRY, @models) { 1156 for (@REGISTRY, @models) {
1020 my ($package, $model) = @$_; 1157 my ($package, $model) = @$_;
1021 if (${"$package\::VERSION"} > 0) { 1158 if (${"$package\::VERSION"} > 0) {
1022 if (eval "require $model") { 1159 if (eval "require $model") {
1023 $MODEL = $model; 1160 $MODEL = $model;
1024 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; 1161 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1025 last; 1162 last;
1026 } 1163 }
1027 } 1164 }
1028 } 1165 }
1029 1166
1034 my ($package, $model) = @$_; 1171 my ($package, $model) = @$_;
1035 if (eval "require $package" 1172 if (eval "require $package"
1036 and ${"$package\::VERSION"} > 0 1173 and ${"$package\::VERSION"} > 0
1037 and eval "require $model") { 1174 and eval "require $model") {
1038 $MODEL = $model; 1175 $MODEL = $model;
1039 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; 1176 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
1040 last; 1177 last;
1041 } 1178 }
1042 } 1179 }
1043 1180
1044 $MODEL 1181 $MODEL
1060 1197
1061sub AUTOLOAD { 1198sub AUTOLOAD {
1062 (my $func = $AUTOLOAD) =~ s/.*://; 1199 (my $func = $AUTOLOAD) =~ s/.*://;
1063 1200
1064 $method{$func} 1201 $method{$func}
1065 or croak "$func: not a valid method for AnyEvent objects"; 1202 or Carp::croak "$func: not a valid method for AnyEvent objects";
1066 1203
1067 detect unless $MODEL; 1204 detect unless $MODEL;
1068 1205
1069 my $class = shift; 1206 my $class = shift;
1070 $class->$func (@_); 1207 $class->$func (@_);
1071} 1208}
1072 1209
1073# utility function to dup a filehandle. this is used by many backends 1210# utility function to dup a filehandle. this is used by many backends
1074# to support binding more than one watcher per filehandle (they usually 1211# to support binding more than one watcher per filehandle (they usually
1075# allow only one watcher per fd, so we dup it to get a different one). 1212# allow only one watcher per fd, so we dup it to get a different one).
1076sub _dupfh($$$$) { 1213sub _dupfh($$;$$) {
1077 my ($poll, $fh, $r, $w) = @_; 1214 my ($poll, $fh, $r, $w) = @_;
1078 1215
1079 # cygwin requires the fh mode to be matching, unix doesn't 1216 # cygwin requires the fh mode to be matching, unix doesn't
1080 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1217 my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1081 : $poll eq "w" ? ($w, ">")
1082 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1083 1218
1084 open my $fh2, "$mode&" . fileno $fh 1219 open my $fh2, $mode, $fh
1085 or die "cannot dup() filehandle: $!,"; 1220 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1086 1221
1087 # we assume CLOEXEC is already set by perl in all important cases 1222 # we assume CLOEXEC is already set by perl in all important cases
1088 1223
1089 ($fh2, $rw) 1224 ($fh2, $rw)
1090} 1225}
1091 1226
1092package AnyEvent::Base; 1227package AnyEvent::Base;
1093 1228
1094# default implementations for many methods 1229# default implementations for many methods
1095 1230
1096BEGIN { 1231sub _time {
1232 # probe for availability of Time::HiRes
1097 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1233 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1234 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1098 *_time = \&Time::HiRes::time; 1235 *_time = \&Time::HiRes::time;
1099 # if (eval "use POSIX (); (POSIX::times())... 1236 # if (eval "use POSIX (); (POSIX::times())...
1100 } else { 1237 } else {
1238 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1101 *_time = sub { time }; # epic fail 1239 *_time = sub { time }; # epic fail
1102 } 1240 }
1241
1242 &_time
1103} 1243}
1104 1244
1105sub time { _time } 1245sub time { _time }
1106sub now { _time } 1246sub now { _time }
1107sub now_update { } 1247sub now_update { }
1112 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1252 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1113} 1253}
1114 1254
1115# default implementation for ->signal 1255# default implementation for ->signal
1116 1256
1257our $HAVE_ASYNC_INTERRUPT;
1117our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1258our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1259our (%SIG_ASY, %SIG_ASY_W);
1260our ($SIG_COUNT, $SIG_TW);
1118 1261
1119sub _signal_exec { 1262sub _signal_exec {
1263 $HAVE_ASYNC_INTERRUPT
1264 ? $SIGPIPE_R->drain
1120 sysread $SIGPIPE_R, my $dummy, 4; 1265 : sysread $SIGPIPE_R, my $dummy, 9;
1121 1266
1122 while (%SIG_EV) { 1267 while (%SIG_EV) {
1123 for (keys %SIG_EV) { 1268 for (keys %SIG_EV) {
1124 delete $SIG_EV{$_}; 1269 delete $SIG_EV{$_};
1125 $_->() for values %{ $SIG_CB{$_} || {} }; 1270 $_->() for values %{ $SIG_CB{$_} || {} };
1126 } 1271 }
1127 } 1272 }
1128} 1273}
1129 1274
1275sub _signal {
1276 my (undef, %arg) = @_;
1277
1278 my $signal = uc $arg{signal}
1279 or Carp::croak "required option 'signal' is missing";
1280
1281 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1282
1283 if ($HAVE_ASYNC_INTERRUPT) {
1284 # async::interrupt
1285
1286 $SIG_ASY{$signal} ||= do {
1287 my $asy = new Async::Interrupt
1288 cb => sub { undef $SIG_EV{$signal} },
1289 signal => $signal,
1290 pipe => [$SIGPIPE_R->filenos],
1291 ;
1292 $asy->pipe_autodrain (0);
1293
1294 $asy
1295 };
1296
1297 } else {
1298 # pure perl
1299
1300 $SIG{$signal} ||= sub {
1301 local $!;
1302 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1303 undef $SIG_EV{$signal};
1304 };
1305
1306 # can't do signal processing without introducing races in pure perl,
1307 # so limit the signal latency.
1308 ++$SIG_COUNT;
1309 $SIG_TW ||= AnyEvent->timer (
1310 after => $MAX_SIGNAL_LATENCY,
1311 interval => $MAX_SIGNAL_LATENCY,
1312 cb => sub { }, # just for the PERL_ASYNC_CHECK
1313 );
1314 }
1315
1316 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1317}
1318
1130sub signal { 1319sub signal {
1131 my (undef, %arg) = @_; 1320 # probe for availability of Async::Interrupt
1321 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1322 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1132 1323
1133 unless ($SIGPIPE_R) { 1324 $HAVE_ASYNC_INTERRUPT = 1;
1325 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1326 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1327
1328 } else {
1329 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1330
1134 require Fcntl; 1331 require Fcntl;
1135 1332
1136 if (AnyEvent::WIN32) { 1333 if (AnyEvent::WIN32) {
1137 require AnyEvent::Util; 1334 require AnyEvent::Util;
1138 1335
1141 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case 1338 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1142 } else { 1339 } else {
1143 pipe $SIGPIPE_R, $SIGPIPE_W; 1340 pipe $SIGPIPE_R, $SIGPIPE_W;
1144 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; 1341 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1145 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case 1342 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1343
1344 # not strictly required, as $^F is normally 2, but let's make sure...
1345 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1346 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1146 } 1347 }
1147 1348
1148 $SIGPIPE_R 1349 $SIGPIPE_R
1149 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1350 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1150 1351
1151 # not strictly required, as $^F is normally 2, but let's make sure...
1152 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1153 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1154
1155 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1352 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1156 } 1353 }
1157 1354
1158 my $signal = uc $arg{signal} 1355 *signal = \&_signal;
1159 or Carp::croak "required option 'signal' is missing"; 1356 &signal
1160
1161 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1162 $SIG{$signal} ||= sub {
1163 local $!;
1164 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1165 undef $SIG_EV{$signal};
1166 };
1167
1168 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1169} 1357}
1170 1358
1171sub AnyEvent::Base::signal::DESTROY { 1359sub AnyEvent::Base::signal::DESTROY {
1172 my ($signal, $cb) = @{$_[0]}; 1360 my ($signal, $cb) = @{$_[0]};
1173 1361
1362 undef $SIG_TW
1363 unless --$SIG_COUNT;
1364
1174 delete $SIG_CB{$signal}{$cb}; 1365 delete $SIG_CB{$signal}{$cb};
1175 1366
1367 # delete doesn't work with older perls - they then
1368 # print weird messages, or just unconditionally exit
1369 # instead of getting the default action.
1370 undef $SIG{$signal}
1176 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; 1371 unless keys %{ $SIG_CB{$signal} };
1177} 1372}
1178 1373
1179# default implementation for ->child 1374# default implementation for ->child
1180 1375
1181our %PID_CB; 1376our %PID_CB;
1182our $CHLD_W; 1377our $CHLD_W;
1183our $CHLD_DELAY_W; 1378our $CHLD_DELAY_W;
1184our $PID_IDLE;
1185our $WNOHANG; 1379our $WNOHANG;
1186 1380
1187sub _child_wait { 1381sub _sigchld {
1188 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1382 while (0 < (my $pid = waitpid -1, $WNOHANG)) {
1383 $_->($pid, $?)
1189 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1384 for values %{ $PID_CB{$pid} || {} },
1190 (values %{ $PID_CB{0} || {} }); 1385 values %{ $PID_CB{0} || {} };
1191 } 1386 }
1192
1193 undef $PID_IDLE;
1194}
1195
1196sub _sigchld {
1197 # make sure we deliver these changes "synchronous" with the event loop.
1198 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1199 undef $CHLD_DELAY_W;
1200 &_child_wait;
1201 });
1202} 1387}
1203 1388
1204sub child { 1389sub child {
1205 my (undef, %arg) = @_; 1390 my (undef, %arg) = @_;
1206 1391
1207 defined (my $pid = $arg{pid} + 0) 1392 defined (my $pid = $arg{pid} + 0)
1208 or Carp::croak "required option 'pid' is missing"; 1393 or Carp::croak "required option 'pid' is missing";
1209 1394
1210 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1395 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1211 1396
1212 unless ($WNOHANG) { 1397 # WNOHANG is almost cetrainly 1 everywhere
1398 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1399 ? 1
1213 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1400 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1214 }
1215 1401
1216 unless ($CHLD_W) { 1402 unless ($CHLD_W) {
1217 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1403 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1218 # child could be a zombie already, so make at least one round 1404 # child could be a zombie already, so make at least one round
1219 &_sigchld; 1405 &_sigchld;
1230 1416
1231 undef $CHLD_W unless keys %PID_CB; 1417 undef $CHLD_W unless keys %PID_CB;
1232} 1418}
1233 1419
1234# idle emulation is done by simply using a timer, regardless 1420# idle emulation is done by simply using a timer, regardless
1235# of whether the proces sis idle or not, and not letting 1421# of whether the process is idle or not, and not letting
1236# the callback use more than 50% of the time. 1422# the callback use more than 50% of the time.
1237sub idle { 1423sub idle {
1238 my (undef, %arg) = @_; 1424 my (undef, %arg) = @_;
1239 1425
1240 my ($cb, $w, $rcb) = $arg{cb}; 1426 my ($cb, $w, $rcb) = $arg{cb};
1271 1457
1272our @ISA = AnyEvent::CondVar::Base::; 1458our @ISA = AnyEvent::CondVar::Base::;
1273 1459
1274package AnyEvent::CondVar::Base; 1460package AnyEvent::CondVar::Base;
1275 1461
1276use overload 1462#use overload
1277 '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1463# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1278 fallback => 1; 1464# fallback => 1;
1465
1466# save 300+ kilobytes by dirtily hardcoding overloading
1467${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
1468*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
1469*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
1470${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1471
1472our $WAITING;
1279 1473
1280sub _send { 1474sub _send {
1281 # nop 1475 # nop
1282} 1476}
1283 1477
1296sub ready { 1490sub ready {
1297 $_[0]{_ae_sent} 1491 $_[0]{_ae_sent}
1298} 1492}
1299 1493
1300sub _wait { 1494sub _wait {
1495 $WAITING
1496 and !$_[0]{_ae_sent}
1497 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1498
1499 local $WAITING = 1;
1301 AnyEvent->one_event while !$_[0]{_ae_sent}; 1500 AnyEvent->one_event while !$_[0]{_ae_sent};
1302} 1501}
1303 1502
1304sub recv { 1503sub recv {
1305 $_[0]->_wait; 1504 $_[0]->_wait;
1346so on. 1545so on.
1347 1546
1348=head1 ENVIRONMENT VARIABLES 1547=head1 ENVIRONMENT VARIABLES
1349 1548
1350The following environment variables are used by this module or its 1549The following environment variables are used by this module or its
1351submodules: 1550submodules.
1551
1552Note that AnyEvent will remove I<all> environment variables starting with
1553C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
1554enabled.
1352 1555
1353=over 4 1556=over 4
1354 1557
1355=item C<PERL_ANYEVENT_VERBOSE> 1558=item C<PERL_ANYEVENT_VERBOSE>
1356 1559
1363C<PERL_ANYEVENT_MODEL>. 1566C<PERL_ANYEVENT_MODEL>.
1364 1567
1365When set to C<2> or higher, cause AnyEvent to report to STDERR which event 1568When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1366model it chooses. 1569model it chooses.
1367 1570
1571When set to C<8> or higher, then AnyEvent will report extra information on
1572which optional modules it loads and how it implements certain features.
1573
1368=item C<PERL_ANYEVENT_STRICT> 1574=item C<PERL_ANYEVENT_STRICT>
1369 1575
1370AnyEvent does not do much argument checking by default, as thorough 1576AnyEvent does not do much argument checking by default, as thorough
1371argument checking is very costly. Setting this variable to a true value 1577argument checking is very costly. Setting this variable to a true value
1372will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly 1578will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1373check the arguments passed to most method calls. If it finds any problems 1579check the arguments passed to most method calls. If it finds any problems,
1374it will croak. 1580it will croak.
1375 1581
1376In other words, enables "strict" mode. 1582In other words, enables "strict" mode.
1377 1583
1378Unlike C<use strict>, it is definitely recommended ot keep it off in 1584Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1379production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while 1585>>, it is definitely recommended to keep it off in production. Keeping
1380developing programs can be very useful, however. 1586C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1587can be very useful, however.
1381 1588
1382=item C<PERL_ANYEVENT_MODEL> 1589=item C<PERL_ANYEVENT_MODEL>
1383 1590
1384This can be used to specify the event model to be used by AnyEvent, before 1591This can be used to specify the event model to be used by AnyEvent, before
1385auto detection and -probing kicks in. It must be a string consisting 1592auto detection and -probing kicks in. It must be a string consisting
1428 1635
1429=item C<PERL_ANYEVENT_MAX_FORKS> 1636=item C<PERL_ANYEVENT_MAX_FORKS>
1430 1637
1431The maximum number of child processes that C<AnyEvent::Util::fork_call> 1638The maximum number of child processes that C<AnyEvent::Util::fork_call>
1432will create in parallel. 1639will create in parallel.
1640
1641=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1642
1643The default value for the C<max_outstanding> parameter for the default DNS
1644resolver - this is the maximum number of parallel DNS requests that are
1645sent to the DNS server.
1646
1647=item C<PERL_ANYEVENT_RESOLV_CONF>
1648
1649The file to use instead of F</etc/resolv.conf> (or OS-specific
1650configuration) in the default resolver. When set to the empty string, no
1651default config will be used.
1652
1653=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1654
1655When neither C<ca_file> nor C<ca_path> was specified during
1656L<AnyEvent::TLS> context creation, and either of these environment
1657variables exist, they will be used to specify CA certificate locations
1658instead of a system-dependent default.
1659
1660=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1661
1662When these are set to C<1>, then the respective modules are not
1663loaded. Mostly good for testing AnyEvent itself.
1433 1664
1434=back 1665=back
1435 1666
1436=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1667=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1437 1668
1682 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 1913 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1683 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 1914 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1684 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 1915 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1685 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 1916 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1686 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 1917 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1918 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
1919 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1687 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 1920 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1688 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 1921 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1689 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 1922 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1690 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 1923 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1691 1924
1720performance becomes really bad with lots of file descriptors (and few of 1953performance becomes really bad with lots of file descriptors (and few of
1721them active), of course, but this was not subject of this benchmark. 1954them active), of course, but this was not subject of this benchmark.
1722 1955
1723The C<Event> module has a relatively high setup and callback invocation 1956The C<Event> module has a relatively high setup and callback invocation
1724cost, but overall scores in on the third place. 1957cost, but overall scores in on the third place.
1958
1959C<IO::Async> performs admirably well, about on par with C<Event>, even
1960when using its pure perl backend.
1725 1961
1726C<Glib>'s memory usage is quite a bit higher, but it features a 1962C<Glib>'s memory usage is quite a bit higher, but it features a
1727faster callback invocation and overall ends up in the same class as 1963faster callback invocation and overall ends up in the same class as
1728C<Event>. However, Glib scales extremely badly, doubling the number of 1964C<Event>. However, Glib scales extremely badly, doubling the number of
1729watchers increases the processing time by more than a factor of four, 1965watchers increases the processing time by more than a factor of four,
1807it to another server. This includes deleting the old timeout and creating 2043it to another server. This includes deleting the old timeout and creating
1808a new one that moves the timeout into the future. 2044a new one that moves the timeout into the future.
1809 2045
1810=head3 Results 2046=head3 Results
1811 2047
1812 name sockets create request 2048 name sockets create request
1813 EV 20000 69.01 11.16 2049 EV 20000 69.01 11.16
1814 Perl 20000 73.32 35.87 2050 Perl 20000 73.32 35.87
2051 IOAsync 20000 157.00 98.14 epoll
2052 IOAsync 20000 159.31 616.06 poll
1815 Event 20000 212.62 257.32 2053 Event 20000 212.62 257.32
1816 Glib 20000 651.16 1896.30 2054 Glib 20000 651.16 1896.30
1817 POE 20000 349.67 12317.24 uses POE::Loop::Event 2055 POE 20000 349.67 12317.24 uses POE::Loop::Event
1818 2056
1819=head3 Discussion 2057=head3 Discussion
1820 2058
1821This benchmark I<does> measure scalability and overall performance of the 2059This benchmark I<does> measure scalability and overall performance of the
1822particular event loop. 2060particular event loop.
1824EV is again fastest. Since it is using epoll on my system, the setup time 2062EV is again fastest. Since it is using epoll on my system, the setup time
1825is relatively high, though. 2063is relatively high, though.
1826 2064
1827Perl surprisingly comes second. It is much faster than the C-based event 2065Perl surprisingly comes second. It is much faster than the C-based event
1828loops Event and Glib. 2066loops Event and Glib.
2067
2068IO::Async performs very well when using its epoll backend, and still quite
2069good compared to Glib when using its pure perl backend.
1829 2070
1830Event suffers from high setup time as well (look at its code and you will 2071Event suffers from high setup time as well (look at its code and you will
1831understand why). Callback invocation also has a high overhead compared to 2072understand why). Callback invocation also has a high overhead compared to
1832the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 2073the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1833uses select or poll in basically all documented configurations. 2074uses select or poll in basically all documented configurations.
1896=item * C-based event loops perform very well with small number of 2137=item * C-based event loops perform very well with small number of
1897watchers, as the management overhead dominates. 2138watchers, as the management overhead dominates.
1898 2139
1899=back 2140=back
1900 2141
2142=head2 THE IO::Lambda BENCHMARK
2143
2144Recently I was told about the benchmark in the IO::Lambda manpage, which
2145could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
2146simply compares IO::Lambda with POE, and IO::Lambda looks better (which
2147shouldn't come as a surprise to anybody). As such, the benchmark is
2148fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
2149very optimal. But how would AnyEvent compare when used without the extra
2150baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
2151
2152The benchmark itself creates an echo-server, and then, for 500 times,
2153connects to the echo server, sends a line, waits for the reply, and then
2154creates the next connection. This is a rather bad benchmark, as it doesn't
2155test the efficiency of the framework or much non-blocking I/O, but it is a
2156benchmark nevertheless.
2157
2158 name runtime
2159 Lambda/select 0.330 sec
2160 + optimized 0.122 sec
2161 Lambda/AnyEvent 0.327 sec
2162 + optimized 0.138 sec
2163 Raw sockets/select 0.077 sec
2164 POE/select, components 0.662 sec
2165 POE/select, raw sockets 0.226 sec
2166 POE/select, optimized 0.404 sec
2167
2168 AnyEvent/select/nb 0.085 sec
2169 AnyEvent/EV/nb 0.068 sec
2170 +state machine 0.134 sec
2171
2172The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
2173benchmarks actually make blocking connects and use 100% blocking I/O,
2174defeating the purpose of an event-based solution. All of the newly
2175written AnyEvent benchmarks use 100% non-blocking connects (using
2176AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
2177resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
2178generally require a lot more bookkeeping and event handling than blocking
2179connects (which involve a single syscall only).
2180
2181The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
2182offers similar expressive power as POE and IO::Lambda, using conventional
2183Perl syntax. This means that both the echo server and the client are 100%
2184non-blocking, further placing it at a disadvantage.
2185
2186As you can see, the AnyEvent + EV combination even beats the
2187hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2188backend easily beats IO::Lambda and POE.
2189
2190And even the 100% non-blocking version written using the high-level (and
2191slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
2192large margin, even though it does all of DNS, tcp-connect and socket I/O
2193in a non-blocking way.
2194
2195The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2196F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2197part of the IO::lambda distribution and were used without any changes.
2198
1901 2199
1902=head1 SIGNALS 2200=head1 SIGNALS
1903 2201
1904AnyEvent currently installs handlers for these signals: 2202AnyEvent currently installs handlers for these signals:
1905 2203
1908=item SIGCHLD 2206=item SIGCHLD
1909 2207
1910A handler for C<SIGCHLD> is installed by AnyEvent's child watcher 2208A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1911emulation for event loops that do not support them natively. Also, some 2209emulation for event loops that do not support them natively. Also, some
1912event loops install a similar handler. 2210event loops install a similar handler.
2211
2212Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2213AnyEvent will reset it to default, to avoid losing child exit statuses.
1913 2214
1914=item SIGPIPE 2215=item SIGPIPE
1915 2216
1916A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> 2217A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1917when AnyEvent gets loaded. 2218when AnyEvent gets loaded.
1929 2230
1930=back 2231=back
1931 2232
1932=cut 2233=cut
1933 2234
2235undef $SIG{CHLD}
2236 if $SIG{CHLD} eq 'IGNORE';
2237
1934$SIG{PIPE} = sub { } 2238$SIG{PIPE} = sub { }
1935 unless defined $SIG{PIPE}; 2239 unless defined $SIG{PIPE};
2240
2241=head1 RECOMMENDED/OPTIONAL MODULES
2242
2243One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2244it's built-in modules) are required to use it.
2245
2246That does not mean that AnyEvent won't take advantage of some additional
2247modules if they are installed.
2248
2249This section epxlains which additional modules will be used, and how they
2250affect AnyEvent's operetion.
2251
2252=over 4
2253
2254=item L<Async::Interrupt>
2255
2256This slightly arcane module is used to implement fast signal handling: To
2257my knowledge, there is no way to do completely race-free and quick
2258signal handling in pure perl. To ensure that signals still get
2259delivered, AnyEvent will start an interval timer to wake up perl (and
2260catch the signals) with soemd elay (default is 10 seconds, look for
2261C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2262
2263If this module is available, then it will be used to implement signal
2264catching, which means that signals will not be delayed, and the event loop
2265will not be interrupted regularly, which is more efficient (And good for
2266battery life on laptops).
2267
2268This affects not just the pure-perl event loop, but also other event loops
2269that have no signal handling on their own (e.g. Glib, Tk, Qt).
2270
2271=item L<EV>
2272
2273This module isn't really "optional", as it is simply one of the backend
2274event loops that AnyEvent can use. However, it is simply the best event
2275loop available in terms of features, speed and stability: It supports
2276the AnyEvent API optimally, implements all the watcher types in XS, does
2277automatic timer adjustments even when no monotonic clock is available,
2278can take avdantage of advanced kernel interfaces such as C<epoll> and
2279C<kqueue>, and is the fastest backend I<by far>. You can even embed
2280L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2281
2282=item L<Guard>
2283
2284The guard module, when used, will be used to implement
2285C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2286lot less memory), but otherwise doesn't affect guard operation much. It is
2287purely used for performance.
2288
2289=item L<JSON> and L<JSON::XS>
2290
2291This module is required when you want to read or write JSON data via
2292L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2293advantage of the ulta-high-speed L<JSON::XS> module when it is installed.
2294
2295In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2296installed.
2297
2298=item L<Net::SSLeay>
2299
2300Implementing TLS/SSL in Perl is certainly interesting, but not very
2301worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2302the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2303
2304=item L<Time::HiRes>
2305
2306This module is part of perl since release 5.008. It will be used when the
2307chosen event library does not come with a timing source on it's own. The
2308pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2309try to use a monotonic clock for timing stability.
2310
2311=back
1936 2312
1937 2313
1938=head1 FORK 2314=head1 FORK
1939 2315
1940Most event libraries are not fork-safe. The ones who are usually are 2316Most event libraries are not fork-safe. The ones who are usually are
1941because they rely on inefficient but fork-safe C<select> or C<poll> 2317because they rely on inefficient but fork-safe C<select> or C<poll>
1942calls. Only L<EV> is fully fork-aware. 2318calls. Only L<EV> is fully fork-aware.
1943 2319
1944If you have to fork, you must either do so I<before> creating your first 2320If you have to fork, you must either do so I<before> creating your first
1945watcher OR you must not use AnyEvent at all in the child. 2321watcher OR you must not use AnyEvent at all in the child OR you must do
2322something completely out of the scope of AnyEvent.
1946 2323
1947 2324
1948=head1 SECURITY CONSIDERATIONS 2325=head1 SECURITY CONSIDERATIONS
1949 2326
1950AnyEvent can be forced to load any event model via 2327AnyEvent can be forced to load any event model via
1962 use AnyEvent; 2339 use AnyEvent;
1963 2340
1964Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2341Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1965be used to probe what backend is used and gain other information (which is 2342be used to probe what backend is used and gain other information (which is
1966probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and 2343probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1967$ENV{PERL_ANYEGENT_STRICT}. 2344$ENV{PERL_ANYEVENT_STRICT}.
2345
2346Note that AnyEvent will remove I<all> environment variables starting with
2347C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2348enabled.
1968 2349
1969 2350
1970=head1 BUGS 2351=head1 BUGS
1971 2352
1972Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 2353Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1984L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2365L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1985 2366
1986Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2367Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1987L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2368L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1988L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2369L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1989L<AnyEvent::Impl::POE>. 2370L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.
1990 2371
1991Non-blocking file handles, sockets, TCP clients and 2372Non-blocking file handles, sockets, TCP clients and
1992servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. 2373servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1993 2374
1994Asynchronous DNS: L<AnyEvent::DNS>. 2375Asynchronous DNS: L<AnyEvent::DNS>.
1995 2376
1996Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 2377Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
2378L<Coro::Event>,
1997 2379
1998Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 2380Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
2381L<AnyEvent::HTTP>.
1999 2382
2000 2383
2001=head1 AUTHOR 2384=head1 AUTHOR
2002 2385
2003 Marc Lehmann <schmorp@schmorp.de> 2386 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines