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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines