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.264 by root, Wed Jul 29 12:42:09 2009 UTC vs.
Revision 1.297 by root, Thu Nov 19 01:55:57 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
383 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 406 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384 407
385=head3 Signal Races, Delays and Workarounds 408=head3 Signal Races, Delays and Workarounds
386 409
387Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 410Many 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 411callbacks 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 412do race-free signal handling in perl, requiring C libraries for
413this. 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 414signals will be delayed. The maximum time a signal might be delayed is
391be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 415specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392seconds). This variable can be changed only before the first signal 416variable can be changed only before the first signal watcher is created,
393watcher is created, and should be left alone otherwise. Higher values 417and should be left alone otherwise. This variable determines how often
418AnyEvent 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 419will cause fewer spurious wake-ups, which is better for power and CPU
420saving.
421
395saving. All these problems can be avoided by installing the optional 422All these problems can be avoided by installing the optional
396L<Async::Interrupt> module. This will not work with inherently broken 423L<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> 424work 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 425(and not with L<POE> currently, as POE does it's own workaround with
399those, you just have to suffer the delays. 426one-second latency). For those, you just have to suffer the delays.
400 427
401=head2 CHILD PROCESS WATCHERS 428=head2 CHILD PROCESS WATCHERS
429
430 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
402 431
403You can also watch on a child process exit and catch its exit status. 432You can also watch on a child process exit and catch its exit status.
404 433
405The child process is specified by the C<pid> argument (one some backends, 434The 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 435using C<0> watches for any child process exit, on others this will
455 # do something else, then wait for process exit 484 # do something else, then wait for process exit
456 $done->recv; 485 $done->recv;
457 486
458=head2 IDLE WATCHERS 487=head2 IDLE WATCHERS
459 488
489 $w = AnyEvent->idle (cb => <callback>);
490
460Sometimes there is a need to do something, but it is not so important 491Sometimes 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 492to 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 493"nothing better to do" is usually defined to be "no other events need
463attention by the event loop". 494attention by the event loop".
464 495
490 }); 521 });
491 }); 522 });
492 523
493=head2 CONDITION VARIABLES 524=head2 CONDITION VARIABLES
494 525
526 $cv = AnyEvent->condvar;
527
528 $cv->send (<list>);
529 my @res = $cv->recv;
530
495If you are familiar with some event loops you will know that all of them 531If 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 532require you to run some blocking "loop", "run" or similar function that
497will actively watch for new events and call your callbacks. 533will actively watch for new events and call your callbacks.
498 534
499AnyEvent is slightly different: it expects somebody else to run the event 535AnyEvent is slightly different: it expects somebody else to run the event
563 after => 1, 599 after => 1,
564 cb => sub { $result_ready->send }, 600 cb => sub { $result_ready->send },
565 ); 601 );
566 602
567 # this "blocks" (while handling events) till the callback 603 # this "blocks" (while handling events) till the callback
568 # calls -<send 604 # calls ->send
569 $result_ready->recv; 605 $result_ready->recv;
570 606
571Example: wait for a timer, but take advantage of the fact that condition 607Example: wait for a timer, but take advantage of the fact that condition
572variables are also callable directly. 608variables are also callable directly.
573 609
637one. For example, a function that pings many hosts in parallel might want 673one. For example, a function that pings many hosts in parallel might want
638to use a condition variable for the whole process. 674to use a condition variable for the whole process.
639 675
640Every call to C<< ->begin >> will increment a counter, and every call to 676Every 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 677C<< ->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 678>>, 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 679condvar as first argument. That callback is I<supposed> to call C<< ->send
644callback was set, C<send> will be called without any arguments. 680>>, but that is not required. If no group callback was set, C<send> will
681be called without any arguments.
645 682
646You can think of C<< $cv->send >> giving you an OR condition (one call 683You 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 684sends), 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). 685condition (all C<begin> calls must be C<end>'ed before the condvar sends).
649 686
676begung can potentially be zero: 713begung can potentially be zero:
677 714
678 my $cv = AnyEvent->condvar; 715 my $cv = AnyEvent->condvar;
679 716
680 my %result; 717 my %result;
681 $cv->begin (sub { $cv->send (\%result) }); 718 $cv->begin (sub { shift->send (\%result) });
682 719
683 for my $host (@list_of_hosts) { 720 for my $host (@list_of_hosts) {
684 $cv->begin; 721 $cv->begin;
685 ping_host_then_call_callback $host, sub { 722 ping_host_then_call_callback $host, sub {
686 $result{$host} = ...; 723 $result{$host} = ...;
761=item $cb = $cv->cb ($cb->($cv)) 798=item $cb = $cv->cb ($cb->($cv))
762 799
763This is a mutator function that returns the callback set and optionally 800This is a mutator function that returns the callback set and optionally
764replaces it before doing so. 801replaces it before doing so.
765 802
766The callback will be called when the condition becomes "true", i.e. when 803The 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 804"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 805the only argument being the condition variable itself. Calling C<recv>
769is guaranteed not to block. 806inside the callback or at any later time is guaranteed not to block.
770 807
771=back 808=back
772 809
773=head1 SUPPORTED EVENT LOOPS/BACKENDS 810=head1 SUPPORTED EVENT LOOPS/BACKENDS
774 811
777=over 4 814=over 4
778 815
779=item Backends that are autoprobed when no other event loop can be found. 816=item Backends that are autoprobed when no other event loop can be found.
780 817
781EV is the preferred backend when no other event loop seems to be in 818EV 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 819use. 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 820pure-perl implementation, which is available everywhere as it comes with
784available everywhere as it comes with AnyEvent itself. 821AnyEvent itself.
785 822
786 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 823 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. 824 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
789 825
790=item Backends that are transparently being picked up when they are used. 826=item Backends that are transparently being picked up when they are used.
791 827
792These will be used when they are currently loaded when the first watcher 828These 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 829is created, in which case it is assumed that the application is using
794them. This means that AnyEvent will automatically pick the right backend 830them. This means that AnyEvent will automatically pick the right backend
795when the main program loads an event module before anything starts to 831when the main program loads an event module before anything starts to
796create watchers. Nothing special needs to be done by the main program. 832create watchers. Nothing special needs to be done by the main program.
797 833
834 AnyEvent::Impl::Event based on Event, very stable, few glitches.
798 AnyEvent::Impl::Glib based on Glib, slow but very stable. 835 AnyEvent::Impl::Glib based on Glib, slow but very stable.
799 AnyEvent::Impl::Tk based on Tk, very broken. 836 AnyEvent::Impl::Tk based on Tk, very broken.
800 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 837 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
801 AnyEvent::Impl::POE based on POE, very slow, some limitations. 838 AnyEvent::Impl::POE based on POE, very slow, some limitations.
802 AnyEvent::Impl::Irssi used when running within irssi. 839 AnyEvent::Impl::Irssi used when running within irssi.
1076 1113
1077package AnyEvent; 1114package AnyEvent;
1078 1115
1079# basically a tuned-down version of common::sense 1116# basically a tuned-down version of common::sense
1080sub common_sense { 1117sub common_sense {
1081 # no warnings 1118 # from common:.sense 1.0
1082 ${^WARNING_BITS} ^= ${^WARNING_BITS}; 1119 ${^WARNING_BITS} = "\xfc\x3f\xf3\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03";
1083 # use strict vars subs 1120 # use strict vars subs
1084 $^H |= 0x00000600; 1121 $^H |= 0x00000600;
1085} 1122}
1086 1123
1087BEGIN { AnyEvent::common_sense } 1124BEGIN { AnyEvent::common_sense }
1088 1125
1089use Carp (); 1126use Carp ();
1090 1127
1091our $VERSION = 4.881; 1128our $VERSION = '5.21';
1092our $MODEL; 1129our $MODEL;
1093 1130
1094our $AUTOLOAD; 1131our $AUTOLOAD;
1095our @ISA; 1132our @ISA;
1096 1133
1097our @REGISTRY; 1134our @REGISTRY;
1098
1099our $WIN32;
1100 1135
1101our $VERBOSE; 1136our $VERBOSE;
1102 1137
1103BEGIN { 1138BEGIN {
1104 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1139 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
1122 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1157 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1123} 1158}
1124 1159
1125my @models = ( 1160my @models = (
1126 [EV:: => AnyEvent::Impl::EV:: , 1], 1161 [EV:: => AnyEvent::Impl::EV:: , 1],
1127 [Event:: => AnyEvent::Impl::Event::, 1],
1128 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1162 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1129 # everything below here will not (normally) be autoprobed 1163 # everything below here will not (normally) be autoprobed
1130 # as the pureperl backend should work everywhere 1164 # as the pureperl backend should work everywhere
1131 # and is usually faster 1165 # and is usually faster
1166 [Event:: => AnyEvent::Impl::Event::, 1],
1132 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1167 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1133 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1168 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1134 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1169 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1135 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1170 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1136 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1171 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1139 [Prima:: => AnyEvent::Impl::POE::], 1174 [Prima:: => AnyEvent::Impl::POE::],
1140 # IO::Async is just too broken - we would need workarounds for its 1175 # IO::Async is just too broken - we would need workarounds for its
1141 # byzantine signal and broken child handling, among others. 1176 # byzantine signal and broken child handling, among others.
1142 # IO::Async is rather hard to detect, as it doesn't have any 1177 # IO::Async is rather hard to detect, as it doesn't have any
1143 # obvious default class. 1178 # obvious default class.
1144# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1179 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1145# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1180 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1146# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1181 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1182 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1147); 1183);
1148 1184
1149our %method = map +($_ => 1), 1185our %method = map +($_ => 1),
1150 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1186 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1151 1187
1258 # we assume CLOEXEC is already set by perl in all important cases 1294 # we assume CLOEXEC is already set by perl in all important cases
1259 1295
1260 ($fh2, $rw) 1296 ($fh2, $rw)
1261} 1297}
1262 1298
1299=head1 SIMPLIFIED AE API
1300
1301Starting with version 5.0, AnyEvent officially supports a second, much
1302simpler, API that is designed to reduce the calling, typing and memory
1303overhead.
1304
1305See the L<AE> manpage for details.
1306
1307=cut
1308
1309package AE;
1310
1311our $VERSION = $AnyEvent::VERSION;
1312
1313sub io($$$) {
1314 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1315}
1316
1317sub timer($$$) {
1318 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1319}
1320
1321sub signal($$) {
1322 AnyEvent->signal (signal => $_[0], cb => $_[1])
1323}
1324
1325sub child($$) {
1326 AnyEvent->child (pid => $_[0], cb => $_[1])
1327}
1328
1329sub idle($) {
1330 AnyEvent->idle (cb => $_[0])
1331}
1332
1333sub cv(;&) {
1334 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1335}
1336
1337sub now() {
1338 AnyEvent->now
1339}
1340
1341sub now_update() {
1342 AnyEvent->now_update
1343}
1344
1345sub time() {
1346 AnyEvent->time
1347}
1348
1263package AnyEvent::Base; 1349package AnyEvent::Base;
1264 1350
1265# default implementations for many methods 1351# default implementations for many methods
1266 1352
1267sub _time { 1353sub _time() {
1268 # probe for availability of Time::HiRes 1354 # probe for availability of Time::HiRes
1269 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1355 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1270 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1356 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1271 *_time = \&Time::HiRes::time; 1357 *_time = \&Time::HiRes::time;
1272 # if (eval "use POSIX (); (POSIX::times())... 1358 # if (eval "use POSIX (); (POSIX::times())...
1292 1378
1293our $HAVE_ASYNC_INTERRUPT; 1379our $HAVE_ASYNC_INTERRUPT;
1294 1380
1295sub _have_async_interrupt() { 1381sub _have_async_interrupt() {
1296 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} 1382 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1297 && eval "use Async::Interrupt 1.0 (); 1") 1383 && eval "use Async::Interrupt 1.02 (); 1")
1298 unless defined $HAVE_ASYNC_INTERRUPT; 1384 unless defined $HAVE_ASYNC_INTERRUPT;
1299 1385
1300 $HAVE_ASYNC_INTERRUPT 1386 $HAVE_ASYNC_INTERRUPT
1301} 1387}
1302 1388
1305our ($SIG_COUNT, $SIG_TW); 1391our ($SIG_COUNT, $SIG_TW);
1306 1392
1307sub _signal_exec { 1393sub _signal_exec {
1308 $HAVE_ASYNC_INTERRUPT 1394 $HAVE_ASYNC_INTERRUPT
1309 ? $SIGPIPE_R->drain 1395 ? $SIGPIPE_R->drain
1310 : sysread $SIGPIPE_R, my $dummy, 9; 1396 : sysread $SIGPIPE_R, (my $dummy), 9;
1311 1397
1312 while (%SIG_EV) { 1398 while (%SIG_EV) {
1313 for (keys %SIG_EV) { 1399 for (keys %SIG_EV) {
1314 delete $SIG_EV{$_}; 1400 delete $SIG_EV{$_};
1315 $_->() for values %{ $SIG_CB{$_} || {} }; 1401 $_->() for values %{ $SIG_CB{$_} || {} };
1319 1405
1320# install a dummy wakeup watcher to reduce signal catching latency 1406# install a dummy wakeup watcher to reduce signal catching latency
1321sub _sig_add() { 1407sub _sig_add() {
1322 unless ($SIG_COUNT++) { 1408 unless ($SIG_COUNT++) {
1323 # try to align timer on a full-second boundary, if possible 1409 # try to align timer on a full-second boundary, if possible
1324 my $NOW = AnyEvent->now; 1410 my $NOW = AE::now;
1325 1411
1326 $SIG_TW = AnyEvent->timer ( 1412 $SIG_TW = AE::timer
1327 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1413 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1328 interval => $MAX_SIGNAL_LATENCY, 1414 $MAX_SIGNAL_LATENCY,
1329 cb => sub { }, # just for the PERL_ASYNC_CHECK 1415 sub { } # just for the PERL_ASYNC_CHECK
1330 ); 1416 ;
1331 } 1417 }
1332} 1418}
1333 1419
1334sub _sig_del { 1420sub _sig_del {
1335 undef $SIG_TW 1421 undef $SIG_TW
1336 unless --$SIG_COUNT; 1422 unless --$SIG_COUNT;
1337} 1423}
1338 1424
1339our $_sig_name_init; $_sig_name_init = sub { 1425our $_sig_name_init; $_sig_name_init = sub {
1426 eval q{ # poor man's autoloading
1340 undef $_sig_name_init; 1427 undef $_sig_name_init;
1341 1428
1342 if (_have_async_interrupt) { 1429 if (_have_async_interrupt) {
1343 *sig2num = \&Async::Interrupt::sig2num; 1430 *sig2num = \&Async::Interrupt::sig2num;
1344 *sig2name = \&Async::Interrupt::sig2name; 1431 *sig2name = \&Async::Interrupt::sig2name;
1345 } else { 1432 } else {
1346 require Config; 1433 require Config;
1347 1434
1348 my %signame2num; 1435 my %signame2num;
1349 @signame2num{ split ' ', $Config::Config{sig_name} } 1436 @signame2num{ split ' ', $Config::Config{sig_name} }
1350 = split ' ', $Config::Config{sig_num}; 1437 = split ' ', $Config::Config{sig_num};
1351 1438
1352 my @signum2name; 1439 my @signum2name;
1353 @signum2name[values %signame2num] = keys %signame2num; 1440 @signum2name[values %signame2num] = keys %signame2num;
1354 1441
1355 *sig2num = sub($) { 1442 *sig2num = sub($) {
1356 $_[0] > 0 ? shift : $signame2num{+shift} 1443 $_[0] > 0 ? shift : $signame2num{+shift}
1357 }; 1444 };
1358 *sig2name = sub ($) { 1445 *sig2name = sub ($) {
1359 $_[0] > 0 ? $signum2name[+shift] : shift 1446 $_[0] > 0 ? $signum2name[+shift] : shift
1447 };
1360 }; 1448 }
1361 } 1449 };
1450 die if $@;
1362}; 1451};
1363 1452
1364sub sig2num ($) { &$_sig_name_init; &sig2num } 1453sub sig2num ($) { &$_sig_name_init; &sig2num }
1365sub sig2name($) { &$_sig_name_init; &sig2name } 1454sub sig2name($) { &$_sig_name_init; &sig2name }
1366 1455
1367sub _signal { 1456sub signal {
1457 eval q{ # poor man's autoloading {}
1458 # probe for availability of Async::Interrupt
1459 if (_have_async_interrupt) {
1460 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1461
1462 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1463 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1464
1465 } else {
1466 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1467
1468 require Fcntl;
1469
1470 if (AnyEvent::WIN32) {
1471 require AnyEvent::Util;
1472
1473 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1474 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1475 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1476 } else {
1477 pipe $SIGPIPE_R, $SIGPIPE_W;
1478 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1479 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1480
1481 # not strictly required, as $^F is normally 2, but let's make sure...
1482 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1483 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1484 }
1485
1486 $SIGPIPE_R
1487 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1488
1489 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1490 }
1491
1492 *signal = sub {
1368 my (undef, %arg) = @_; 1493 my (undef, %arg) = @_;
1369 1494
1370 my $signal = uc $arg{signal} 1495 my $signal = uc $arg{signal}
1371 or Carp::croak "required option 'signal' is missing"; 1496 or Carp::croak "required option 'signal' is missing";
1372 1497
1373 if ($HAVE_ASYNC_INTERRUPT) { 1498 if ($HAVE_ASYNC_INTERRUPT) {
1374 # async::interrupt 1499 # async::interrupt
1375 1500
1376 $signal = sig2num $signal; 1501 $signal = sig2num $signal;
1377 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1502 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1378 1503
1379 $SIG_ASY{$signal} ||= new Async::Interrupt 1504 $SIG_ASY{$signal} ||= new Async::Interrupt
1380 cb => sub { undef $SIG_EV{$signal} }, 1505 cb => sub { undef $SIG_EV{$signal} },
1381 signal => $signal, 1506 signal => $signal,
1382 pipe => [$SIGPIPE_R->filenos], 1507 pipe => [$SIGPIPE_R->filenos],
1383 pipe_autodrain => 0, 1508 pipe_autodrain => 0,
1384 ; 1509 ;
1385 1510
1386 } else { 1511 } else {
1387 # pure perl 1512 # pure perl
1388 1513
1389 # AE::Util has been loaded in signal 1514 # AE::Util has been loaded in signal
1390 $signal = sig2name $signal; 1515 $signal = sig2name $signal;
1391 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1516 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1392 1517
1393 $SIG{$signal} ||= sub { 1518 $SIG{$signal} ||= sub {
1394 local $!; 1519 local $!;
1395 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1520 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1396 undef $SIG_EV{$signal}; 1521 undef $SIG_EV{$signal};
1522 };
1523
1524 # can't do signal processing without introducing races in pure perl,
1525 # so limit the signal latency.
1526 _sig_add;
1527 }
1528
1529 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1397 }; 1530 };
1398 1531
1399 # can't do signal processing without introducing races in pure perl, 1532 *AnyEvent::Base::signal::DESTROY = sub {
1400 # so limit the signal latency. 1533 my ($signal, $cb) = @{$_[0]};
1534
1401 _sig_add; 1535 _sig_del;
1402 }
1403 1536
1404 bless [$signal, $arg{cb}], "AnyEvent::Base::signal" 1537 delete $SIG_CB{$signal}{$cb};
1405}
1406 1538
1407sub signal { 1539 $HAVE_ASYNC_INTERRUPT
1408 # probe for availability of Async::Interrupt 1540 ? delete $SIG_ASY{$signal}
1409 if (_have_async_interrupt) { 1541 : # delete doesn't work with older perls - they then
1410 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1542 # print weird messages, or just unconditionally exit
1411 1543 # instead of getting the default action.
1412 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1544 undef $SIG{$signal}
1413 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); 1545 unless keys %{ $SIG_CB{$signal} };
1414
1415 } else {
1416 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1417
1418 require Fcntl;
1419
1420 if (AnyEvent::WIN32) {
1421 require AnyEvent::Util;
1422
1423 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1424 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1425 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1426 } else {
1427 pipe $SIGPIPE_R, $SIGPIPE_W;
1428 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1429 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1430
1431 # not strictly required, as $^F is normally 2, but let's make sure...
1432 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1433 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1434 } 1546 };
1435
1436 $SIGPIPE_R
1437 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1438
1439 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1440 } 1547 };
1441 1548 die if $@;
1442 *signal = \&_signal;
1443 &signal 1549 &signal
1444}
1445
1446sub AnyEvent::Base::signal::DESTROY {
1447 my ($signal, $cb) = @{$_[0]};
1448
1449 _sig_del;
1450
1451 delete $SIG_CB{$signal}{$cb};
1452
1453 $HAVE_ASYNC_INTERRUPT
1454 ? delete $SIG_ASY{$signal}
1455 : # delete doesn't work with older perls - they then
1456 # print weird messages, or just unconditionally exit
1457 # instead of getting the default action.
1458 undef $SIG{$signal}
1459 unless keys %{ $SIG_CB{$signal} };
1460} 1550}
1461 1551
1462# default implementation for ->child 1552# default implementation for ->child
1463 1553
1464our %PID_CB; 1554our %PID_CB;
1493 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1583 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1494 ? 1 1584 ? 1
1495 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1585 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1496 1586
1497 unless ($CHLD_W) { 1587 unless ($CHLD_W) {
1498 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1588 $CHLD_W = AE::signal CHLD => \&_sigchld;
1499 # child could be a zombie already, so make at least one round 1589 # child could be a zombie already, so make at least one round
1500 &_sigchld; 1590 &_sigchld;
1501 } 1591 }
1502 1592
1503 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1593 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1529 # never use more then 50% of the time for the idle watcher, 1619 # never use more then 50% of the time for the idle watcher,
1530 # within some limits 1620 # within some limits
1531 $w = 0.0001 if $w < 0.0001; 1621 $w = 0.0001 if $w < 0.0001;
1532 $w = 5 if $w > 5; 1622 $w = 5 if $w > 5;
1533 1623
1534 $w = AnyEvent->timer (after => $w, cb => $rcb); 1624 $w = AE::timer $w, 0, $rcb;
1535 } else { 1625 } else {
1536 # clean up... 1626 # clean up...
1537 undef $w; 1627 undef $w;
1538 undef $rcb; 1628 undef $rcb;
1539 } 1629 }
1540 }; 1630 };
1541 1631
1542 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1632 $w = AE::timer 0.05, 0, $rcb;
1543 1633
1544 bless \\$cb, "AnyEvent::Base::idle" 1634 bless \\$cb, "AnyEvent::Base::idle"
1545} 1635}
1546 1636
1547sub AnyEvent::Base::idle::DESTROY { 1637sub AnyEvent::Base::idle::DESTROY {
1601 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1691 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1602 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1692 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1603} 1693}
1604 1694
1605sub cb { 1695sub cb {
1606 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1696 my $cv = shift;
1697
1698 @_
1699 and $cv->{_ae_cb} = shift
1700 and $cv->{_ae_sent}
1701 and (delete $cv->{_ae_cb})->($cv);
1702
1607 $_[0]{_ae_cb} 1703 $cv->{_ae_cb}
1608} 1704}
1609 1705
1610sub begin { 1706sub begin {
1611 ++$_[0]{_ae_counter}; 1707 ++$_[0]{_ae_counter};
1612 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1708 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1821 warn "read: $input\n"; # output what has been read 1917 warn "read: $input\n"; # output what has been read
1822 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1918 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1823 }, 1919 },
1824 ); 1920 );
1825 1921
1826 my $time_watcher; # can only be used once
1827
1828 sub new_timer {
1829 $timer = AnyEvent->timer (after => 1, cb => sub { 1922 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1830 warn "timeout\n"; # print 'timeout' about every second 1923 warn "timeout\n"; # print 'timeout' at most every second
1831 &new_timer; # and restart the time
1832 }); 1924 });
1833 }
1834
1835 new_timer; # create first timer
1836 1925
1837 $cv->recv; # wait until user enters /^q/i 1926 $cv->recv; # wait until user enters /^q/i
1838 1927
1839=head1 REAL-WORLD EXAMPLE 1928=head1 REAL-WORLD EXAMPLE
1840 1929
1971through AnyEvent. The benchmark creates a lot of timers (with a zero 2060through AnyEvent. The benchmark creates a lot of timers (with a zero
1972timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2061timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1973which it is), lets them fire exactly once and destroys them again. 2062which it is), lets them fire exactly once and destroys them again.
1974 2063
1975Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2064Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1976distribution. 2065distribution. It uses the L<AE> interface, which makes a real difference
2066for the EV and Perl backends only.
1977 2067
1978=head3 Explanation of the columns 2068=head3 Explanation of the columns
1979 2069
1980I<watcher> is the number of event watchers created/destroyed. Since 2070I<watcher> is the number of event watchers created/destroyed. Since
1981different event models feature vastly different performances, each event 2071different event models feature vastly different performances, each event
2002watcher. 2092watcher.
2003 2093
2004=head3 Results 2094=head3 Results
2005 2095
2006 name watchers bytes create invoke destroy comment 2096 name watchers bytes create invoke destroy comment
2007 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2097 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2008 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2098 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2009 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2099 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2010 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2100 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2011 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2101 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2012 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2102 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2013 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 2103 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2014 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 2104 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2015 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2105 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2016 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2106 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2017 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2107 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2018 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2108 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2019 2109
2020=head3 Discussion 2110=head3 Discussion
2021 2111
2022The benchmark does I<not> measure scalability of the event loop very 2112The benchmark does I<not> measure scalability of the event loop very
2023well. For example, a select-based event loop (such as the pure perl one) 2113well. For example, a select-based event loop (such as the pure perl one)
2035benchmark machine, handling an event takes roughly 1600 CPU cycles with 2125benchmark machine, handling an event takes roughly 1600 CPU cycles with
2036EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2126EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2037cycles with POE. 2127cycles with POE.
2038 2128
2039C<EV> is the sole leader regarding speed and memory use, which are both 2129C<EV> is the sole leader regarding speed and memory use, which are both
2040maximal/minimal, respectively. Even when going through AnyEvent, it uses 2130maximal/minimal, respectively. When using the L<AE> API there is zero
2131overhead (when going through the AnyEvent API create is about 5-6 times
2132slower, with other times being equal, so still uses far less memory than
2041far less memory than any other event loop and is still faster than Event 2133any other event loop and is still faster than Event natively).
2042natively.
2043 2134
2044The pure perl implementation is hit in a few sweet spots (both the 2135The pure perl implementation is hit in a few sweet spots (both the
2045constant timeout and the use of a single fd hit optimisations in the perl 2136constant timeout and the use of a single fd hit optimisations in the perl
2046interpreter and the backend itself). Nevertheless this shows that it 2137interpreter and the backend itself). Nevertheless this shows that it
2047adds very little overhead in itself. Like any select-based backend its 2138adds very little overhead in itself. Like any select-based backend its
2121In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2212In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2122(1%) are active. This mirrors the activity of large servers with many 2213(1%) are active. This mirrors the activity of large servers with many
2123connections, most of which are idle at any one point in time. 2214connections, most of which are idle at any one point in time.
2124 2215
2125Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2216Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2126distribution. 2217distribution. It uses the L<AE> interface, which makes a real difference
2218for the EV and Perl backends only.
2127 2219
2128=head3 Explanation of the columns 2220=head3 Explanation of the columns
2129 2221
2130I<sockets> is the number of sockets, and twice the number of "servers" (as 2222I<sockets> is the number of sockets, and twice the number of "servers" (as
2131each server has a read and write socket end). 2223each server has a read and write socket end).
2139a new one that moves the timeout into the future. 2231a new one that moves the timeout into the future.
2140 2232
2141=head3 Results 2233=head3 Results
2142 2234
2143 name sockets create request 2235 name sockets create request
2144 EV 20000 69.01 11.16 2236 EV 20000 62.66 7.99
2145 Perl 20000 73.32 35.87 2237 Perl 20000 68.32 32.64
2146 IOAsync 20000 157.00 98.14 epoll 2238 IOAsync 20000 174.06 101.15 epoll
2147 IOAsync 20000 159.31 616.06 poll 2239 IOAsync 20000 174.67 610.84 poll
2148 Event 20000 212.62 257.32 2240 Event 20000 202.69 242.91
2149 Glib 20000 651.16 1896.30 2241 Glib 20000 557.01 1689.52
2150 POE 20000 349.67 12317.24 uses POE::Loop::Event 2242 POE 20000 341.54 12086.32 uses POE::Loop::Event
2151 2243
2152=head3 Discussion 2244=head3 Discussion
2153 2245
2154This benchmark I<does> measure scalability and overall performance of the 2246This benchmark I<does> measure scalability and overall performance of the
2155particular event loop. 2247particular event loop.
2281As you can see, the AnyEvent + EV combination even beats the 2373As you can see, the AnyEvent + EV combination even beats the
2282hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2374hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2283backend easily beats IO::Lambda and POE. 2375backend easily beats IO::Lambda and POE.
2284 2376
2285And even the 100% non-blocking version written using the high-level (and 2377And even the 100% non-blocking version written using the high-level (and
2286slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2378slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2287large margin, even though it does all of DNS, tcp-connect and socket I/O 2379higher level ("unoptimised") abstractions by a large margin, even though
2288in a non-blocking way. 2380it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2289 2381
2290The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2382The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2291F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2383F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2292part of the IO::lambda distribution and were used without any changes. 2384part of the IO::Lambda distribution and were used without any changes.
2293 2385
2294 2386
2295=head1 SIGNALS 2387=head1 SIGNALS
2296 2388
2297AnyEvent currently installs handlers for these signals: 2389AnyEvent currently installs handlers for these signals:
2386lot less memory), but otherwise doesn't affect guard operation much. It is 2478lot less memory), but otherwise doesn't affect guard operation much. It is
2387purely used for performance. 2479purely used for performance.
2388 2480
2389=item L<JSON> and L<JSON::XS> 2481=item L<JSON> and L<JSON::XS>
2390 2482
2391This module is required when you want to read or write JSON data via 2483One of these modules is required when you want to read or write JSON data
2392L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2484via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2393advantage of the ultra-high-speed L<JSON::XS> module when it is installed. 2485advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2394 2486
2395In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is 2487In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2396installed. 2488installed.
2397 2489

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines