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.261 by root, Tue Jul 28 12:56:17 2009 UTC vs.
Revision 1.296 by root, Tue Nov 17 01:19:49 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.202';
1092our $MODEL; 1129our $MODEL;
1093 1130
1094our $AUTOLOAD; 1131our $AUTOLOAD;
1095our @ISA; 1132our @ISA;
1096 1133
1122 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1159 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1123} 1160}
1124 1161
1125my @models = ( 1162my @models = (
1126 [EV:: => AnyEvent::Impl::EV:: , 1], 1163 [EV:: => AnyEvent::Impl::EV:: , 1],
1127 [Event:: => AnyEvent::Impl::Event::, 1],
1128 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1164 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1129 # everything below here will not (normally) be autoprobed 1165 # everything below here will not (normally) be autoprobed
1130 # as the pureperl backend should work everywhere 1166 # as the pureperl backend should work everywhere
1131 # and is usually faster 1167 # and is usually faster
1168 [Event:: => AnyEvent::Impl::Event::, 1],
1132 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1169 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1133 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1170 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1134 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1171 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1135 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1172 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1136 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1173 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1139 [Prima:: => AnyEvent::Impl::POE::], 1176 [Prima:: => AnyEvent::Impl::POE::],
1140 # IO::Async is just too broken - we would need workarounds for its 1177 # IO::Async is just too broken - we would need workarounds for its
1141 # byzantine signal and broken child handling, among others. 1178 # byzantine signal and broken child handling, among others.
1142 # IO::Async is rather hard to detect, as it doesn't have any 1179 # IO::Async is rather hard to detect, as it doesn't have any
1143 # obvious default class. 1180 # obvious default class.
1144# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1181 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1145# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1182 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1146# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1183 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1184 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1147); 1185);
1148 1186
1149our %method = map +($_ => 1), 1187our %method = map +($_ => 1),
1150 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1188 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1151 1189
1258 # we assume CLOEXEC is already set by perl in all important cases 1296 # we assume CLOEXEC is already set by perl in all important cases
1259 1297
1260 ($fh2, $rw) 1298 ($fh2, $rw)
1261} 1299}
1262 1300
1301=head1 SIMPLIFIED AE API
1302
1303Starting with version 5.0, AnyEvent officially supports a second, much
1304simpler, API that is designed to reduce the calling, typing and memory
1305overhead.
1306
1307See the L<AE> manpage for details.
1308
1309=cut
1310
1311package AE;
1312
1313our $VERSION = $AnyEvent::VERSION;
1314
1315sub io($$$) {
1316 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1317}
1318
1319sub timer($$$) {
1320 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1321}
1322
1323sub signal($$) {
1324 AnyEvent->signal (signal => $_[0], cb => $_[1])
1325}
1326
1327sub child($$) {
1328 AnyEvent->child (pid => $_[0], cb => $_[1])
1329}
1330
1331sub idle($) {
1332 AnyEvent->idle (cb => $_[0])
1333}
1334
1335sub cv(;&) {
1336 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1337}
1338
1339sub now() {
1340 AnyEvent->now
1341}
1342
1343sub now_update() {
1344 AnyEvent->now_update
1345}
1346
1347sub time() {
1348 AnyEvent->time
1349}
1350
1263package AnyEvent::Base; 1351package AnyEvent::Base;
1264 1352
1265# default implementations for many methods 1353# default implementations for many methods
1266 1354
1267sub _time { 1355sub _time() {
1268 # probe for availability of Time::HiRes 1356 # probe for availability of Time::HiRes
1269 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1357 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1270 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1358 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1271 *_time = \&Time::HiRes::time; 1359 *_time = \&Time::HiRes::time;
1272 # if (eval "use POSIX (); (POSIX::times())... 1360 # if (eval "use POSIX (); (POSIX::times())...
1289} 1377}
1290 1378
1291# default implementation for ->signal 1379# default implementation for ->signal
1292 1380
1293our $HAVE_ASYNC_INTERRUPT; 1381our $HAVE_ASYNC_INTERRUPT;
1382
1383sub _have_async_interrupt() {
1384 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1385 && eval "use Async::Interrupt 1.02 (); 1")
1386 unless defined $HAVE_ASYNC_INTERRUPT;
1387
1388 $HAVE_ASYNC_INTERRUPT
1389}
1390
1294our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1391our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1295our (%SIG_ASY, %SIG_ASY_W); 1392our (%SIG_ASY, %SIG_ASY_W);
1296our ($SIG_COUNT, $SIG_TW); 1393our ($SIG_COUNT, $SIG_TW);
1297 1394
1298sub _signal_exec { 1395sub _signal_exec {
1299 $HAVE_ASYNC_INTERRUPT 1396 $HAVE_ASYNC_INTERRUPT
1300 ? $SIGPIPE_R->drain 1397 ? $SIGPIPE_R->drain
1301 : sysread $SIGPIPE_R, my $dummy, 9; 1398 : sysread $SIGPIPE_R, (my $dummy), 9;
1302 1399
1303 while (%SIG_EV) { 1400 while (%SIG_EV) {
1304 for (keys %SIG_EV) { 1401 for (keys %SIG_EV) {
1305 delete $SIG_EV{$_}; 1402 delete $SIG_EV{$_};
1306 $_->() for values %{ $SIG_CB{$_} || {} }; 1403 $_->() for values %{ $SIG_CB{$_} || {} };
1310 1407
1311# install a dummy wakeup watcher to reduce signal catching latency 1408# install a dummy wakeup watcher to reduce signal catching latency
1312sub _sig_add() { 1409sub _sig_add() {
1313 unless ($SIG_COUNT++) { 1410 unless ($SIG_COUNT++) {
1314 # try to align timer on a full-second boundary, if possible 1411 # try to align timer on a full-second boundary, if possible
1315 my $NOW = AnyEvent->now; 1412 my $NOW = AE::now;
1316 1413
1317 $SIG_TW = AnyEvent->timer ( 1414 $SIG_TW = AE::timer
1318 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1415 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1319 interval => $MAX_SIGNAL_LATENCY, 1416 $MAX_SIGNAL_LATENCY,
1320 cb => sub { }, # just for the PERL_ASYNC_CHECK 1417 sub { } # just for the PERL_ASYNC_CHECK
1321 ); 1418 ;
1322 } 1419 }
1323} 1420}
1324 1421
1325sub _sig_del { 1422sub _sig_del {
1326 undef $SIG_TW 1423 undef $SIG_TW
1327 unless --$SIG_COUNT; 1424 unless --$SIG_COUNT;
1328} 1425}
1329 1426
1427our $_sig_name_init; $_sig_name_init = sub {
1428 eval q{ # poor man's autoloading
1429 undef $_sig_name_init;
1430
1431 if (_have_async_interrupt) {
1432 *sig2num = \&Async::Interrupt::sig2num;
1433 *sig2name = \&Async::Interrupt::sig2name;
1434 } else {
1435 require Config;
1436
1437 my %signame2num;
1438 @signame2num{ split ' ', $Config::Config{sig_name} }
1439 = split ' ', $Config::Config{sig_num};
1440
1441 my @signum2name;
1442 @signum2name[values %signame2num] = keys %signame2num;
1443
1444 *sig2num = sub($) {
1445 $_[0] > 0 ? shift : $signame2num{+shift}
1446 };
1447 *sig2name = sub ($) {
1448 $_[0] > 0 ? $signum2name[+shift] : shift
1449 };
1450 }
1451 };
1452 die if $@;
1453};
1454
1455sub sig2num ($) { &$_sig_name_init; &sig2num }
1456sub sig2name($) { &$_sig_name_init; &sig2name }
1457
1330sub _signal { 1458sub signal {
1459 eval q{ # poor man's autoloading {}
1460 # probe for availability of Async::Interrupt
1461 if (_have_async_interrupt) {
1462 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1463
1464 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1465 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1466
1467 } else {
1468 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1469
1470 require Fcntl;
1471
1472 if (AnyEvent::WIN32) {
1473 require AnyEvent::Util;
1474
1475 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1476 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1477 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1478 } else {
1479 pipe $SIGPIPE_R, $SIGPIPE_W;
1480 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1481 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1482
1483 # not strictly required, as $^F is normally 2, but let's make sure...
1484 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1485 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1486 }
1487
1488 $SIGPIPE_R
1489 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1490
1491 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1492 }
1493
1494 *signal = sub {
1331 my (undef, %arg) = @_; 1495 my (undef, %arg) = @_;
1332 1496
1333 my $signal = uc $arg{signal} 1497 my $signal = uc $arg{signal}
1334 or Carp::croak "required option 'signal' is missing"; 1498 or Carp::croak "required option 'signal' is missing";
1335 1499
1336 if ($HAVE_ASYNC_INTERRUPT) { 1500 if ($HAVE_ASYNC_INTERRUPT) {
1337 # async::interrupt 1501 # async::interrupt
1338 1502
1339 $signal = Async::Interrupt::sig2num ($signal); 1503 $signal = sig2num $signal;
1340 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1504 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1341 1505
1342 $SIG_ASY{$signal} ||= do { 1506 $SIG_ASY{$signal} ||= new Async::Interrupt
1343 my $asy = new Async::Interrupt
1344 cb => sub { undef $SIG_EV{$signal} }, 1507 cb => sub { undef $SIG_EV{$signal} },
1345 signal => $signal, 1508 signal => $signal,
1346 pipe => [$SIGPIPE_R->filenos], 1509 pipe => [$SIGPIPE_R->filenos],
1510 pipe_autodrain => 0,
1511 ;
1512
1513 } else {
1514 # pure perl
1515
1516 # AE::Util has been loaded in signal
1517 $signal = sig2name $signal;
1518 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1519
1520 $SIG{$signal} ||= sub {
1521 local $!;
1522 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1523 undef $SIG_EV{$signal};
1524 };
1525
1526 # can't do signal processing without introducing races in pure perl,
1527 # so limit the signal latency.
1528 _sig_add;
1347 ; 1529 }
1348 $asy->pipe_autodrain (0);
1349 1530
1350 $asy 1531 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1351 }; 1532 };
1352 1533
1353 } else { 1534 *AnyEvent::Base::signal::DESTROY = sub {
1354 # pure perl 1535 my ($signal, $cb) = @{$_[0]};
1355 1536
1356 # AE::Util has been loaded in signal 1537 _sig_del;
1357 $signal = AnyEvent::Util::sig2name ($signal);
1358 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1359 1538
1360 $SIG{$signal} ||= sub { 1539 delete $SIG_CB{$signal}{$cb};
1361 local $!; 1540
1362 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1541 $HAVE_ASYNC_INTERRUPT
1542 ? delete $SIG_ASY{$signal}
1543 : # delete doesn't work with older perls - they then
1544 # print weird messages, or just unconditionally exit
1545 # instead of getting the default action.
1363 undef $SIG_EV{$signal}; 1546 undef $SIG{$signal}
1547 unless keys %{ $SIG_CB{$signal} };
1364 }; 1548 };
1365
1366 # can't do signal processing without introducing races in pure perl,
1367 # so limit the signal latency.
1368 _sig_add;
1369 } 1549 };
1370 1550 die if $@;
1371 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1372}
1373
1374sub signal {
1375 # probe for availability of Async::Interrupt
1376 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 1.0 (); 1") {
1377 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1378
1379 $HAVE_ASYNC_INTERRUPT = 1;
1380 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1381 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1382
1383 } else {
1384 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1385
1386 require Fcntl;
1387
1388 if (AnyEvent::WIN32) {
1389 require AnyEvent::Util;
1390
1391 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1392 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1393 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1394 } else {
1395 pipe $SIGPIPE_R, $SIGPIPE_W;
1396 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1397 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1398
1399 # not strictly required, as $^F is normally 2, but let's make sure...
1400 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1401 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1402 }
1403
1404 $SIGPIPE_R
1405 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1406
1407 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1408 }
1409
1410 *signal = \&_signal;
1411 &signal 1551 &signal
1412}
1413
1414sub AnyEvent::Base::signal::DESTROY {
1415 my ($signal, $cb) = @{$_[0]};
1416
1417 _sig_del;
1418
1419 delete $SIG_CB{$signal}{$cb};
1420
1421 $HAVE_ASYNC_INTERRUPT
1422 ? delete $SIG_ASY{$signal}
1423 : # delete doesn't work with older perls - they then
1424 # print weird messages, or just unconditionally exit
1425 # instead of getting the default action.
1426 undef $SIG{$signal}
1427 unless keys %{ $SIG_CB{$signal} };
1428} 1552}
1429 1553
1430# default implementation for ->child 1554# default implementation for ->child
1431 1555
1432our %PID_CB; 1556our %PID_CB;
1461 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1585 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1462 ? 1 1586 ? 1
1463 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1587 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1464 1588
1465 unless ($CHLD_W) { 1589 unless ($CHLD_W) {
1466 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1590 $CHLD_W = AE::signal CHLD => \&_sigchld;
1467 # child could be a zombie already, so make at least one round 1591 # child could be a zombie already, so make at least one round
1468 &_sigchld; 1592 &_sigchld;
1469 } 1593 }
1470 1594
1471 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1595 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1497 # never use more then 50% of the time for the idle watcher, 1621 # never use more then 50% of the time for the idle watcher,
1498 # within some limits 1622 # within some limits
1499 $w = 0.0001 if $w < 0.0001; 1623 $w = 0.0001 if $w < 0.0001;
1500 $w = 5 if $w > 5; 1624 $w = 5 if $w > 5;
1501 1625
1502 $w = AnyEvent->timer (after => $w, cb => $rcb); 1626 $w = AE::timer $w, 0, $rcb;
1503 } else { 1627 } else {
1504 # clean up... 1628 # clean up...
1505 undef $w; 1629 undef $w;
1506 undef $rcb; 1630 undef $rcb;
1507 } 1631 }
1508 }; 1632 };
1509 1633
1510 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1634 $w = AE::timer 0.05, 0, $rcb;
1511 1635
1512 bless \\$cb, "AnyEvent::Base::idle" 1636 bless \\$cb, "AnyEvent::Base::idle"
1513} 1637}
1514 1638
1515sub AnyEvent::Base::idle::DESTROY { 1639sub AnyEvent::Base::idle::DESTROY {
1569 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1693 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1570 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1694 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1571} 1695}
1572 1696
1573sub cb { 1697sub cb {
1574 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1698 my $cv = shift;
1699
1700 @_
1701 and $cv->{_ae_cb} = shift
1702 and $cv->{_ae_sent}
1703 and (delete $cv->{_ae_cb})->($cv);
1704
1575 $_[0]{_ae_cb} 1705 $cv->{_ae_cb}
1576} 1706}
1577 1707
1578sub begin { 1708sub begin {
1579 ++$_[0]{_ae_counter}; 1709 ++$_[0]{_ae_counter};
1580 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1710 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1789 warn "read: $input\n"; # output what has been read 1919 warn "read: $input\n"; # output what has been read
1790 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1920 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1791 }, 1921 },
1792 ); 1922 );
1793 1923
1794 my $time_watcher; # can only be used once
1795
1796 sub new_timer {
1797 $timer = AnyEvent->timer (after => 1, cb => sub { 1924 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1798 warn "timeout\n"; # print 'timeout' about every second 1925 warn "timeout\n"; # print 'timeout' at most every second
1799 &new_timer; # and restart the time
1800 }); 1926 });
1801 }
1802
1803 new_timer; # create first timer
1804 1927
1805 $cv->recv; # wait until user enters /^q/i 1928 $cv->recv; # wait until user enters /^q/i
1806 1929
1807=head1 REAL-WORLD EXAMPLE 1930=head1 REAL-WORLD EXAMPLE
1808 1931
1939through AnyEvent. The benchmark creates a lot of timers (with a zero 2062through AnyEvent. The benchmark creates a lot of timers (with a zero
1940timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2063timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1941which it is), lets them fire exactly once and destroys them again. 2064which it is), lets them fire exactly once and destroys them again.
1942 2065
1943Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2066Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1944distribution. 2067distribution. It uses the L<AE> interface, which makes a real difference
2068for the EV and Perl backends only.
1945 2069
1946=head3 Explanation of the columns 2070=head3 Explanation of the columns
1947 2071
1948I<watcher> is the number of event watchers created/destroyed. Since 2072I<watcher> is the number of event watchers created/destroyed. Since
1949different event models feature vastly different performances, each event 2073different event models feature vastly different performances, each event
1970watcher. 2094watcher.
1971 2095
1972=head3 Results 2096=head3 Results
1973 2097
1974 name watchers bytes create invoke destroy comment 2098 name watchers bytes create invoke destroy comment
1975 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2099 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1976 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2100 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1977 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2101 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1978 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2102 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1979 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2103 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1980 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2104 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1981 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 2105 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1982 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 2106 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1983 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2107 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1984 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2108 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1985 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2109 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1986 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2110 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1987 2111
1988=head3 Discussion 2112=head3 Discussion
1989 2113
1990The benchmark does I<not> measure scalability of the event loop very 2114The benchmark does I<not> measure scalability of the event loop very
1991well. For example, a select-based event loop (such as the pure perl one) 2115well. For example, a select-based event loop (such as the pure perl one)
2003benchmark machine, handling an event takes roughly 1600 CPU cycles with 2127benchmark machine, handling an event takes roughly 1600 CPU cycles with
2004EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2128EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2005cycles with POE. 2129cycles with POE.
2006 2130
2007C<EV> is the sole leader regarding speed and memory use, which are both 2131C<EV> is the sole leader regarding speed and memory use, which are both
2008maximal/minimal, respectively. Even when going through AnyEvent, it uses 2132maximal/minimal, respectively. When using the L<AE> API there is zero
2133overhead (when going through the AnyEvent API create is about 5-6 times
2134slower, with other times being equal, so still uses far less memory than
2009far less memory than any other event loop and is still faster than Event 2135any other event loop and is still faster than Event natively).
2010natively.
2011 2136
2012The pure perl implementation is hit in a few sweet spots (both the 2137The pure perl implementation is hit in a few sweet spots (both the
2013constant timeout and the use of a single fd hit optimisations in the perl 2138constant timeout and the use of a single fd hit optimisations in the perl
2014interpreter and the backend itself). Nevertheless this shows that it 2139interpreter and the backend itself). Nevertheless this shows that it
2015adds very little overhead in itself. Like any select-based backend its 2140adds very little overhead in itself. Like any select-based backend its
2089In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2214In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2090(1%) are active. This mirrors the activity of large servers with many 2215(1%) are active. This mirrors the activity of large servers with many
2091connections, most of which are idle at any one point in time. 2216connections, most of which are idle at any one point in time.
2092 2217
2093Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2218Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2094distribution. 2219distribution. It uses the L<AE> interface, which makes a real difference
2220for the EV and Perl backends only.
2095 2221
2096=head3 Explanation of the columns 2222=head3 Explanation of the columns
2097 2223
2098I<sockets> is the number of sockets, and twice the number of "servers" (as 2224I<sockets> is the number of sockets, and twice the number of "servers" (as
2099each server has a read and write socket end). 2225each server has a read and write socket end).
2107a new one that moves the timeout into the future. 2233a new one that moves the timeout into the future.
2108 2234
2109=head3 Results 2235=head3 Results
2110 2236
2111 name sockets create request 2237 name sockets create request
2112 EV 20000 69.01 11.16 2238 EV 20000 62.66 7.99
2113 Perl 20000 73.32 35.87 2239 Perl 20000 68.32 32.64
2114 IOAsync 20000 157.00 98.14 epoll 2240 IOAsync 20000 174.06 101.15 epoll
2115 IOAsync 20000 159.31 616.06 poll 2241 IOAsync 20000 174.67 610.84 poll
2116 Event 20000 212.62 257.32 2242 Event 20000 202.69 242.91
2117 Glib 20000 651.16 1896.30 2243 Glib 20000 557.01 1689.52
2118 POE 20000 349.67 12317.24 uses POE::Loop::Event 2244 POE 20000 341.54 12086.32 uses POE::Loop::Event
2119 2245
2120=head3 Discussion 2246=head3 Discussion
2121 2247
2122This benchmark I<does> measure scalability and overall performance of the 2248This benchmark I<does> measure scalability and overall performance of the
2123particular event loop. 2249particular event loop.
2249As you can see, the AnyEvent + EV combination even beats the 2375As you can see, the AnyEvent + EV combination even beats the
2250hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2376hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2251backend easily beats IO::Lambda and POE. 2377backend easily beats IO::Lambda and POE.
2252 2378
2253And even the 100% non-blocking version written using the high-level (and 2379And even the 100% non-blocking version written using the high-level (and
2254slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2380slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2255large margin, even though it does all of DNS, tcp-connect and socket I/O 2381higher level ("unoptimised") abstractions by a large margin, even though
2256in a non-blocking way. 2382it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2257 2383
2258The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2384The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2259F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2385F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2260part of the IO::lambda distribution and were used without any changes. 2386part of the IO::Lambda distribution and were used without any changes.
2261 2387
2262 2388
2263=head1 SIGNALS 2389=head1 SIGNALS
2264 2390
2265AnyEvent currently installs handlers for these signals: 2391AnyEvent currently installs handlers for these signals:
2354lot less memory), but otherwise doesn't affect guard operation much. It is 2480lot less memory), but otherwise doesn't affect guard operation much. It is
2355purely used for performance. 2481purely used for performance.
2356 2482
2357=item L<JSON> and L<JSON::XS> 2483=item L<JSON> and L<JSON::XS>
2358 2484
2359This module is required when you want to read or write JSON data via 2485One of these modules is required when you want to read or write JSON data
2360L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2486via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2361advantage of the ultra-high-speed L<JSON::XS> module when it is installed. 2487advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2362 2488
2363In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is 2489In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2364installed. 2490installed.
2365 2491

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines