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.269 by root, Fri Jul 31 20:16:29 2009 UTC vs.
Revision 1.329 by root, Sun Jul 11 05:44:22 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 => ...
135 use AnyEvent; 138 use AnyEvent;
136 139
137 # .. AnyEvent will likely default to Tk 140 # .. AnyEvent will likely default to Tk
138 141
139The I<likely> means that, if any module loads another event model and 142The I<likely> means that, if any module loads another event model and
140starts using it, all bets are off. Maybe you should tell their authors to 143starts using it, all bets are off - this case should be very rare though,
141use AnyEvent so their modules work together with others seamlessly... 144as very few modules hardcode event loops without announcing this very
145loudly.
142 146
143The pure-perl implementation of AnyEvent is called 147The pure-perl implementation of AnyEvent is called
144C<AnyEvent::Impl::Perl>. Like other event modules you can load it 148C<AnyEvent::Impl::Perl>. Like other event modules you can load it
145explicitly and enjoy the high availability of that event loop :) 149explicitly and enjoy the high availability of that event loop :)
146 150
363might affect timers and time-outs. 367might affect timers and time-outs.
364 368
365When this is the case, you can call this method, which will update the 369When this is the case, you can call this method, which will update the
366event loop's idea of "current time". 370event loop's idea of "current time".
367 371
372A typical example would be a script in a web server (e.g. C<mod_perl>) -
373when mod_perl executes the script, then the event loop will have the wrong
374idea about the "current time" (being potentially far in the past, when the
375script ran the last time). In that case you should arrange a call to C<<
376AnyEvent->now_update >> each time the web server process wakes up again
377(e.g. at the start of your script, or in a handler).
378
368Note that updating the time I<might> cause some events to be handled. 379Note that updating the time I<might> cause some events to be handled.
369 380
370=back 381=back
371 382
372=head2 SIGNAL WATCHERS 383=head2 SIGNAL WATCHERS
395correctly. 406correctly.
396 407
397Example: exit on SIGINT 408Example: exit on SIGINT
398 409
399 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 410 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
411
412=head3 Restart Behaviour
413
414While restart behaviour is up to the event loop implementation, most will
415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
416pure perl implementation).
417
418=head3 Safe/Unsafe Signals
419
420Perl signals can be either "safe" (synchronous to opcode handling) or
421"unsafe" (asynchronous) - the former might get delayed indefinitely, the
422latter might corrupt your memory.
423
424AnyEvent signal handlers are, in addition, synchronous to the event loop,
425i.e. they will not interrupt your running perl program but will only be
426called as part of the normal event handling (just like timer, I/O etc.
427callbacks, too).
400 428
401=head3 Signal Races, Delays and Workarounds 429=head3 Signal Races, Delays and Workarounds
402 430
403Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 431Many 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 432callbacks to signals in a generic way, which is a pity, as you cannot
479 507
480=head2 IDLE WATCHERS 508=head2 IDLE WATCHERS
481 509
482 $w = AnyEvent->idle (cb => <callback>); 510 $w = AnyEvent->idle (cb => <callback>);
483 511
484Sometimes there is a need to do something, but it is not so important 512Repeatedly invoke the callback after the process becomes idle, until
485to do it instantly, but only when there is nothing better to do. This 513either the watcher is destroyed or new events have been detected.
486"nothing better to do" is usually defined to be "no other events need
487attention by the event loop".
488 514
489Idle watchers ideally get invoked when the event loop has nothing 515Idle watchers are useful when there is a need to do something, but it
490better to do, just before it would block the process to wait for new 516is not so important (or wise) to do it instantly. The callback will be
491events. Instead of blocking, the idle watcher is invoked. 517invoked only when there is "nothing better to do", which is usually
518defined as "all outstanding events have been handled and no new events
519have been detected". That means that idle watchers ideally get invoked
520when the event loop has just polled for new events but none have been
521detected. Instead of blocking to wait for more events, the idle watchers
522will be invoked.
492 523
493Most event loops unfortunately do not really support idle watchers (only 524Unfortunately, most event loops do not really support idle watchers (only
494EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent 525EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
495will simply call the callback "from time to time". 526will simply call the callback "from time to time".
496 527
497Example: read lines from STDIN, but only process them when the 528Example: read lines from STDIN, but only process them when the
498program is otherwise idle: 529program is otherwise idle:
526will actively watch for new events and call your callbacks. 557will actively watch for new events and call your callbacks.
527 558
528AnyEvent is slightly different: it expects somebody else to run the event 559AnyEvent is slightly different: it expects somebody else to run the event
529loop and will only block when necessary (usually when told by the user). 560loop and will only block when necessary (usually when told by the user).
530 561
531The instrument to do that is called a "condition variable", so called 562The tool to do that is called a "condition variable", so called because
532because they represent a condition that must become true. 563they represent a condition that must become true.
533 564
534Now is probably a good time to look at the examples further below. 565Now is probably a good time to look at the examples further below.
535 566
536Condition variables can be created by calling the C<< AnyEvent->condvar 567Condition variables can be created by calling the C<< AnyEvent->condvar
537>> method, usually without arguments. The only argument pair allowed is 568>> method, usually without arguments. The only argument pair allowed is
542After creation, the condition variable is "false" until it becomes "true" 573After creation, the condition variable is "false" until it becomes "true"
543by calling the C<send> method (or calling the condition variable as if it 574by calling the C<send> method (or calling the condition variable as if it
544were a callback, read about the caveats in the description for the C<< 575were a callback, read about the caveats in the description for the C<<
545->send >> method). 576->send >> method).
546 577
547Condition variables are similar to callbacks, except that you can 578Since condition variables are the most complex part of the AnyEvent API, here are
548optionally wait for them. They can also be called merge points - points 579some different mental models of what they are - pick the ones you can connect to:
549in time where multiple outstanding events have been processed. And yet 580
550another way to call them is transactions - each condition variable can be 581=over 4
551used to represent a transaction, which finishes at some point and delivers 582
552a result. And yet some people know them as "futures" - a promise to 583=item * Condition variables are like callbacks - you can call them (and pass them instead
553compute/deliver something that you can wait for. 584of callbacks). Unlike callbacks however, you can also wait for them to be called.
585
586=item * Condition variables are signals - one side can emit or send them,
587the other side can wait for them, or install a handler that is called when
588the signal fires.
589
590=item * Condition variables are like "Merge Points" - points in your program
591where you merge multiple independent results/control flows into one.
592
593=item * Condition variables represent a transaction - function that start
594some kind of transaction can return them, leaving the caller the choice
595between waiting in a blocking fashion, or setting a callback.
596
597=item * Condition variables represent future values, or promises to deliver
598some result, long before the result is available.
599
600=back
554 601
555Condition variables are very useful to signal that something has finished, 602Condition variables are very useful to signal that something has finished,
556for example, if you write a module that does asynchronous http requests, 603for example, if you write a module that does asynchronous http requests,
557then a condition variable would be the ideal candidate to signal the 604then a condition variable would be the ideal candidate to signal the
558availability of results. The user can either act when the callback is 605availability of results. The user can either act when the callback is
579eventually calls C<< -> send >>, and the "consumer side", which waits 626eventually calls C<< -> send >>, and the "consumer side", which waits
580for the send to occur. 627for the send to occur.
581 628
582Example: wait for a timer. 629Example: wait for a timer.
583 630
584 # wait till the result is ready 631 # condition: "wait till the timer is fired"
585 my $result_ready = AnyEvent->condvar; 632 my $timer_fired = AnyEvent->condvar;
586 633
587 # do something such as adding a timer 634 # create the timer - we could wait for, say
588 # or socket watcher the calls $result_ready->send 635 # a handle becomign ready, or even an
589 # when the "result" is ready. 636 # AnyEvent::HTTP request to finish, but
590 # in this case, we simply use a timer: 637 # in this case, we simply use a timer:
591 my $w = AnyEvent->timer ( 638 my $w = AnyEvent->timer (
592 after => 1, 639 after => 1,
593 cb => sub { $result_ready->send }, 640 cb => sub { $timer_fired->send },
594 ); 641 );
595 642
596 # this "blocks" (while handling events) till the callback 643 # this "blocks" (while handling events) till the callback
597 # calls -<send 644 # calls ->send
598 $result_ready->recv; 645 $timer_fired->recv;
599 646
600Example: wait for a timer, but take advantage of the fact that condition 647Example: wait for a timer, but take advantage of the fact that condition
601variables are also callable directly. 648variables are also callable directly.
602 649
603 my $done = AnyEvent->condvar; 650 my $done = AnyEvent->condvar;
666one. For example, a function that pings many hosts in parallel might want 713one. For example, a function that pings many hosts in parallel might want
667to use a condition variable for the whole process. 714to use a condition variable for the whole process.
668 715
669Every call to C<< ->begin >> will increment a counter, and every call to 716Every call to C<< ->begin >> will increment a counter, and every call to
670C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 717C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
671>>, the (last) callback passed to C<begin> will be executed. That callback 718>>, the (last) callback passed to C<begin> will be executed, passing the
672is I<supposed> to call C<< ->send >>, but that is not required. If no 719condvar as first argument. That callback is I<supposed> to call C<< ->send
673callback was set, C<send> will be called without any arguments. 720>>, but that is not required. If no group callback was set, C<send> will
721be called without any arguments.
674 722
675You can think of C<< $cv->send >> giving you an OR condition (one call 723You can think of C<< $cv->send >> giving you an OR condition (one call
676sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND 724sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
677condition (all C<begin> calls must be C<end>'ed before the condvar sends). 725condition (all C<begin> calls must be C<end>'ed before the condvar sends).
678 726
705begung can potentially be zero: 753begung can potentially be zero:
706 754
707 my $cv = AnyEvent->condvar; 755 my $cv = AnyEvent->condvar;
708 756
709 my %result; 757 my %result;
710 $cv->begin (sub { $cv->send (\%result) }); 758 $cv->begin (sub { shift->send (\%result) });
711 759
712 for my $host (@list_of_hosts) { 760 for my $host (@list_of_hosts) {
713 $cv->begin; 761 $cv->begin;
714 ping_host_then_call_callback $host, sub { 762 ping_host_then_call_callback $host, sub {
715 $result{$host} = ...; 763 $result{$host} = ...;
806=over 4 854=over 4
807 855
808=item Backends that are autoprobed when no other event loop can be found. 856=item Backends that are autoprobed when no other event loop can be found.
809 857
810EV is the preferred backend when no other event loop seems to be in 858EV is the preferred backend when no other event loop seems to be in
811use. If EV is not installed, then AnyEvent will try Event, and, failing 859use. If EV is not installed, then AnyEvent will fall back to its own
812that, will fall back to its own pure-perl implementation, which is 860pure-perl implementation, which is available everywhere as it comes with
813available everywhere as it comes with AnyEvent itself. 861AnyEvent itself.
814 862
815 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 863 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
816 AnyEvent::Impl::Event based on Event, very stable, few glitches.
817 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 864 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
818 865
819=item Backends that are transparently being picked up when they are used. 866=item Backends that are transparently being picked up when they are used.
820 867
821These will be used when they are currently loaded when the first watcher 868These will be used when they are currently loaded when the first watcher
822is created, in which case it is assumed that the application is using 869is created, in which case it is assumed that the application is using
823them. This means that AnyEvent will automatically pick the right backend 870them. This means that AnyEvent will automatically pick the right backend
824when the main program loads an event module before anything starts to 871when the main program loads an event module before anything starts to
825create watchers. Nothing special needs to be done by the main program. 872create watchers. Nothing special needs to be done by the main program.
826 873
874 AnyEvent::Impl::Event based on Event, very stable, few glitches.
827 AnyEvent::Impl::Glib based on Glib, slow but very stable. 875 AnyEvent::Impl::Glib based on Glib, slow but very stable.
828 AnyEvent::Impl::Tk based on Tk, very broken. 876 AnyEvent::Impl::Tk based on Tk, very broken.
829 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 877 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
830 AnyEvent::Impl::POE based on POE, very slow, some limitations. 878 AnyEvent::Impl::POE based on POE, very slow, some limitations.
831 AnyEvent::Impl::Irssi used when running within irssi. 879 AnyEvent::Impl::Irssi used when running within irssi.
941You should check C<$AnyEvent::MODEL> before adding to this array, though: 989You should check C<$AnyEvent::MODEL> before adding to this array, though:
942if it is defined then the event loop has already been detected, and the 990if it is defined then the event loop has already been detected, and the
943array will be ignored. 991array will be ignored.
944 992
945Best use C<AnyEvent::post_detect { BLOCK }> when your application allows 993Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
946it,as it takes care of these details. 994it, as it takes care of these details.
947 995
948This variable is mainly useful for modules that can do something useful 996This variable is mainly useful for modules that can do something useful
949when AnyEvent is used and thus want to know when it is initialised, but do 997when AnyEvent is used and thus want to know when it is initialised, but do
950not need to even load it by default. This array provides the means to hook 998not need to even load it by default. This array provides the means to hook
951into AnyEvent passively, without loading it. 999into AnyEvent passively, without loading it.
1000
1001Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
1002together, you could put this into Coro (this is the actual code used by
1003Coro to accomplish this):
1004
1005 if (defined $AnyEvent::MODEL) {
1006 # AnyEvent already initialised, so load Coro::AnyEvent
1007 require Coro::AnyEvent;
1008 } else {
1009 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1010 # as soon as it is
1011 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1012 }
952 1013
953=back 1014=back
954 1015
955=head1 WHAT TO DO IN A MODULE 1016=head1 WHAT TO DO IN A MODULE
956 1017
1013=head1 OTHER MODULES 1074=head1 OTHER MODULES
1014 1075
1015The following is a non-exhaustive list of additional modules that use 1076The following is a non-exhaustive list of additional modules that use
1016AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1077AnyEvent as a client and can therefore be mixed easily with other AnyEvent
1017modules and other event loops in the same program. Some of the modules 1078modules and other event loops in the same program. Some of the modules
1018come with AnyEvent, most are available via CPAN. 1079come as part of AnyEvent, the others are available via CPAN.
1019 1080
1020=over 4 1081=over 4
1021 1082
1022=item L<AnyEvent::Util> 1083=item L<AnyEvent::Util>
1023 1084
1038 1099
1039=item L<AnyEvent::DNS> 1100=item L<AnyEvent::DNS>
1040 1101
1041Provides rich asynchronous DNS resolver capabilities. 1102Provides rich asynchronous DNS resolver capabilities.
1042 1103
1104=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1105
1106Implement event-based interfaces to the protocols of the same name (for
1107the curious, IGS is the International Go Server and FCP is the Freenet
1108Client Protocol).
1109
1110=item L<AnyEvent::Handle::UDP>
1111
1112Here be danger!
1113
1114As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1115there are so many things wrong with AnyEvent::Handle::UDP, most notably
1116it's use of a stream-based API with a protocol that isn't streamable, that
1117the only way to improve it is to delete it.
1118
1119It features data corruption (but typically only under load) and general
1120confusion. On top, the author is not only clueless about UDP but also
1121fact-resistant - some gems of his understanding: "connect doesn't work
1122with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1123packets", "I don't need to implement proper error checking as UDP doesn't
1124support error checking" and so on - he doesn't even understand what's
1125wrong with his module when it is explained to him.
1126
1043=item L<AnyEvent::HTTP> 1127=item L<AnyEvent::DBI>
1044 1128
1045A simple-to-use HTTP library that is capable of making a lot of concurrent 1129Executes L<DBI> requests asynchronously in a proxy process for you,
1046HTTP requests. 1130notifying you in an event-bnased way when the operation is finished.
1131
1132=item L<AnyEvent::AIO>
1133
1134Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1135toolbox of every event programmer. AnyEvent::AIO transparently fuses
1136L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1137file I/O, and much more.
1047 1138
1048=item L<AnyEvent::HTTPD> 1139=item L<AnyEvent::HTTPD>
1049 1140
1050Provides a simple web application server framework. 1141A simple embedded webserver.
1051 1142
1052=item L<AnyEvent::FastPing> 1143=item L<AnyEvent::FastPing>
1053 1144
1054The fastest ping in the west. 1145The fastest ping in the west.
1055
1056=item L<AnyEvent::DBI>
1057
1058Executes L<DBI> requests asynchronously in a proxy process.
1059
1060=item L<AnyEvent::AIO>
1061
1062Truly asynchronous I/O, should be in the toolbox of every event
1063programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1064together.
1065
1066=item L<AnyEvent::BDB>
1067
1068Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1069L<BDB> and AnyEvent together.
1070
1071=item L<AnyEvent::GPSD>
1072
1073A non-blocking interface to gpsd, a daemon delivering GPS information.
1074
1075=item L<AnyEvent::IRC>
1076
1077AnyEvent based IRC client module family (replacing the older Net::IRC3).
1078
1079=item L<AnyEvent::XMPP>
1080
1081AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1082Net::XMPP2>.
1083
1084=item L<AnyEvent::IGS>
1085
1086A non-blocking interface to the Internet Go Server protocol (used by
1087L<App::IGS>).
1088
1089=item L<Net::FCP>
1090
1091AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1092of AnyEvent.
1093
1094=item L<Event::ExecFlow>
1095
1096High level API for event-based execution flow control.
1097 1146
1098=item L<Coro> 1147=item L<Coro>
1099 1148
1100Has special support for AnyEvent via L<Coro::AnyEvent>. 1149Has special support for AnyEvent via L<Coro::AnyEvent>.
1101 1150
1105 1154
1106package AnyEvent; 1155package AnyEvent;
1107 1156
1108# basically a tuned-down version of common::sense 1157# basically a tuned-down version of common::sense
1109sub common_sense { 1158sub common_sense {
1110 # no warnings 1159 # from common:.sense 1.0
1111 ${^WARNING_BITS} ^= ${^WARNING_BITS}; 1160 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1112 # use strict vars subs 1161 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1113 $^H |= 0x00000600; 1162 $^H |= 0x00000600;
1114} 1163}
1115 1164
1116BEGIN { AnyEvent::common_sense } 1165BEGIN { AnyEvent::common_sense }
1117 1166
1118use Carp (); 1167use Carp ();
1119 1168
1120our $VERSION = 4.9; 1169our $VERSION = '5.271';
1121our $MODEL; 1170our $MODEL;
1122 1171
1123our $AUTOLOAD; 1172our $AUTOLOAD;
1124our @ISA; 1173our @ISA;
1125 1174
1126our @REGISTRY; 1175our @REGISTRY;
1127 1176
1128our $WIN32;
1129
1130our $VERBOSE; 1177our $VERBOSE;
1131 1178
1132BEGIN { 1179BEGIN {
1133 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1180 require "AnyEvent/constants.pl";
1181
1134 eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; 1182 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1135 1183
1136 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1184 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1137 if ${^TAINT}; 1185 if ${^TAINT};
1138 1186
1139 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1187 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1151 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1199 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1152} 1200}
1153 1201
1154my @models = ( 1202my @models = (
1155 [EV:: => AnyEvent::Impl::EV:: , 1], 1203 [EV:: => AnyEvent::Impl::EV:: , 1],
1156 [Event:: => AnyEvent::Impl::Event::, 1],
1157 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1204 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1158 # everything below here will not (normally) be autoprobed 1205 # everything below here will not (normally) be autoprobed
1159 # as the pureperl backend should work everywhere 1206 # as the pureperl backend should work everywhere
1160 # and is usually faster 1207 # and is usually faster
1208 [Event:: => AnyEvent::Impl::Event::, 1],
1161 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1209 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1162 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1210 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1163 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1211 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1164 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1212 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1165 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1213 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1168 [Prima:: => AnyEvent::Impl::POE::], 1216 [Prima:: => AnyEvent::Impl::POE::],
1169 # IO::Async is just too broken - we would need workarounds for its 1217 # IO::Async is just too broken - we would need workarounds for its
1170 # byzantine signal and broken child handling, among others. 1218 # byzantine signal and broken child handling, among others.
1171 # IO::Async is rather hard to detect, as it doesn't have any 1219 # IO::Async is rather hard to detect, as it doesn't have any
1172 # obvious default class. 1220 # obvious default class.
1173# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1221 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1174# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1222 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1175# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1223 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1224 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1176); 1225);
1177 1226
1178our %method = map +($_ => 1), 1227our %method = map +($_ => 1),
1179 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1228 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1180 1229
1181our @post_detect; 1230our @post_detect;
1182 1231
1183sub post_detect(&) { 1232sub post_detect(&) {
1184 my ($cb) = @_; 1233 my ($cb) = @_;
1185 1234
1186 if ($MODEL) {
1187 $cb->();
1188
1189 undef
1190 } else {
1191 push @post_detect, $cb; 1235 push @post_detect, $cb;
1192 1236
1193 defined wantarray 1237 defined wantarray
1194 ? bless \$cb, "AnyEvent::Util::postdetect" 1238 ? bless \$cb, "AnyEvent::Util::postdetect"
1195 : () 1239 : ()
1196 }
1197} 1240}
1198 1241
1199sub AnyEvent::Util::postdetect::DESTROY { 1242sub AnyEvent::Util::postdetect::DESTROY {
1200 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1243 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1201} 1244}
1202 1245
1203sub detect() { 1246sub detect() {
1247 # free some memory
1248 *detect = sub () { $MODEL };
1249
1250 local $!; # for good measure
1251 local $SIG{__DIE__};
1252
1253 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1254 my $model = "AnyEvent::Impl::$1";
1255 if (eval "require $model") {
1256 $MODEL = $model;
1257 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1258 } else {
1259 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1260 }
1261 }
1262
1263 # check for already loaded models
1204 unless ($MODEL) { 1264 unless ($MODEL) {
1205 local $SIG{__DIE__}; 1265 for (@REGISTRY, @models) {
1206 1266 my ($package, $model) = @$_;
1207 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1267 if (${"$package\::VERSION"} > 0) {
1208 my $model = "AnyEvent::Impl::$1";
1209 if (eval "require $model") { 1268 if (eval "require $model") {
1210 $MODEL = $model; 1269 $MODEL = $model;
1211 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; 1270 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1212 } else { 1271 last;
1213 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1272 }
1214 } 1273 }
1215 } 1274 }
1216 1275
1217 # check for already loaded models
1218 unless ($MODEL) { 1276 unless ($MODEL) {
1277 # try to autoload a model
1219 for (@REGISTRY, @models) { 1278 for (@REGISTRY, @models) {
1220 my ($package, $model) = @$_; 1279 my ($package, $model, $autoload) = @$_;
1280 if (
1281 $autoload
1282 and eval "require $package"
1221 if (${"$package\::VERSION"} > 0) { 1283 and ${"$package\::VERSION"} > 0
1222 if (eval "require $model") { 1284 and eval "require $model"
1285 ) {
1223 $MODEL = $model; 1286 $MODEL = $model;
1224 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1287 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1225 last; 1288 last;
1226 }
1227 } 1289 }
1228 } 1290 }
1229 1291
1230 unless ($MODEL) {
1231 # try to autoload a model
1232 for (@REGISTRY, @models) {
1233 my ($package, $model, $autoload) = @$_;
1234 if (
1235 $autoload
1236 and eval "require $package"
1237 and ${"$package\::VERSION"} > 0
1238 and eval "require $model"
1239 ) {
1240 $MODEL = $model;
1241 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1242 last;
1243 }
1244 }
1245
1246 $MODEL 1292 $MODEL
1247 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1293 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1248 }
1249 } 1294 }
1250
1251 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1252
1253 unshift @ISA, $MODEL;
1254
1255 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1256
1257 (shift @post_detect)->() while @post_detect;
1258 } 1295 }
1296
1297 @models = (); # free probe data
1298
1299 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1300 unshift @ISA, $MODEL;
1301
1302 # now nuke some methods that are overriden by the backend.
1303 # SUPER is not allowed.
1304 for (qw(time signal child idle)) {
1305 undef &{"AnyEvent::Base::$_"}
1306 if defined &{"$MODEL\::$_"};
1307 }
1308
1309 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1310
1311 (shift @post_detect)->() while @post_detect;
1312
1313 *post_detect = sub(&) {
1314 shift->();
1315
1316 undef
1317 };
1259 1318
1260 $MODEL 1319 $MODEL
1261} 1320}
1262 1321
1263sub AUTOLOAD { 1322sub AUTOLOAD {
1264 (my $func = $AUTOLOAD) =~ s/.*://; 1323 (my $func = $AUTOLOAD) =~ s/.*://;
1265 1324
1266 $method{$func} 1325 $method{$func}
1267 or Carp::croak "$func: not a valid method for AnyEvent objects"; 1326 or Carp::croak "$func: not a valid AnyEvent class method";
1268 1327
1269 detect unless $MODEL; 1328 detect;
1270 1329
1271 my $class = shift; 1330 my $class = shift;
1272 $class->$func (@_); 1331 $class->$func (@_);
1273} 1332}
1274 1333
1287 # we assume CLOEXEC is already set by perl in all important cases 1346 # we assume CLOEXEC is already set by perl in all important cases
1288 1347
1289 ($fh2, $rw) 1348 ($fh2, $rw)
1290} 1349}
1291 1350
1351=head1 SIMPLIFIED AE API
1352
1353Starting with version 5.0, AnyEvent officially supports a second, much
1354simpler, API that is designed to reduce the calling, typing and memory
1355overhead by using function call syntax and a fixed number of parameters.
1356
1357See the L<AE> manpage for details.
1358
1359=cut
1360
1361package AE;
1362
1363our $VERSION = $AnyEvent::VERSION;
1364
1365# fall back to the main API by default - backends and AnyEvent::Base
1366# implementations can overwrite these.
1367
1368sub io($$$) {
1369 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1370}
1371
1372sub timer($$$) {
1373 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1374}
1375
1376sub signal($$) {
1377 AnyEvent->signal (signal => $_[0], cb => $_[1])
1378}
1379
1380sub child($$) {
1381 AnyEvent->child (pid => $_[0], cb => $_[1])
1382}
1383
1384sub idle($) {
1385 AnyEvent->idle (cb => $_[0])
1386}
1387
1388sub cv(;&) {
1389 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1390}
1391
1392sub now() {
1393 AnyEvent->now
1394}
1395
1396sub now_update() {
1397 AnyEvent->now_update
1398}
1399
1400sub time() {
1401 AnyEvent->time
1402}
1403
1292package AnyEvent::Base; 1404package AnyEvent::Base;
1293 1405
1294# default implementations for many methods 1406# default implementations for many methods
1295 1407
1296sub _time { 1408sub time {
1409 eval q{ # poor man's autoloading {}
1297 # probe for availability of Time::HiRes 1410 # probe for availability of Time::HiRes
1298 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1411 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1299 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1412 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1300 *_time = \&Time::HiRes::time; 1413 *AE::time = \&Time::HiRes::time;
1301 # if (eval "use POSIX (); (POSIX::times())... 1414 # if (eval "use POSIX (); (POSIX::times())...
1302 } else { 1415 } else {
1303 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1416 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1304 *_time = sub { time }; # epic fail 1417 *AE::time = sub (){ time }; # epic fail
1418 }
1419
1420 *time = sub { AE::time }; # different prototypes
1305 } 1421 };
1422 die if $@;
1306 1423
1307 &_time 1424 &time
1308} 1425}
1309 1426
1310sub time { _time } 1427*now = \&time;
1311sub now { _time } 1428
1312sub now_update { } 1429sub now_update { }
1313 1430
1314# default implementation for ->condvar 1431# default implementation for ->condvar
1315 1432
1316sub condvar { 1433sub condvar {
1434 eval q{ # poor man's autoloading {}
1435 *condvar = sub {
1317 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1436 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1437 };
1438
1439 *AE::cv = sub (;&) {
1440 bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
1441 };
1442 };
1443 die if $@;
1444
1445 &condvar
1318} 1446}
1319 1447
1320# default implementation for ->signal 1448# default implementation for ->signal
1321 1449
1322our $HAVE_ASYNC_INTERRUPT; 1450our $HAVE_ASYNC_INTERRUPT;
1323 1451
1324sub _have_async_interrupt() { 1452sub _have_async_interrupt() {
1325 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} 1453 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1326 && eval "use Async::Interrupt 1.0 (); 1") 1454 && eval "use Async::Interrupt 1.02 (); 1")
1327 unless defined $HAVE_ASYNC_INTERRUPT; 1455 unless defined $HAVE_ASYNC_INTERRUPT;
1328 1456
1329 $HAVE_ASYNC_INTERRUPT 1457 $HAVE_ASYNC_INTERRUPT
1330} 1458}
1331 1459
1332our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1460our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1333our (%SIG_ASY, %SIG_ASY_W); 1461our (%SIG_ASY, %SIG_ASY_W);
1334our ($SIG_COUNT, $SIG_TW); 1462our ($SIG_COUNT, $SIG_TW);
1335 1463
1336sub _signal_exec {
1337 $HAVE_ASYNC_INTERRUPT
1338 ? $SIGPIPE_R->drain
1339 : sysread $SIGPIPE_R, my $dummy, 9;
1340
1341 while (%SIG_EV) {
1342 for (keys %SIG_EV) {
1343 delete $SIG_EV{$_};
1344 $_->() for values %{ $SIG_CB{$_} || {} };
1345 }
1346 }
1347}
1348
1349# install a dummy wakeup watcher to reduce signal catching latency 1464# install a dummy wakeup watcher to reduce signal catching latency
1465# used by Impls
1350sub _sig_add() { 1466sub _sig_add() {
1351 unless ($SIG_COUNT++) { 1467 unless ($SIG_COUNT++) {
1352 # try to align timer on a full-second boundary, if possible 1468 # try to align timer on a full-second boundary, if possible
1353 my $NOW = AnyEvent->now; 1469 my $NOW = AE::now;
1354 1470
1355 $SIG_TW = AnyEvent->timer ( 1471 $SIG_TW = AE::timer
1356 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1472 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1357 interval => $MAX_SIGNAL_LATENCY, 1473 $MAX_SIGNAL_LATENCY,
1358 cb => sub { }, # just for the PERL_ASYNC_CHECK 1474 sub { } # just for the PERL_ASYNC_CHECK
1359 ); 1475 ;
1360 } 1476 }
1361} 1477}
1362 1478
1363sub _sig_del { 1479sub _sig_del {
1364 undef $SIG_TW 1480 undef $SIG_TW
1365 unless --$SIG_COUNT; 1481 unless --$SIG_COUNT;
1366} 1482}
1367 1483
1368our $_sig_name_init; $_sig_name_init = sub { 1484our $_sig_name_init; $_sig_name_init = sub {
1369 eval q{ # poor man's autoloading 1485 eval q{ # poor man's autoloading {}
1370 undef $_sig_name_init; 1486 undef $_sig_name_init;
1371 1487
1372 if (_have_async_interrupt) { 1488 if (_have_async_interrupt) {
1373 *sig2num = \&Async::Interrupt::sig2num; 1489 *sig2num = \&Async::Interrupt::sig2num;
1374 *sig2name = \&Async::Interrupt::sig2name; 1490 *sig2name = \&Async::Interrupt::sig2name;
1401 # probe for availability of Async::Interrupt 1517 # probe for availability of Async::Interrupt
1402 if (_have_async_interrupt) { 1518 if (_have_async_interrupt) {
1403 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1519 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1404 1520
1405 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1521 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1406 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); 1522 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1407 1523
1408 } else { 1524 } else {
1409 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1525 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1410
1411 require Fcntl;
1412 1526
1413 if (AnyEvent::WIN32) { 1527 if (AnyEvent::WIN32) {
1414 require AnyEvent::Util; 1528 require AnyEvent::Util;
1415 1529
1416 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1530 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1417 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R; 1531 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1418 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case 1532 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1419 } else { 1533 } else {
1420 pipe $SIGPIPE_R, $SIGPIPE_W; 1534 pipe $SIGPIPE_R, $SIGPIPE_W;
1421 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; 1535 fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1422 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case 1536 fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1423 1537
1424 # not strictly required, as $^F is normally 2, but let's make sure... 1538 # not strictly required, as $^F is normally 2, but let's make sure...
1425 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; 1539 fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1426 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; 1540 fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1427 } 1541 }
1428 1542
1429 $SIGPIPE_R 1543 $SIGPIPE_R
1430 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1544 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1431 1545
1432 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1546 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1433 } 1547 }
1434 1548
1435 *signal = sub { 1549 *signal = $HAVE_ASYNC_INTERRUPT
1550 ? sub {
1436 my (undef, %arg) = @_; 1551 my (undef, %arg) = @_;
1437 1552
1438 my $signal = uc $arg{signal}
1439 or Carp::croak "required option 'signal' is missing";
1440
1441 if ($HAVE_ASYNC_INTERRUPT) {
1442 # async::interrupt 1553 # async::interrupt
1443
1444 $signal = sig2num $signal; 1554 my $signal = sig2num $arg{signal};
1445 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1555 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1446 1556
1447 $SIG_ASY{$signal} ||= new Async::Interrupt 1557 $SIG_ASY{$signal} ||= new Async::Interrupt
1448 cb => sub { undef $SIG_EV{$signal} }, 1558 cb => sub { undef $SIG_EV{$signal} },
1449 signal => $signal, 1559 signal => $signal,
1450 pipe => [$SIGPIPE_R->filenos], 1560 pipe => [$SIGPIPE_R->filenos],
1451 pipe_autodrain => 0, 1561 pipe_autodrain => 0,
1452 ; 1562 ;
1453 1563
1454 } else { 1564 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1565 }
1566 : sub {
1567 my (undef, %arg) = @_;
1568
1455 # pure perl 1569 # pure perl
1456
1457 # AE::Util has been loaded in signal
1458 $signal = sig2name $signal; 1570 my $signal = sig2name $arg{signal};
1459 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1571 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1460 1572
1461 $SIG{$signal} ||= sub { 1573 $SIG{$signal} ||= sub {
1462 local $!; 1574 local $!;
1463 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1575 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1464 undef $SIG_EV{$signal}; 1576 undef $SIG_EV{$signal};
1465 }; 1577 };
1466 1578
1467 # can't do signal processing without introducing races in pure perl, 1579 # can't do signal processing without introducing races in pure perl,
1468 # so limit the signal latency. 1580 # so limit the signal latency.
1469 _sig_add; 1581 _sig_add;
1470 }
1471 1582
1472 bless [$signal, $arg{cb}], "AnyEvent::Base::signal" 1583 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1584 }
1473 }; 1585 ;
1474 1586
1475 *AnyEvent::Base::signal::DESTROY = sub { 1587 *AnyEvent::Base::signal::DESTROY = sub {
1476 my ($signal, $cb) = @{$_[0]}; 1588 my ($signal, $cb) = @{$_[0]};
1477 1589
1478 _sig_del; 1590 _sig_del;
1485 # print weird messages, or just unconditionally exit 1597 # print weird messages, or just unconditionally exit
1486 # instead of getting the default action. 1598 # instead of getting the default action.
1487 undef $SIG{$signal} 1599 undef $SIG{$signal}
1488 unless keys %{ $SIG_CB{$signal} }; 1600 unless keys %{ $SIG_CB{$signal} };
1489 }; 1601 };
1602
1603 *_signal_exec = sub {
1604 $HAVE_ASYNC_INTERRUPT
1605 ? $SIGPIPE_R->drain
1606 : sysread $SIGPIPE_R, (my $dummy), 9;
1607
1608 while (%SIG_EV) {
1609 for (keys %SIG_EV) {
1610 delete $SIG_EV{$_};
1611 $_->() for values %{ $SIG_CB{$_} || {} };
1612 }
1613 }
1614 };
1490 }; 1615 };
1491 die if $@; 1616 die if $@;
1617
1492 &signal 1618 &signal
1493} 1619}
1494 1620
1495# default implementation for ->child 1621# default implementation for ->child
1496 1622
1497our %PID_CB; 1623our %PID_CB;
1498our $CHLD_W; 1624our $CHLD_W;
1499our $CHLD_DELAY_W; 1625our $CHLD_DELAY_W;
1500our $WNOHANG; 1626our $WNOHANG;
1501 1627
1628# used by many Impl's
1502sub _emit_childstatus($$) { 1629sub _emit_childstatus($$) {
1503 my (undef, $rpid, $rstatus) = @_; 1630 my (undef, $rpid, $rstatus) = @_;
1504 1631
1505 $_->($rpid, $rstatus) 1632 $_->($rpid, $rstatus)
1506 for values %{ $PID_CB{$rpid} || {} }, 1633 for values %{ $PID_CB{$rpid} || {} },
1507 values %{ $PID_CB{0} || {} }; 1634 values %{ $PID_CB{0} || {} };
1508} 1635}
1509 1636
1510sub _sigchld {
1511 my $pid;
1512
1513 AnyEvent->_emit_childstatus ($pid, $?)
1514 while ($pid = waitpid -1, $WNOHANG) > 0;
1515}
1516
1517sub child { 1637sub child {
1638 eval q{ # poor man's autoloading {}
1639 *_sigchld = sub {
1640 my $pid;
1641
1642 AnyEvent->_emit_childstatus ($pid, $?)
1643 while ($pid = waitpid -1, $WNOHANG) > 0;
1644 };
1645
1646 *child = sub {
1518 my (undef, %arg) = @_; 1647 my (undef, %arg) = @_;
1519 1648
1520 defined (my $pid = $arg{pid} + 0) 1649 defined (my $pid = $arg{pid} + 0)
1521 or Carp::croak "required option 'pid' is missing"; 1650 or Carp::croak "required option 'pid' is missing";
1522 1651
1523 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1652 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1524 1653
1525 # WNOHANG is almost cetrainly 1 everywhere 1654 # WNOHANG is almost cetrainly 1 everywhere
1526 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1655 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1527 ? 1 1656 ? 1
1528 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1657 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1529 1658
1530 unless ($CHLD_W) { 1659 unless ($CHLD_W) {
1531 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1660 $CHLD_W = AE::signal CHLD => \&_sigchld;
1532 # child could be a zombie already, so make at least one round 1661 # child could be a zombie already, so make at least one round
1533 &_sigchld; 1662 &_sigchld;
1534 } 1663 }
1535 1664
1536 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1665 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1537} 1666 };
1538 1667
1539sub AnyEvent::Base::child::DESTROY { 1668 *AnyEvent::Base::child::DESTROY = sub {
1540 my ($pid, $cb) = @{$_[0]}; 1669 my ($pid, $cb) = @{$_[0]};
1541 1670
1542 delete $PID_CB{$pid}{$cb}; 1671 delete $PID_CB{$pid}{$cb};
1543 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1672 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1544 1673
1545 undef $CHLD_W unless keys %PID_CB; 1674 undef $CHLD_W unless keys %PID_CB;
1675 };
1676 };
1677 die if $@;
1678
1679 &child
1546} 1680}
1547 1681
1548# idle emulation is done by simply using a timer, regardless 1682# idle emulation is done by simply using a timer, regardless
1549# of whether the process is idle or not, and not letting 1683# of whether the process is idle or not, and not letting
1550# the callback use more than 50% of the time. 1684# the callback use more than 50% of the time.
1551sub idle { 1685sub idle {
1686 eval q{ # poor man's autoloading {}
1687 *idle = sub {
1552 my (undef, %arg) = @_; 1688 my (undef, %arg) = @_;
1553 1689
1554 my ($cb, $w, $rcb) = $arg{cb}; 1690 my ($cb, $w, $rcb) = $arg{cb};
1555 1691
1556 $rcb = sub { 1692 $rcb = sub {
1557 if ($cb) { 1693 if ($cb) {
1558 $w = _time; 1694 $w = _time;
1559 &$cb; 1695 &$cb;
1560 $w = _time - $w; 1696 $w = _time - $w;
1561 1697
1562 # never use more then 50% of the time for the idle watcher, 1698 # never use more then 50% of the time for the idle watcher,
1563 # within some limits 1699 # within some limits
1564 $w = 0.0001 if $w < 0.0001; 1700 $w = 0.0001 if $w < 0.0001;
1565 $w = 5 if $w > 5; 1701 $w = 5 if $w > 5;
1566 1702
1567 $w = AnyEvent->timer (after => $w, cb => $rcb); 1703 $w = AE::timer $w, 0, $rcb;
1568 } else { 1704 } else {
1569 # clean up... 1705 # clean up...
1570 undef $w; 1706 undef $w;
1571 undef $rcb; 1707 undef $rcb;
1708 }
1709 };
1710
1711 $w = AE::timer 0.05, 0, $rcb;
1712
1713 bless \\$cb, "AnyEvent::Base::idle"
1572 } 1714 };
1715
1716 *AnyEvent::Base::idle::DESTROY = sub {
1717 undef $${$_[0]};
1718 };
1573 }; 1719 };
1720 die if $@;
1574 1721
1575 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1722 &idle
1576
1577 bless \\$cb, "AnyEvent::Base::idle"
1578}
1579
1580sub AnyEvent::Base::idle::DESTROY {
1581 undef $${$_[0]};
1582} 1723}
1583 1724
1584package AnyEvent::CondVar; 1725package AnyEvent::CondVar;
1585 1726
1586our @ISA = AnyEvent::CondVar::Base::; 1727our @ISA = AnyEvent::CondVar::Base::;
1640 1781
1641 @_ 1782 @_
1642 and $cv->{_ae_cb} = shift 1783 and $cv->{_ae_cb} = shift
1643 and $cv->{_ae_sent} 1784 and $cv->{_ae_sent}
1644 and (delete $cv->{_ae_cb})->($cv); 1785 and (delete $cv->{_ae_cb})->($cv);
1786
1645 $cv->{_ae_cb} 1787 $cv->{_ae_cb}
1646} 1788}
1647 1789
1648sub begin { 1790sub begin {
1649 ++$_[0]{_ae_counter}; 1791 ++$_[0]{_ae_counter};
1656} 1798}
1657 1799
1658# undocumented/compatibility with pre-3.4 1800# undocumented/compatibility with pre-3.4
1659*broadcast = \&send; 1801*broadcast = \&send;
1660*wait = \&_wait; 1802*wait = \&_wait;
1661
1662#############################################################################
1663# "new" API, currently only emulation of it
1664#############################################################################
1665
1666package AE;
1667
1668sub io($$$) {
1669 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1670}
1671
1672sub timer($$$) {
1673 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
1674}
1675
1676sub signal($$) {
1677 AnyEvent->signal (signal => $_[0], cb => $_[1]);
1678}
1679
1680sub child($$) {
1681 AnyEvent->child (pid => $_[0], cb => $_[1]);
1682}
1683
1684sub idle($) {
1685 AnyEvent->idle (cb => $_[0]);
1686}
1687
1688sub cv() {
1689 AnyEvent->condvar
1690}
1691
1692sub now() {
1693 AnyEvent->now
1694}
1695
1696sub now_update() {
1697 AnyEvent->now_update
1698}
1699
1700sub time() {
1701 AnyEvent->time
1702}
1703 1803
1704=head1 ERROR AND EXCEPTION HANDLING 1804=head1 ERROR AND EXCEPTION HANDLING
1705 1805
1706In general, AnyEvent does not do any error handling - it relies on the 1806In general, AnyEvent does not do any error handling - it relies on the
1707caller to do that if required. The L<AnyEvent::Strict> module (see also 1807caller to do that if required. The L<AnyEvent::Strict> module (see also
1901 warn "read: $input\n"; # output what has been read 2001 warn "read: $input\n"; # output what has been read
1902 $cv->send if $input =~ /^q/i; # quit program if /^q/i 2002 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1903 }, 2003 },
1904 ); 2004 );
1905 2005
1906 my $time_watcher; # can only be used once
1907
1908 sub new_timer {
1909 $timer = AnyEvent->timer (after => 1, cb => sub { 2006 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1910 warn "timeout\n"; # print 'timeout' about every second 2007 warn "timeout\n"; # print 'timeout' at most every second
1911 &new_timer; # and restart the time
1912 }); 2008 });
1913 }
1914
1915 new_timer; # create first timer
1916 2009
1917 $cv->recv; # wait until user enters /^q/i 2010 $cv->recv; # wait until user enters /^q/i
1918 2011
1919=head1 REAL-WORLD EXAMPLE 2012=head1 REAL-WORLD EXAMPLE
1920 2013
1993 2086
1994The actual code goes further and collects all errors (C<die>s, exceptions) 2087The actual code goes further and collects all errors (C<die>s, exceptions)
1995that occurred during request processing. The C<result> method detects 2088that occurred during request processing. The C<result> method detects
1996whether an exception as thrown (it is stored inside the $txn object) 2089whether an exception as thrown (it is stored inside the $txn object)
1997and just throws the exception, which means connection errors and other 2090and just throws the exception, which means connection errors and other
1998problems get reported tot he code that tries to use the result, not in a 2091problems get reported to the code that tries to use the result, not in a
1999random callback. 2092random callback.
2000 2093
2001All of this enables the following usage styles: 2094All of this enables the following usage styles:
2002 2095
20031. Blocking: 20961. Blocking:
2051through AnyEvent. The benchmark creates a lot of timers (with a zero 2144through AnyEvent. The benchmark creates a lot of timers (with a zero
2052timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2145timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
2053which it is), lets them fire exactly once and destroys them again. 2146which it is), lets them fire exactly once and destroys them again.
2054 2147
2055Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2148Source code for this benchmark is found as F<eg/bench> in the AnyEvent
2056distribution. 2149distribution. It uses the L<AE> interface, which makes a real difference
2150for the EV and Perl backends only.
2057 2151
2058=head3 Explanation of the columns 2152=head3 Explanation of the columns
2059 2153
2060I<watcher> is the number of event watchers created/destroyed. Since 2154I<watcher> is the number of event watchers created/destroyed. Since
2061different event models feature vastly different performances, each event 2155different event models feature vastly different performances, each event
2082watcher. 2176watcher.
2083 2177
2084=head3 Results 2178=head3 Results
2085 2179
2086 name watchers bytes create invoke destroy comment 2180 name watchers bytes create invoke destroy comment
2087 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2181 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2088 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2182 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2089 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2183 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2090 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2184 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2091 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2185 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2092 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2186 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2093 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 2187 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2094 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 2188 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2095 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2189 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2096 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2190 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2097 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2191 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2098 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2192 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2099 2193
2100=head3 Discussion 2194=head3 Discussion
2101 2195
2102The benchmark does I<not> measure scalability of the event loop very 2196The benchmark does I<not> measure scalability of the event loop very
2103well. For example, a select-based event loop (such as the pure perl one) 2197well. For example, a select-based event loop (such as the pure perl one)
2115benchmark machine, handling an event takes roughly 1600 CPU cycles with 2209benchmark machine, handling an event takes roughly 1600 CPU cycles with
2116EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2210EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2117cycles with POE. 2211cycles with POE.
2118 2212
2119C<EV> is the sole leader regarding speed and memory use, which are both 2213C<EV> is the sole leader regarding speed and memory use, which are both
2120maximal/minimal, respectively. Even when going through AnyEvent, it uses 2214maximal/minimal, respectively. When using the L<AE> API there is zero
2215overhead (when going through the AnyEvent API create is about 5-6 times
2216slower, with other times being equal, so still uses far less memory than
2121far less memory than any other event loop and is still faster than Event 2217any other event loop and is still faster than Event natively).
2122natively.
2123 2218
2124The pure perl implementation is hit in a few sweet spots (both the 2219The pure perl implementation is hit in a few sweet spots (both the
2125constant timeout and the use of a single fd hit optimisations in the perl 2220constant timeout and the use of a single fd hit optimisations in the perl
2126interpreter and the backend itself). Nevertheless this shows that it 2221interpreter and the backend itself). Nevertheless this shows that it
2127adds very little overhead in itself. Like any select-based backend its 2222adds very little overhead in itself. Like any select-based backend its
2201In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2296In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2202(1%) are active. This mirrors the activity of large servers with many 2297(1%) are active. This mirrors the activity of large servers with many
2203connections, most of which are idle at any one point in time. 2298connections, most of which are idle at any one point in time.
2204 2299
2205Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2300Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2206distribution. 2301distribution. It uses the L<AE> interface, which makes a real difference
2302for the EV and Perl backends only.
2207 2303
2208=head3 Explanation of the columns 2304=head3 Explanation of the columns
2209 2305
2210I<sockets> is the number of sockets, and twice the number of "servers" (as 2306I<sockets> is the number of sockets, and twice the number of "servers" (as
2211each server has a read and write socket end). 2307each server has a read and write socket end).
2219a new one that moves the timeout into the future. 2315a new one that moves the timeout into the future.
2220 2316
2221=head3 Results 2317=head3 Results
2222 2318
2223 name sockets create request 2319 name sockets create request
2224 EV 20000 69.01 11.16 2320 EV 20000 62.66 7.99
2225 Perl 20000 73.32 35.87 2321 Perl 20000 68.32 32.64
2226 IOAsync 20000 157.00 98.14 epoll 2322 IOAsync 20000 174.06 101.15 epoll
2227 IOAsync 20000 159.31 616.06 poll 2323 IOAsync 20000 174.67 610.84 poll
2228 Event 20000 212.62 257.32 2324 Event 20000 202.69 242.91
2229 Glib 20000 651.16 1896.30 2325 Glib 20000 557.01 1689.52
2230 POE 20000 349.67 12317.24 uses POE::Loop::Event 2326 POE 20000 341.54 12086.32 uses POE::Loop::Event
2231 2327
2232=head3 Discussion 2328=head3 Discussion
2233 2329
2234This benchmark I<does> measure scalability and overall performance of the 2330This benchmark I<does> measure scalability and overall performance of the
2235particular event loop. 2331particular event loop.
2361As you can see, the AnyEvent + EV combination even beats the 2457As you can see, the AnyEvent + EV combination even beats the
2362hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2458hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2363backend easily beats IO::Lambda and POE. 2459backend easily beats IO::Lambda and POE.
2364 2460
2365And even the 100% non-blocking version written using the high-level (and 2461And even the 100% non-blocking version written using the high-level (and
2366slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2462slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2367large margin, even though it does all of DNS, tcp-connect and socket I/O 2463higher level ("unoptimised") abstractions by a large margin, even though
2368in a non-blocking way. 2464it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2369 2465
2370The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2466The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2371F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2467F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2372part of the IO::lambda distribution and were used without any changes. 2468part of the IO::Lambda distribution and were used without any changes.
2373 2469
2374 2470
2375=head1 SIGNALS 2471=head1 SIGNALS
2376 2472
2377AnyEvent currently installs handlers for these signals: 2473AnyEvent currently installs handlers for these signals:
2419it's built-in modules) are required to use it. 2515it's built-in modules) are required to use it.
2420 2516
2421That does not mean that AnyEvent won't take advantage of some additional 2517That does not mean that AnyEvent won't take advantage of some additional
2422modules if they are installed. 2518modules if they are installed.
2423 2519
2424This section epxlains which additional modules will be used, and how they 2520This section explains which additional modules will be used, and how they
2425affect AnyEvent's operetion. 2521affect AnyEvent's operation.
2426 2522
2427=over 4 2523=over 4
2428 2524
2429=item L<Async::Interrupt> 2525=item L<Async::Interrupt>
2430 2526
2435catch the signals) with some delay (default is 10 seconds, look for 2531catch the signals) with some delay (default is 10 seconds, look for
2436C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2532C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2437 2533
2438If this module is available, then it will be used to implement signal 2534If this module is available, then it will be used to implement signal
2439catching, which means that signals will not be delayed, and the event loop 2535catching, which means that signals will not be delayed, and the event loop
2440will not be interrupted regularly, which is more efficient (And good for 2536will not be interrupted regularly, which is more efficient (and good for
2441battery life on laptops). 2537battery life on laptops).
2442 2538
2443This affects not just the pure-perl event loop, but also other event loops 2539This affects not just the pure-perl event loop, but also other event loops
2444that have no signal handling on their own (e.g. Glib, Tk, Qt). 2540that have no signal handling on their own (e.g. Glib, Tk, Qt).
2445 2541
2457automatic timer adjustments even when no monotonic clock is available, 2553automatic timer adjustments even when no monotonic clock is available,
2458can take avdantage of advanced kernel interfaces such as C<epoll> and 2554can take avdantage of advanced kernel interfaces such as C<epoll> and
2459C<kqueue>, and is the fastest backend I<by far>. You can even embed 2555C<kqueue>, and is the fastest backend I<by far>. You can even embed
2460L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). 2556L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2461 2557
2558If you only use backends that rely on another event loop (e.g. C<Tk>),
2559then this module will do nothing for you.
2560
2462=item L<Guard> 2561=item L<Guard>
2463 2562
2464The guard module, when used, will be used to implement 2563The guard module, when used, will be used to implement
2465C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a 2564C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2466lot less memory), but otherwise doesn't affect guard operation much. It is 2565lot less memory), but otherwise doesn't affect guard operation much. It is
2467purely used for performance. 2566purely used for performance.
2468 2567
2469=item L<JSON> and L<JSON::XS> 2568=item L<JSON> and L<JSON::XS>
2470 2569
2471This module is required when you want to read or write JSON data via 2570One of these modules is required when you want to read or write JSON data
2472L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2571via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2473advantage of the ultra-high-speed L<JSON::XS> module when it is installed. 2572advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2474
2475In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2476installed.
2477 2573
2478=item L<Net::SSLeay> 2574=item L<Net::SSLeay>
2479 2575
2480Implementing TLS/SSL in Perl is certainly interesting, but not very 2576Implementing TLS/SSL in Perl is certainly interesting, but not very
2481worthwhile: If this module is installed, then L<AnyEvent::Handle> (with 2577worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2492 2588
2493 2589
2494=head1 FORK 2590=head1 FORK
2495 2591
2496Most event libraries are not fork-safe. The ones who are usually are 2592Most event libraries are not fork-safe. The ones who are usually are
2497because they rely on inefficient but fork-safe C<select> or C<poll> 2593because they rely on inefficient but fork-safe C<select> or C<poll> calls
2498calls. Only L<EV> is fully fork-aware. 2594- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
2595are usually badly thought-out hacks that are incompatible with fork in
2596one way or another. Only L<EV> is fully fork-aware and ensures that you
2597continue event-processing in both parent and child (or both, if you know
2598what you are doing).
2599
2600This means that, in general, you cannot fork and do event processing in
2601the child if the event library was initialised before the fork (which
2602usually happens when the first AnyEvent watcher is created, or the library
2603is loaded).
2499 2604
2500If you have to fork, you must either do so I<before> creating your first 2605If you have to fork, you must either do so I<before> creating your first
2501watcher OR you must not use AnyEvent at all in the child OR you must do 2606watcher OR you must not use AnyEvent at all in the child OR you must do
2502something completely out of the scope of AnyEvent. 2607something completely out of the scope of AnyEvent.
2608
2609The problem of doing event processing in the parent I<and> the child
2610is much more complicated: even for backends that I<are> fork-aware or
2611fork-safe, their behaviour is not usually what you want: fork clones all
2612watchers, that means all timers, I/O watchers etc. are active in both
2613parent and child, which is almost never what you want. USing C<exec>
2614to start worker children from some kind of manage rprocess is usually
2615preferred, because it is much easier and cleaner, at the expense of having
2616to have another binary.
2503 2617
2504 2618
2505=head1 SECURITY CONSIDERATIONS 2619=head1 SECURITY CONSIDERATIONS
2506 2620
2507AnyEvent can be forced to load any event model via 2621AnyEvent can be forced to load any event model via

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines