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.265 by root, Wed Jul 29 13:10:58 2009 UTC vs.
Revision 1.306 by root, Tue Dec 15 05:49:13 2009 UTC

181my variables are only visible after the statement in which they are 181my variables are only visible after the statement in which they are
182declared. 182declared.
183 183
184=head2 I/O WATCHERS 184=head2 I/O WATCHERS
185 185
186 $w = AnyEvent->io (
187 fh => <filehandle_or_fileno>,
188 poll => <"r" or "w">,
189 cb => <callback>,
190 );
191
186You can create an I/O watcher by calling the C<< AnyEvent->io >> method 192You can create an I/O watcher by calling the C<< AnyEvent->io >> method
187with the following mandatory key-value pairs as arguments: 193with the following mandatory key-value pairs as arguments:
188 194
189C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch 195C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
190for events (AnyEvent might or might not keep a reference to this file 196for events (AnyEvent might or might not keep a reference to this file
219 undef $w; 225 undef $w;
220 }); 226 });
221 227
222=head2 TIME WATCHERS 228=head2 TIME WATCHERS
223 229
230 $w = AnyEvent->timer (after => <seconds>, cb => <callback>);
231
232 $w = AnyEvent->timer (
233 after => <fractional_seconds>,
234 interval => <fractional_seconds>,
235 cb => <callback>,
236 );
237
224You can create a time watcher by calling the C<< AnyEvent->timer >> 238You can create a time watcher by calling the C<< AnyEvent->timer >>
225method with the following mandatory arguments: 239method with the following mandatory arguments:
226 240
227C<after> specifies after how many seconds (fractional values are 241C<after> specifies after how many seconds (fractional values are
228supported) the callback should be invoked. C<cb> is the callback to invoke 242supported) the callback should be invoked. C<cb> is the callback to invoke
349might affect timers and time-outs. 363might affect timers and time-outs.
350 364
351When this is the case, you can call this method, which will update the 365When this is the case, you can call this method, which will update the
352event loop's idea of "current time". 366event loop's idea of "current time".
353 367
368A typical example would be a script in a web server (e.g. C<mod_perl>) -
369when mod_perl executes the script, then the event loop will have the wrong
370idea about the "current time" (being potentially far in the past, when the
371script ran the last time). In that case you should arrange a call to C<<
372AnyEvent->now_update >> each time the web server process wakes up again
373(e.g. at the start of your script, or in a handler).
374
354Note that updating the time I<might> cause some events to be handled. 375Note that updating the time I<might> cause some events to be handled.
355 376
356=back 377=back
357 378
358=head2 SIGNAL WATCHERS 379=head2 SIGNAL WATCHERS
380
381 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
359 382
360You can watch for signals using a signal watcher, C<signal> is the signal 383You can watch for signals using a signal watcher, C<signal> is the signal
361I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl 384I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
362callback to be invoked whenever a signal occurs. 385callback to be invoked whenever a signal occurs.
363 386
380 403
381Example: exit on SIGINT 404Example: exit on SIGINT
382 405
383 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 406 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384 407
408=head3 Restart Behaviour
409
410While restart behaviour is up to the event loop implementation, most will
411not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
412pure perl implementation).
413
414=head3 Safe/Unsafe Signals
415
416Perl signals can be either "safe" (synchronous to opcode handling) or
417"unsafe" (asynchronous) - the former might get delayed indefinitely, the
418latter might corrupt your memory.
419
420AnyEvent signal handlers are, in addition, synchronous to the event loop,
421i.e. they will not interrupt your running perl program but will only be
422called as part of the normal event handling (just like timer, I/O etc.
423callbacks, too).
424
385=head3 Signal Races, Delays and Workarounds 425=head3 Signal Races, Delays and Workarounds
386 426
387Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 427Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
388callbacks to signals in a generic way, which is a pity, as you cannot do 428callbacks to signals in a generic way, which is a pity, as you cannot
389race-free signal handling in perl. AnyEvent will try to do it's best, but 429do race-free signal handling in perl, requiring C libraries for
430this. AnyEvent will try to do it's best, which means in some cases,
390in some cases, signals will be delayed. The maximum time a signal might 431signals will be delayed. The maximum time a signal might be delayed is
391be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 432specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392seconds). This variable can be changed only before the first signal 433variable can be changed only before the first signal watcher is created,
393watcher is created, and should be left alone otherwise. Higher values 434and should be left alone otherwise. This variable determines how often
435AnyEvent polls for signals (in case a wake-up was missed). Higher values
394will cause fewer spurious wake-ups, which is better for power and CPU 436will cause fewer spurious wake-ups, which is better for power and CPU
437saving.
438
395saving. All these problems can be avoided by installing the optional 439All these problems can be avoided by installing the optional
396L<Async::Interrupt> module. This will not work with inherently broken 440L<Async::Interrupt> module, which works with most event loops. It will not
397event loops such as L<Event> or L<Event::Lib> (and not with L<POE> 441work with inherently broken event loops such as L<Event> or L<Event::Lib>
398currently, as POE does it's own workaround with one-second latency). With 442(and not with L<POE> currently, as POE does it's own workaround with
399those, you just have to suffer the delays. 443one-second latency). For those, you just have to suffer the delays.
400 444
401=head2 CHILD PROCESS WATCHERS 445=head2 CHILD PROCESS WATCHERS
446
447 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
402 448
403You can also watch on a child process exit and catch its exit status. 449You can also watch on a child process exit and catch its exit status.
404 450
405The child process is specified by the C<pid> argument (one some backends, 451The child process is specified by the C<pid> argument (one some backends,
406using C<0> watches for any child process exit, on others this will 452using C<0> watches for any child process exit, on others this will
455 # do something else, then wait for process exit 501 # do something else, then wait for process exit
456 $done->recv; 502 $done->recv;
457 503
458=head2 IDLE WATCHERS 504=head2 IDLE WATCHERS
459 505
506 $w = AnyEvent->idle (cb => <callback>);
507
460Sometimes there is a need to do something, but it is not so important 508Sometimes there is a need to do something, but it is not so important
461to do it instantly, but only when there is nothing better to do. This 509to do it instantly, but only when there is nothing better to do. This
462"nothing better to do" is usually defined to be "no other events need 510"nothing better to do" is usually defined to be "no other events need
463attention by the event loop". 511attention by the event loop".
464 512
490 }); 538 });
491 }); 539 });
492 540
493=head2 CONDITION VARIABLES 541=head2 CONDITION VARIABLES
494 542
543 $cv = AnyEvent->condvar;
544
545 $cv->send (<list>);
546 my @res = $cv->recv;
547
495If you are familiar with some event loops you will know that all of them 548If you are familiar with some event loops you will know that all of them
496require you to run some blocking "loop", "run" or similar function that 549require you to run some blocking "loop", "run" or similar function that
497will actively watch for new events and call your callbacks. 550will actively watch for new events and call your callbacks.
498 551
499AnyEvent is slightly different: it expects somebody else to run the event 552AnyEvent is slightly different: it expects somebody else to run the event
563 after => 1, 616 after => 1,
564 cb => sub { $result_ready->send }, 617 cb => sub { $result_ready->send },
565 ); 618 );
566 619
567 # this "blocks" (while handling events) till the callback 620 # this "blocks" (while handling events) till the callback
568 # calls -<send 621 # calls ->send
569 $result_ready->recv; 622 $result_ready->recv;
570 623
571Example: wait for a timer, but take advantage of the fact that condition 624Example: wait for a timer, but take advantage of the fact that condition
572variables are also callable directly. 625variables are also callable directly.
573 626
637one. For example, a function that pings many hosts in parallel might want 690one. For example, a function that pings many hosts in parallel might want
638to use a condition variable for the whole process. 691to use a condition variable for the whole process.
639 692
640Every call to C<< ->begin >> will increment a counter, and every call to 693Every call to C<< ->begin >> will increment a counter, and every call to
641C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 694C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
642>>, the (last) callback passed to C<begin> will be executed. That callback 695>>, the (last) callback passed to C<begin> will be executed, passing the
643is I<supposed> to call C<< ->send >>, but that is not required. If no 696condvar as first argument. That callback is I<supposed> to call C<< ->send
644callback was set, C<send> will be called without any arguments. 697>>, but that is not required. If no group callback was set, C<send> will
698be called without any arguments.
645 699
646You can think of C<< $cv->send >> giving you an OR condition (one call 700You can think of C<< $cv->send >> giving you an OR condition (one call
647sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND 701sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
648condition (all C<begin> calls must be C<end>'ed before the condvar sends). 702condition (all C<begin> calls must be C<end>'ed before the condvar sends).
649 703
676begung can potentially be zero: 730begung can potentially be zero:
677 731
678 my $cv = AnyEvent->condvar; 732 my $cv = AnyEvent->condvar;
679 733
680 my %result; 734 my %result;
681 $cv->begin (sub { $cv->send (\%result) }); 735 $cv->begin (sub { shift->send (\%result) });
682 736
683 for my $host (@list_of_hosts) { 737 for my $host (@list_of_hosts) {
684 $cv->begin; 738 $cv->begin;
685 ping_host_then_call_callback $host, sub { 739 ping_host_then_call_callback $host, sub {
686 $result{$host} = ...; 740 $result{$host} = ...;
761=item $cb = $cv->cb ($cb->($cv)) 815=item $cb = $cv->cb ($cb->($cv))
762 816
763This is a mutator function that returns the callback set and optionally 817This is a mutator function that returns the callback set and optionally
764replaces it before doing so. 818replaces it before doing so.
765 819
766The callback will be called when the condition becomes "true", i.e. when 820The callback will be called when the condition becomes (or already was)
767C<send> or C<croak> are called, with the only argument being the condition 821"true", i.e. when C<send> or C<croak> are called (or were called), with
768variable itself. Calling C<recv> inside the callback or at any later time 822the only argument being the condition variable itself. Calling C<recv>
769is guaranteed not to block. 823inside the callback or at any later time is guaranteed not to block.
770 824
771=back 825=back
772 826
773=head1 SUPPORTED EVENT LOOPS/BACKENDS 827=head1 SUPPORTED EVENT LOOPS/BACKENDS
774 828
777=over 4 831=over 4
778 832
779=item Backends that are autoprobed when no other event loop can be found. 833=item Backends that are autoprobed when no other event loop can be found.
780 834
781EV is the preferred backend when no other event loop seems to be in 835EV is the preferred backend when no other event loop seems to be in
782use. If EV is not installed, then AnyEvent will try Event, and, failing 836use. If EV is not installed, then AnyEvent will fall back to its own
783that, will fall back to its own pure-perl implementation, which is 837pure-perl implementation, which is available everywhere as it comes with
784available everywhere as it comes with AnyEvent itself. 838AnyEvent itself.
785 839
786 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 840 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
787 AnyEvent::Impl::Event based on Event, very stable, few glitches.
788 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 841 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
789 842
790=item Backends that are transparently being picked up when they are used. 843=item Backends that are transparently being picked up when they are used.
791 844
792These will be used when they are currently loaded when the first watcher 845These will be used when they are currently loaded when the first watcher
793is created, in which case it is assumed that the application is using 846is created, in which case it is assumed that the application is using
794them. This means that AnyEvent will automatically pick the right backend 847them. This means that AnyEvent will automatically pick the right backend
795when the main program loads an event module before anything starts to 848when the main program loads an event module before anything starts to
796create watchers. Nothing special needs to be done by the main program. 849create watchers. Nothing special needs to be done by the main program.
797 850
851 AnyEvent::Impl::Event based on Event, very stable, few glitches.
798 AnyEvent::Impl::Glib based on Glib, slow but very stable. 852 AnyEvent::Impl::Glib based on Glib, slow but very stable.
799 AnyEvent::Impl::Tk based on Tk, very broken. 853 AnyEvent::Impl::Tk based on Tk, very broken.
800 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 854 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
801 AnyEvent::Impl::POE based on POE, very slow, some limitations. 855 AnyEvent::Impl::POE based on POE, very slow, some limitations.
802 AnyEvent::Impl::Irssi used when running within irssi. 856 AnyEvent::Impl::Irssi used when running within irssi.
912You should check C<$AnyEvent::MODEL> before adding to this array, though: 966You should check C<$AnyEvent::MODEL> before adding to this array, though:
913if it is defined then the event loop has already been detected, and the 967if it is defined then the event loop has already been detected, and the
914array will be ignored. 968array will be ignored.
915 969
916Best use C<AnyEvent::post_detect { BLOCK }> when your application allows 970Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
917it,as it takes care of these details. 971it, as it takes care of these details.
918 972
919This variable is mainly useful for modules that can do something useful 973This variable is mainly useful for modules that can do something useful
920when AnyEvent is used and thus want to know when it is initialised, but do 974when AnyEvent is used and thus want to know when it is initialised, but do
921not need to even load it by default. This array provides the means to hook 975not need to even load it by default. This array provides the means to hook
922into AnyEvent passively, without loading it. 976into AnyEvent passively, without loading it.
977
978Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
979together, you could put this into Coro (this is the actual code used by
980Coro to accomplish this):
981
982 if (defined $AnyEvent::MODEL) {
983 # AnyEvent already initialised, so load Coro::AnyEvent
984 require Coro::AnyEvent;
985 } else {
986 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
987 # as soon as it is
988 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
989 }
923 990
924=back 991=back
925 992
926=head1 WHAT TO DO IN A MODULE 993=head1 WHAT TO DO IN A MODULE
927 994
1076 1143
1077package AnyEvent; 1144package AnyEvent;
1078 1145
1079# basically a tuned-down version of common::sense 1146# basically a tuned-down version of common::sense
1080sub common_sense { 1147sub common_sense {
1081 # no warnings 1148 # from common:.sense 1.0
1082 ${^WARNING_BITS} ^= ${^WARNING_BITS}; 1149 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1083 # use strict vars subs 1150 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1084 $^H |= 0x00000600; 1151 $^H |= 0x00000600;
1085} 1152}
1086 1153
1087BEGIN { AnyEvent::common_sense } 1154BEGIN { AnyEvent::common_sense }
1088 1155
1089use Carp (); 1156use Carp ();
1090 1157
1091our $VERSION = 4.881; 1158our $VERSION = '5.22';
1092our $MODEL; 1159our $MODEL;
1093 1160
1094our $AUTOLOAD; 1161our $AUTOLOAD;
1095our @ISA; 1162our @ISA;
1096 1163
1097our @REGISTRY; 1164our @REGISTRY;
1098
1099our $WIN32;
1100 1165
1101our $VERBOSE; 1166our $VERBOSE;
1102 1167
1103BEGIN { 1168BEGIN {
1104 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1169 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
1122 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1187 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1123} 1188}
1124 1189
1125my @models = ( 1190my @models = (
1126 [EV:: => AnyEvent::Impl::EV:: , 1], 1191 [EV:: => AnyEvent::Impl::EV:: , 1],
1127 [Event:: => AnyEvent::Impl::Event::, 1],
1128 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1192 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1129 # everything below here will not (normally) be autoprobed 1193 # everything below here will not (normally) be autoprobed
1130 # as the pureperl backend should work everywhere 1194 # as the pureperl backend should work everywhere
1131 # and is usually faster 1195 # and is usually faster
1196 [Event:: => AnyEvent::Impl::Event::, 1],
1132 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1197 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1133 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1198 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1134 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1199 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1135 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1200 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1136 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1201 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1139 [Prima:: => AnyEvent::Impl::POE::], 1204 [Prima:: => AnyEvent::Impl::POE::],
1140 # IO::Async is just too broken - we would need workarounds for its 1205 # IO::Async is just too broken - we would need workarounds for its
1141 # byzantine signal and broken child handling, among others. 1206 # byzantine signal and broken child handling, among others.
1142 # IO::Async is rather hard to detect, as it doesn't have any 1207 # IO::Async is rather hard to detect, as it doesn't have any
1143 # obvious default class. 1208 # obvious default class.
1144# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1209 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1145# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1210 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1146# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1211 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1212 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1147); 1213);
1148 1214
1149our %method = map +($_ => 1), 1215our %method = map +($_ => 1),
1150 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1216 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1151 1217
1258 # we assume CLOEXEC is already set by perl in all important cases 1324 # we assume CLOEXEC is already set by perl in all important cases
1259 1325
1260 ($fh2, $rw) 1326 ($fh2, $rw)
1261} 1327}
1262 1328
1329=head1 SIMPLIFIED AE API
1330
1331Starting with version 5.0, AnyEvent officially supports a second, much
1332simpler, API that is designed to reduce the calling, typing and memory
1333overhead.
1334
1335See the L<AE> manpage for details.
1336
1337=cut
1338
1339package AE;
1340
1341our $VERSION = $AnyEvent::VERSION;
1342
1343sub io($$$) {
1344 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1345}
1346
1347sub timer($$$) {
1348 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1349}
1350
1351sub signal($$) {
1352 AnyEvent->signal (signal => $_[0], cb => $_[1])
1353}
1354
1355sub child($$) {
1356 AnyEvent->child (pid => $_[0], cb => $_[1])
1357}
1358
1359sub idle($) {
1360 AnyEvent->idle (cb => $_[0])
1361}
1362
1363sub cv(;&) {
1364 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1365}
1366
1367sub now() {
1368 AnyEvent->now
1369}
1370
1371sub now_update() {
1372 AnyEvent->now_update
1373}
1374
1375sub time() {
1376 AnyEvent->time
1377}
1378
1263package AnyEvent::Base; 1379package AnyEvent::Base;
1264 1380
1265# default implementations for many methods 1381# default implementations for many methods
1266 1382
1267sub _time { 1383sub _time() {
1268 # probe for availability of Time::HiRes 1384 # probe for availability of Time::HiRes
1269 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1385 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1270 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1386 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1271 *_time = \&Time::HiRes::time; 1387 *_time = \&Time::HiRes::time;
1272 # if (eval "use POSIX (); (POSIX::times())... 1388 # if (eval "use POSIX (); (POSIX::times())...
1292 1408
1293our $HAVE_ASYNC_INTERRUPT; 1409our $HAVE_ASYNC_INTERRUPT;
1294 1410
1295sub _have_async_interrupt() { 1411sub _have_async_interrupt() {
1296 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} 1412 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1297 && eval "use Async::Interrupt 1.0 (); 1") 1413 && eval "use Async::Interrupt 1.02 (); 1")
1298 unless defined $HAVE_ASYNC_INTERRUPT; 1414 unless defined $HAVE_ASYNC_INTERRUPT;
1299 1415
1300 $HAVE_ASYNC_INTERRUPT 1416 $HAVE_ASYNC_INTERRUPT
1301} 1417}
1302 1418
1305our ($SIG_COUNT, $SIG_TW); 1421our ($SIG_COUNT, $SIG_TW);
1306 1422
1307sub _signal_exec { 1423sub _signal_exec {
1308 $HAVE_ASYNC_INTERRUPT 1424 $HAVE_ASYNC_INTERRUPT
1309 ? $SIGPIPE_R->drain 1425 ? $SIGPIPE_R->drain
1310 : sysread $SIGPIPE_R, my $dummy, 9; 1426 : sysread $SIGPIPE_R, (my $dummy), 9;
1311 1427
1312 while (%SIG_EV) { 1428 while (%SIG_EV) {
1313 for (keys %SIG_EV) { 1429 for (keys %SIG_EV) {
1314 delete $SIG_EV{$_}; 1430 delete $SIG_EV{$_};
1315 $_->() for values %{ $SIG_CB{$_} || {} }; 1431 $_->() for values %{ $SIG_CB{$_} || {} };
1319 1435
1320# install a dummy wakeup watcher to reduce signal catching latency 1436# install a dummy wakeup watcher to reduce signal catching latency
1321sub _sig_add() { 1437sub _sig_add() {
1322 unless ($SIG_COUNT++) { 1438 unless ($SIG_COUNT++) {
1323 # try to align timer on a full-second boundary, if possible 1439 # try to align timer on a full-second boundary, if possible
1324 my $NOW = AnyEvent->now; 1440 my $NOW = AE::now;
1325 1441
1326 $SIG_TW = AnyEvent->timer ( 1442 $SIG_TW = AE::timer
1327 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1443 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1328 interval => $MAX_SIGNAL_LATENCY, 1444 $MAX_SIGNAL_LATENCY,
1329 cb => sub { }, # just for the PERL_ASYNC_CHECK 1445 sub { } # just for the PERL_ASYNC_CHECK
1330 ); 1446 ;
1331 } 1447 }
1332} 1448}
1333 1449
1334sub _sig_del { 1450sub _sig_del {
1335 undef $SIG_TW 1451 undef $SIG_TW
1372 # probe for availability of Async::Interrupt 1488 # probe for availability of Async::Interrupt
1373 if (_have_async_interrupt) { 1489 if (_have_async_interrupt) {
1374 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1490 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1375 1491
1376 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1492 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1377 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); 1493 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1378 1494
1379 } else { 1495 } else {
1380 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1496 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1381 1497
1382 require Fcntl; 1498 require Fcntl;
1398 } 1514 }
1399 1515
1400 $SIGPIPE_R 1516 $SIGPIPE_R
1401 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1517 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1402 1518
1403 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1519 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1404 } 1520 }
1405 1521
1406 *signal = sub { 1522 *signal = sub {
1407 my (undef, %arg) = @_; 1523 my (undef, %arg) = @_;
1408 1524
1497 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1613 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1498 ? 1 1614 ? 1
1499 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1615 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1500 1616
1501 unless ($CHLD_W) { 1617 unless ($CHLD_W) {
1502 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1618 $CHLD_W = AE::signal CHLD => \&_sigchld;
1503 # child could be a zombie already, so make at least one round 1619 # child could be a zombie already, so make at least one round
1504 &_sigchld; 1620 &_sigchld;
1505 } 1621 }
1506 1622
1507 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1623 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1533 # never use more then 50% of the time for the idle watcher, 1649 # never use more then 50% of the time for the idle watcher,
1534 # within some limits 1650 # within some limits
1535 $w = 0.0001 if $w < 0.0001; 1651 $w = 0.0001 if $w < 0.0001;
1536 $w = 5 if $w > 5; 1652 $w = 5 if $w > 5;
1537 1653
1538 $w = AnyEvent->timer (after => $w, cb => $rcb); 1654 $w = AE::timer $w, 0, $rcb;
1539 } else { 1655 } else {
1540 # clean up... 1656 # clean up...
1541 undef $w; 1657 undef $w;
1542 undef $rcb; 1658 undef $rcb;
1543 } 1659 }
1544 }; 1660 };
1545 1661
1546 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1662 $w = AE::timer 0.05, 0, $rcb;
1547 1663
1548 bless \\$cb, "AnyEvent::Base::idle" 1664 bless \\$cb, "AnyEvent::Base::idle"
1549} 1665}
1550 1666
1551sub AnyEvent::Base::idle::DESTROY { 1667sub AnyEvent::Base::idle::DESTROY {
1605 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1721 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1606 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1722 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1607} 1723}
1608 1724
1609sub cb { 1725sub cb {
1610 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1726 my $cv = shift;
1727
1728 @_
1729 and $cv->{_ae_cb} = shift
1730 and $cv->{_ae_sent}
1731 and (delete $cv->{_ae_cb})->($cv);
1732
1611 $_[0]{_ae_cb} 1733 $cv->{_ae_cb}
1612} 1734}
1613 1735
1614sub begin { 1736sub begin {
1615 ++$_[0]{_ae_counter}; 1737 ++$_[0]{_ae_counter};
1616 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1738 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1825 warn "read: $input\n"; # output what has been read 1947 warn "read: $input\n"; # output what has been read
1826 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1948 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1827 }, 1949 },
1828 ); 1950 );
1829 1951
1830 my $time_watcher; # can only be used once
1831
1832 sub new_timer {
1833 $timer = AnyEvent->timer (after => 1, cb => sub { 1952 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1834 warn "timeout\n"; # print 'timeout' about every second 1953 warn "timeout\n"; # print 'timeout' at most every second
1835 &new_timer; # and restart the time
1836 }); 1954 });
1837 }
1838
1839 new_timer; # create first timer
1840 1955
1841 $cv->recv; # wait until user enters /^q/i 1956 $cv->recv; # wait until user enters /^q/i
1842 1957
1843=head1 REAL-WORLD EXAMPLE 1958=head1 REAL-WORLD EXAMPLE
1844 1959
1975through AnyEvent. The benchmark creates a lot of timers (with a zero 2090through AnyEvent. The benchmark creates a lot of timers (with a zero
1976timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2091timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1977which it is), lets them fire exactly once and destroys them again. 2092which it is), lets them fire exactly once and destroys them again.
1978 2093
1979Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2094Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1980distribution. 2095distribution. It uses the L<AE> interface, which makes a real difference
2096for the EV and Perl backends only.
1981 2097
1982=head3 Explanation of the columns 2098=head3 Explanation of the columns
1983 2099
1984I<watcher> is the number of event watchers created/destroyed. Since 2100I<watcher> is the number of event watchers created/destroyed. Since
1985different event models feature vastly different performances, each event 2101different event models feature vastly different performances, each event
2006watcher. 2122watcher.
2007 2123
2008=head3 Results 2124=head3 Results
2009 2125
2010 name watchers bytes create invoke destroy comment 2126 name watchers bytes create invoke destroy comment
2011 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2127 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2012 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2128 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2013 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2129 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2014 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2130 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2015 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2131 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2016 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2132 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2017 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 2133 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2018 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 2134 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2019 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2135 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2020 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2136 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2021 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2137 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2022 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2138 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2023 2139
2024=head3 Discussion 2140=head3 Discussion
2025 2141
2026The benchmark does I<not> measure scalability of the event loop very 2142The benchmark does I<not> measure scalability of the event loop very
2027well. For example, a select-based event loop (such as the pure perl one) 2143well. For example, a select-based event loop (such as the pure perl one)
2039benchmark machine, handling an event takes roughly 1600 CPU cycles with 2155benchmark machine, handling an event takes roughly 1600 CPU cycles with
2040EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2156EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2041cycles with POE. 2157cycles with POE.
2042 2158
2043C<EV> is the sole leader regarding speed and memory use, which are both 2159C<EV> is the sole leader regarding speed and memory use, which are both
2044maximal/minimal, respectively. Even when going through AnyEvent, it uses 2160maximal/minimal, respectively. When using the L<AE> API there is zero
2161overhead (when going through the AnyEvent API create is about 5-6 times
2162slower, with other times being equal, so still uses far less memory than
2045far less memory than any other event loop and is still faster than Event 2163any other event loop and is still faster than Event natively).
2046natively.
2047 2164
2048The pure perl implementation is hit in a few sweet spots (both the 2165The pure perl implementation is hit in a few sweet spots (both the
2049constant timeout and the use of a single fd hit optimisations in the perl 2166constant timeout and the use of a single fd hit optimisations in the perl
2050interpreter and the backend itself). Nevertheless this shows that it 2167interpreter and the backend itself). Nevertheless this shows that it
2051adds very little overhead in itself. Like any select-based backend its 2168adds very little overhead in itself. Like any select-based backend its
2125In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2242In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2126(1%) are active. This mirrors the activity of large servers with many 2243(1%) are active. This mirrors the activity of large servers with many
2127connections, most of which are idle at any one point in time. 2244connections, most of which are idle at any one point in time.
2128 2245
2129Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2246Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2130distribution. 2247distribution. It uses the L<AE> interface, which makes a real difference
2248for the EV and Perl backends only.
2131 2249
2132=head3 Explanation of the columns 2250=head3 Explanation of the columns
2133 2251
2134I<sockets> is the number of sockets, and twice the number of "servers" (as 2252I<sockets> is the number of sockets, and twice the number of "servers" (as
2135each server has a read and write socket end). 2253each server has a read and write socket end).
2143a new one that moves the timeout into the future. 2261a new one that moves the timeout into the future.
2144 2262
2145=head3 Results 2263=head3 Results
2146 2264
2147 name sockets create request 2265 name sockets create request
2148 EV 20000 69.01 11.16 2266 EV 20000 62.66 7.99
2149 Perl 20000 73.32 35.87 2267 Perl 20000 68.32 32.64
2150 IOAsync 20000 157.00 98.14 epoll 2268 IOAsync 20000 174.06 101.15 epoll
2151 IOAsync 20000 159.31 616.06 poll 2269 IOAsync 20000 174.67 610.84 poll
2152 Event 20000 212.62 257.32 2270 Event 20000 202.69 242.91
2153 Glib 20000 651.16 1896.30 2271 Glib 20000 557.01 1689.52
2154 POE 20000 349.67 12317.24 uses POE::Loop::Event 2272 POE 20000 341.54 12086.32 uses POE::Loop::Event
2155 2273
2156=head3 Discussion 2274=head3 Discussion
2157 2275
2158This benchmark I<does> measure scalability and overall performance of the 2276This benchmark I<does> measure scalability and overall performance of the
2159particular event loop. 2277particular event loop.
2285As you can see, the AnyEvent + EV combination even beats the 2403As you can see, the AnyEvent + EV combination even beats the
2286hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2404hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2287backend easily beats IO::Lambda and POE. 2405backend easily beats IO::Lambda and POE.
2288 2406
2289And even the 100% non-blocking version written using the high-level (and 2407And even the 100% non-blocking version written using the high-level (and
2290slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2408slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2291large margin, even though it does all of DNS, tcp-connect and socket I/O 2409higher level ("unoptimised") abstractions by a large margin, even though
2292in a non-blocking way. 2410it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2293 2411
2294The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2412The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2295F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2413F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2296part of the IO::lambda distribution and were used without any changes. 2414part of the IO::Lambda distribution and were used without any changes.
2297 2415
2298 2416
2299=head1 SIGNALS 2417=head1 SIGNALS
2300 2418
2301AnyEvent currently installs handlers for these signals: 2419AnyEvent currently installs handlers for these signals:
2343it's built-in modules) are required to use it. 2461it's built-in modules) are required to use it.
2344 2462
2345That does not mean that AnyEvent won't take advantage of some additional 2463That does not mean that AnyEvent won't take advantage of some additional
2346modules if they are installed. 2464modules if they are installed.
2347 2465
2348This section epxlains which additional modules will be used, and how they 2466This section explains which additional modules will be used, and how they
2349affect AnyEvent's operetion. 2467affect AnyEvent's operation.
2350 2468
2351=over 4 2469=over 4
2352 2470
2353=item L<Async::Interrupt> 2471=item L<Async::Interrupt>
2354 2472
2359catch the signals) with some delay (default is 10 seconds, look for 2477catch the signals) with some delay (default is 10 seconds, look for
2360C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2478C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2361 2479
2362If this module is available, then it will be used to implement signal 2480If this module is available, then it will be used to implement signal
2363catching, which means that signals will not be delayed, and the event loop 2481catching, which means that signals will not be delayed, and the event loop
2364will not be interrupted regularly, which is more efficient (And good for 2482will not be interrupted regularly, which is more efficient (and good for
2365battery life on laptops). 2483battery life on laptops).
2366 2484
2367This affects not just the pure-perl event loop, but also other event loops 2485This affects not just the pure-perl event loop, but also other event loops
2368that have no signal handling on their own (e.g. Glib, Tk, Qt). 2486that have no signal handling on their own (e.g. Glib, Tk, Qt).
2369 2487
2390lot less memory), but otherwise doesn't affect guard operation much. It is 2508lot less memory), but otherwise doesn't affect guard operation much. It is
2391purely used for performance. 2509purely used for performance.
2392 2510
2393=item L<JSON> and L<JSON::XS> 2511=item L<JSON> and L<JSON::XS>
2394 2512
2395This module is required when you want to read or write JSON data via 2513One of these modules is required when you want to read or write JSON data
2396L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2514via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2397advantage of the ultra-high-speed L<JSON::XS> module when it is installed. 2515advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2398 2516
2399In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is 2517In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2400installed. 2518installed.
2401 2519
2419 2537
2420Most event libraries are not fork-safe. The ones who are usually are 2538Most event libraries are not fork-safe. The ones who are usually are
2421because they rely on inefficient but fork-safe C<select> or C<poll> 2539because they rely on inefficient but fork-safe C<select> or C<poll>
2422calls. Only L<EV> is fully fork-aware. 2540calls. Only L<EV> is fully fork-aware.
2423 2541
2542This means that, in general, you cannot fork and do event processing
2543in the child if a watcher was created before the fork (which in turn
2544initialises the event library).
2545
2424If you have to fork, you must either do so I<before> creating your first 2546If you have to fork, you must either do so I<before> creating your first
2425watcher OR you must not use AnyEvent at all in the child OR you must do 2547watcher OR you must not use AnyEvent at all in the child OR you must do
2426something completely out of the scope of AnyEvent. 2548something completely out of the scope of AnyEvent.
2549
2550The problem of doing event processing in the parent I<and> the child
2551is much more complicated: even for backends that I<are> fork-aware or
2552fork-safe, their behaviour is not usually what you want: fork clones all
2553watchers, that means all timers, I/O watchers etc. are active in both
2554parent and child, which is almost never what you want.
2427 2555
2428 2556
2429=head1 SECURITY CONSIDERATIONS 2557=head1 SECURITY CONSIDERATIONS
2430 2558
2431AnyEvent can be forced to load any event model via 2559AnyEvent can be forced to load any event model via

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines