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.213 by root, Sat Jun 20 07:14:35 2009 UTC vs.
Revision 1.249 by root, Mon Jul 20 06:00:42 2009 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - events independent of event loop implementation
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported 5EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported
6event loops. 6event loops.
7 7
8=head1 SYNOPSIS 8=head1 SYNOPSIS
40=head1 INTRODUCTION/TUTORIAL 40=head1 INTRODUCTION/TUTORIAL
41 41
42This manpage is mainly a reference manual. If you are interested 42This manpage is mainly a reference manual. If you are interested
43in a tutorial or some gentle introduction, have a look at the 43in a tutorial or some gentle introduction, have a look at the
44L<AnyEvent::Intro> manpage. 44L<AnyEvent::Intro> manpage.
45
46=head1 SUPPORT
47
48There is a mailinglist for discussing all things AnyEvent, and an IRC
49channel, too.
50
51See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52Respository>, at L<http://anyevent.schmorp.de>, for more info.
45 53
46=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 54=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
47 55
48Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 56Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
49nowadays. So what is different about AnyEvent? 57nowadays. So what is different about AnyEvent?
176=head2 I/O WATCHERS 184=head2 I/O WATCHERS
177 185
178You can create an I/O watcher by calling the C<< AnyEvent->io >> method 186You can create an I/O watcher by calling the C<< AnyEvent->io >> method
179with the following mandatory key-value pairs as arguments: 187with the following mandatory key-value pairs as arguments:
180 188
181C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch 189C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
182for events (AnyEvent might or might not keep a reference to this file 190for events (AnyEvent might or might not keep a reference to this file
183handle). Note that only file handles pointing to things for which 191handle). Note that only file handles pointing to things for which
184non-blocking operation makes sense are allowed. This includes sockets, 192non-blocking operation makes sense are allowed. This includes sockets,
185most character devices, pipes, fifos and so on, but not for example files 193most character devices, pipes, fifos and so on, but not for example files
186or block devices. 194or block devices.
361invocation, and callback invocation will be synchronous. Synchronous means 369invocation, and callback invocation will be synchronous. Synchronous means
362that it might take a while until the signal gets handled by the process, 370that it might take a while until the signal gets handled by the process,
363but it is guaranteed not to interrupt any other callbacks. 371but it is guaranteed not to interrupt any other callbacks.
364 372
365The main advantage of using these watchers is that you can share a signal 373The main advantage of using these watchers is that you can share a signal
366between multiple watchers. 374between multiple watchers, and AnyEvent will ensure that signals will not
375interrupt your program at bad times.
367 376
368This watcher might use C<%SIG>, so programs overwriting those signals 377This watcher might use C<%SIG> (depending on the event loop used),
369directly will likely not work correctly. 378so programs overwriting those signals directly will likely not work
379correctly.
370 380
371Example: exit on SIGINT 381Example: exit on SIGINT
372 382
373 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 383 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384
385=head3 Signal Races, Delays and Workarounds
386
387Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
388callbacks to signals in a generic way, which is a pity, as you cannot do
389race-free signal handling in perl. AnyEvent will try to do it's best, but
390in some cases, signals will be delayed. The maximum time a signal might
391be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10
392seconds). This variable can be changed only before the first signal
393watcher is created, and should be left alone otherwise. Higher values
394will cause fewer spurious wake-ups, which is better for power and CPU
395saving. All these problems can be avoided by installing the optional
396L<Async::Interrupt> module. This will not work with inherently broken
397event loops such as L<Event> or L<Event::Lib> (and not with L<POE>
398currently, as POE does it's own workaround with one-second latency). With
399those, you just have to suffer the delays.
374 400
375=head2 CHILD PROCESS WATCHERS 401=head2 CHILD PROCESS WATCHERS
376 402
377You can also watch on a child process exit and catch its exit status. 403You can also watch on a child process exit and catch its exit status.
378 404
392 418
393There is a slight catch to child watchers, however: you usually start them 419There is a slight catch to child watchers, however: you usually start them
394I<after> the child process was created, and this means the process could 420I<after> the child process was created, and this means the process could
395have exited already (and no SIGCHLD will be sent anymore). 421have exited already (and no SIGCHLD will be sent anymore).
396 422
397Not all event models handle this correctly (POE doesn't), but even for 423Not all event models handle this correctly (neither POE nor IO::Async do,
424see their AnyEvent::Impl manpages for details), but even for event models
398event models that I<do> handle this correctly, they usually need to be 425that I<do> handle this correctly, they usually need to be loaded before
399loaded before the process exits (i.e. before you fork in the first place). 426the process exits (i.e. before you fork in the first place). AnyEvent's
427pure perl event loop handles all cases correctly regardless of when you
428start the watcher.
400 429
401This means you cannot create a child watcher as the very first thing in an 430This means you cannot create a child watcher as the very first
402AnyEvent program, you I<have> to create at least one watcher before you 431thing in an AnyEvent program, you I<have> to create at least one
403C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 432watcher before you C<fork> the child (alternatively, you can call
433C<AnyEvent::detect>).
434
435As most event loops do not support waiting for child events, they will be
436emulated by AnyEvent in most cases, in which the latency and race problems
437mentioned in the description of signal watchers apply.
404 438
405Example: fork a process and wait for it 439Example: fork a process and wait for it
406 440
407 my $done = AnyEvent->condvar; 441 my $done = AnyEvent->condvar;
408 442
459 493
460If you are familiar with some event loops you will know that all of them 494If you are familiar with some event loops you will know that all of them
461require you to run some blocking "loop", "run" or similar function that 495require you to run some blocking "loop", "run" or similar function that
462will actively watch for new events and call your callbacks. 496will actively watch for new events and call your callbacks.
463 497
464AnyEvent is different, it expects somebody else to run the event loop and 498AnyEvent is slightly different: it expects somebody else to run the event
465will only block when necessary (usually when told by the user). 499loop and will only block when necessary (usually when told by the user).
466 500
467The instrument to do that is called a "condition variable", so called 501The instrument to do that is called a "condition variable", so called
468because they represent a condition that must become true. 502because they represent a condition that must become true.
469 503
504Now is probably a good time to look at the examples further below.
505
470Condition variables can be created by calling the C<< AnyEvent->condvar 506Condition variables can be created by calling the C<< AnyEvent->condvar
471>> method, usually without arguments. The only argument pair allowed is 507>> method, usually without arguments. The only argument pair allowed is
472
473C<cb>, which specifies a callback to be called when the condition variable 508C<cb>, which specifies a callback to be called when the condition variable
474becomes true, with the condition variable as the first argument (but not 509becomes true, with the condition variable as the first argument (but not
475the results). 510the results).
476 511
477After creation, the condition variable is "false" until it becomes "true" 512After creation, the condition variable is "false" until it becomes "true"
526 after => 1, 561 after => 1,
527 cb => sub { $result_ready->send }, 562 cb => sub { $result_ready->send },
528 ); 563 );
529 564
530 # this "blocks" (while handling events) till the callback 565 # this "blocks" (while handling events) till the callback
531 # calls send 566 # calls -<send
532 $result_ready->recv; 567 $result_ready->recv;
533 568
534Example: wait for a timer, but take advantage of the fact that 569Example: wait for a timer, but take advantage of the fact that condition
535condition variables are also code references. 570variables are also callable directly.
536 571
537 my $done = AnyEvent->condvar; 572 my $done = AnyEvent->condvar;
538 my $delay = AnyEvent->timer (after => 5, cb => $done); 573 my $delay = AnyEvent->timer (after => 5, cb => $done);
539 $done->recv; 574 $done->recv;
540 575
546 581
547 ... 582 ...
548 583
549 my @info = $couchdb->info->recv; 584 my @info = $couchdb->info->recv;
550 585
551And this is how you would just ste a callback to be called whenever the 586And this is how you would just set a callback to be called whenever the
552results are available: 587results are available:
553 588
554 $couchdb->info->cb (sub { 589 $couchdb->info->cb (sub {
555 my @info = $_[0]->recv; 590 my @info = $_[0]->recv;
556 }); 591 });
574immediately from within send. 609immediately from within send.
575 610
576Any arguments passed to the C<send> call will be returned by all 611Any arguments passed to the C<send> call will be returned by all
577future C<< ->recv >> calls. 612future C<< ->recv >> calls.
578 613
579Condition variables are overloaded so one can call them directly 614Condition variables are overloaded so one can call them directly (as if
580(as a code reference). Calling them directly is the same as calling 615they were a code reference). Calling them directly is the same as calling
581C<send>. Note, however, that many C-based event loops do not handle 616C<send>.
582overloading, so as tempting as it may be, passing a condition variable
583instead of a callback does not work. Both the pure perl and EV loops
584support overloading, however, as well as all functions that use perl to
585invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
586example).
587 617
588=item $cv->croak ($error) 618=item $cv->croak ($error)
589 619
590Similar to send, but causes all call's to C<< ->recv >> to invoke 620Similar to send, but causes all call's to C<< ->recv >> to invoke
591C<Carp::croak> with the given error message/object/scalar. 621C<Carp::croak> with the given error message/object/scalar.
592 622
593This can be used to signal any errors to the condition variable 623This can be used to signal any errors to the condition variable
594user/consumer. 624user/consumer. Doing it this way instead of calling C<croak> directly
625delays the error detetcion, but has the overwhelmign advantage that it
626diagnoses the error at the place where the result is expected, and not
627deep in some event clalback without connection to the actual code causing
628the problem.
595 629
596=item $cv->begin ([group callback]) 630=item $cv->begin ([group callback])
597 631
598=item $cv->end 632=item $cv->end
599
600These two methods are EXPERIMENTAL and MIGHT CHANGE.
601 633
602These two methods can be used to combine many transactions/events into 634These two methods can be used to combine many transactions/events into
603one. For example, a function that pings many hosts in parallel might want 635one. For example, a function that pings many hosts in parallel might want
604to use a condition variable for the whole process. 636to use a condition variable for the whole process.
605 637
607C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 639C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
608>>, the (last) callback passed to C<begin> will be executed. That callback 640>>, the (last) callback passed to C<begin> will be executed. That callback
609is I<supposed> to call C<< ->send >>, but that is not required. If no 641is I<supposed> to call C<< ->send >>, but that is not required. If no
610callback was set, C<send> will be called without any arguments. 642callback was set, C<send> will be called without any arguments.
611 643
612Let's clarify this with the ping example: 644You can think of C<< $cv->send >> giving you an OR condition (one call
645sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
646condition (all C<begin> calls must be C<end>'ed before the condvar sends).
647
648Let's start with a simple example: you have two I/O watchers (for example,
649STDOUT and STDERR for a program), and you want to wait for both streams to
650close before activating a condvar:
651
652 my $cv = AnyEvent->condvar;
653
654 $cv->begin; # first watcher
655 my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
656 defined sysread $fh1, my $buf, 4096
657 or $cv->end;
658 });
659
660 $cv->begin; # second watcher
661 my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
662 defined sysread $fh2, my $buf, 4096
663 or $cv->end;
664 });
665
666 $cv->recv;
667
668This works because for every event source (EOF on file handle), there is
669one call to C<begin>, so the condvar waits for all calls to C<end> before
670sending.
671
672The ping example mentioned above is slightly more complicated, as the
673there are results to be passwd back, and the number of tasks that are
674begung can potentially be zero:
613 675
614 my $cv = AnyEvent->condvar; 676 my $cv = AnyEvent->condvar;
615 677
616 my %result; 678 my %result;
617 $cv->begin (sub { $cv->send (\%result) }); 679 $cv->begin (sub { $cv->send (\%result) });
637loop, which serves two important purposes: first, it sets the callback 699loop, which serves two important purposes: first, it sets the callback
638to be called once the counter reaches C<0>, and second, it ensures that 700to be called once the counter reaches C<0>, and second, it ensures that
639C<send> is called even when C<no> hosts are being pinged (the loop 701C<send> is called even when C<no> hosts are being pinged (the loop
640doesn't execute once). 702doesn't execute once).
641 703
642This is the general pattern when you "fan out" into multiple subrequests: 704This is the general pattern when you "fan out" into multiple (but
643use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 705potentially none) subrequests: use an outer C<begin>/C<end> pair to set
644is called at least once, and then, for each subrequest you start, call 706the callback and ensure C<end> is called at least once, and then, for each
645C<begin> and for each subrequest you finish, call C<end>. 707subrequest you start, call C<begin> and for each subrequest you finish,
708call C<end>.
646 709
647=back 710=back
648 711
649=head3 METHODS FOR CONSUMERS 712=head3 METHODS FOR CONSUMERS
650 713
666function will call C<croak>. 729function will call C<croak>.
667 730
668In list context, all parameters passed to C<send> will be returned, 731In list context, all parameters passed to C<send> will be returned,
669in scalar context only the first one will be returned. 732in scalar context only the first one will be returned.
670 733
734Note that doing a blocking wait in a callback is not supported by any
735event loop, that is, recursive invocation of a blocking C<< ->recv
736>> is not allowed, and the C<recv> call will C<croak> if such a
737condition is detected. This condition can be slightly loosened by using
738L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
739any thread that doesn't run the event loop itself.
740
671Not all event models support a blocking wait - some die in that case 741Not all event models support a blocking wait - some die in that case
672(programs might want to do that to stay interactive), so I<if you are 742(programs might want to do that to stay interactive), so I<if you are
673using this from a module, never require a blocking wait>, but let the 743using this from a module, never require a blocking wait>. Instead, let the
674caller decide whether the call will block or not (for example, by coupling 744caller decide whether the call will block or not (for example, by coupling
675condition variables with some kind of request results and supporting 745condition variables with some kind of request results and supporting
676callbacks so the caller knows that getting the result will not block, 746callbacks so the caller knows that getting the result will not block,
677while still supporting blocking waits if the caller so desires). 747while still supporting blocking waits if the caller so desires).
678 748
679Another reason I<never> to C<< ->recv >> in a module is that you cannot
680sensibly have two C<< ->recv >>'s in parallel, as that would require
681multiple interpreters or coroutines/threads, none of which C<AnyEvent>
682can supply.
683
684The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
685fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
686versions and also integrates coroutines into AnyEvent, making blocking
687C<< ->recv >> calls perfectly safe as long as they are done from another
688coroutine (one that doesn't run the event loop).
689
690You can ensure that C<< -recv >> never blocks by setting a callback and 749You can ensure that C<< -recv >> never blocks by setting a callback and
691only calling C<< ->recv >> from within that callback (or at a later 750only calling C<< ->recv >> from within that callback (or at a later
692time). This will work even when the event loop does not support blocking 751time). This will work even when the event loop does not support blocking
693waits otherwise. 752waits otherwise.
694 753
707variable itself. Calling C<recv> inside the callback or at any later time 766variable itself. Calling C<recv> inside the callback or at any later time
708is guaranteed not to block. 767is guaranteed not to block.
709 768
710=back 769=back
711 770
771=head1 SUPPORTED EVENT LOOPS/BACKENDS
772
773The available backend classes are (every class has its own manpage):
774
775=over 4
776
777=item Backends that are autoprobed when no other event loop can be found.
778
779EV is the preferred backend when no other event loop seems to be in
780use. If EV is not installed, then AnyEvent will try Event, and, failing
781that, will fall back to its own pure-perl implementation, which is
782available everywhere as it comes with AnyEvent itself.
783
784 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
785 AnyEvent::Impl::Event based on Event, very stable, few glitches.
786 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
787
788=item Backends that are transparently being picked up when they are used.
789
790These will be used when they are currently loaded when the first watcher
791is created, in which case it is assumed that the application is using
792them. This means that AnyEvent will automatically pick the right backend
793when the main program loads an event module before anything starts to
794create watchers. Nothing special needs to be done by the main program.
795
796 AnyEvent::Impl::Glib based on Glib, slow but very stable.
797 AnyEvent::Impl::Tk based on Tk, very broken.
798 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
799 AnyEvent::Impl::POE based on POE, very slow, some limitations.
800
801=item Backends with special needs.
802
803Qt requires the Qt::Application to be instantiated first, but will
804otherwise be picked up automatically. As long as the main program
805instantiates the application before any AnyEvent watchers are created,
806everything should just work.
807
808 AnyEvent::Impl::Qt based on Qt.
809
810Support for IO::Async can only be partial, as it is too broken and
811architecturally limited to even support the AnyEvent API. It also
812is the only event loop that needs the loop to be set explicitly, so
813it can only be used by a main program knowing about AnyEvent. See
814L<AnyEvent::Impl::Async> for the gory details.
815
816 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
817
818=item Event loops that are indirectly supported via other backends.
819
820Some event loops can be supported via other modules:
821
822There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
823
824B<WxWidgets> has no support for watching file handles. However, you can
825use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
826polls 20 times per second, which was considered to be too horrible to even
827consider for AnyEvent.
828
829B<Prima> is not supported as nobody seems to be using it, but it has a POE
830backend, so it can be supported through POE.
831
832AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
833load L<POE> when detecting them, in the hope that POE will pick them up,
834in which case everything will be automatic.
835
836=back
837
712=head1 GLOBAL VARIABLES AND FUNCTIONS 838=head1 GLOBAL VARIABLES AND FUNCTIONS
713 839
840These are not normally required to use AnyEvent, but can be useful to
841write AnyEvent extension modules.
842
714=over 4 843=over 4
715 844
716=item $AnyEvent::MODEL 845=item $AnyEvent::MODEL
717 846
718Contains C<undef> until the first watcher is being created. Then it 847Contains C<undef> until the first watcher is being created, before the
848backend has been autodetected.
849
719contains the event model that is being used, which is the name of the 850Afterwards it contains the event model that is being used, which is the
720Perl class implementing the model. This class is usually one of the 851name of the Perl class implementing the model. This class is usually one
721C<AnyEvent::Impl:xxx> modules, but can be any other class in the case 852of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
722AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). 853case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
723 854will be C<urxvt::anyevent>).
724The known classes so far are:
725
726 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
727 AnyEvent::Impl::Event based on Event, second best choice.
728 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
729 AnyEvent::Impl::Glib based on Glib, third-best choice.
730 AnyEvent::Impl::Tk based on Tk, very bad choice.
731 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
732 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
733 AnyEvent::Impl::POE based on POE, not generic enough for full support.
734
735There is no support for WxWidgets, as WxWidgets has no support for
736watching file handles. However, you can use WxWidgets through the
737POE Adaptor, as POE has a Wx backend that simply polls 20 times per
738second, which was considered to be too horrible to even consider for
739AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
740it's adaptor.
741
742AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
743autodetecting them.
744 855
745=item AnyEvent::detect 856=item AnyEvent::detect
746 857
747Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 858Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
748if necessary. You should only call this function right before you would 859if necessary. You should only call this function right before you would
749have created an AnyEvent watcher anyway, that is, as late as possible at 860have created an AnyEvent watcher anyway, that is, as late as possible at
750runtime. 861runtime, and not e.g. while initialising of your module.
862
863If you need to do some initialisation before AnyEvent watchers are
864created, use C<post_detect>.
751 865
752=item $guard = AnyEvent::post_detect { BLOCK } 866=item $guard = AnyEvent::post_detect { BLOCK }
753 867
754Arranges for the code block to be executed as soon as the event model is 868Arranges for the code block to be executed as soon as the event model is
755autodetected (or immediately if this has already happened). 869autodetected (or immediately if this has already happened).
870
871The block will be executed I<after> the actual backend has been detected
872(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
873created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
874other initialisations - see the sources of L<AnyEvent::Strict> or
875L<AnyEvent::AIO> to see how this is used.
876
877The most common usage is to create some global watchers, without forcing
878event module detection too early, for example, L<AnyEvent::AIO> creates
879and installs the global L<IO::AIO> watcher in a C<post_detect> block to
880avoid autodetecting the event module at load time.
756 881
757If called in scalar or list context, then it creates and returns an object 882If called in scalar or list context, then it creates and returns an object
758that automatically removes the callback again when it is destroyed. See 883that automatically removes the callback again when it is destroyed. See
759L<Coro::BDB> for a case where this is useful. 884L<Coro::BDB> for a case where this is useful.
760 885
763If there are any code references in this array (you can C<push> to it 888If there are any code references in this array (you can C<push> to it
764before or after loading AnyEvent), then they will called directly after 889before or after loading AnyEvent), then they will called directly after
765the event loop has been chosen. 890the event loop has been chosen.
766 891
767You should check C<$AnyEvent::MODEL> before adding to this array, though: 892You should check C<$AnyEvent::MODEL> before adding to this array, though:
768if it contains a true value then the event loop has already been detected, 893if it is defined then the event loop has already been detected, and the
769and the array will be ignored. 894array will be ignored.
770 895
771Best use C<AnyEvent::post_detect { BLOCK }> instead. 896Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
897it,as it takes care of these details.
898
899This variable is mainly useful for modules that can do something useful
900when AnyEvent is used and thus want to know when it is initialised, but do
901not need to even load it by default. This array provides the means to hook
902into AnyEvent passively, without loading it.
772 903
773=back 904=back
774 905
775=head1 WHAT TO DO IN A MODULE 906=head1 WHAT TO DO IN A MODULE
776 907
831 962
832 963
833=head1 OTHER MODULES 964=head1 OTHER MODULES
834 965
835The following is a non-exhaustive list of additional modules that use 966The following is a non-exhaustive list of additional modules that use
836AnyEvent and can therefore be mixed easily with other AnyEvent modules 967AnyEvent as a client and can therefore be mixed easily with other AnyEvent
837in the same program. Some of the modules come with AnyEvent, some are 968modules and other event loops in the same program. Some of the modules
838available via CPAN. 969come with AnyEvent, most are available via CPAN.
839 970
840=over 4 971=over 4
841 972
842=item L<AnyEvent::Util> 973=item L<AnyEvent::Util>
843 974
852 983
853=item L<AnyEvent::Handle> 984=item L<AnyEvent::Handle>
854 985
855Provide read and write buffers, manages watchers for reads and writes, 986Provide read and write buffers, manages watchers for reads and writes,
856supports raw and formatted I/O, I/O queued and fully transparent and 987supports raw and formatted I/O, I/O queued and fully transparent and
857non-blocking SSL/TLS. 988non-blocking SSL/TLS (via L<AnyEvent::TLS>.
858 989
859=item L<AnyEvent::DNS> 990=item L<AnyEvent::DNS>
860 991
861Provides rich asynchronous DNS resolver capabilities. 992Provides rich asynchronous DNS resolver capabilities.
862 993
890 1021
891=item L<AnyEvent::GPSD> 1022=item L<AnyEvent::GPSD>
892 1023
893A non-blocking interface to gpsd, a daemon delivering GPS information. 1024A non-blocking interface to gpsd, a daemon delivering GPS information.
894 1025
1026=item L<AnyEvent::IRC>
1027
1028AnyEvent based IRC client module family (replacing the older Net::IRC3).
1029
1030=item L<AnyEvent::XMPP>
1031
1032AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1033Net::XMPP2>.
1034
895=item L<AnyEvent::IGS> 1035=item L<AnyEvent::IGS>
896 1036
897A non-blocking interface to the Internet Go Server protocol (used by 1037A non-blocking interface to the Internet Go Server protocol (used by
898L<App::IGS>). 1038L<App::IGS>).
899 1039
900=item L<AnyEvent::IRC>
901
902AnyEvent based IRC client module family (replacing the older Net::IRC3).
903
904=item L<Net::XMPP2>
905
906AnyEvent based XMPP (Jabber protocol) module family.
907
908=item L<Net::FCP> 1040=item L<Net::FCP>
909 1041
910AnyEvent-based implementation of the Freenet Client Protocol, birthplace 1042AnyEvent-based implementation of the Freenet Client Protocol, birthplace
911of AnyEvent. 1043of AnyEvent.
912 1044
916 1048
917=item L<Coro> 1049=item L<Coro>
918 1050
919Has special support for AnyEvent via L<Coro::AnyEvent>. 1051Has special support for AnyEvent via L<Coro::AnyEvent>.
920 1052
921=item L<IO::Lambda>
922
923The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
924
925=back 1053=back
926 1054
927=cut 1055=cut
928 1056
929package AnyEvent; 1057package AnyEvent;
930 1058
1059# basically a tuned-down version of common::sense
1060sub common_sense {
931no warnings; 1061 # no warnings
1062 ${^WARNING_BITS} ^= ${^WARNING_BITS};
932use strict qw(vars subs); 1063 # use strict vars subs
1064 $^H |= 0x00000600;
1065}
933 1066
1067BEGIN { AnyEvent::common_sense }
1068
934use Carp; 1069use Carp ();
935 1070
936our $VERSION = 4.411; 1071our $VERSION = 4.85;
937our $MODEL; 1072our $MODEL;
938 1073
939our $AUTOLOAD; 1074our $AUTOLOAD;
940our @ISA; 1075our @ISA;
941 1076
942our @REGISTRY; 1077our @REGISTRY;
943 1078
944our $WIN32; 1079our $WIN32;
945 1080
1081our $VERBOSE;
1082
946BEGIN { 1083BEGIN {
947 my $win32 = ! ! ($^O =~ /mswin32/i); 1084 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
948 eval "sub WIN32(){ $win32 }"; 1085 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
949}
950 1086
1087 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1088 if ${^TAINT};
1089
951our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1090 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1091
1092}
1093
1094our $MAX_SIGNAL_LATENCY = 10;
952 1095
953our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1096our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
954 1097
955{ 1098{
956 my $idx; 1099 my $idx;
964 [Event:: => AnyEvent::Impl::Event::], 1107 [Event:: => AnyEvent::Impl::Event::],
965 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1108 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
966 # everything below here will not be autoprobed 1109 # everything below here will not be autoprobed
967 # as the pureperl backend should work everywhere 1110 # as the pureperl backend should work everywhere
968 # and is usually faster 1111 # and is usually faster
969 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
970 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1112 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
971 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1113 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1114 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
972 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1115 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
973 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1116 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
974 [Wx:: => AnyEvent::Impl::POE::], 1117 [Wx:: => AnyEvent::Impl::POE::],
975 [Prima:: => AnyEvent::Impl::POE::], 1118 [Prima:: => AnyEvent::Impl::POE::],
1119 # IO::Async is just too broken - we would need workarounds for its
1120 # byzantine signal and broken child handling, among others.
1121 # IO::Async is rather hard to detect, as it doesn't have any
1122 # obvious default class.
1123# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1124# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1125# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
976); 1126);
977 1127
978our %method = map +($_ => 1), 1128our %method = map +($_ => 1),
979 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1129 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
980 1130
1000 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1150 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1001} 1151}
1002 1152
1003sub detect() { 1153sub detect() {
1004 unless ($MODEL) { 1154 unless ($MODEL) {
1005 no strict 'refs';
1006 local $SIG{__DIE__}; 1155 local $SIG{__DIE__};
1007 1156
1008 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1157 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1009 my $model = "AnyEvent::Impl::$1"; 1158 my $model = "AnyEvent::Impl::$1";
1010 if (eval "require $model") { 1159 if (eval "require $model") {
1011 $MODEL = $model; 1160 $MODEL = $model;
1012 warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; 1161 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1013 } else { 1162 } else {
1014 warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; 1163 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1015 } 1164 }
1016 } 1165 }
1017 1166
1018 # check for already loaded models 1167 # check for already loaded models
1019 unless ($MODEL) { 1168 unless ($MODEL) {
1020 for (@REGISTRY, @models) { 1169 for (@REGISTRY, @models) {
1021 my ($package, $model) = @$_; 1170 my ($package, $model) = @$_;
1022 if (${"$package\::VERSION"} > 0) { 1171 if (${"$package\::VERSION"} > 0) {
1023 if (eval "require $model") { 1172 if (eval "require $model") {
1024 $MODEL = $model; 1173 $MODEL = $model;
1025 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; 1174 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1026 last; 1175 last;
1027 } 1176 }
1028 } 1177 }
1029 } 1178 }
1030 1179
1035 my ($package, $model) = @$_; 1184 my ($package, $model) = @$_;
1036 if (eval "require $package" 1185 if (eval "require $package"
1037 and ${"$package\::VERSION"} > 0 1186 and ${"$package\::VERSION"} > 0
1038 and eval "require $model") { 1187 and eval "require $model") {
1039 $MODEL = $model; 1188 $MODEL = $model;
1040 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; 1189 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
1041 last; 1190 last;
1042 } 1191 }
1043 } 1192 }
1044 1193
1045 $MODEL 1194 $MODEL
1061 1210
1062sub AUTOLOAD { 1211sub AUTOLOAD {
1063 (my $func = $AUTOLOAD) =~ s/.*://; 1212 (my $func = $AUTOLOAD) =~ s/.*://;
1064 1213
1065 $method{$func} 1214 $method{$func}
1066 or croak "$func: not a valid method for AnyEvent objects"; 1215 or Carp::croak "$func: not a valid method for AnyEvent objects";
1067 1216
1068 detect unless $MODEL; 1217 detect unless $MODEL;
1069 1218
1070 my $class = shift; 1219 my $class = shift;
1071 $class->$func (@_); 1220 $class->$func (@_);
1072} 1221}
1073 1222
1074# utility function to dup a filehandle. this is used by many backends 1223# utility function to dup a filehandle. this is used by many backends
1075# to support binding more than one watcher per filehandle (they usually 1224# to support binding more than one watcher per filehandle (they usually
1076# allow only one watcher per fd, so we dup it to get a different one). 1225# allow only one watcher per fd, so we dup it to get a different one).
1077sub _dupfh($$$$) { 1226sub _dupfh($$;$$) {
1078 my ($poll, $fh, $r, $w) = @_; 1227 my ($poll, $fh, $r, $w) = @_;
1079 1228
1080 # cygwin requires the fh mode to be matching, unix doesn't 1229 # cygwin requires the fh mode to be matching, unix doesn't
1081 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1230 my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1082 : $poll eq "w" ? ($w, ">")
1083 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1084 1231
1085 open my $fh2, "$mode&" . fileno $fh 1232 open my $fh2, $mode, $fh
1086 or die "cannot dup() filehandle: $!,"; 1233 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1087 1234
1088 # we assume CLOEXEC is already set by perl in all important cases 1235 # we assume CLOEXEC is already set by perl in all important cases
1089 1236
1090 ($fh2, $rw) 1237 ($fh2, $rw)
1091} 1238}
1092 1239
1093package AnyEvent::Base; 1240package AnyEvent::Base;
1094 1241
1095# default implementations for many methods 1242# default implementations for many methods
1096 1243
1097BEGIN { 1244sub _time {
1245 # probe for availability of Time::HiRes
1098 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1246 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1247 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1099 *_time = \&Time::HiRes::time; 1248 *_time = \&Time::HiRes::time;
1100 # if (eval "use POSIX (); (POSIX::times())... 1249 # if (eval "use POSIX (); (POSIX::times())...
1101 } else { 1250 } else {
1251 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1102 *_time = sub { time }; # epic fail 1252 *_time = sub { time }; # epic fail
1103 } 1253 }
1254
1255 &_time
1104} 1256}
1105 1257
1106sub time { _time } 1258sub time { _time }
1107sub now { _time } 1259sub now { _time }
1108sub now_update { } 1260sub now_update { }
1113 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1265 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1114} 1266}
1115 1267
1116# default implementation for ->signal 1268# default implementation for ->signal
1117 1269
1270our $HAVE_ASYNC_INTERRUPT;
1118our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1271our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1272our (%SIG_ASY, %SIG_ASY_W);
1273our ($SIG_COUNT, $SIG_TW);
1119 1274
1120sub _signal_exec { 1275sub _signal_exec {
1276 $HAVE_ASYNC_INTERRUPT
1277 ? $SIGPIPE_R->drain
1121 sysread $SIGPIPE_R, my $dummy, 4; 1278 : sysread $SIGPIPE_R, my $dummy, 9;
1122 1279
1123 while (%SIG_EV) { 1280 while (%SIG_EV) {
1124 for (keys %SIG_EV) { 1281 for (keys %SIG_EV) {
1125 delete $SIG_EV{$_}; 1282 delete $SIG_EV{$_};
1126 $_->() for values %{ $SIG_CB{$_} || {} }; 1283 $_->() for values %{ $SIG_CB{$_} || {} };
1127 } 1284 }
1128 } 1285 }
1129} 1286}
1130 1287
1288# install a dumym wakeupw atcher to reduce signal catching latency
1289sub _sig_add() {
1290 unless ($SIG_COUNT++) {
1291 # try to align timer on a full-second boundary, if possible
1292 my $NOW = AnyEvent->now;
1293
1294 $SIG_TW = AnyEvent->timer (
1295 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1296 interval => $MAX_SIGNAL_LATENCY,
1297 cb => sub { }, # just for the PERL_ASYNC_CHECK
1298 );
1299 }
1300}
1301
1302sub _sig_del {
1303 undef $SIG_TW
1304 unless --$SIG_COUNT;
1305}
1306
1307sub _signal {
1308 my (undef, %arg) = @_;
1309
1310 my $signal = uc $arg{signal}
1311 or Carp::croak "required option 'signal' is missing";
1312
1313 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1314
1315 if ($HAVE_ASYNC_INTERRUPT) {
1316 # async::interrupt
1317
1318 $SIG_ASY{$signal} ||= do {
1319 my $asy = new Async::Interrupt
1320 cb => sub { undef $SIG_EV{$signal} },
1321 signal => $signal,
1322 pipe => [$SIGPIPE_R->filenos],
1323 ;
1324 $asy->pipe_autodrain (0);
1325
1326 $asy
1327 };
1328
1329 } else {
1330 # pure perl
1331
1332 $SIG{$signal} ||= sub {
1333 local $!;
1334 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1335 undef $SIG_EV{$signal};
1336 };
1337
1338 # can't do signal processing without introducing races in pure perl,
1339 # so limit the signal latency.
1340 _sig_add;
1341 }
1342
1343 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1344}
1345
1131sub signal { 1346sub signal {
1132 my (undef, %arg) = @_; 1347 # probe for availability of Async::Interrupt
1348 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1349 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1133 1350
1134 unless ($SIGPIPE_R) { 1351 $HAVE_ASYNC_INTERRUPT = 1;
1352 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1353 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1354
1355 } else {
1356 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1357
1135 require Fcntl; 1358 require Fcntl;
1136 1359
1137 if (AnyEvent::WIN32) { 1360 if (AnyEvent::WIN32) {
1138 require AnyEvent::Util; 1361 require AnyEvent::Util;
1139 1362
1154 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1377 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1155 1378
1156 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1379 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1157 } 1380 }
1158 1381
1159 my $signal = uc $arg{signal} 1382 *signal = \&_signal;
1160 or Carp::croak "required option 'signal' is missing"; 1383 &signal
1161
1162 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1163 $SIG{$signal} ||= sub {
1164 local $!;
1165 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1166 undef $SIG_EV{$signal};
1167 };
1168
1169 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1170} 1384}
1171 1385
1172sub AnyEvent::Base::signal::DESTROY { 1386sub AnyEvent::Base::signal::DESTROY {
1173 my ($signal, $cb) = @{$_[0]}; 1387 my ($signal, $cb) = @{$_[0]};
1174 1388
1389 _sig_del;
1390
1175 delete $SIG_CB{$signal}{$cb}; 1391 delete $SIG_CB{$signal}{$cb};
1176 1392
1393 $HAVE_ASYNC_INTERRUPT
1394 ? delete $SIG_ASY{$signal}
1177 # delete doesn't work with older perls - they then 1395 : # delete doesn't work with older perls - they then
1178 # print weird messages, or just unconditionally exit 1396 # print weird messages, or just unconditionally exit
1179 # instead of getting the default action. 1397 # instead of getting the default action.
1398 undef $SIG{$signal}
1180 undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; 1399 unless keys %{ $SIG_CB{$signal} };
1181} 1400}
1182 1401
1183# default implementation for ->child 1402# default implementation for ->child
1184 1403
1185our %PID_CB; 1404our %PID_CB;
1187our $CHLD_DELAY_W; 1406our $CHLD_DELAY_W;
1188our $WNOHANG; 1407our $WNOHANG;
1189 1408
1190sub _sigchld { 1409sub _sigchld {
1191 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1410 while (0 < (my $pid = waitpid -1, $WNOHANG)) {
1411 $_->($pid, $?)
1192 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1412 for values %{ $PID_CB{$pid} || {} },
1193 (values %{ $PID_CB{0} || {} }); 1413 values %{ $PID_CB{0} || {} };
1194 } 1414 }
1195} 1415}
1196 1416
1197sub child { 1417sub child {
1198 my (undef, %arg) = @_; 1418 my (undef, %arg) = @_;
1200 defined (my $pid = $arg{pid} + 0) 1420 defined (my $pid = $arg{pid} + 0)
1201 or Carp::croak "required option 'pid' is missing"; 1421 or Carp::croak "required option 'pid' is missing";
1202 1422
1203 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1423 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1204 1424
1425 # WNOHANG is almost cetrainly 1 everywhere
1426 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1427 ? 1
1205 $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1428 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1206 1429
1207 unless ($CHLD_W) { 1430 unless ($CHLD_W) {
1208 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1431 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1209 # child could be a zombie already, so make at least one round 1432 # child could be a zombie already, so make at least one round
1210 &_sigchld; 1433 &_sigchld;
1262 1485
1263our @ISA = AnyEvent::CondVar::Base::; 1486our @ISA = AnyEvent::CondVar::Base::;
1264 1487
1265package AnyEvent::CondVar::Base; 1488package AnyEvent::CondVar::Base;
1266 1489
1267use overload 1490#use overload
1268 '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1491# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1269 fallback => 1; 1492# fallback => 1;
1493
1494# save 300+ kilobytes by dirtily hardcoding overloading
1495${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
1496*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
1497*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
1498${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1499
1500our $WAITING;
1270 1501
1271sub _send { 1502sub _send {
1272 # nop 1503 # nop
1273} 1504}
1274 1505
1287sub ready { 1518sub ready {
1288 $_[0]{_ae_sent} 1519 $_[0]{_ae_sent}
1289} 1520}
1290 1521
1291sub _wait { 1522sub _wait {
1523 $WAITING
1524 and !$_[0]{_ae_sent}
1525 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1526
1527 local $WAITING = 1;
1292 AnyEvent->one_event while !$_[0]{_ae_sent}; 1528 AnyEvent->one_event while !$_[0]{_ae_sent};
1293} 1529}
1294 1530
1295sub recv { 1531sub recv {
1296 $_[0]->_wait; 1532 $_[0]->_wait;
1337so on. 1573so on.
1338 1574
1339=head1 ENVIRONMENT VARIABLES 1575=head1 ENVIRONMENT VARIABLES
1340 1576
1341The following environment variables are used by this module or its 1577The following environment variables are used by this module or its
1342submodules: 1578submodules.
1579
1580Note that AnyEvent will remove I<all> environment variables starting with
1581C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
1582enabled.
1343 1583
1344=over 4 1584=over 4
1345 1585
1346=item C<PERL_ANYEVENT_VERBOSE> 1586=item C<PERL_ANYEVENT_VERBOSE>
1347 1587
1354C<PERL_ANYEVENT_MODEL>. 1594C<PERL_ANYEVENT_MODEL>.
1355 1595
1356When set to C<2> or higher, cause AnyEvent to report to STDERR which event 1596When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1357model it chooses. 1597model it chooses.
1358 1598
1599When set to C<8> or higher, then AnyEvent will report extra information on
1600which optional modules it loads and how it implements certain features.
1601
1359=item C<PERL_ANYEVENT_STRICT> 1602=item C<PERL_ANYEVENT_STRICT>
1360 1603
1361AnyEvent does not do much argument checking by default, as thorough 1604AnyEvent does not do much argument checking by default, as thorough
1362argument checking is very costly. Setting this variable to a true value 1605argument checking is very costly. Setting this variable to a true value
1363will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly 1606will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1364check the arguments passed to most method calls. If it finds any problems 1607check the arguments passed to most method calls. If it finds any problems,
1365it will croak. 1608it will croak.
1366 1609
1367In other words, enables "strict" mode. 1610In other words, enables "strict" mode.
1368 1611
1369Unlike C<use strict>, it is definitely recommended ot keep it off in 1612Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1370production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while 1613>>, it is definitely recommended to keep it off in production. Keeping
1371developing programs can be very useful, however. 1614C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1615can be very useful, however.
1372 1616
1373=item C<PERL_ANYEVENT_MODEL> 1617=item C<PERL_ANYEVENT_MODEL>
1374 1618
1375This can be used to specify the event model to be used by AnyEvent, before 1619This can be used to specify the event model to be used by AnyEvent, before
1376auto detection and -probing kicks in. It must be a string consisting 1620auto detection and -probing kicks in. It must be a string consisting
1419 1663
1420=item C<PERL_ANYEVENT_MAX_FORKS> 1664=item C<PERL_ANYEVENT_MAX_FORKS>
1421 1665
1422The maximum number of child processes that C<AnyEvent::Util::fork_call> 1666The maximum number of child processes that C<AnyEvent::Util::fork_call>
1423will create in parallel. 1667will create in parallel.
1668
1669=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1670
1671The default value for the C<max_outstanding> parameter for the default DNS
1672resolver - this is the maximum number of parallel DNS requests that are
1673sent to the DNS server.
1674
1675=item C<PERL_ANYEVENT_RESOLV_CONF>
1676
1677The file to use instead of F</etc/resolv.conf> (or OS-specific
1678configuration) in the default resolver. When set to the empty string, no
1679default config will be used.
1680
1681=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1682
1683When neither C<ca_file> nor C<ca_path> was specified during
1684L<AnyEvent::TLS> context creation, and either of these environment
1685variables exist, they will be used to specify CA certificate locations
1686instead of a system-dependent default.
1687
1688=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1689
1690When these are set to C<1>, then the respective modules are not
1691loaded. Mostly good for testing AnyEvent itself.
1424 1692
1425=back 1693=back
1426 1694
1427=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1695=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1428 1696
1673 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 1941 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1674 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 1942 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1675 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 1943 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1676 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 1944 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1677 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 1945 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1946 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
1947 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1678 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 1948 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1679 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 1949 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1680 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 1950 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1681 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 1951 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1682 1952
1711performance becomes really bad with lots of file descriptors (and few of 1981performance becomes really bad with lots of file descriptors (and few of
1712them active), of course, but this was not subject of this benchmark. 1982them active), of course, but this was not subject of this benchmark.
1713 1983
1714The C<Event> module has a relatively high setup and callback invocation 1984The C<Event> module has a relatively high setup and callback invocation
1715cost, but overall scores in on the third place. 1985cost, but overall scores in on the third place.
1986
1987C<IO::Async> performs admirably well, about on par with C<Event>, even
1988when using its pure perl backend.
1716 1989
1717C<Glib>'s memory usage is quite a bit higher, but it features a 1990C<Glib>'s memory usage is quite a bit higher, but it features a
1718faster callback invocation and overall ends up in the same class as 1991faster callback invocation and overall ends up in the same class as
1719C<Event>. However, Glib scales extremely badly, doubling the number of 1992C<Event>. However, Glib scales extremely badly, doubling the number of
1720watchers increases the processing time by more than a factor of four, 1993watchers increases the processing time by more than a factor of four,
1798it to another server. This includes deleting the old timeout and creating 2071it to another server. This includes deleting the old timeout and creating
1799a new one that moves the timeout into the future. 2072a new one that moves the timeout into the future.
1800 2073
1801=head3 Results 2074=head3 Results
1802 2075
1803 name sockets create request 2076 name sockets create request
1804 EV 20000 69.01 11.16 2077 EV 20000 69.01 11.16
1805 Perl 20000 73.32 35.87 2078 Perl 20000 73.32 35.87
2079 IOAsync 20000 157.00 98.14 epoll
2080 IOAsync 20000 159.31 616.06 poll
1806 Event 20000 212.62 257.32 2081 Event 20000 212.62 257.32
1807 Glib 20000 651.16 1896.30 2082 Glib 20000 651.16 1896.30
1808 POE 20000 349.67 12317.24 uses POE::Loop::Event 2083 POE 20000 349.67 12317.24 uses POE::Loop::Event
1809 2084
1810=head3 Discussion 2085=head3 Discussion
1811 2086
1812This benchmark I<does> measure scalability and overall performance of the 2087This benchmark I<does> measure scalability and overall performance of the
1813particular event loop. 2088particular event loop.
1815EV is again fastest. Since it is using epoll on my system, the setup time 2090EV is again fastest. Since it is using epoll on my system, the setup time
1816is relatively high, though. 2091is relatively high, though.
1817 2092
1818Perl surprisingly comes second. It is much faster than the C-based event 2093Perl surprisingly comes second. It is much faster than the C-based event
1819loops Event and Glib. 2094loops Event and Glib.
2095
2096IO::Async performs very well when using its epoll backend, and still quite
2097good compared to Glib when using its pure perl backend.
1820 2098
1821Event suffers from high setup time as well (look at its code and you will 2099Event suffers from high setup time as well (look at its code and you will
1822understand why). Callback invocation also has a high overhead compared to 2100understand why). Callback invocation also has a high overhead compared to
1823the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 2101the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1824uses select or poll in basically all documented configurations. 2102uses select or poll in basically all documented configurations.
1887=item * C-based event loops perform very well with small number of 2165=item * C-based event loops perform very well with small number of
1888watchers, as the management overhead dominates. 2166watchers, as the management overhead dominates.
1889 2167
1890=back 2168=back
1891 2169
2170=head2 THE IO::Lambda BENCHMARK
2171
2172Recently I was told about the benchmark in the IO::Lambda manpage, which
2173could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
2174simply compares IO::Lambda with POE, and IO::Lambda looks better (which
2175shouldn't come as a surprise to anybody). As such, the benchmark is
2176fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
2177very optimal. But how would AnyEvent compare when used without the extra
2178baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
2179
2180The benchmark itself creates an echo-server, and then, for 500 times,
2181connects to the echo server, sends a line, waits for the reply, and then
2182creates the next connection. This is a rather bad benchmark, as it doesn't
2183test the efficiency of the framework or much non-blocking I/O, but it is a
2184benchmark nevertheless.
2185
2186 name runtime
2187 Lambda/select 0.330 sec
2188 + optimized 0.122 sec
2189 Lambda/AnyEvent 0.327 sec
2190 + optimized 0.138 sec
2191 Raw sockets/select 0.077 sec
2192 POE/select, components 0.662 sec
2193 POE/select, raw sockets 0.226 sec
2194 POE/select, optimized 0.404 sec
2195
2196 AnyEvent/select/nb 0.085 sec
2197 AnyEvent/EV/nb 0.068 sec
2198 +state machine 0.134 sec
2199
2200The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
2201benchmarks actually make blocking connects and use 100% blocking I/O,
2202defeating the purpose of an event-based solution. All of the newly
2203written AnyEvent benchmarks use 100% non-blocking connects (using
2204AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
2205resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
2206generally require a lot more bookkeeping and event handling than blocking
2207connects (which involve a single syscall only).
2208
2209The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
2210offers similar expressive power as POE and IO::Lambda, using conventional
2211Perl syntax. This means that both the echo server and the client are 100%
2212non-blocking, further placing it at a disadvantage.
2213
2214As you can see, the AnyEvent + EV combination even beats the
2215hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2216backend easily beats IO::Lambda and POE.
2217
2218And even the 100% non-blocking version written using the high-level (and
2219slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
2220large margin, even though it does all of DNS, tcp-connect and socket I/O
2221in a non-blocking way.
2222
2223The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2224F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2225part of the IO::lambda distribution and were used without any changes.
2226
1892 2227
1893=head1 SIGNALS 2228=head1 SIGNALS
1894 2229
1895AnyEvent currently installs handlers for these signals: 2230AnyEvent currently installs handlers for these signals:
1896 2231
1899=item SIGCHLD 2234=item SIGCHLD
1900 2235
1901A handler for C<SIGCHLD> is installed by AnyEvent's child watcher 2236A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1902emulation for event loops that do not support them natively. Also, some 2237emulation for event loops that do not support them natively. Also, some
1903event loops install a similar handler. 2238event loops install a similar handler.
2239
2240Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2241AnyEvent will reset it to default, to avoid losing child exit statuses.
1904 2242
1905=item SIGPIPE 2243=item SIGPIPE
1906 2244
1907A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> 2245A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1908when AnyEvent gets loaded. 2246when AnyEvent gets loaded.
1920 2258
1921=back 2259=back
1922 2260
1923=cut 2261=cut
1924 2262
2263undef $SIG{CHLD}
2264 if $SIG{CHLD} eq 'IGNORE';
2265
1925$SIG{PIPE} = sub { } 2266$SIG{PIPE} = sub { }
1926 unless defined $SIG{PIPE}; 2267 unless defined $SIG{PIPE};
2268
2269=head1 RECOMMENDED/OPTIONAL MODULES
2270
2271One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2272it's built-in modules) are required to use it.
2273
2274That does not mean that AnyEvent won't take advantage of some additional
2275modules if they are installed.
2276
2277This section epxlains which additional modules will be used, and how they
2278affect AnyEvent's operetion.
2279
2280=over 4
2281
2282=item L<Async::Interrupt>
2283
2284This slightly arcane module is used to implement fast signal handling: To
2285my knowledge, there is no way to do completely race-free and quick
2286signal handling in pure perl. To ensure that signals still get
2287delivered, AnyEvent will start an interval timer to wake up perl (and
2288catch the signals) with some delay (default is 10 seconds, look for
2289C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2290
2291If this module is available, then it will be used to implement signal
2292catching, which means that signals will not be delayed, and the event loop
2293will not be interrupted regularly, which is more efficient (And good for
2294battery life on laptops).
2295
2296This affects not just the pure-perl event loop, but also other event loops
2297that have no signal handling on their own (e.g. Glib, Tk, Qt).
2298
2299Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
2300and either employ their own workarounds (POE) or use AnyEvent's workaround
2301(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
2302does nothing for those backends.
2303
2304=item L<EV>
2305
2306This module isn't really "optional", as it is simply one of the backend
2307event loops that AnyEvent can use. However, it is simply the best event
2308loop available in terms of features, speed and stability: It supports
2309the AnyEvent API optimally, implements all the watcher types in XS, does
2310automatic timer adjustments even when no monotonic clock is available,
2311can take avdantage of advanced kernel interfaces such as C<epoll> and
2312C<kqueue>, and is the fastest backend I<by far>. You can even embed
2313L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2314
2315=item L<Guard>
2316
2317The guard module, when used, will be used to implement
2318C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2319lot less memory), but otherwise doesn't affect guard operation much. It is
2320purely used for performance.
2321
2322=item L<JSON> and L<JSON::XS>
2323
2324This module is required when you want to read or write JSON data via
2325L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2326advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2327
2328In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2329installed.
2330
2331=item L<Net::SSLeay>
2332
2333Implementing TLS/SSL in Perl is certainly interesting, but not very
2334worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2335the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2336
2337=item L<Time::HiRes>
2338
2339This module is part of perl since release 5.008. It will be used when the
2340chosen event library does not come with a timing source on it's own. The
2341pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2342try to use a monotonic clock for timing stability.
2343
2344=back
1927 2345
1928 2346
1929=head1 FORK 2347=head1 FORK
1930 2348
1931Most event libraries are not fork-safe. The ones who are usually are 2349Most event libraries are not fork-safe. The ones who are usually are
1932because they rely on inefficient but fork-safe C<select> or C<poll> 2350because they rely on inefficient but fork-safe C<select> or C<poll>
1933calls. Only L<EV> is fully fork-aware. 2351calls. Only L<EV> is fully fork-aware.
1934 2352
1935If you have to fork, you must either do so I<before> creating your first 2353If you have to fork, you must either do so I<before> creating your first
1936watcher OR you must not use AnyEvent at all in the child. 2354watcher OR you must not use AnyEvent at all in the child OR you must do
2355something completely out of the scope of AnyEvent.
1937 2356
1938 2357
1939=head1 SECURITY CONSIDERATIONS 2358=head1 SECURITY CONSIDERATIONS
1940 2359
1941AnyEvent can be forced to load any event model via 2360AnyEvent can be forced to load any event model via
1955Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2374Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1956be used to probe what backend is used and gain other information (which is 2375be used to probe what backend is used and gain other information (which is
1957probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and 2376probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1958$ENV{PERL_ANYEVENT_STRICT}. 2377$ENV{PERL_ANYEVENT_STRICT}.
1959 2378
2379Note that AnyEvent will remove I<all> environment variables starting with
2380C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2381enabled.
2382
1960 2383
1961=head1 BUGS 2384=head1 BUGS
1962 2385
1963Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 2386Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1964to work around. If you suffer from memleaks, first upgrade to Perl 5.10 2387to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1975L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2398L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1976 2399
1977Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2400Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1978L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2401L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1979L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2402L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1980L<AnyEvent::Impl::POE>. 2403L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.
1981 2404
1982Non-blocking file handles, sockets, TCP clients and 2405Non-blocking file handles, sockets, TCP clients and
1983servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. 2406servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1984 2407
1985Asynchronous DNS: L<AnyEvent::DNS>. 2408Asynchronous DNS: L<AnyEvent::DNS>.
1986 2409
1987Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 2410Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
2411L<Coro::Event>,
1988 2412
1989Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 2413Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
2414L<AnyEvent::HTTP>.
1990 2415
1991 2416
1992=head1 AUTHOR 2417=head1 AUTHOR
1993 2418
1994 Marc Lehmann <schmorp@schmorp.de> 2419 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines