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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines