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.219 by root, Thu Jun 25 11:16:08 2009 UTC vs.
Revision 1.264 by root, Wed Jul 29 12:42:09 2009 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - the DBI of event loop programming
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported 5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6event loops. 6and POE are various supported event loops/environments.
7 7
8=head1 SYNOPSIS 8=head1 SYNOPSIS
9 9
10 use AnyEvent; 10 use AnyEvent;
11 11
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
52Repository>, 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 });
374 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.
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
379The child process is specified by the C<pid> argument (if set to C<0>, it 405The child process is specified by the C<pid> argument (one some backends,
380watches for any child process exit). The watcher will triggered only when 406using C<0> watches for any child process exit, on others this will
381the child process has finished and an exit status is available, not on 407croak). The watcher will be triggered only when the child process has
382any trace events (stopped/continued). 408finished and an exit status is available, not on any trace events
409(stopped/continued).
383 410
384The callback will be called with the pid and exit status (as returned by 411The callback will be called with the pid and exit status (as returned by
385waitpid), so unlike other watcher types, you I<can> rely on child watcher 412waitpid), so unlike other watcher types, you I<can> rely on child watcher
386callback arguments. 413callback arguments.
387 414
403 430
404This means you cannot create a child watcher as the very first 431This means you cannot create a child watcher as the very first
405thing in an AnyEvent program, you I<have> to create at least one 432thing in an AnyEvent program, you I<have> to create at least one
406watcher before you C<fork> the child (alternatively, you can call 433watcher before you C<fork> the child (alternatively, you can call
407C<AnyEvent::detect>). 434C<AnyEvent::detect>).
435
436As most event loops do not support waiting for child events, they will be
437emulated by AnyEvent in most cases, in which the latency and race problems
438mentioned in the description of signal watchers apply.
408 439
409Example: fork a process and wait for it 440Example: fork a process and wait for it
410 441
411 my $done = AnyEvent->condvar; 442 my $done = AnyEvent->condvar;
412 443
463 494
464If you are familiar with some event loops you will know that all of them 495If you are familiar with some event loops you will know that all of them
465require you to run some blocking "loop", "run" or similar function that 496require you to run some blocking "loop", "run" or similar function that
466will actively watch for new events and call your callbacks. 497will actively watch for new events and call your callbacks.
467 498
468AnyEvent is different, it expects somebody else to run the event loop and 499AnyEvent is slightly different: it expects somebody else to run the event
469will only block when necessary (usually when told by the user). 500loop and will only block when necessary (usually when told by the user).
470 501
471The instrument to do that is called a "condition variable", so called 502The instrument to do that is called a "condition variable", so called
472because they represent a condition that must become true. 503because they represent a condition that must become true.
473 504
505Now is probably a good time to look at the examples further below.
506
474Condition variables can be created by calling the C<< AnyEvent->condvar 507Condition variables can be created by calling the C<< AnyEvent->condvar
475>> method, usually without arguments. The only argument pair allowed is 508>> method, usually without arguments. The only argument pair allowed is
476
477C<cb>, which specifies a callback to be called when the condition variable 509C<cb>, which specifies a callback to be called when the condition variable
478becomes true, with the condition variable as the first argument (but not 510becomes true, with the condition variable as the first argument (but not
479the results). 511the results).
480 512
481After creation, the condition variable is "false" until it becomes "true" 513After creation, the condition variable is "false" until it becomes "true"
486Condition variables are similar to callbacks, except that you can 518Condition variables are similar to callbacks, except that you can
487optionally wait for them. They can also be called merge points - points 519optionally wait for them. They can also be called merge points - points
488in time where multiple outstanding events have been processed. And yet 520in time where multiple outstanding events have been processed. And yet
489another way to call them is transactions - each condition variable can be 521another way to call them is transactions - each condition variable can be
490used to represent a transaction, which finishes at some point and delivers 522used to represent a transaction, which finishes at some point and delivers
491a result. 523a result. And yet some people know them as "futures" - a promise to
524compute/deliver something that you can wait for.
492 525
493Condition variables are very useful to signal that something has finished, 526Condition variables are very useful to signal that something has finished,
494for example, if you write a module that does asynchronous http requests, 527for example, if you write a module that does asynchronous http requests,
495then a condition variable would be the ideal candidate to signal the 528then a condition variable would be the ideal candidate to signal the
496availability of results. The user can either act when the callback is 529availability of results. The user can either act when the callback is
530 after => 1, 563 after => 1,
531 cb => sub { $result_ready->send }, 564 cb => sub { $result_ready->send },
532 ); 565 );
533 566
534 # this "blocks" (while handling events) till the callback 567 # this "blocks" (while handling events) till the callback
535 # calls send 568 # calls -<send
536 $result_ready->recv; 569 $result_ready->recv;
537 570
538Example: wait for a timer, but take advantage of the fact that 571Example: wait for a timer, but take advantage of the fact that condition
539condition variables are also code references. 572variables are also callable directly.
540 573
541 my $done = AnyEvent->condvar; 574 my $done = AnyEvent->condvar;
542 my $delay = AnyEvent->timer (after => 5, cb => $done); 575 my $delay = AnyEvent->timer (after => 5, cb => $done);
543 $done->recv; 576 $done->recv;
544 577
550 583
551 ... 584 ...
552 585
553 my @info = $couchdb->info->recv; 586 my @info = $couchdb->info->recv;
554 587
555And this is how you would just ste a callback to be called whenever the 588And this is how you would just set a callback to be called whenever the
556results are available: 589results are available:
557 590
558 $couchdb->info->cb (sub { 591 $couchdb->info->cb (sub {
559 my @info = $_[0]->recv; 592 my @info = $_[0]->recv;
560 }); 593 });
578immediately from within send. 611immediately from within send.
579 612
580Any arguments passed to the C<send> call will be returned by all 613Any arguments passed to the C<send> call will be returned by all
581future C<< ->recv >> calls. 614future C<< ->recv >> calls.
582 615
583Condition variables are overloaded so one can call them directly 616Condition variables are overloaded so one can call them directly (as if
584(as a code reference). Calling them directly is the same as calling 617they were a code reference). Calling them directly is the same as calling
585C<send>. Note, however, that many C-based event loops do not handle 618C<send>.
586overloading, so as tempting as it may be, passing a condition variable
587instead of a callback does not work. Both the pure perl and EV loops
588support overloading, however, as well as all functions that use perl to
589invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
590example).
591 619
592=item $cv->croak ($error) 620=item $cv->croak ($error)
593 621
594Similar to send, but causes all call's to C<< ->recv >> to invoke 622Similar to send, but causes all call's to C<< ->recv >> to invoke
595C<Carp::croak> with the given error message/object/scalar. 623C<Carp::croak> with the given error message/object/scalar.
596 624
597This can be used to signal any errors to the condition variable 625This can be used to signal any errors to the condition variable
598user/consumer. 626user/consumer. Doing it this way instead of calling C<croak> directly
627delays the error detetcion, but has the overwhelmign advantage that it
628diagnoses the error at the place where the result is expected, and not
629deep in some event clalback without connection to the actual code causing
630the problem.
599 631
600=item $cv->begin ([group callback]) 632=item $cv->begin ([group callback])
601 633
602=item $cv->end 634=item $cv->end
603
604These two methods are EXPERIMENTAL and MIGHT CHANGE.
605 635
606These two methods can be used to combine many transactions/events into 636These two methods can be used to combine many transactions/events into
607one. For example, a function that pings many hosts in parallel might want 637one. For example, a function that pings many hosts in parallel might want
608to use a condition variable for the whole process. 638to use a condition variable for the whole process.
609 639
611C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 641C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
612>>, the (last) callback passed to C<begin> will be executed. That callback 642>>, the (last) callback passed to C<begin> will be executed. That callback
613is I<supposed> to call C<< ->send >>, but that is not required. If no 643is I<supposed> to call C<< ->send >>, but that is not required. If no
614callback was set, C<send> will be called without any arguments. 644callback was set, C<send> will be called without any arguments.
615 645
616Let's clarify this with the ping example: 646You can think of C<< $cv->send >> giving you an OR condition (one call
647sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
648condition (all C<begin> calls must be C<end>'ed before the condvar sends).
649
650Let's start with a simple example: you have two I/O watchers (for example,
651STDOUT and STDERR for a program), and you want to wait for both streams to
652close before activating a condvar:
653
654 my $cv = AnyEvent->condvar;
655
656 $cv->begin; # first watcher
657 my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
658 defined sysread $fh1, my $buf, 4096
659 or $cv->end;
660 });
661
662 $cv->begin; # second watcher
663 my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
664 defined sysread $fh2, my $buf, 4096
665 or $cv->end;
666 });
667
668 $cv->recv;
669
670This works because for every event source (EOF on file handle), there is
671one call to C<begin>, so the condvar waits for all calls to C<end> before
672sending.
673
674The ping example mentioned above is slightly more complicated, as the
675there are results to be passwd back, and the number of tasks that are
676begung can potentially be zero:
617 677
618 my $cv = AnyEvent->condvar; 678 my $cv = AnyEvent->condvar;
619 679
620 my %result; 680 my %result;
621 $cv->begin (sub { $cv->send (\%result) }); 681 $cv->begin (sub { $cv->send (\%result) });
641loop, which serves two important purposes: first, it sets the callback 701loop, which serves two important purposes: first, it sets the callback
642to be called once the counter reaches C<0>, and second, it ensures that 702to be called once the counter reaches C<0>, and second, it ensures that
643C<send> is called even when C<no> hosts are being pinged (the loop 703C<send> is called even when C<no> hosts are being pinged (the loop
644doesn't execute once). 704doesn't execute once).
645 705
646This is the general pattern when you "fan out" into multiple subrequests: 706This is the general pattern when you "fan out" into multiple (but
647use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 707potentially none) subrequests: use an outer C<begin>/C<end> pair to set
648is called at least once, and then, for each subrequest you start, call 708the callback and ensure C<end> is called at least once, and then, for each
649C<begin> and for each subrequest you finish, call C<end>. 709subrequest you start, call C<begin> and for each subrequest you finish,
710call C<end>.
650 711
651=back 712=back
652 713
653=head3 METHODS FOR CONSUMERS 714=head3 METHODS FOR CONSUMERS
654 715
670function will call C<croak>. 731function will call C<croak>.
671 732
672In list context, all parameters passed to C<send> will be returned, 733In list context, all parameters passed to C<send> will be returned,
673in scalar context only the first one will be returned. 734in scalar context only the first one will be returned.
674 735
736Note that doing a blocking wait in a callback is not supported by any
737event loop, that is, recursive invocation of a blocking C<< ->recv
738>> is not allowed, and the C<recv> call will C<croak> if such a
739condition is detected. This condition can be slightly loosened by using
740L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
741any thread that doesn't run the event loop itself.
742
675Not all event models support a blocking wait - some die in that case 743Not all event models support a blocking wait - some die in that case
676(programs might want to do that to stay interactive), so I<if you are 744(programs might want to do that to stay interactive), so I<if you are
677using this from a module, never require a blocking wait>, but let the 745using this from a module, never require a blocking wait>. Instead, let the
678caller decide whether the call will block or not (for example, by coupling 746caller decide whether the call will block or not (for example, by coupling
679condition variables with some kind of request results and supporting 747condition variables with some kind of request results and supporting
680callbacks so the caller knows that getting the result will not block, 748callbacks so the caller knows that getting the result will not block,
681while still supporting blocking waits if the caller so desires). 749while still supporting blocking waits if the caller so desires).
682 750
683Another reason I<never> to C<< ->recv >> in a module is that you cannot
684sensibly have two C<< ->recv >>'s in parallel, as that would require
685multiple interpreters or coroutines/threads, none of which C<AnyEvent>
686can supply.
687
688The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
689fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
690versions and also integrates coroutines into AnyEvent, making blocking
691C<< ->recv >> calls perfectly safe as long as they are done from another
692coroutine (one that doesn't run the event loop).
693
694You can ensure that C<< -recv >> never blocks by setting a callback and 751You can ensure that C<< -recv >> never blocks by setting a callback and
695only calling C<< ->recv >> from within that callback (or at a later 752only calling C<< ->recv >> from within that callback (or at a later
696time). This will work even when the event loop does not support blocking 753time). This will work even when the event loop does not support blocking
697waits otherwise. 754waits otherwise.
698 755
711variable itself. Calling C<recv> inside the callback or at any later time 768variable itself. Calling C<recv> inside the callback or at any later time
712is guaranteed not to block. 769is guaranteed not to block.
713 770
714=back 771=back
715 772
773=head1 SUPPORTED EVENT LOOPS/BACKENDS
774
775The available backend classes are (every class has its own manpage):
776
777=over 4
778
779=item Backends that are autoprobed when no other event loop can be found.
780
781EV is the preferred backend when no other event loop seems to be in
782use. If EV is not installed, then AnyEvent will try Event, and, failing
783that, will fall back to its own pure-perl implementation, which is
784available everywhere as it comes with AnyEvent itself.
785
786 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
787 AnyEvent::Impl::Event based on Event, very stable, few glitches.
788 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
789
790=item Backends that are transparently being picked up when they are used.
791
792These will be used when they are currently loaded when the first watcher
793is created, in which case it is assumed that the application is using
794them. This means that AnyEvent will automatically pick the right backend
795when the main program loads an event module before anything starts to
796create watchers. Nothing special needs to be done by the main program.
797
798 AnyEvent::Impl::Glib based on Glib, slow but very stable.
799 AnyEvent::Impl::Tk based on Tk, very broken.
800 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
801 AnyEvent::Impl::POE based on POE, very slow, some limitations.
802 AnyEvent::Impl::Irssi used when running within irssi.
803
804=item Backends with special needs.
805
806Qt requires the Qt::Application to be instantiated first, but will
807otherwise be picked up automatically. As long as the main program
808instantiates the application before any AnyEvent watchers are created,
809everything should just work.
810
811 AnyEvent::Impl::Qt based on Qt.
812
813Support for IO::Async can only be partial, as it is too broken and
814architecturally limited to even support the AnyEvent API. It also
815is the only event loop that needs the loop to be set explicitly, so
816it can only be used by a main program knowing about AnyEvent. See
817L<AnyEvent::Impl::Async> for the gory details.
818
819 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
820
821=item Event loops that are indirectly supported via other backends.
822
823Some event loops can be supported via other modules:
824
825There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
826
827B<WxWidgets> has no support for watching file handles. However, you can
828use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
829polls 20 times per second, which was considered to be too horrible to even
830consider for AnyEvent.
831
832B<Prima> is not supported as nobody seems to be using it, but it has a POE
833backend, so it can be supported through POE.
834
835AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
836load L<POE> when detecting them, in the hope that POE will pick them up,
837in which case everything will be automatic.
838
839=back
840
716=head1 GLOBAL VARIABLES AND FUNCTIONS 841=head1 GLOBAL VARIABLES AND FUNCTIONS
717 842
843These are not normally required to use AnyEvent, but can be useful to
844write AnyEvent extension modules.
845
718=over 4 846=over 4
719 847
720=item $AnyEvent::MODEL 848=item $AnyEvent::MODEL
721 849
722Contains C<undef> until the first watcher is being created. Then it 850Contains C<undef> until the first watcher is being created, before the
851backend has been autodetected.
852
723contains the event model that is being used, which is the name of the 853Afterwards it contains the event model that is being used, which is the
724Perl class implementing the model. This class is usually one of the 854name of the Perl class implementing the model. This class is usually one
725C<AnyEvent::Impl:xxx> modules, but can be any other class in the case 855of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
726AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). 856case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
727 857will be C<urxvt::anyevent>).
728The known classes so far are:
729
730 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
731 AnyEvent::Impl::Event based on Event, second best choice.
732 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
733 AnyEvent::Impl::Glib based on Glib, third-best choice.
734 AnyEvent::Impl::Tk based on Tk, very bad choice.
735 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
736 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
737 AnyEvent::Impl::POE based on POE, not generic enough for full support.
738
739 # warning, support for IO::Async is only partial, as it is too broken
740 # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
741 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
742
743There is no support for WxWidgets, as WxWidgets has no support for
744watching file handles. However, you can use WxWidgets through the
745POE Adaptor, as POE has a Wx backend that simply polls 20 times per
746second, which was considered to be too horrible to even consider for
747AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
748it's adaptor.
749
750AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
751autodetecting them.
752 858
753=item AnyEvent::detect 859=item AnyEvent::detect
754 860
755Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 861Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
756if necessary. You should only call this function right before you would 862if necessary. You should only call this function right before you would
757have created an AnyEvent watcher anyway, that is, as late as possible at 863have created an AnyEvent watcher anyway, that is, as late as possible at
758runtime. 864runtime, and not e.g. while initialising of your module.
865
866If you need to do some initialisation before AnyEvent watchers are
867created, use C<post_detect>.
759 868
760=item $guard = AnyEvent::post_detect { BLOCK } 869=item $guard = AnyEvent::post_detect { BLOCK }
761 870
762Arranges for the code block to be executed as soon as the event model is 871Arranges for the code block to be executed as soon as the event model is
763autodetected (or immediately if this has already happened). 872autodetected (or immediately if this has already happened).
764 873
874The block will be executed I<after> the actual backend has been detected
875(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
876created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
877other initialisations - see the sources of L<AnyEvent::Strict> or
878L<AnyEvent::AIO> to see how this is used.
879
880The most common usage is to create some global watchers, without forcing
881event module detection too early, for example, L<AnyEvent::AIO> creates
882and installs the global L<IO::AIO> watcher in a C<post_detect> block to
883avoid autodetecting the event module at load time.
884
765If called in scalar or list context, then it creates and returns an object 885If called in scalar or list context, then it creates and returns an object
766that automatically removes the callback again when it is destroyed. See 886that automatically removes the callback again when it is destroyed (or
887C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
767L<Coro::BDB> for a case where this is useful. 888a case where this is useful.
889
890Example: Create a watcher for the IO::AIO module and store it in
891C<$WATCHER>. Only do so after the event loop is initialised, though.
892
893 our WATCHER;
894
895 my $guard = AnyEvent::post_detect {
896 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
897 };
898
899 # the ||= is important in case post_detect immediately runs the block,
900 # as to not clobber the newly-created watcher. assigning both watcher and
901 # post_detect guard to the same variable has the advantage of users being
902 # able to just C<undef $WATCHER> if the watcher causes them grief.
903
904 $WATCHER ||= $guard;
768 905
769=item @AnyEvent::post_detect 906=item @AnyEvent::post_detect
770 907
771If there are any code references in this array (you can C<push> to it 908If there are any code references in this array (you can C<push> to it
772before or after loading AnyEvent), then they will called directly after 909before or after loading AnyEvent), then they will called directly after
773the event loop has been chosen. 910the event loop has been chosen.
774 911
775You should check C<$AnyEvent::MODEL> before adding to this array, though: 912You should check C<$AnyEvent::MODEL> before adding to this array, though:
776if it contains a true value then the event loop has already been detected, 913if it is defined then the event loop has already been detected, and the
777and the array will be ignored. 914array will be ignored.
778 915
779Best use C<AnyEvent::post_detect { BLOCK }> instead. 916Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
917it,as it takes care of these details.
918
919This variable is mainly useful for modules that can do something useful
920when AnyEvent is used and thus want to know when it is initialised, but do
921not need to even load it by default. This array provides the means to hook
922into AnyEvent passively, without loading it.
780 923
781=back 924=back
782 925
783=head1 WHAT TO DO IN A MODULE 926=head1 WHAT TO DO IN A MODULE
784 927
839 982
840 983
841=head1 OTHER MODULES 984=head1 OTHER MODULES
842 985
843The following is a non-exhaustive list of additional modules that use 986The following is a non-exhaustive list of additional modules that use
844AnyEvent and can therefore be mixed easily with other AnyEvent modules 987AnyEvent as a client and can therefore be mixed easily with other AnyEvent
845in the same program. Some of the modules come with AnyEvent, some are 988modules and other event loops in the same program. Some of the modules
846available via CPAN. 989come with AnyEvent, most are available via CPAN.
847 990
848=over 4 991=over 4
849 992
850=item L<AnyEvent::Util> 993=item L<AnyEvent::Util>
851 994
860 1003
861=item L<AnyEvent::Handle> 1004=item L<AnyEvent::Handle>
862 1005
863Provide read and write buffers, manages watchers for reads and writes, 1006Provide read and write buffers, manages watchers for reads and writes,
864supports raw and formatted I/O, I/O queued and fully transparent and 1007supports raw and formatted I/O, I/O queued and fully transparent and
865non-blocking SSL/TLS. 1008non-blocking SSL/TLS (via L<AnyEvent::TLS>.
866 1009
867=item L<AnyEvent::DNS> 1010=item L<AnyEvent::DNS>
868 1011
869Provides rich asynchronous DNS resolver capabilities. 1012Provides rich asynchronous DNS resolver capabilities.
870 1013
898 1041
899=item L<AnyEvent::GPSD> 1042=item L<AnyEvent::GPSD>
900 1043
901A non-blocking interface to gpsd, a daemon delivering GPS information. 1044A non-blocking interface to gpsd, a daemon delivering GPS information.
902 1045
1046=item L<AnyEvent::IRC>
1047
1048AnyEvent based IRC client module family (replacing the older Net::IRC3).
1049
1050=item L<AnyEvent::XMPP>
1051
1052AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1053Net::XMPP2>.
1054
903=item L<AnyEvent::IGS> 1055=item L<AnyEvent::IGS>
904 1056
905A non-blocking interface to the Internet Go Server protocol (used by 1057A non-blocking interface to the Internet Go Server protocol (used by
906L<App::IGS>). 1058L<App::IGS>).
907 1059
908=item L<AnyEvent::IRC>
909
910AnyEvent based IRC client module family (replacing the older Net::IRC3).
911
912=item L<Net::XMPP2>
913
914AnyEvent based XMPP (Jabber protocol) module family.
915
916=item L<Net::FCP> 1060=item L<Net::FCP>
917 1061
918AnyEvent-based implementation of the Freenet Client Protocol, birthplace 1062AnyEvent-based implementation of the Freenet Client Protocol, birthplace
919of AnyEvent. 1063of AnyEvent.
920 1064
924 1068
925=item L<Coro> 1069=item L<Coro>
926 1070
927Has special support for AnyEvent via L<Coro::AnyEvent>. 1071Has special support for AnyEvent via L<Coro::AnyEvent>.
928 1072
929=item L<IO::Lambda>
930
931The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
932
933=back 1073=back
934 1074
935=cut 1075=cut
936 1076
937package AnyEvent; 1077package AnyEvent;
938 1078
1079# basically a tuned-down version of common::sense
1080sub common_sense {
939no warnings; 1081 # no warnings
1082 ${^WARNING_BITS} ^= ${^WARNING_BITS};
940use strict qw(vars subs); 1083 # use strict vars subs
1084 $^H |= 0x00000600;
1085}
941 1086
1087BEGIN { AnyEvent::common_sense }
1088
942use Carp; 1089use Carp ();
943 1090
944our $VERSION = 4.412; 1091our $VERSION = 4.881;
945our $MODEL; 1092our $MODEL;
946 1093
947our $AUTOLOAD; 1094our $AUTOLOAD;
948our @ISA; 1095our @ISA;
949 1096
950our @REGISTRY; 1097our @REGISTRY;
951 1098
952our $WIN32; 1099our $WIN32;
1100
1101our $VERBOSE;
953 1102
954BEGIN { 1103BEGIN {
955 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1104 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
956 eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; 1105 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
957 1106
958 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1107 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
959 if ${^TAINT}; 1108 if ${^TAINT};
960}
961 1109
962our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1110 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1111
1112}
1113
1114our $MAX_SIGNAL_LATENCY = 10;
963 1115
964our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1116our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
965 1117
966{ 1118{
967 my $idx; 1119 my $idx;
969 for reverse split /\s*,\s*/, 1121 for reverse split /\s*,\s*/,
970 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1122 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
971} 1123}
972 1124
973my @models = ( 1125my @models = (
974 [EV:: => AnyEvent::Impl::EV::], 1126 [EV:: => AnyEvent::Impl::EV:: , 1],
975 [Event:: => AnyEvent::Impl::Event::], 1127 [Event:: => AnyEvent::Impl::Event::, 1],
976 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1128 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
977 # everything below here will not be autoprobed 1129 # everything below here will not (normally) be autoprobed
978 # as the pureperl backend should work everywhere 1130 # as the pureperl backend should work everywhere
979 # and is usually faster 1131 # and is usually faster
1132 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1133 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1134 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
980 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1135 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
981 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
982 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
983 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1136 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
984 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1137 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
985 [Wx:: => AnyEvent::Impl::POE::], 1138 [Wx:: => AnyEvent::Impl::POE::],
986 [Prima:: => AnyEvent::Impl::POE::], 1139 [Prima:: => AnyEvent::Impl::POE::],
987 # IO::Async is just too broken - we would need workaorunds for its 1140 # IO::Async is just too broken - we would need workarounds for its
988 # byzantine signal and broken child handling, among others. 1141 # byzantine signal and broken child handling, among others.
989 # IO::Async is rather hard to detect, as it doesn't have any 1142 # IO::Async is rather hard to detect, as it doesn't have any
990 # obvious default class. 1143 # obvious default class.
991# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1144# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
992# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1145# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
993# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1146# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
994); 1147);
995 1148
996our %method = map +($_ => 1), 1149our %method = map +($_ => 1),
997 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1150 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
998 1151
1002 my ($cb) = @_; 1155 my ($cb) = @_;
1003 1156
1004 if ($MODEL) { 1157 if ($MODEL) {
1005 $cb->(); 1158 $cb->();
1006 1159
1007 1 1160 undef
1008 } else { 1161 } else {
1009 push @post_detect, $cb; 1162 push @post_detect, $cb;
1010 1163
1011 defined wantarray 1164 defined wantarray
1012 ? bless \$cb, "AnyEvent::Util::postdetect" 1165 ? bless \$cb, "AnyEvent::Util::postdetect"
1018 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1171 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1019} 1172}
1020 1173
1021sub detect() { 1174sub detect() {
1022 unless ($MODEL) { 1175 unless ($MODEL) {
1023 no strict 'refs';
1024 local $SIG{__DIE__}; 1176 local $SIG{__DIE__};
1025 1177
1026 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1178 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1027 my $model = "AnyEvent::Impl::$1"; 1179 my $model = "AnyEvent::Impl::$1";
1028 if (eval "require $model") { 1180 if (eval "require $model") {
1029 $MODEL = $model; 1181 $MODEL = $model;
1030 warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; 1182 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1031 } else { 1183 } else {
1032 warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; 1184 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1033 } 1185 }
1034 } 1186 }
1035 1187
1036 # check for already loaded models 1188 # check for already loaded models
1037 unless ($MODEL) { 1189 unless ($MODEL) {
1038 for (@REGISTRY, @models) { 1190 for (@REGISTRY, @models) {
1039 my ($package, $model) = @$_; 1191 my ($package, $model) = @$_;
1040 if (${"$package\::VERSION"} > 0) { 1192 if (${"$package\::VERSION"} > 0) {
1041 if (eval "require $model") { 1193 if (eval "require $model") {
1042 $MODEL = $model; 1194 $MODEL = $model;
1043 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; 1195 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1044 last; 1196 last;
1045 } 1197 }
1046 } 1198 }
1047 } 1199 }
1048 1200
1049 unless ($MODEL) { 1201 unless ($MODEL) {
1050 # try to load a model 1202 # try to autoload a model
1051
1052 for (@REGISTRY, @models) { 1203 for (@REGISTRY, @models) {
1053 my ($package, $model) = @$_; 1204 my ($package, $model, $autoload) = @$_;
1205 if (
1206 $autoload
1054 if (eval "require $package" 1207 and eval "require $package"
1055 and ${"$package\::VERSION"} > 0 1208 and ${"$package\::VERSION"} > 0
1056 and eval "require $model") { 1209 and eval "require $model"
1210 ) {
1057 $MODEL = $model; 1211 $MODEL = $model;
1058 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; 1212 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1059 last; 1213 last;
1060 } 1214 }
1061 } 1215 }
1062 1216
1063 $MODEL 1217 $MODEL
1079 1233
1080sub AUTOLOAD { 1234sub AUTOLOAD {
1081 (my $func = $AUTOLOAD) =~ s/.*://; 1235 (my $func = $AUTOLOAD) =~ s/.*://;
1082 1236
1083 $method{$func} 1237 $method{$func}
1084 or croak "$func: not a valid method for AnyEvent objects"; 1238 or Carp::croak "$func: not a valid method for AnyEvent objects";
1085 1239
1086 detect unless $MODEL; 1240 detect unless $MODEL;
1087 1241
1088 my $class = shift; 1242 my $class = shift;
1089 $class->$func (@_); 1243 $class->$func (@_);
1094# allow only one watcher per fd, so we dup it to get a different one). 1248# allow only one watcher per fd, so we dup it to get a different one).
1095sub _dupfh($$;$$) { 1249sub _dupfh($$;$$) {
1096 my ($poll, $fh, $r, $w) = @_; 1250 my ($poll, $fh, $r, $w) = @_;
1097 1251
1098 # cygwin requires the fh mode to be matching, unix doesn't 1252 # cygwin requires the fh mode to be matching, unix doesn't
1099 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1253 my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1100 : $poll eq "w" ? ($w, ">")
1101 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1102 1254
1103 open my $fh2, "$mode&" . fileno $fh 1255 open my $fh2, $mode, $fh
1104 or die "cannot dup() filehandle: $!,"; 1256 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1105 1257
1106 # we assume CLOEXEC is already set by perl in all important cases 1258 # we assume CLOEXEC is already set by perl in all important cases
1107 1259
1108 ($fh2, $rw) 1260 ($fh2, $rw)
1109} 1261}
1110 1262
1111package AnyEvent::Base; 1263package AnyEvent::Base;
1112 1264
1113# default implementations for many methods 1265# default implementations for many methods
1114 1266
1115BEGIN { 1267sub _time {
1268 # probe for availability of Time::HiRes
1116 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1269 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1270 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1117 *_time = \&Time::HiRes::time; 1271 *_time = \&Time::HiRes::time;
1118 # if (eval "use POSIX (); (POSIX::times())... 1272 # if (eval "use POSIX (); (POSIX::times())...
1119 } else { 1273 } else {
1274 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1120 *_time = sub { time }; # epic fail 1275 *_time = sub { time }; # epic fail
1121 } 1276 }
1277
1278 &_time
1122} 1279}
1123 1280
1124sub time { _time } 1281sub time { _time }
1125sub now { _time } 1282sub now { _time }
1126sub now_update { } 1283sub now_update { }
1131 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1288 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1132} 1289}
1133 1290
1134# default implementation for ->signal 1291# default implementation for ->signal
1135 1292
1293our $HAVE_ASYNC_INTERRUPT;
1294
1295sub _have_async_interrupt() {
1296 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1297 && eval "use Async::Interrupt 1.0 (); 1")
1298 unless defined $HAVE_ASYNC_INTERRUPT;
1299
1300 $HAVE_ASYNC_INTERRUPT
1301}
1302
1136our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1303our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1304our (%SIG_ASY, %SIG_ASY_W);
1305our ($SIG_COUNT, $SIG_TW);
1137 1306
1138sub _signal_exec { 1307sub _signal_exec {
1308 $HAVE_ASYNC_INTERRUPT
1309 ? $SIGPIPE_R->drain
1139 sysread $SIGPIPE_R, my $dummy, 4; 1310 : sysread $SIGPIPE_R, my $dummy, 9;
1140 1311
1141 while (%SIG_EV) { 1312 while (%SIG_EV) {
1142 for (keys %SIG_EV) { 1313 for (keys %SIG_EV) {
1143 delete $SIG_EV{$_}; 1314 delete $SIG_EV{$_};
1144 $_->() for values %{ $SIG_CB{$_} || {} }; 1315 $_->() for values %{ $SIG_CB{$_} || {} };
1145 } 1316 }
1146 } 1317 }
1147} 1318}
1148 1319
1320# install a dummy wakeup watcher to reduce signal catching latency
1321sub _sig_add() {
1322 unless ($SIG_COUNT++) {
1323 # try to align timer on a full-second boundary, if possible
1324 my $NOW = AnyEvent->now;
1325
1326 $SIG_TW = AnyEvent->timer (
1327 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1328 interval => $MAX_SIGNAL_LATENCY,
1329 cb => sub { }, # just for the PERL_ASYNC_CHECK
1330 );
1331 }
1332}
1333
1334sub _sig_del {
1335 undef $SIG_TW
1336 unless --$SIG_COUNT;
1337}
1338
1339our $_sig_name_init; $_sig_name_init = sub {
1340 undef $_sig_name_init;
1341
1342 if (_have_async_interrupt) {
1343 *sig2num = \&Async::Interrupt::sig2num;
1344 *sig2name = \&Async::Interrupt::sig2name;
1345 } else {
1346 require Config;
1347
1348 my %signame2num;
1349 @signame2num{ split ' ', $Config::Config{sig_name} }
1350 = split ' ', $Config::Config{sig_num};
1351
1352 my @signum2name;
1353 @signum2name[values %signame2num] = keys %signame2num;
1354
1355 *sig2num = sub($) {
1356 $_[0] > 0 ? shift : $signame2num{+shift}
1357 };
1358 *sig2name = sub ($) {
1359 $_[0] > 0 ? $signum2name[+shift] : shift
1360 };
1361 }
1362};
1363
1364sub sig2num ($) { &$_sig_name_init; &sig2num }
1365sub sig2name($) { &$_sig_name_init; &sig2name }
1366
1367sub _signal {
1368 my (undef, %arg) = @_;
1369
1370 my $signal = uc $arg{signal}
1371 or Carp::croak "required option 'signal' is missing";
1372
1373 if ($HAVE_ASYNC_INTERRUPT) {
1374 # async::interrupt
1375
1376 $signal = sig2num $signal;
1377 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1378
1379 $SIG_ASY{$signal} ||= new Async::Interrupt
1380 cb => sub { undef $SIG_EV{$signal} },
1381 signal => $signal,
1382 pipe => [$SIGPIPE_R->filenos],
1383 pipe_autodrain => 0,
1384 ;
1385
1386 } else {
1387 # pure perl
1388
1389 # AE::Util has been loaded in signal
1390 $signal = sig2name $signal;
1391 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1392
1393 $SIG{$signal} ||= sub {
1394 local $!;
1395 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1396 undef $SIG_EV{$signal};
1397 };
1398
1399 # can't do signal processing without introducing races in pure perl,
1400 # so limit the signal latency.
1401 _sig_add;
1402 }
1403
1404 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1405}
1406
1149sub signal { 1407sub signal {
1150 my (undef, %arg) = @_; 1408 # probe for availability of Async::Interrupt
1409 if (_have_async_interrupt) {
1410 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1151 1411
1152 unless ($SIGPIPE_R) { 1412 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1413 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1414
1415 } else {
1416 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1417
1153 require Fcntl; 1418 require Fcntl;
1154 1419
1155 if (AnyEvent::WIN32) { 1420 if (AnyEvent::WIN32) {
1156 require AnyEvent::Util; 1421 require AnyEvent::Util;
1157 1422
1172 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1437 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1173 1438
1174 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1439 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1175 } 1440 }
1176 1441
1177 my $signal = uc $arg{signal} 1442 *signal = \&_signal;
1178 or Carp::croak "required option 'signal' is missing"; 1443 &signal
1179
1180 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1181 $SIG{$signal} ||= sub {
1182 local $!;
1183 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1184 undef $SIG_EV{$signal};
1185 };
1186
1187 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1188} 1444}
1189 1445
1190sub AnyEvent::Base::signal::DESTROY { 1446sub AnyEvent::Base::signal::DESTROY {
1191 my ($signal, $cb) = @{$_[0]}; 1447 my ($signal, $cb) = @{$_[0]};
1192 1448
1449 _sig_del;
1450
1193 delete $SIG_CB{$signal}{$cb}; 1451 delete $SIG_CB{$signal}{$cb};
1194 1452
1453 $HAVE_ASYNC_INTERRUPT
1454 ? delete $SIG_ASY{$signal}
1195 # delete doesn't work with older perls - they then 1455 : # delete doesn't work with older perls - they then
1196 # print weird messages, or just unconditionally exit 1456 # print weird messages, or just unconditionally exit
1197 # instead of getting the default action. 1457 # instead of getting the default action.
1458 undef $SIG{$signal}
1198 undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; 1459 unless keys %{ $SIG_CB{$signal} };
1199} 1460}
1200 1461
1201# default implementation for ->child 1462# default implementation for ->child
1202 1463
1203our %PID_CB; 1464our %PID_CB;
1204our $CHLD_W; 1465our $CHLD_W;
1205our $CHLD_DELAY_W; 1466our $CHLD_DELAY_W;
1206our $WNOHANG; 1467our $WNOHANG;
1207 1468
1469sub _emit_childstatus($$) {
1470 my (undef, $rpid, $rstatus) = @_;
1471
1472 $_->($rpid, $rstatus)
1473 for values %{ $PID_CB{$rpid} || {} },
1474 values %{ $PID_CB{0} || {} };
1475}
1476
1208sub _sigchld { 1477sub _sigchld {
1478 my $pid;
1479
1480 AnyEvent->_emit_childstatus ($pid, $?)
1209 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1481 while ($pid = waitpid -1, $WNOHANG) > 0;
1210 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),
1211 (values %{ $PID_CB{0} || {} });
1212 }
1213} 1482}
1214 1483
1215sub child { 1484sub child {
1216 my (undef, %arg) = @_; 1485 my (undef, %arg) = @_;
1217 1486
1218 defined (my $pid = $arg{pid} + 0) 1487 defined (my $pid = $arg{pid} + 0)
1219 or Carp::croak "required option 'pid' is missing"; 1488 or Carp::croak "required option 'pid' is missing";
1220 1489
1221 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1490 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1222 1491
1492 # WNOHANG is almost cetrainly 1 everywhere
1493 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1494 ? 1
1223 $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1495 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1224 1496
1225 unless ($CHLD_W) { 1497 unless ($CHLD_W) {
1226 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1498 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1227 # child could be a zombie already, so make at least one round 1499 # child could be a zombie already, so make at least one round
1228 &_sigchld; 1500 &_sigchld;
1280 1552
1281our @ISA = AnyEvent::CondVar::Base::; 1553our @ISA = AnyEvent::CondVar::Base::;
1282 1554
1283package AnyEvent::CondVar::Base; 1555package AnyEvent::CondVar::Base;
1284 1556
1285use overload 1557#use overload
1286 '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1558# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1287 fallback => 1; 1559# fallback => 1;
1560
1561# save 300+ kilobytes by dirtily hardcoding overloading
1562${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
1563*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
1564*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
1565${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1566
1567our $WAITING;
1288 1568
1289sub _send { 1569sub _send {
1290 # nop 1570 # nop
1291} 1571}
1292 1572
1305sub ready { 1585sub ready {
1306 $_[0]{_ae_sent} 1586 $_[0]{_ae_sent}
1307} 1587}
1308 1588
1309sub _wait { 1589sub _wait {
1590 $WAITING
1591 and !$_[0]{_ae_sent}
1592 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1593
1594 local $WAITING = 1;
1310 AnyEvent->one_event while !$_[0]{_ae_sent}; 1595 AnyEvent->one_event while !$_[0]{_ae_sent};
1311} 1596}
1312 1597
1313sub recv { 1598sub recv {
1314 $_[0]->_wait; 1599 $_[0]->_wait;
1376C<PERL_ANYEVENT_MODEL>. 1661C<PERL_ANYEVENT_MODEL>.
1377 1662
1378When set to C<2> or higher, cause AnyEvent to report to STDERR which event 1663When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1379model it chooses. 1664model it chooses.
1380 1665
1666When set to C<8> or higher, then AnyEvent will report extra information on
1667which optional modules it loads and how it implements certain features.
1668
1381=item C<PERL_ANYEVENT_STRICT> 1669=item C<PERL_ANYEVENT_STRICT>
1382 1670
1383AnyEvent does not do much argument checking by default, as thorough 1671AnyEvent does not do much argument checking by default, as thorough
1384argument checking is very costly. Setting this variable to a true value 1672argument checking is very costly. Setting this variable to a true value
1385will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly 1673will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1386check the arguments passed to most method calls. If it finds any problems, 1674check the arguments passed to most method calls. If it finds any problems,
1387it will croak. 1675it will croak.
1388 1676
1389In other words, enables "strict" mode. 1677In other words, enables "strict" mode.
1390 1678
1391Unlike C<use strict>, it is definitely recommended to keep it off in 1679Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1392production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while 1680>>, it is definitely recommended to keep it off in production. Keeping
1393developing programs can be very useful, however. 1681C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1682can be very useful, however.
1394 1683
1395=item C<PERL_ANYEVENT_MODEL> 1684=item C<PERL_ANYEVENT_MODEL>
1396 1685
1397This can be used to specify the event model to be used by AnyEvent, before 1686This can be used to specify the event model to be used by AnyEvent, before
1398auto detection and -probing kicks in. It must be a string consisting 1687auto detection and -probing kicks in. It must be a string consisting
1441 1730
1442=item C<PERL_ANYEVENT_MAX_FORKS> 1731=item C<PERL_ANYEVENT_MAX_FORKS>
1443 1732
1444The maximum number of child processes that C<AnyEvent::Util::fork_call> 1733The maximum number of child processes that C<AnyEvent::Util::fork_call>
1445will create in parallel. 1734will create in parallel.
1735
1736=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1737
1738The default value for the C<max_outstanding> parameter for the default DNS
1739resolver - this is the maximum number of parallel DNS requests that are
1740sent to the DNS server.
1741
1742=item C<PERL_ANYEVENT_RESOLV_CONF>
1743
1744The file to use instead of F</etc/resolv.conf> (or OS-specific
1745configuration) in the default resolver. When set to the empty string, no
1746default config will be used.
1747
1748=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1749
1750When neither C<ca_file> nor C<ca_path> was specified during
1751L<AnyEvent::TLS> context creation, and either of these environment
1752variables exist, they will be used to specify CA certificate locations
1753instead of a system-dependent default.
1754
1755=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1756
1757When these are set to C<1>, then the respective modules are not
1758loaded. Mostly good for testing AnyEvent itself.
1446 1759
1447=back 1760=back
1448 1761
1449=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1762=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1450 1763
1695 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2008 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1696 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2009 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1697 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2010 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1698 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2011 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1699 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2012 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
2013 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
2014 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1700 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2015 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1701 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2016 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1702 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2017 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1703 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2018 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1704 2019
1733performance becomes really bad with lots of file descriptors (and few of 2048performance becomes really bad with lots of file descriptors (and few of
1734them active), of course, but this was not subject of this benchmark. 2049them active), of course, but this was not subject of this benchmark.
1735 2050
1736The C<Event> module has a relatively high setup and callback invocation 2051The C<Event> module has a relatively high setup and callback invocation
1737cost, but overall scores in on the third place. 2052cost, but overall scores in on the third place.
2053
2054C<IO::Async> performs admirably well, about on par with C<Event>, even
2055when using its pure perl backend.
1738 2056
1739C<Glib>'s memory usage is quite a bit higher, but it features a 2057C<Glib>'s memory usage is quite a bit higher, but it features a
1740faster callback invocation and overall ends up in the same class as 2058faster callback invocation and overall ends up in the same class as
1741C<Event>. However, Glib scales extremely badly, doubling the number of 2059C<Event>. However, Glib scales extremely badly, doubling the number of
1742watchers increases the processing time by more than a factor of four, 2060watchers increases the processing time by more than a factor of four,
1820it to another server. This includes deleting the old timeout and creating 2138it to another server. This includes deleting the old timeout and creating
1821a new one that moves the timeout into the future. 2139a new one that moves the timeout into the future.
1822 2140
1823=head3 Results 2141=head3 Results
1824 2142
1825 name sockets create request 2143 name sockets create request
1826 EV 20000 69.01 11.16 2144 EV 20000 69.01 11.16
1827 Perl 20000 73.32 35.87 2145 Perl 20000 73.32 35.87
2146 IOAsync 20000 157.00 98.14 epoll
2147 IOAsync 20000 159.31 616.06 poll
1828 Event 20000 212.62 257.32 2148 Event 20000 212.62 257.32
1829 Glib 20000 651.16 1896.30 2149 Glib 20000 651.16 1896.30
1830 POE 20000 349.67 12317.24 uses POE::Loop::Event 2150 POE 20000 349.67 12317.24 uses POE::Loop::Event
1831 2151
1832=head3 Discussion 2152=head3 Discussion
1833 2153
1834This benchmark I<does> measure scalability and overall performance of the 2154This benchmark I<does> measure scalability and overall performance of the
1835particular event loop. 2155particular event loop.
1837EV is again fastest. Since it is using epoll on my system, the setup time 2157EV is again fastest. Since it is using epoll on my system, the setup time
1838is relatively high, though. 2158is relatively high, though.
1839 2159
1840Perl surprisingly comes second. It is much faster than the C-based event 2160Perl surprisingly comes second. It is much faster than the C-based event
1841loops Event and Glib. 2161loops Event and Glib.
2162
2163IO::Async performs very well when using its epoll backend, and still quite
2164good compared to Glib when using its pure perl backend.
1842 2165
1843Event suffers from high setup time as well (look at its code and you will 2166Event suffers from high setup time as well (look at its code and you will
1844understand why). Callback invocation also has a high overhead compared to 2167understand why). Callback invocation also has a high overhead compared to
1845the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 2168the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1846uses select or poll in basically all documented configurations. 2169uses select or poll in basically all documented configurations.
1979 2302
1980A handler for C<SIGCHLD> is installed by AnyEvent's child watcher 2303A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1981emulation for event loops that do not support them natively. Also, some 2304emulation for event loops that do not support them natively. Also, some
1982event loops install a similar handler. 2305event loops install a similar handler.
1983 2306
1984If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will 2307Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
1985reset it to default, to avoid losing child exit statuses. 2308AnyEvent will reset it to default, to avoid losing child exit statuses.
1986 2309
1987=item SIGPIPE 2310=item SIGPIPE
1988 2311
1989A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> 2312A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1990when AnyEvent gets loaded. 2313when AnyEvent gets loaded.
2008 if $SIG{CHLD} eq 'IGNORE'; 2331 if $SIG{CHLD} eq 'IGNORE';
2009 2332
2010$SIG{PIPE} = sub { } 2333$SIG{PIPE} = sub { }
2011 unless defined $SIG{PIPE}; 2334 unless defined $SIG{PIPE};
2012 2335
2336=head1 RECOMMENDED/OPTIONAL MODULES
2337
2338One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2339it's built-in modules) are required to use it.
2340
2341That does not mean that AnyEvent won't take advantage of some additional
2342modules if they are installed.
2343
2344This section epxlains which additional modules will be used, and how they
2345affect AnyEvent's operetion.
2346
2347=over 4
2348
2349=item L<Async::Interrupt>
2350
2351This slightly arcane module is used to implement fast signal handling: To
2352my knowledge, there is no way to do completely race-free and quick
2353signal handling in pure perl. To ensure that signals still get
2354delivered, AnyEvent will start an interval timer to wake up perl (and
2355catch the signals) with some delay (default is 10 seconds, look for
2356C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2357
2358If this module is available, then it will be used to implement signal
2359catching, which means that signals will not be delayed, and the event loop
2360will not be interrupted regularly, which is more efficient (And good for
2361battery life on laptops).
2362
2363This affects not just the pure-perl event loop, but also other event loops
2364that have no signal handling on their own (e.g. Glib, Tk, Qt).
2365
2366Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
2367and either employ their own workarounds (POE) or use AnyEvent's workaround
2368(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
2369does nothing for those backends.
2370
2371=item L<EV>
2372
2373This module isn't really "optional", as it is simply one of the backend
2374event loops that AnyEvent can use. However, it is simply the best event
2375loop available in terms of features, speed and stability: It supports
2376the AnyEvent API optimally, implements all the watcher types in XS, does
2377automatic timer adjustments even when no monotonic clock is available,
2378can take avdantage of advanced kernel interfaces such as C<epoll> and
2379C<kqueue>, and is the fastest backend I<by far>. You can even embed
2380L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2381
2382=item L<Guard>
2383
2384The guard module, when used, will be used to implement
2385C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2386lot less memory), but otherwise doesn't affect guard operation much. It is
2387purely used for performance.
2388
2389=item L<JSON> and L<JSON::XS>
2390
2391This module is required when you want to read or write JSON data via
2392L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2393advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2394
2395In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2396installed.
2397
2398=item L<Net::SSLeay>
2399
2400Implementing TLS/SSL in Perl is certainly interesting, but not very
2401worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2402the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2403
2404=item L<Time::HiRes>
2405
2406This module is part of perl since release 5.008. It will be used when the
2407chosen event library does not come with a timing source on it's own. The
2408pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2409try to use a monotonic clock for timing stability.
2410
2411=back
2412
2413
2013=head1 FORK 2414=head1 FORK
2014 2415
2015Most event libraries are not fork-safe. The ones who are usually are 2416Most event libraries are not fork-safe. The ones who are usually are
2016because they rely on inefficient but fork-safe C<select> or C<poll> 2417because they rely on inefficient but fork-safe C<select> or C<poll>
2017calls. Only L<EV> is fully fork-aware. 2418calls. Only L<EV> is fully fork-aware.
2018 2419
2019If you have to fork, you must either do so I<before> creating your first 2420If you have to fork, you must either do so I<before> creating your first
2020watcher OR you must not use AnyEvent at all in the child. 2421watcher OR you must not use AnyEvent at all in the child OR you must do
2422something completely out of the scope of AnyEvent.
2021 2423
2022 2424
2023=head1 SECURITY CONSIDERATIONS 2425=head1 SECURITY CONSIDERATIONS
2024 2426
2025AnyEvent can be forced to load any event model via 2427AnyEvent can be forced to load any event model via
2063L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2465L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2064 2466
2065Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2467Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2066L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2468L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2067L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2469L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2068L<AnyEvent::Impl::POE>. 2470L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2069 2471
2070Non-blocking file handles, sockets, TCP clients and 2472Non-blocking file handles, sockets, TCP clients and
2071servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. 2473servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2072 2474
2073Asynchronous DNS: L<AnyEvent::DNS>. 2475Asynchronous DNS: L<AnyEvent::DNS>.
2074 2476
2075Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 2477Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
2478L<Coro::Event>,
2076 2479
2077Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 2480Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
2481L<AnyEvent::HTTP>.
2078 2482
2079 2483
2080=head1 AUTHOR 2484=head1 AUTHOR
2081 2485
2082 Marc Lehmann <schmorp@schmorp.de> 2486 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines