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.266 by root, Thu Jul 30 03:41:56 2009 UTC vs.
Revision 1.324 by root, Thu May 20 23:55:51 2010 UTC

7 7
8=head1 SYNOPSIS 8=head1 SYNOPSIS
9 9
10 use AnyEvent; 10 use AnyEvent;
11 11
12 # if you prefer function calls, look at the AE manpage for
13 # an alternative API.
14
12 # file descriptor readable 15 # file handle or descriptor readable
13 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); 16 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14 17
15 # one-shot or repeating timers 18 # one-shot or repeating timers
16 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); 19 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... 20 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
363might affect timers and time-outs. 366might affect timers and time-outs.
364 367
365When this is the case, you can call this method, which will update the 368When this is the case, you can call this method, which will update the
366event loop's idea of "current time". 369event loop's idea of "current time".
367 370
371A typical example would be a script in a web server (e.g. C<mod_perl>) -
372when mod_perl executes the script, then the event loop will have the wrong
373idea about the "current time" (being potentially far in the past, when the
374script ran the last time). In that case you should arrange a call to C<<
375AnyEvent->now_update >> each time the web server process wakes up again
376(e.g. at the start of your script, or in a handler).
377
368Note that updating the time I<might> cause some events to be handled. 378Note that updating the time I<might> cause some events to be handled.
369 379
370=back 380=back
371 381
372=head2 SIGNAL WATCHERS 382=head2 SIGNAL WATCHERS
396 406
397Example: exit on SIGINT 407Example: exit on SIGINT
398 408
399 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 409 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
400 410
411=head3 Restart Behaviour
412
413While restart behaviour is up to the event loop implementation, most will
414not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
415pure perl implementation).
416
417=head3 Safe/Unsafe Signals
418
419Perl signals can be either "safe" (synchronous to opcode handling) or
420"unsafe" (asynchronous) - the former might get delayed indefinitely, the
421latter might corrupt your memory.
422
423AnyEvent signal handlers are, in addition, synchronous to the event loop,
424i.e. they will not interrupt your running perl program but will only be
425called as part of the normal event handling (just like timer, I/O etc.
426callbacks, too).
427
401=head3 Signal Races, Delays and Workarounds 428=head3 Signal Races, Delays and Workarounds
402 429
403Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 430Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
404callbacks to signals in a generic way, which is a pity, as you cannot do 431callbacks to signals in a generic way, which is a pity, as you cannot
405race-free signal handling in perl. AnyEvent will try to do it's best, but 432do race-free signal handling in perl, requiring C libraries for
433this. AnyEvent will try to do it's best, which means in some cases,
406in some cases, signals will be delayed. The maximum time a signal might 434signals will be delayed. The maximum time a signal might be delayed is
407be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 435specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
408seconds). This variable can be changed only before the first signal 436variable can be changed only before the first signal watcher is created,
409watcher is created, and should be left alone otherwise. Higher values 437and should be left alone otherwise. This variable determines how often
438AnyEvent polls for signals (in case a wake-up was missed). Higher values
410will cause fewer spurious wake-ups, which is better for power and CPU 439will cause fewer spurious wake-ups, which is better for power and CPU
440saving.
441
411saving. All these problems can be avoided by installing the optional 442All these problems can be avoided by installing the optional
412L<Async::Interrupt> module. This will not work with inherently broken 443L<Async::Interrupt> module, which works with most event loops. It will not
413event loops such as L<Event> or L<Event::Lib> (and not with L<POE> 444work with inherently broken event loops such as L<Event> or L<Event::Lib>
414currently, as POE does it's own workaround with one-second latency). With 445(and not with L<POE> currently, as POE does it's own workaround with
415those, you just have to suffer the delays. 446one-second latency). For those, you just have to suffer the delays.
416 447
417=head2 CHILD PROCESS WATCHERS 448=head2 CHILD PROCESS WATCHERS
418 449
419 $w = AnyEvent->child (pid => <process id>, cb => <callback>); 450 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
420 451
475 506
476=head2 IDLE WATCHERS 507=head2 IDLE WATCHERS
477 508
478 $w = AnyEvent->idle (cb => <callback>); 509 $w = AnyEvent->idle (cb => <callback>);
479 510
480Sometimes there is a need to do something, but it is not so important 511Repeatedly invoke the callback after the process becomes idle, until
481to do it instantly, but only when there is nothing better to do. This 512either the watcher is destroyed or new events have been detected.
482"nothing better to do" is usually defined to be "no other events need
483attention by the event loop".
484 513
485Idle watchers ideally get invoked when the event loop has nothing 514Idle watchers are useful when there is a need to do something, but it
486better to do, just before it would block the process to wait for new 515is not so important (or wise) to do it instantly. The callback will be
487events. Instead of blocking, the idle watcher is invoked. 516invoked only when there is "nothing better to do", which is usually
517defined as "all outstanding events have been handled and no new events
518have been detected". That means that idle watchers ideally get invoked
519when the event loop has just polled for new events but none have been
520detected. Instead of blocking to wait for more events, the idle watchers
521will be invoked.
488 522
489Most event loops unfortunately do not really support idle watchers (only 523Unfortunately, most event loops do not really support idle watchers (only
490EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent 524EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
491will simply call the callback "from time to time". 525will simply call the callback "from time to time".
492 526
493Example: read lines from STDIN, but only process them when the 527Example: read lines from STDIN, but only process them when the
494program is otherwise idle: 528program is otherwise idle:
575eventually calls C<< -> send >>, and the "consumer side", which waits 609eventually calls C<< -> send >>, and the "consumer side", which waits
576for the send to occur. 610for the send to occur.
577 611
578Example: wait for a timer. 612Example: wait for a timer.
579 613
580 # wait till the result is ready 614 # condition: "wait till the timer is fired"
581 my $result_ready = AnyEvent->condvar; 615 my $timer_fired = AnyEvent->condvar;
582 616
583 # do something such as adding a timer 617 # create the timer - we could wait for, say
584 # or socket watcher the calls $result_ready->send 618 # a handle becomign ready, or even an
585 # when the "result" is ready. 619 # AnyEvent::HTTP request to finish, but
586 # in this case, we simply use a timer: 620 # in this case, we simply use a timer:
587 my $w = AnyEvent->timer ( 621 my $w = AnyEvent->timer (
588 after => 1, 622 after => 1,
589 cb => sub { $result_ready->send }, 623 cb => sub { $timer_fired->send },
590 ); 624 );
591 625
592 # this "blocks" (while handling events) till the callback 626 # this "blocks" (while handling events) till the callback
593 # calls -<send 627 # calls ->send
594 $result_ready->recv; 628 $timer_fired->recv;
595 629
596Example: wait for a timer, but take advantage of the fact that condition 630Example: wait for a timer, but take advantage of the fact that condition
597variables are also callable directly. 631variables are also callable directly.
598 632
599 my $done = AnyEvent->condvar; 633 my $done = AnyEvent->condvar;
662one. For example, a function that pings many hosts in parallel might want 696one. For example, a function that pings many hosts in parallel might want
663to use a condition variable for the whole process. 697to use a condition variable for the whole process.
664 698
665Every call to C<< ->begin >> will increment a counter, and every call to 699Every call to C<< ->begin >> will increment a counter, and every call to
666C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 700C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
667>>, the (last) callback passed to C<begin> will be executed. That callback 701>>, the (last) callback passed to C<begin> will be executed, passing the
668is I<supposed> to call C<< ->send >>, but that is not required. If no 702condvar as first argument. That callback is I<supposed> to call C<< ->send
669callback was set, C<send> will be called without any arguments. 703>>, but that is not required. If no group callback was set, C<send> will
704be called without any arguments.
670 705
671You can think of C<< $cv->send >> giving you an OR condition (one call 706You can think of C<< $cv->send >> giving you an OR condition (one call
672sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND 707sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
673condition (all C<begin> calls must be C<end>'ed before the condvar sends). 708condition (all C<begin> calls must be C<end>'ed before the condvar sends).
674 709
701begung can potentially be zero: 736begung can potentially be zero:
702 737
703 my $cv = AnyEvent->condvar; 738 my $cv = AnyEvent->condvar;
704 739
705 my %result; 740 my %result;
706 $cv->begin (sub { $cv->send (\%result) }); 741 $cv->begin (sub { shift->send (\%result) });
707 742
708 for my $host (@list_of_hosts) { 743 for my $host (@list_of_hosts) {
709 $cv->begin; 744 $cv->begin;
710 ping_host_then_call_callback $host, sub { 745 ping_host_then_call_callback $host, sub {
711 $result{$host} = ...; 746 $result{$host} = ...;
786=item $cb = $cv->cb ($cb->($cv)) 821=item $cb = $cv->cb ($cb->($cv))
787 822
788This is a mutator function that returns the callback set and optionally 823This is a mutator function that returns the callback set and optionally
789replaces it before doing so. 824replaces it before doing so.
790 825
791The callback will be called when the condition becomes "true", i.e. when 826The callback will be called when the condition becomes (or already was)
792C<send> or C<croak> are called, with the only argument being the condition 827"true", i.e. when C<send> or C<croak> are called (or were called), with
793variable itself. Calling C<recv> inside the callback or at any later time 828the only argument being the condition variable itself. Calling C<recv>
794is guaranteed not to block. 829inside the callback or at any later time is guaranteed not to block.
795 830
796=back 831=back
797 832
798=head1 SUPPORTED EVENT LOOPS/BACKENDS 833=head1 SUPPORTED EVENT LOOPS/BACKENDS
799 834
802=over 4 837=over 4
803 838
804=item Backends that are autoprobed when no other event loop can be found. 839=item Backends that are autoprobed when no other event loop can be found.
805 840
806EV is the preferred backend when no other event loop seems to be in 841EV is the preferred backend when no other event loop seems to be in
807use. If EV is not installed, then AnyEvent will try Event, and, failing 842use. If EV is not installed, then AnyEvent will fall back to its own
808that, will fall back to its own pure-perl implementation, which is 843pure-perl implementation, which is available everywhere as it comes with
809available everywhere as it comes with AnyEvent itself. 844AnyEvent itself.
810 845
811 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 846 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
812 AnyEvent::Impl::Event based on Event, very stable, few glitches.
813 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 847 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
814 848
815=item Backends that are transparently being picked up when they are used. 849=item Backends that are transparently being picked up when they are used.
816 850
817These will be used when they are currently loaded when the first watcher 851These will be used when they are currently loaded when the first watcher
818is created, in which case it is assumed that the application is using 852is created, in which case it is assumed that the application is using
819them. This means that AnyEvent will automatically pick the right backend 853them. This means that AnyEvent will automatically pick the right backend
820when the main program loads an event module before anything starts to 854when the main program loads an event module before anything starts to
821create watchers. Nothing special needs to be done by the main program. 855create watchers. Nothing special needs to be done by the main program.
822 856
857 AnyEvent::Impl::Event based on Event, very stable, few glitches.
823 AnyEvent::Impl::Glib based on Glib, slow but very stable. 858 AnyEvent::Impl::Glib based on Glib, slow but very stable.
824 AnyEvent::Impl::Tk based on Tk, very broken. 859 AnyEvent::Impl::Tk based on Tk, very broken.
825 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 860 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
826 AnyEvent::Impl::POE based on POE, very slow, some limitations. 861 AnyEvent::Impl::POE based on POE, very slow, some limitations.
827 AnyEvent::Impl::Irssi used when running within irssi. 862 AnyEvent::Impl::Irssi used when running within irssi.
937You should check C<$AnyEvent::MODEL> before adding to this array, though: 972You should check C<$AnyEvent::MODEL> before adding to this array, though:
938if it is defined then the event loop has already been detected, and the 973if it is defined then the event loop has already been detected, and the
939array will be ignored. 974array will be ignored.
940 975
941Best use C<AnyEvent::post_detect { BLOCK }> when your application allows 976Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
942it,as it takes care of these details. 977it, as it takes care of these details.
943 978
944This variable is mainly useful for modules that can do something useful 979This variable is mainly useful for modules that can do something useful
945when AnyEvent is used and thus want to know when it is initialised, but do 980when AnyEvent is used and thus want to know when it is initialised, but do
946not need to even load it by default. This array provides the means to hook 981not need to even load it by default. This array provides the means to hook
947into AnyEvent passively, without loading it. 982into AnyEvent passively, without loading it.
983
984Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
985together, you could put this into Coro (this is the actual code used by
986Coro to accomplish this):
987
988 if (defined $AnyEvent::MODEL) {
989 # AnyEvent already initialised, so load Coro::AnyEvent
990 require Coro::AnyEvent;
991 } else {
992 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
993 # as soon as it is
994 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
995 }
948 996
949=back 997=back
950 998
951=head1 WHAT TO DO IN A MODULE 999=head1 WHAT TO DO IN A MODULE
952 1000
1009=head1 OTHER MODULES 1057=head1 OTHER MODULES
1010 1058
1011The following is a non-exhaustive list of additional modules that use 1059The following is a non-exhaustive list of additional modules that use
1012AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1060AnyEvent as a client and can therefore be mixed easily with other AnyEvent
1013modules and other event loops in the same program. Some of the modules 1061modules and other event loops in the same program. Some of the modules
1014come with AnyEvent, most are available via CPAN. 1062come with AnyEvent, the others are available via CPAN.
1015 1063
1016=over 4 1064=over 4
1017 1065
1018=item L<AnyEvent::Util> 1066=item L<AnyEvent::Util>
1019 1067
1034 1082
1035=item L<AnyEvent::DNS> 1083=item L<AnyEvent::DNS>
1036 1084
1037Provides rich asynchronous DNS resolver capabilities. 1085Provides rich asynchronous DNS resolver capabilities.
1038 1086
1087=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1088
1089Implement event-based interfaces to the protocols of the same name (for
1090the curious, IGS is the International Go Server and FCP is the Freenet
1091Client Protocol).
1092
1093=item L<AnyEvent::Handle::UDP>
1094
1095Here be danger!
1096
1097As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1098there are so many things wrong with AnyEvent::Handle::UDP, most notably
1099it's use of a stream-based API with a protocol that isn't streamable, that
1100the only way to improve it is to delete it.
1101
1102It features data corruption (but typically only under load) and general
1103confusion. On top, the author is not only clueless about UDP but also
1104fact-resistant - some gems of his understanding: "connect doesn't work
1105with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1106packets", "I don't need to implement proper error checking as UDP doesn't
1107support error checking" and so on - he doesn't even understand what's
1108wrong with his module when it is explained to him.
1109
1039=item L<AnyEvent::HTTP> 1110=item L<AnyEvent::DBI>
1040 1111
1041A simple-to-use HTTP library that is capable of making a lot of concurrent 1112Executes L<DBI> requests asynchronously in a proxy process for you,
1042HTTP requests. 1113notifying you in an event-bnased way when the operation is finished.
1114
1115=item L<AnyEvent::AIO>
1116
1117Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1118toolbox of every event programmer. AnyEvent::AIO transparently fuses
1119L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1120file I/O, and much more.
1043 1121
1044=item L<AnyEvent::HTTPD> 1122=item L<AnyEvent::HTTPD>
1045 1123
1046Provides a simple web application server framework. 1124A simple embedded webserver.
1047 1125
1048=item L<AnyEvent::FastPing> 1126=item L<AnyEvent::FastPing>
1049 1127
1050The fastest ping in the west. 1128The fastest ping in the west.
1051
1052=item L<AnyEvent::DBI>
1053
1054Executes L<DBI> requests asynchronously in a proxy process.
1055
1056=item L<AnyEvent::AIO>
1057
1058Truly asynchronous I/O, should be in the toolbox of every event
1059programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1060together.
1061
1062=item L<AnyEvent::BDB>
1063
1064Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1065L<BDB> and AnyEvent together.
1066
1067=item L<AnyEvent::GPSD>
1068
1069A non-blocking interface to gpsd, a daemon delivering GPS information.
1070
1071=item L<AnyEvent::IRC>
1072
1073AnyEvent based IRC client module family (replacing the older Net::IRC3).
1074
1075=item L<AnyEvent::XMPP>
1076
1077AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1078Net::XMPP2>.
1079
1080=item L<AnyEvent::IGS>
1081
1082A non-blocking interface to the Internet Go Server protocol (used by
1083L<App::IGS>).
1084
1085=item L<Net::FCP>
1086
1087AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1088of AnyEvent.
1089
1090=item L<Event::ExecFlow>
1091
1092High level API for event-based execution flow control.
1093 1129
1094=item L<Coro> 1130=item L<Coro>
1095 1131
1096Has special support for AnyEvent via L<Coro::AnyEvent>. 1132Has special support for AnyEvent via L<Coro::AnyEvent>.
1097 1133
1101 1137
1102package AnyEvent; 1138package AnyEvent;
1103 1139
1104# basically a tuned-down version of common::sense 1140# basically a tuned-down version of common::sense
1105sub common_sense { 1141sub common_sense {
1106 # no warnings 1142 # from common:.sense 1.0
1107 ${^WARNING_BITS} ^= ${^WARNING_BITS}; 1143 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1108 # use strict vars subs 1144 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1109 $^H |= 0x00000600; 1145 $^H |= 0x00000600;
1110} 1146}
1111 1147
1112BEGIN { AnyEvent::common_sense } 1148BEGIN { AnyEvent::common_sense }
1113 1149
1114use Carp (); 1150use Carp ();
1115 1151
1116our $VERSION = 4.881; 1152our $VERSION = '5.261';
1117our $MODEL; 1153our $MODEL;
1118 1154
1119our $AUTOLOAD; 1155our $AUTOLOAD;
1120our @ISA; 1156our @ISA;
1121 1157
1122our @REGISTRY; 1158our @REGISTRY;
1123 1159
1124our $WIN32;
1125
1126our $VERBOSE; 1160our $VERBOSE;
1127 1161
1128BEGIN { 1162BEGIN {
1129 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1163 require "AnyEvent/constants.pl";
1164
1130 eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; 1165 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1131 1166
1132 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1167 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1133 if ${^TAINT}; 1168 if ${^TAINT};
1134 1169
1135 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1170 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1147 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1182 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1148} 1183}
1149 1184
1150my @models = ( 1185my @models = (
1151 [EV:: => AnyEvent::Impl::EV:: , 1], 1186 [EV:: => AnyEvent::Impl::EV:: , 1],
1152 [Event:: => AnyEvent::Impl::Event::, 1],
1153 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1187 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1154 # everything below here will not (normally) be autoprobed 1188 # everything below here will not (normally) be autoprobed
1155 # as the pureperl backend should work everywhere 1189 # as the pureperl backend should work everywhere
1156 # and is usually faster 1190 # and is usually faster
1191 [Event:: => AnyEvent::Impl::Event::, 1],
1157 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1192 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1158 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1193 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1159 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1194 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1160 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1195 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1161 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1196 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1164 [Prima:: => AnyEvent::Impl::POE::], 1199 [Prima:: => AnyEvent::Impl::POE::],
1165 # IO::Async is just too broken - we would need workarounds for its 1200 # IO::Async is just too broken - we would need workarounds for its
1166 # byzantine signal and broken child handling, among others. 1201 # byzantine signal and broken child handling, among others.
1167 # IO::Async is rather hard to detect, as it doesn't have any 1202 # IO::Async is rather hard to detect, as it doesn't have any
1168 # obvious default class. 1203 # obvious default class.
1169# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1204 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1170# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1205 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1171# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1206 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1207 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1172); 1208);
1173 1209
1174our %method = map +($_ => 1), 1210our %method = map +($_ => 1),
1175 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1211 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1176 1212
1177our @post_detect; 1213our @post_detect;
1178 1214
1179sub post_detect(&) { 1215sub post_detect(&) {
1180 my ($cb) = @_; 1216 my ($cb) = @_;
1181 1217
1182 if ($MODEL) {
1183 $cb->();
1184
1185 undef
1186 } else {
1187 push @post_detect, $cb; 1218 push @post_detect, $cb;
1188 1219
1189 defined wantarray 1220 defined wantarray
1190 ? bless \$cb, "AnyEvent::Util::postdetect" 1221 ? bless \$cb, "AnyEvent::Util::postdetect"
1191 : () 1222 : ()
1192 }
1193} 1223}
1194 1224
1195sub AnyEvent::Util::postdetect::DESTROY { 1225sub AnyEvent::Util::postdetect::DESTROY {
1196 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1226 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1197} 1227}
1198 1228
1199sub detect() { 1229sub detect() {
1230 # free some memory
1231 *detect = sub () { $MODEL };
1232
1233 local $!; # for good measure
1234 local $SIG{__DIE__};
1235
1236 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1237 my $model = "AnyEvent::Impl::$1";
1238 if (eval "require $model") {
1239 $MODEL = $model;
1240 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1241 } else {
1242 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1243 }
1244 }
1245
1246 # check for already loaded models
1200 unless ($MODEL) { 1247 unless ($MODEL) {
1201 local $SIG{__DIE__}; 1248 for (@REGISTRY, @models) {
1202 1249 my ($package, $model) = @$_;
1203 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1250 if (${"$package\::VERSION"} > 0) {
1204 my $model = "AnyEvent::Impl::$1";
1205 if (eval "require $model") { 1251 if (eval "require $model") {
1206 $MODEL = $model; 1252 $MODEL = $model;
1207 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; 1253 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1208 } else { 1254 last;
1209 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1255 }
1210 } 1256 }
1211 } 1257 }
1212 1258
1213 # check for already loaded models
1214 unless ($MODEL) { 1259 unless ($MODEL) {
1260 # try to autoload a model
1215 for (@REGISTRY, @models) { 1261 for (@REGISTRY, @models) {
1216 my ($package, $model) = @$_; 1262 my ($package, $model, $autoload) = @$_;
1263 if (
1264 $autoload
1265 and eval "require $package"
1217 if (${"$package\::VERSION"} > 0) { 1266 and ${"$package\::VERSION"} > 0
1218 if (eval "require $model") { 1267 and eval "require $model"
1268 ) {
1219 $MODEL = $model; 1269 $MODEL = $model;
1220 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1270 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1221 last; 1271 last;
1222 }
1223 } 1272 }
1224 } 1273 }
1225 1274
1226 unless ($MODEL) {
1227 # try to autoload a model
1228 for (@REGISTRY, @models) {
1229 my ($package, $model, $autoload) = @$_;
1230 if (
1231 $autoload
1232 and eval "require $package"
1233 and ${"$package\::VERSION"} > 0
1234 and eval "require $model"
1235 ) {
1236 $MODEL = $model;
1237 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1238 last;
1239 }
1240 }
1241
1242 $MODEL 1275 $MODEL
1243 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1276 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1244 }
1245 } 1277 }
1246
1247 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1248
1249 unshift @ISA, $MODEL;
1250
1251 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1252
1253 (shift @post_detect)->() while @post_detect;
1254 } 1278 }
1279
1280 @models = (); # free probe data
1281
1282 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1283 unshift @ISA, $MODEL;
1284
1285 # now nuke some methods that are overriden by the backend.
1286 # SUPER is not allowed.
1287 for (qw(time signal child idle)) {
1288 undef &{"AnyEvent::Base::$_"}
1289 if defined &{"$MODEL\::$_"};
1290 }
1291
1292 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1293
1294 (shift @post_detect)->() while @post_detect;
1295
1296 *post_detect = sub(&) {
1297 shift->();
1298
1299 undef
1300 };
1255 1301
1256 $MODEL 1302 $MODEL
1257} 1303}
1258 1304
1259sub AUTOLOAD { 1305sub AUTOLOAD {
1260 (my $func = $AUTOLOAD) =~ s/.*://; 1306 (my $func = $AUTOLOAD) =~ s/.*://;
1261 1307
1262 $method{$func} 1308 $method{$func}
1263 or Carp::croak "$func: not a valid method for AnyEvent objects"; 1309 or Carp::croak "$func: not a valid AnyEvent class method";
1264 1310
1265 detect unless $MODEL; 1311 detect;
1266 1312
1267 my $class = shift; 1313 my $class = shift;
1268 $class->$func (@_); 1314 $class->$func (@_);
1269} 1315}
1270 1316
1283 # we assume CLOEXEC is already set by perl in all important cases 1329 # we assume CLOEXEC is already set by perl in all important cases
1284 1330
1285 ($fh2, $rw) 1331 ($fh2, $rw)
1286} 1332}
1287 1333
1334=head1 SIMPLIFIED AE API
1335
1336Starting with version 5.0, AnyEvent officially supports a second, much
1337simpler, API that is designed to reduce the calling, typing and memory
1338overhead by using function call syntax and a fixed number of parameters.
1339
1340See the L<AE> manpage for details.
1341
1342=cut
1343
1344package AE;
1345
1346our $VERSION = $AnyEvent::VERSION;
1347
1348# fall back to the main API by default - backends and AnyEvent::Base
1349# implementations can overwrite these.
1350
1351sub io($$$) {
1352 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1353}
1354
1355sub timer($$$) {
1356 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1357}
1358
1359sub signal($$) {
1360 AnyEvent->signal (signal => $_[0], cb => $_[1])
1361}
1362
1363sub child($$) {
1364 AnyEvent->child (pid => $_[0], cb => $_[1])
1365}
1366
1367sub idle($) {
1368 AnyEvent->idle (cb => $_[0])
1369}
1370
1371sub cv(;&) {
1372 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1373}
1374
1375sub now() {
1376 AnyEvent->now
1377}
1378
1379sub now_update() {
1380 AnyEvent->now_update
1381}
1382
1383sub time() {
1384 AnyEvent->time
1385}
1386
1288package AnyEvent::Base; 1387package AnyEvent::Base;
1289 1388
1290# default implementations for many methods 1389# default implementations for many methods
1291 1390
1292sub _time { 1391sub time {
1392 eval q{ # poor man's autoloading {}
1293 # probe for availability of Time::HiRes 1393 # probe for availability of Time::HiRes
1294 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1394 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1295 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1395 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1296 *_time = \&Time::HiRes::time; 1396 *AE::time = \&Time::HiRes::time;
1297 # if (eval "use POSIX (); (POSIX::times())... 1397 # if (eval "use POSIX (); (POSIX::times())...
1298 } else { 1398 } else {
1299 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1399 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1300 *_time = sub { time }; # epic fail 1400 *AE::time = sub (){ time }; # epic fail
1401 }
1402
1403 *time = sub { AE::time }; # different prototypes
1301 } 1404 };
1405 die if $@;
1302 1406
1303 &_time 1407 &time
1304} 1408}
1305 1409
1306sub time { _time } 1410*now = \&time;
1307sub now { _time } 1411
1308sub now_update { } 1412sub now_update { }
1309 1413
1310# default implementation for ->condvar 1414# default implementation for ->condvar
1311 1415
1312sub condvar { 1416sub condvar {
1417 eval q{ # poor man's autoloading {}
1418 *condvar = sub {
1313 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1419 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1420 };
1421
1422 *AE::cv = sub (;&) {
1423 bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
1424 };
1425 };
1426 die if $@;
1427
1428 &condvar
1314} 1429}
1315 1430
1316# default implementation for ->signal 1431# default implementation for ->signal
1317 1432
1318our $HAVE_ASYNC_INTERRUPT; 1433our $HAVE_ASYNC_INTERRUPT;
1319 1434
1320sub _have_async_interrupt() { 1435sub _have_async_interrupt() {
1321 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} 1436 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1322 && eval "use Async::Interrupt 1.0 (); 1") 1437 && eval "use Async::Interrupt 1.02 (); 1")
1323 unless defined $HAVE_ASYNC_INTERRUPT; 1438 unless defined $HAVE_ASYNC_INTERRUPT;
1324 1439
1325 $HAVE_ASYNC_INTERRUPT 1440 $HAVE_ASYNC_INTERRUPT
1326} 1441}
1327 1442
1328our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1443our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1329our (%SIG_ASY, %SIG_ASY_W); 1444our (%SIG_ASY, %SIG_ASY_W);
1330our ($SIG_COUNT, $SIG_TW); 1445our ($SIG_COUNT, $SIG_TW);
1331 1446
1332sub _signal_exec {
1333 $HAVE_ASYNC_INTERRUPT
1334 ? $SIGPIPE_R->drain
1335 : sysread $SIGPIPE_R, my $dummy, 9;
1336
1337 while (%SIG_EV) {
1338 for (keys %SIG_EV) {
1339 delete $SIG_EV{$_};
1340 $_->() for values %{ $SIG_CB{$_} || {} };
1341 }
1342 }
1343}
1344
1345# install a dummy wakeup watcher to reduce signal catching latency 1447# install a dummy wakeup watcher to reduce signal catching latency
1448# used by Impls
1346sub _sig_add() { 1449sub _sig_add() {
1347 unless ($SIG_COUNT++) { 1450 unless ($SIG_COUNT++) {
1348 # try to align timer on a full-second boundary, if possible 1451 # try to align timer on a full-second boundary, if possible
1349 my $NOW = AnyEvent->now; 1452 my $NOW = AE::now;
1350 1453
1351 $SIG_TW = AnyEvent->timer ( 1454 $SIG_TW = AE::timer
1352 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1455 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1353 interval => $MAX_SIGNAL_LATENCY, 1456 $MAX_SIGNAL_LATENCY,
1354 cb => sub { }, # just for the PERL_ASYNC_CHECK 1457 sub { } # just for the PERL_ASYNC_CHECK
1355 ); 1458 ;
1356 } 1459 }
1357} 1460}
1358 1461
1359sub _sig_del { 1462sub _sig_del {
1360 undef $SIG_TW 1463 undef $SIG_TW
1361 unless --$SIG_COUNT; 1464 unless --$SIG_COUNT;
1362} 1465}
1363 1466
1364our $_sig_name_init; $_sig_name_init = sub { 1467our $_sig_name_init; $_sig_name_init = sub {
1365 eval q{ # poor man's autoloading 1468 eval q{ # poor man's autoloading {}
1366 undef $_sig_name_init; 1469 undef $_sig_name_init;
1367 1470
1368 if (_have_async_interrupt) { 1471 if (_have_async_interrupt) {
1369 *sig2num = \&Async::Interrupt::sig2num; 1472 *sig2num = \&Async::Interrupt::sig2num;
1370 *sig2name = \&Async::Interrupt::sig2name; 1473 *sig2name = \&Async::Interrupt::sig2name;
1397 # probe for availability of Async::Interrupt 1500 # probe for availability of Async::Interrupt
1398 if (_have_async_interrupt) { 1501 if (_have_async_interrupt) {
1399 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1502 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1400 1503
1401 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1504 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1402 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); 1505 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1403 1506
1404 } else { 1507 } else {
1405 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1508 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1406
1407 require Fcntl;
1408 1509
1409 if (AnyEvent::WIN32) { 1510 if (AnyEvent::WIN32) {
1410 require AnyEvent::Util; 1511 require AnyEvent::Util;
1411 1512
1412 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1513 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1413 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R; 1514 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1414 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case 1515 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1415 } else { 1516 } else {
1416 pipe $SIGPIPE_R, $SIGPIPE_W; 1517 pipe $SIGPIPE_R, $SIGPIPE_W;
1417 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; 1518 fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1418 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case 1519 fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1419 1520
1420 # not strictly required, as $^F is normally 2, but let's make sure... 1521 # not strictly required, as $^F is normally 2, but let's make sure...
1421 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; 1522 fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1422 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; 1523 fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1423 } 1524 }
1424 1525
1425 $SIGPIPE_R 1526 $SIGPIPE_R
1426 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1527 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1427 1528
1428 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1529 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1429 } 1530 }
1430 1531
1431 *signal = sub { 1532 *signal = $HAVE_ASYNC_INTERRUPT
1533 ? sub {
1432 my (undef, %arg) = @_; 1534 my (undef, %arg) = @_;
1433 1535
1434 my $signal = uc $arg{signal}
1435 or Carp::croak "required option 'signal' is missing";
1436
1437 if ($HAVE_ASYNC_INTERRUPT) {
1438 # async::interrupt 1536 # async::interrupt
1439
1440 $signal = sig2num $signal; 1537 my $signal = sig2num $arg{signal};
1441 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1538 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1442 1539
1443 $SIG_ASY{$signal} ||= new Async::Interrupt 1540 $SIG_ASY{$signal} ||= new Async::Interrupt
1444 cb => sub { undef $SIG_EV{$signal} }, 1541 cb => sub { undef $SIG_EV{$signal} },
1445 signal => $signal, 1542 signal => $signal,
1446 pipe => [$SIGPIPE_R->filenos], 1543 pipe => [$SIGPIPE_R->filenos],
1447 pipe_autodrain => 0, 1544 pipe_autodrain => 0,
1448 ; 1545 ;
1449 1546
1450 } else { 1547 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1548 }
1549 : sub {
1550 my (undef, %arg) = @_;
1551
1451 # pure perl 1552 # pure perl
1452
1453 # AE::Util has been loaded in signal
1454 $signal = sig2name $signal; 1553 my $signal = sig2name $arg{signal};
1455 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1554 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1456 1555
1457 $SIG{$signal} ||= sub { 1556 $SIG{$signal} ||= sub {
1458 local $!; 1557 local $!;
1459 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1558 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1460 undef $SIG_EV{$signal}; 1559 undef $SIG_EV{$signal};
1461 }; 1560 };
1462 1561
1463 # can't do signal processing without introducing races in pure perl, 1562 # can't do signal processing without introducing races in pure perl,
1464 # so limit the signal latency. 1563 # so limit the signal latency.
1465 _sig_add; 1564 _sig_add;
1466 }
1467 1565
1468 bless [$signal, $arg{cb}], "AnyEvent::Base::signal" 1566 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1567 }
1469 }; 1568 ;
1470 1569
1471 *AnyEvent::Base::signal::DESTROY = sub { 1570 *AnyEvent::Base::signal::DESTROY = sub {
1472 my ($signal, $cb) = @{$_[0]}; 1571 my ($signal, $cb) = @{$_[0]};
1473 1572
1474 _sig_del; 1573 _sig_del;
1481 # print weird messages, or just unconditionally exit 1580 # print weird messages, or just unconditionally exit
1482 # instead of getting the default action. 1581 # instead of getting the default action.
1483 undef $SIG{$signal} 1582 undef $SIG{$signal}
1484 unless keys %{ $SIG_CB{$signal} }; 1583 unless keys %{ $SIG_CB{$signal} };
1485 }; 1584 };
1585
1586 *_signal_exec = sub {
1587 $HAVE_ASYNC_INTERRUPT
1588 ? $SIGPIPE_R->drain
1589 : sysread $SIGPIPE_R, (my $dummy), 9;
1590
1591 while (%SIG_EV) {
1592 for (keys %SIG_EV) {
1593 delete $SIG_EV{$_};
1594 $_->() for values %{ $SIG_CB{$_} || {} };
1595 }
1596 }
1597 };
1486 }; 1598 };
1487 die if $@; 1599 die if $@;
1600
1488 &signal 1601 &signal
1489} 1602}
1490 1603
1491# default implementation for ->child 1604# default implementation for ->child
1492 1605
1493our %PID_CB; 1606our %PID_CB;
1494our $CHLD_W; 1607our $CHLD_W;
1495our $CHLD_DELAY_W; 1608our $CHLD_DELAY_W;
1496our $WNOHANG; 1609our $WNOHANG;
1497 1610
1611# used by many Impl's
1498sub _emit_childstatus($$) { 1612sub _emit_childstatus($$) {
1499 my (undef, $rpid, $rstatus) = @_; 1613 my (undef, $rpid, $rstatus) = @_;
1500 1614
1501 $_->($rpid, $rstatus) 1615 $_->($rpid, $rstatus)
1502 for values %{ $PID_CB{$rpid} || {} }, 1616 for values %{ $PID_CB{$rpid} || {} },
1503 values %{ $PID_CB{0} || {} }; 1617 values %{ $PID_CB{0} || {} };
1504} 1618}
1505 1619
1506sub _sigchld {
1507 my $pid;
1508
1509 AnyEvent->_emit_childstatus ($pid, $?)
1510 while ($pid = waitpid -1, $WNOHANG) > 0;
1511}
1512
1513sub child { 1620sub child {
1621 eval q{ # poor man's autoloading {}
1622 *_sigchld = sub {
1623 my $pid;
1624
1625 AnyEvent->_emit_childstatus ($pid, $?)
1626 while ($pid = waitpid -1, $WNOHANG) > 0;
1627 };
1628
1629 *child = sub {
1514 my (undef, %arg) = @_; 1630 my (undef, %arg) = @_;
1515 1631
1516 defined (my $pid = $arg{pid} + 0) 1632 defined (my $pid = $arg{pid} + 0)
1517 or Carp::croak "required option 'pid' is missing"; 1633 or Carp::croak "required option 'pid' is missing";
1518 1634
1519 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1635 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1520 1636
1521 # WNOHANG is almost cetrainly 1 everywhere 1637 # WNOHANG is almost cetrainly 1 everywhere
1522 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1638 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1523 ? 1 1639 ? 1
1524 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1640 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1525 1641
1526 unless ($CHLD_W) { 1642 unless ($CHLD_W) {
1527 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1643 $CHLD_W = AE::signal CHLD => \&_sigchld;
1528 # child could be a zombie already, so make at least one round 1644 # child could be a zombie already, so make at least one round
1529 &_sigchld; 1645 &_sigchld;
1530 } 1646 }
1531 1647
1532 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1648 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1533} 1649 };
1534 1650
1535sub AnyEvent::Base::child::DESTROY { 1651 *AnyEvent::Base::child::DESTROY = sub {
1536 my ($pid, $cb) = @{$_[0]}; 1652 my ($pid, $cb) = @{$_[0]};
1537 1653
1538 delete $PID_CB{$pid}{$cb}; 1654 delete $PID_CB{$pid}{$cb};
1539 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1655 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1540 1656
1541 undef $CHLD_W unless keys %PID_CB; 1657 undef $CHLD_W unless keys %PID_CB;
1658 };
1659 };
1660 die if $@;
1661
1662 &child
1542} 1663}
1543 1664
1544# idle emulation is done by simply using a timer, regardless 1665# idle emulation is done by simply using a timer, regardless
1545# of whether the process is idle or not, and not letting 1666# of whether the process is idle or not, and not letting
1546# the callback use more than 50% of the time. 1667# the callback use more than 50% of the time.
1547sub idle { 1668sub idle {
1669 eval q{ # poor man's autoloading {}
1670 *idle = sub {
1548 my (undef, %arg) = @_; 1671 my (undef, %arg) = @_;
1549 1672
1550 my ($cb, $w, $rcb) = $arg{cb}; 1673 my ($cb, $w, $rcb) = $arg{cb};
1551 1674
1552 $rcb = sub { 1675 $rcb = sub {
1553 if ($cb) { 1676 if ($cb) {
1554 $w = _time; 1677 $w = _time;
1555 &$cb; 1678 &$cb;
1556 $w = _time - $w; 1679 $w = _time - $w;
1557 1680
1558 # never use more then 50% of the time for the idle watcher, 1681 # never use more then 50% of the time for the idle watcher,
1559 # within some limits 1682 # within some limits
1560 $w = 0.0001 if $w < 0.0001; 1683 $w = 0.0001 if $w < 0.0001;
1561 $w = 5 if $w > 5; 1684 $w = 5 if $w > 5;
1562 1685
1563 $w = AnyEvent->timer (after => $w, cb => $rcb); 1686 $w = AE::timer $w, 0, $rcb;
1564 } else { 1687 } else {
1565 # clean up... 1688 # clean up...
1566 undef $w; 1689 undef $w;
1567 undef $rcb; 1690 undef $rcb;
1691 }
1692 };
1693
1694 $w = AE::timer 0.05, 0, $rcb;
1695
1696 bless \\$cb, "AnyEvent::Base::idle"
1568 } 1697 };
1698
1699 *AnyEvent::Base::idle::DESTROY = sub {
1700 undef $${$_[0]};
1701 };
1569 }; 1702 };
1703 die if $@;
1570 1704
1571 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1705 &idle
1572
1573 bless \\$cb, "AnyEvent::Base::idle"
1574}
1575
1576sub AnyEvent::Base::idle::DESTROY {
1577 undef $${$_[0]};
1578} 1706}
1579 1707
1580package AnyEvent::CondVar; 1708package AnyEvent::CondVar;
1581 1709
1582our @ISA = AnyEvent::CondVar::Base::; 1710our @ISA = AnyEvent::CondVar::Base::;
1630 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1758 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1631 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1759 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1632} 1760}
1633 1761
1634sub cb { 1762sub cb {
1635 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1763 my $cv = shift;
1764
1765 @_
1766 and $cv->{_ae_cb} = shift
1767 and $cv->{_ae_sent}
1768 and (delete $cv->{_ae_cb})->($cv);
1769
1636 $_[0]{_ae_cb} 1770 $cv->{_ae_cb}
1637} 1771}
1638 1772
1639sub begin { 1773sub begin {
1640 ++$_[0]{_ae_counter}; 1774 ++$_[0]{_ae_counter};
1641 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1775 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1647} 1781}
1648 1782
1649# undocumented/compatibility with pre-3.4 1783# undocumented/compatibility with pre-3.4
1650*broadcast = \&send; 1784*broadcast = \&send;
1651*wait = \&_wait; 1785*wait = \&_wait;
1652
1653#############################################################################
1654# "new" API, currently only emulation of it
1655#############################################################################
1656
1657package AE;
1658
1659sub io($$$) {
1660 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1661}
1662
1663sub timer($$$) {
1664 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
1665}
1666
1667sub signal($$) {
1668 AnyEvent->signal (signal => $_[0], cb => $_[1]);
1669}
1670
1671sub child($$) {
1672 AnyEvent->child (pid => $_[0], cb => $_[1]);
1673}
1674
1675sub idle($) {
1676 AnyEvent->idle (cb => $_[0]);
1677}
1678
1679sub cv() {
1680 AnyEvent->condvar
1681}
1682
1683sub now() {
1684 AnyEvent->now
1685}
1686
1687sub now_update() {
1688 AnyEvent->now_update
1689}
1690
1691sub time() {
1692 AnyEvent->time
1693}
1694 1786
1695=head1 ERROR AND EXCEPTION HANDLING 1787=head1 ERROR AND EXCEPTION HANDLING
1696 1788
1697In general, AnyEvent does not do any error handling - it relies on the 1789In general, AnyEvent does not do any error handling - it relies on the
1698caller to do that if required. The L<AnyEvent::Strict> module (see also 1790caller to do that if required. The L<AnyEvent::Strict> module (see also
1892 warn "read: $input\n"; # output what has been read 1984 warn "read: $input\n"; # output what has been read
1893 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1985 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1894 }, 1986 },
1895 ); 1987 );
1896 1988
1897 my $time_watcher; # can only be used once
1898
1899 sub new_timer {
1900 $timer = AnyEvent->timer (after => 1, cb => sub { 1989 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1901 warn "timeout\n"; # print 'timeout' about every second 1990 warn "timeout\n"; # print 'timeout' at most every second
1902 &new_timer; # and restart the time
1903 }); 1991 });
1904 }
1905
1906 new_timer; # create first timer
1907 1992
1908 $cv->recv; # wait until user enters /^q/i 1993 $cv->recv; # wait until user enters /^q/i
1909 1994
1910=head1 REAL-WORLD EXAMPLE 1995=head1 REAL-WORLD EXAMPLE
1911 1996
1984 2069
1985The actual code goes further and collects all errors (C<die>s, exceptions) 2070The actual code goes further and collects all errors (C<die>s, exceptions)
1986that occurred during request processing. The C<result> method detects 2071that occurred during request processing. The C<result> method detects
1987whether an exception as thrown (it is stored inside the $txn object) 2072whether an exception as thrown (it is stored inside the $txn object)
1988and just throws the exception, which means connection errors and other 2073and just throws the exception, which means connection errors and other
1989problems get reported tot he code that tries to use the result, not in a 2074problems get reported to the code that tries to use the result, not in a
1990random callback. 2075random callback.
1991 2076
1992All of this enables the following usage styles: 2077All of this enables the following usage styles:
1993 2078
19941. Blocking: 20791. Blocking:
2042through AnyEvent. The benchmark creates a lot of timers (with a zero 2127through AnyEvent. The benchmark creates a lot of timers (with a zero
2043timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2128timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
2044which it is), lets them fire exactly once and destroys them again. 2129which it is), lets them fire exactly once and destroys them again.
2045 2130
2046Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2131Source code for this benchmark is found as F<eg/bench> in the AnyEvent
2047distribution. 2132distribution. It uses the L<AE> interface, which makes a real difference
2133for the EV and Perl backends only.
2048 2134
2049=head3 Explanation of the columns 2135=head3 Explanation of the columns
2050 2136
2051I<watcher> is the number of event watchers created/destroyed. Since 2137I<watcher> is the number of event watchers created/destroyed. Since
2052different event models feature vastly different performances, each event 2138different event models feature vastly different performances, each event
2073watcher. 2159watcher.
2074 2160
2075=head3 Results 2161=head3 Results
2076 2162
2077 name watchers bytes create invoke destroy comment 2163 name watchers bytes create invoke destroy comment
2078 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2164 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2079 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2165 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2080 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2166 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2081 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2167 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2082 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2168 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2083 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2169 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2084 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 2170 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2085 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 2171 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2086 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2172 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2087 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2173 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2088 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2174 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2089 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2175 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2090 2176
2091=head3 Discussion 2177=head3 Discussion
2092 2178
2093The benchmark does I<not> measure scalability of the event loop very 2179The benchmark does I<not> measure scalability of the event loop very
2094well. For example, a select-based event loop (such as the pure perl one) 2180well. For example, a select-based event loop (such as the pure perl one)
2106benchmark machine, handling an event takes roughly 1600 CPU cycles with 2192benchmark machine, handling an event takes roughly 1600 CPU cycles with
2107EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2193EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2108cycles with POE. 2194cycles with POE.
2109 2195
2110C<EV> is the sole leader regarding speed and memory use, which are both 2196C<EV> is the sole leader regarding speed and memory use, which are both
2111maximal/minimal, respectively. Even when going through AnyEvent, it uses 2197maximal/minimal, respectively. When using the L<AE> API there is zero
2198overhead (when going through the AnyEvent API create is about 5-6 times
2199slower, with other times being equal, so still uses far less memory than
2112far less memory than any other event loop and is still faster than Event 2200any other event loop and is still faster than Event natively).
2113natively.
2114 2201
2115The pure perl implementation is hit in a few sweet spots (both the 2202The pure perl implementation is hit in a few sweet spots (both the
2116constant timeout and the use of a single fd hit optimisations in the perl 2203constant timeout and the use of a single fd hit optimisations in the perl
2117interpreter and the backend itself). Nevertheless this shows that it 2204interpreter and the backend itself). Nevertheless this shows that it
2118adds very little overhead in itself. Like any select-based backend its 2205adds very little overhead in itself. Like any select-based backend its
2192In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2279In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2193(1%) are active. This mirrors the activity of large servers with many 2280(1%) are active. This mirrors the activity of large servers with many
2194connections, most of which are idle at any one point in time. 2281connections, most of which are idle at any one point in time.
2195 2282
2196Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2283Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2197distribution. 2284distribution. It uses the L<AE> interface, which makes a real difference
2285for the EV and Perl backends only.
2198 2286
2199=head3 Explanation of the columns 2287=head3 Explanation of the columns
2200 2288
2201I<sockets> is the number of sockets, and twice the number of "servers" (as 2289I<sockets> is the number of sockets, and twice the number of "servers" (as
2202each server has a read and write socket end). 2290each server has a read and write socket end).
2210a new one that moves the timeout into the future. 2298a new one that moves the timeout into the future.
2211 2299
2212=head3 Results 2300=head3 Results
2213 2301
2214 name sockets create request 2302 name sockets create request
2215 EV 20000 69.01 11.16 2303 EV 20000 62.66 7.99
2216 Perl 20000 73.32 35.87 2304 Perl 20000 68.32 32.64
2217 IOAsync 20000 157.00 98.14 epoll 2305 IOAsync 20000 174.06 101.15 epoll
2218 IOAsync 20000 159.31 616.06 poll 2306 IOAsync 20000 174.67 610.84 poll
2219 Event 20000 212.62 257.32 2307 Event 20000 202.69 242.91
2220 Glib 20000 651.16 1896.30 2308 Glib 20000 557.01 1689.52
2221 POE 20000 349.67 12317.24 uses POE::Loop::Event 2309 POE 20000 341.54 12086.32 uses POE::Loop::Event
2222 2310
2223=head3 Discussion 2311=head3 Discussion
2224 2312
2225This benchmark I<does> measure scalability and overall performance of the 2313This benchmark I<does> measure scalability and overall performance of the
2226particular event loop. 2314particular event loop.
2352As you can see, the AnyEvent + EV combination even beats the 2440As you can see, the AnyEvent + EV combination even beats the
2353hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2441hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2354backend easily beats IO::Lambda and POE. 2442backend easily beats IO::Lambda and POE.
2355 2443
2356And even the 100% non-blocking version written using the high-level (and 2444And even the 100% non-blocking version written using the high-level (and
2357slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2445slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2358large margin, even though it does all of DNS, tcp-connect and socket I/O 2446higher level ("unoptimised") abstractions by a large margin, even though
2359in a non-blocking way. 2447it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2360 2448
2361The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2449The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2362F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2450F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2363part of the IO::lambda distribution and were used without any changes. 2451part of the IO::Lambda distribution and were used without any changes.
2364 2452
2365 2453
2366=head1 SIGNALS 2454=head1 SIGNALS
2367 2455
2368AnyEvent currently installs handlers for these signals: 2456AnyEvent currently installs handlers for these signals:
2410it's built-in modules) are required to use it. 2498it's built-in modules) are required to use it.
2411 2499
2412That does not mean that AnyEvent won't take advantage of some additional 2500That does not mean that AnyEvent won't take advantage of some additional
2413modules if they are installed. 2501modules if they are installed.
2414 2502
2415This section epxlains which additional modules will be used, and how they 2503This section explains which additional modules will be used, and how they
2416affect AnyEvent's operetion. 2504affect AnyEvent's operation.
2417 2505
2418=over 4 2506=over 4
2419 2507
2420=item L<Async::Interrupt> 2508=item L<Async::Interrupt>
2421 2509
2426catch the signals) with some delay (default is 10 seconds, look for 2514catch the signals) with some delay (default is 10 seconds, look for
2427C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2515C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2428 2516
2429If this module is available, then it will be used to implement signal 2517If this module is available, then it will be used to implement signal
2430catching, which means that signals will not be delayed, and the event loop 2518catching, which means that signals will not be delayed, and the event loop
2431will not be interrupted regularly, which is more efficient (And good for 2519will not be interrupted regularly, which is more efficient (and good for
2432battery life on laptops). 2520battery life on laptops).
2433 2521
2434This affects not just the pure-perl event loop, but also other event loops 2522This affects not just the pure-perl event loop, but also other event loops
2435that have no signal handling on their own (e.g. Glib, Tk, Qt). 2523that have no signal handling on their own (e.g. Glib, Tk, Qt).
2436 2524
2448automatic timer adjustments even when no monotonic clock is available, 2536automatic timer adjustments even when no monotonic clock is available,
2449can take avdantage of advanced kernel interfaces such as C<epoll> and 2537can take avdantage of advanced kernel interfaces such as C<epoll> and
2450C<kqueue>, and is the fastest backend I<by far>. You can even embed 2538C<kqueue>, and is the fastest backend I<by far>. You can even embed
2451L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). 2539L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2452 2540
2541If you only use backends that rely on another event loop (e.g. C<Tk>),
2542then this module will do nothing for you.
2543
2453=item L<Guard> 2544=item L<Guard>
2454 2545
2455The guard module, when used, will be used to implement 2546The guard module, when used, will be used to implement
2456C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a 2547C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2457lot less memory), but otherwise doesn't affect guard operation much. It is 2548lot less memory), but otherwise doesn't affect guard operation much. It is
2458purely used for performance. 2549purely used for performance.
2459 2550
2460=item L<JSON> and L<JSON::XS> 2551=item L<JSON> and L<JSON::XS>
2461 2552
2462This module is required when you want to read or write JSON data via 2553One of these modules is required when you want to read or write JSON data
2463L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2554via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2464advantage of the ultra-high-speed L<JSON::XS> module when it is installed. 2555advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2465
2466In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2467installed.
2468 2556
2469=item L<Net::SSLeay> 2557=item L<Net::SSLeay>
2470 2558
2471Implementing TLS/SSL in Perl is certainly interesting, but not very 2559Implementing TLS/SSL in Perl is certainly interesting, but not very
2472worthwhile: If this module is installed, then L<AnyEvent::Handle> (with 2560worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2483 2571
2484 2572
2485=head1 FORK 2573=head1 FORK
2486 2574
2487Most event libraries are not fork-safe. The ones who are usually are 2575Most event libraries are not fork-safe. The ones who are usually are
2488because they rely on inefficient but fork-safe C<select> or C<poll> 2576because they rely on inefficient but fork-safe C<select> or C<poll> calls
2489calls. Only L<EV> is fully fork-aware. 2577- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
2578are usually badly thought-out hacks that are incompatible with fork in
2579one way or another. Only L<EV> is fully fork-aware and ensures that you
2580continue event-processing in both parent and child (or both, if you know
2581what you are doing).
2582
2583This means that, in general, you cannot fork and do event processing in
2584the child if the event library was initialised before the fork (which
2585usually happens when the first AnyEvent watcher is created, or the library
2586is loaded).
2490 2587
2491If you have to fork, you must either do so I<before> creating your first 2588If you have to fork, you must either do so I<before> creating your first
2492watcher OR you must not use AnyEvent at all in the child OR you must do 2589watcher OR you must not use AnyEvent at all in the child OR you must do
2493something completely out of the scope of AnyEvent. 2590something completely out of the scope of AnyEvent.
2591
2592The problem of doing event processing in the parent I<and> the child
2593is much more complicated: even for backends that I<are> fork-aware or
2594fork-safe, their behaviour is not usually what you want: fork clones all
2595watchers, that means all timers, I/O watchers etc. are active in both
2596parent and child, which is almost never what you want. USing C<exec>
2597to start worker children from some kind of manage rprocess is usually
2598preferred, because it is much easier and cleaner, at the expense of having
2599to have another binary.
2494 2600
2495 2601
2496=head1 SECURITY CONSIDERATIONS 2602=head1 SECURITY CONSIDERATIONS
2497 2603
2498AnyEvent can be forced to load any event model via 2604AnyEvent can be forced to load any event model via

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines