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.298 by root, Tue Nov 24 05:48: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
349might affect timers and time-outs. 363might affect timers and time-outs.
350 364
351When this is the case, you can call this method, which will update the 365When this is the case, you can call this method, which will update the
352event loop's idea of "current time". 366event loop's idea of "current time".
353 367
368A typical example would be a script in a web server (e.g. C<mod_perl>) -
369when mod_perl executes the script, then the event loop will have the wrong
370idea about the "current time" (being potentially far in the past, when the
371script ran the last time). In that case you should arrange a call to C<<
372AnyEvent->now_update >> each time the web server process wakes up again
373(e.g. at the start of your script, or in a handler).
374
354Note that updating the time I<might> cause some events to be handled. 375Note that updating the time I<might> cause some events to be handled.
355 376
356=back 377=back
357 378
358=head2 SIGNAL WATCHERS 379=head2 SIGNAL WATCHERS
380
381 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
359 382
360You can watch for signals using a signal watcher, C<signal> is the signal 383You can watch for signals using a signal watcher, C<signal> is the signal
361I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl 384I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
362callback to be invoked whenever a signal occurs. 385callback to be invoked whenever a signal occurs.
363 386
380 403
381Example: exit on SIGINT 404Example: exit on SIGINT
382 405
383 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 406 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384 407
408=head3 Restart Behaviour
409
410While restart behaviour is up to the event loop implementation, most will
411not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
412pure perl implementation).
413
414=head3 Safe/Unsafe Signals
415
416Perl signals can be either "safe" (synchronous to opcode handling) or
417"unsafe" (asynchronous) - the former might get delayed indefinitely, the
418latter might corrupt your memory.
419
420AnyEvent signal handlers are, in addition, synchronous to the event loop,
421i.e. they will not interrupt your running perl program but will only be
422called as part of the normal event handling (just like timer, I/O etc.
423callbacks, too).
424
385=head3 Signal Races, Delays and Workarounds 425=head3 Signal Races, Delays and Workarounds
386 426
387Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 427Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
388callbacks to signals in a generic way, which is a pity, as you cannot do 428callbacks to signals in a generic way, which is a pity, as you cannot
389race-free signal handling in perl. AnyEvent will try to do it's best, but 429do race-free signal handling in perl, requiring C libraries for
430this. AnyEvent will try to do it's best, which means in some cases,
390in some cases, signals will be delayed. The maximum time a signal might 431signals will be delayed. The maximum time a signal might be delayed is
391be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 432specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392seconds). This variable can be changed only before the first signal 433variable can be changed only before the first signal watcher is created,
393watcher is created, and should be left alone otherwise. Higher values 434and should be left alone otherwise. This variable determines how often
435AnyEvent polls for signals (in case a wake-up was missed). Higher values
394will cause fewer spurious wake-ups, which is better for power and CPU 436will cause fewer spurious wake-ups, which is better for power and CPU
437saving.
438
395saving. All these problems can be avoided by installing the optional 439All these problems can be avoided by installing the optional
396L<Async::Interrupt> module. This will not work with inherently broken 440L<Async::Interrupt> module, which works with most event loops. It will not
397event loops such as L<Event> or L<Event::Lib> (and not with L<POE> 441work with inherently broken event loops such as L<Event> or L<Event::Lib>
398currently, as POE does it's own workaround with one-second latency). With 442(and not with L<POE> currently, as POE does it's own workaround with
399those, you just have to suffer the delays. 443one-second latency). For those, you just have to suffer the delays.
400 444
401=head2 CHILD PROCESS WATCHERS 445=head2 CHILD PROCESS WATCHERS
446
447 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
402 448
403You can also watch on a child process exit and catch its exit status. 449You can also watch on a child process exit and catch its exit status.
404 450
405The child process is specified by the C<pid> argument (one some backends, 451The child process is specified by the C<pid> argument (one some backends,
406using C<0> watches for any child process exit, on others this will 452using C<0> watches for any child process exit, on others this will
455 # do something else, then wait for process exit 501 # do something else, then wait for process exit
456 $done->recv; 502 $done->recv;
457 503
458=head2 IDLE WATCHERS 504=head2 IDLE WATCHERS
459 505
506 $w = AnyEvent->idle (cb => <callback>);
507
460Sometimes there is a need to do something, but it is not so important 508Sometimes there is a need to do something, but it is not so important
461to do it instantly, but only when there is nothing better to do. This 509to do it instantly, but only when there is nothing better to do. This
462"nothing better to do" is usually defined to be "no other events need 510"nothing better to do" is usually defined to be "no other events need
463attention by the event loop". 511attention by the event loop".
464 512
490 }); 538 });
491 }); 539 });
492 540
493=head2 CONDITION VARIABLES 541=head2 CONDITION VARIABLES
494 542
543 $cv = AnyEvent->condvar;
544
545 $cv->send (<list>);
546 my @res = $cv->recv;
547
495If you are familiar with some event loops you will know that all of them 548If you are familiar with some event loops you will know that all of them
496require you to run some blocking "loop", "run" or similar function that 549require you to run some blocking "loop", "run" or similar function that
497will actively watch for new events and call your callbacks. 550will actively watch for new events and call your callbacks.
498 551
499AnyEvent is slightly different: it expects somebody else to run the event 552AnyEvent is slightly different: it expects somebody else to run the event
563 after => 1, 616 after => 1,
564 cb => sub { $result_ready->send }, 617 cb => sub { $result_ready->send },
565 ); 618 );
566 619
567 # this "blocks" (while handling events) till the callback 620 # this "blocks" (while handling events) till the callback
568 # calls -<send 621 # calls ->send
569 $result_ready->recv; 622 $result_ready->recv;
570 623
571Example: wait for a timer, but take advantage of the fact that condition 624Example: wait for a timer, but take advantage of the fact that condition
572variables are also callable directly. 625variables are also callable directly.
573 626
637one. For example, a function that pings many hosts in parallel might want 690one. For example, a function that pings many hosts in parallel might want
638to use a condition variable for the whole process. 691to use a condition variable for the whole process.
639 692
640Every call to C<< ->begin >> will increment a counter, and every call to 693Every call to C<< ->begin >> will increment a counter, and every call to
641C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 694C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
642>>, the (last) callback passed to C<begin> will be executed. That callback 695>>, the (last) callback passed to C<begin> will be executed, passing the
643is I<supposed> to call C<< ->send >>, but that is not required. If no 696condvar as first argument. That callback is I<supposed> to call C<< ->send
644callback was set, C<send> will be called without any arguments. 697>>, but that is not required. If no group callback was set, C<send> will
698be called without any arguments.
645 699
646You can think of C<< $cv->send >> giving you an OR condition (one call 700You can think of C<< $cv->send >> giving you an OR condition (one call
647sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND 701sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
648condition (all C<begin> calls must be C<end>'ed before the condvar sends). 702condition (all C<begin> calls must be C<end>'ed before the condvar sends).
649 703
676begung can potentially be zero: 730begung can potentially be zero:
677 731
678 my $cv = AnyEvent->condvar; 732 my $cv = AnyEvent->condvar;
679 733
680 my %result; 734 my %result;
681 $cv->begin (sub { $cv->send (\%result) }); 735 $cv->begin (sub { shift->send (\%result) });
682 736
683 for my $host (@list_of_hosts) { 737 for my $host (@list_of_hosts) {
684 $cv->begin; 738 $cv->begin;
685 ping_host_then_call_callback $host, sub { 739 ping_host_then_call_callback $host, sub {
686 $result{$host} = ...; 740 $result{$host} = ...;
761=item $cb = $cv->cb ($cb->($cv)) 815=item $cb = $cv->cb ($cb->($cv))
762 816
763This is a mutator function that returns the callback set and optionally 817This is a mutator function that returns the callback set and optionally
764replaces it before doing so. 818replaces it before doing so.
765 819
766The callback will be called when the condition becomes "true", i.e. when 820The callback will be called when the condition becomes (or already was)
767C<send> or C<croak> are called, with the only argument being the condition 821"true", i.e. when C<send> or C<croak> are called (or were called), with
768variable itself. Calling C<recv> inside the callback or at any later time 822the only argument being the condition variable itself. Calling C<recv>
769is guaranteed not to block. 823inside the callback or at any later time is guaranteed not to block.
770 824
771=back 825=back
772 826
773=head1 SUPPORTED EVENT LOOPS/BACKENDS 827=head1 SUPPORTED EVENT LOOPS/BACKENDS
774 828
777=over 4 831=over 4
778 832
779=item Backends that are autoprobed when no other event loop can be found. 833=item Backends that are autoprobed when no other event loop can be found.
780 834
781EV is the preferred backend when no other event loop seems to be in 835EV is the preferred backend when no other event loop seems to be in
782use. If EV is not installed, then AnyEvent will try Event, and, failing 836use. If EV is not installed, then AnyEvent will fall back to its own
783that, will fall back to its own pure-perl implementation, which is 837pure-perl implementation, which is available everywhere as it comes with
784available everywhere as it comes with AnyEvent itself. 838AnyEvent itself.
785 839
786 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 840 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
787 AnyEvent::Impl::Event based on Event, very stable, few glitches.
788 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 841 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
789 842
790=item Backends that are transparently being picked up when they are used. 843=item Backends that are transparently being picked up when they are used.
791 844
792These will be used when they are currently loaded when the first watcher 845These will be used when they are currently loaded when the first watcher
793is created, in which case it is assumed that the application is using 846is created, in which case it is assumed that the application is using
794them. This means that AnyEvent will automatically pick the right backend 847them. This means that AnyEvent will automatically pick the right backend
795when the main program loads an event module before anything starts to 848when the main program loads an event module before anything starts to
796create watchers. Nothing special needs to be done by the main program. 849create watchers. Nothing special needs to be done by the main program.
797 850
851 AnyEvent::Impl::Event based on Event, very stable, few glitches.
798 AnyEvent::Impl::Glib based on Glib, slow but very stable. 852 AnyEvent::Impl::Glib based on Glib, slow but very stable.
799 AnyEvent::Impl::Tk based on Tk, very broken. 853 AnyEvent::Impl::Tk based on Tk, very broken.
800 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 854 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
801 AnyEvent::Impl::POE based on POE, very slow, some limitations. 855 AnyEvent::Impl::POE based on POE, very slow, some limitations.
802 AnyEvent::Impl::Irssi used when running within irssi. 856 AnyEvent::Impl::Irssi used when running within irssi.
1076 1130
1077package AnyEvent; 1131package AnyEvent;
1078 1132
1079# basically a tuned-down version of common::sense 1133# basically a tuned-down version of common::sense
1080sub common_sense { 1134sub common_sense {
1081 # no warnings 1135 # from common:.sense 1.0
1082 ${^WARNING_BITS} ^= ${^WARNING_BITS}; 1136 ${^WARNING_BITS} = "\xfc\x3f\xf3\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03";
1083 # use strict vars subs 1137 # use strict vars subs
1084 $^H |= 0x00000600; 1138 $^H |= 0x00000600;
1085} 1139}
1086 1140
1087BEGIN { AnyEvent::common_sense } 1141BEGIN { AnyEvent::common_sense }
1088 1142
1089use Carp (); 1143use Carp ();
1090 1144
1091our $VERSION = 4.881; 1145our $VERSION = '5.21';
1092our $MODEL; 1146our $MODEL;
1093 1147
1094our $AUTOLOAD; 1148our $AUTOLOAD;
1095our @ISA; 1149our @ISA;
1096 1150
1097our @REGISTRY; 1151our @REGISTRY;
1098
1099our $WIN32;
1100 1152
1101our $VERBOSE; 1153our $VERBOSE;
1102 1154
1103BEGIN { 1155BEGIN {
1104 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1156 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
1122 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1174 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1123} 1175}
1124 1176
1125my @models = ( 1177my @models = (
1126 [EV:: => AnyEvent::Impl::EV:: , 1], 1178 [EV:: => AnyEvent::Impl::EV:: , 1],
1127 [Event:: => AnyEvent::Impl::Event::, 1],
1128 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1179 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1129 # everything below here will not (normally) be autoprobed 1180 # everything below here will not (normally) be autoprobed
1130 # as the pureperl backend should work everywhere 1181 # as the pureperl backend should work everywhere
1131 # and is usually faster 1182 # and is usually faster
1183 [Event:: => AnyEvent::Impl::Event::, 1],
1132 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1184 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1133 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1185 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1134 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1186 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1135 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1187 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1136 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1188 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1139 [Prima:: => AnyEvent::Impl::POE::], 1191 [Prima:: => AnyEvent::Impl::POE::],
1140 # IO::Async is just too broken - we would need workarounds for its 1192 # IO::Async is just too broken - we would need workarounds for its
1141 # byzantine signal and broken child handling, among others. 1193 # byzantine signal and broken child handling, among others.
1142 # IO::Async is rather hard to detect, as it doesn't have any 1194 # IO::Async is rather hard to detect, as it doesn't have any
1143 # obvious default class. 1195 # obvious default class.
1144# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1196 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1145# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1197 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1146# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1198 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1199 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1147); 1200);
1148 1201
1149our %method = map +($_ => 1), 1202our %method = map +($_ => 1),
1150 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1203 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1151 1204
1258 # we assume CLOEXEC is already set by perl in all important cases 1311 # we assume CLOEXEC is already set by perl in all important cases
1259 1312
1260 ($fh2, $rw) 1313 ($fh2, $rw)
1261} 1314}
1262 1315
1316=head1 SIMPLIFIED AE API
1317
1318Starting with version 5.0, AnyEvent officially supports a second, much
1319simpler, API that is designed to reduce the calling, typing and memory
1320overhead.
1321
1322See the L<AE> manpage for details.
1323
1324=cut
1325
1326package AE;
1327
1328our $VERSION = $AnyEvent::VERSION;
1329
1330sub io($$$) {
1331 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1332}
1333
1334sub timer($$$) {
1335 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1336}
1337
1338sub signal($$) {
1339 AnyEvent->signal (signal => $_[0], cb => $_[1])
1340}
1341
1342sub child($$) {
1343 AnyEvent->child (pid => $_[0], cb => $_[1])
1344}
1345
1346sub idle($) {
1347 AnyEvent->idle (cb => $_[0])
1348}
1349
1350sub cv(;&) {
1351 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1352}
1353
1354sub now() {
1355 AnyEvent->now
1356}
1357
1358sub now_update() {
1359 AnyEvent->now_update
1360}
1361
1362sub time() {
1363 AnyEvent->time
1364}
1365
1263package AnyEvent::Base; 1366package AnyEvent::Base;
1264 1367
1265# default implementations for many methods 1368# default implementations for many methods
1266 1369
1267sub _time { 1370sub _time() {
1268 # probe for availability of Time::HiRes 1371 # probe for availability of Time::HiRes
1269 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1372 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1270 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1373 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1271 *_time = \&Time::HiRes::time; 1374 *_time = \&Time::HiRes::time;
1272 # if (eval "use POSIX (); (POSIX::times())... 1375 # if (eval "use POSIX (); (POSIX::times())...
1292 1395
1293our $HAVE_ASYNC_INTERRUPT; 1396our $HAVE_ASYNC_INTERRUPT;
1294 1397
1295sub _have_async_interrupt() { 1398sub _have_async_interrupt() {
1296 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} 1399 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1297 && eval "use Async::Interrupt 1.0 (); 1") 1400 && eval "use Async::Interrupt 1.02 (); 1")
1298 unless defined $HAVE_ASYNC_INTERRUPT; 1401 unless defined $HAVE_ASYNC_INTERRUPT;
1299 1402
1300 $HAVE_ASYNC_INTERRUPT 1403 $HAVE_ASYNC_INTERRUPT
1301} 1404}
1302 1405
1305our ($SIG_COUNT, $SIG_TW); 1408our ($SIG_COUNT, $SIG_TW);
1306 1409
1307sub _signal_exec { 1410sub _signal_exec {
1308 $HAVE_ASYNC_INTERRUPT 1411 $HAVE_ASYNC_INTERRUPT
1309 ? $SIGPIPE_R->drain 1412 ? $SIGPIPE_R->drain
1310 : sysread $SIGPIPE_R, my $dummy, 9; 1413 : sysread $SIGPIPE_R, (my $dummy), 9;
1311 1414
1312 while (%SIG_EV) { 1415 while (%SIG_EV) {
1313 for (keys %SIG_EV) { 1416 for (keys %SIG_EV) {
1314 delete $SIG_EV{$_}; 1417 delete $SIG_EV{$_};
1315 $_->() for values %{ $SIG_CB{$_} || {} }; 1418 $_->() for values %{ $SIG_CB{$_} || {} };
1319 1422
1320# install a dummy wakeup watcher to reduce signal catching latency 1423# install a dummy wakeup watcher to reduce signal catching latency
1321sub _sig_add() { 1424sub _sig_add() {
1322 unless ($SIG_COUNT++) { 1425 unless ($SIG_COUNT++) {
1323 # try to align timer on a full-second boundary, if possible 1426 # try to align timer on a full-second boundary, if possible
1324 my $NOW = AnyEvent->now; 1427 my $NOW = AE::now;
1325 1428
1326 $SIG_TW = AnyEvent->timer ( 1429 $SIG_TW = AE::timer
1327 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1430 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1328 interval => $MAX_SIGNAL_LATENCY, 1431 $MAX_SIGNAL_LATENCY,
1329 cb => sub { }, # just for the PERL_ASYNC_CHECK 1432 sub { } # just for the PERL_ASYNC_CHECK
1330 ); 1433 ;
1331 } 1434 }
1332} 1435}
1333 1436
1334sub _sig_del { 1437sub _sig_del {
1335 undef $SIG_TW 1438 undef $SIG_TW
1336 unless --$SIG_COUNT; 1439 unless --$SIG_COUNT;
1337} 1440}
1338 1441
1339our $_sig_name_init; $_sig_name_init = sub { 1442our $_sig_name_init; $_sig_name_init = sub {
1443 eval q{ # poor man's autoloading
1340 undef $_sig_name_init; 1444 undef $_sig_name_init;
1341 1445
1342 if (_have_async_interrupt) { 1446 if (_have_async_interrupt) {
1343 *sig2num = \&Async::Interrupt::sig2num; 1447 *sig2num = \&Async::Interrupt::sig2num;
1344 *sig2name = \&Async::Interrupt::sig2name; 1448 *sig2name = \&Async::Interrupt::sig2name;
1345 } else { 1449 } else {
1346 require Config; 1450 require Config;
1347 1451
1348 my %signame2num; 1452 my %signame2num;
1349 @signame2num{ split ' ', $Config::Config{sig_name} } 1453 @signame2num{ split ' ', $Config::Config{sig_name} }
1350 = split ' ', $Config::Config{sig_num}; 1454 = split ' ', $Config::Config{sig_num};
1351 1455
1352 my @signum2name; 1456 my @signum2name;
1353 @signum2name[values %signame2num] = keys %signame2num; 1457 @signum2name[values %signame2num] = keys %signame2num;
1354 1458
1355 *sig2num = sub($) { 1459 *sig2num = sub($) {
1356 $_[0] > 0 ? shift : $signame2num{+shift} 1460 $_[0] > 0 ? shift : $signame2num{+shift}
1357 }; 1461 };
1358 *sig2name = sub ($) { 1462 *sig2name = sub ($) {
1359 $_[0] > 0 ? $signum2name[+shift] : shift 1463 $_[0] > 0 ? $signum2name[+shift] : shift
1464 };
1360 }; 1465 }
1361 } 1466 };
1467 die if $@;
1362}; 1468};
1363 1469
1364sub sig2num ($) { &$_sig_name_init; &sig2num } 1470sub sig2num ($) { &$_sig_name_init; &sig2num }
1365sub sig2name($) { &$_sig_name_init; &sig2name } 1471sub sig2name($) { &$_sig_name_init; &sig2name }
1366 1472
1367sub _signal { 1473sub signal {
1474 eval q{ # poor man's autoloading {}
1475 # probe for availability of Async::Interrupt
1476 if (_have_async_interrupt) {
1477 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1478
1479 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1480 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1481
1482 } else {
1483 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1484
1485 require Fcntl;
1486
1487 if (AnyEvent::WIN32) {
1488 require AnyEvent::Util;
1489
1490 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1491 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1492 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1493 } else {
1494 pipe $SIGPIPE_R, $SIGPIPE_W;
1495 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1496 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1497
1498 # not strictly required, as $^F is normally 2, but let's make sure...
1499 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1500 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1501 }
1502
1503 $SIGPIPE_R
1504 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1505
1506 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1507 }
1508
1509 *signal = sub {
1368 my (undef, %arg) = @_; 1510 my (undef, %arg) = @_;
1369 1511
1370 my $signal = uc $arg{signal} 1512 my $signal = uc $arg{signal}
1371 or Carp::croak "required option 'signal' is missing"; 1513 or Carp::croak "required option 'signal' is missing";
1372 1514
1373 if ($HAVE_ASYNC_INTERRUPT) { 1515 if ($HAVE_ASYNC_INTERRUPT) {
1374 # async::interrupt 1516 # async::interrupt
1375 1517
1376 $signal = sig2num $signal; 1518 $signal = sig2num $signal;
1377 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1519 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1378 1520
1379 $SIG_ASY{$signal} ||= new Async::Interrupt 1521 $SIG_ASY{$signal} ||= new Async::Interrupt
1380 cb => sub { undef $SIG_EV{$signal} }, 1522 cb => sub { undef $SIG_EV{$signal} },
1381 signal => $signal, 1523 signal => $signal,
1382 pipe => [$SIGPIPE_R->filenos], 1524 pipe => [$SIGPIPE_R->filenos],
1383 pipe_autodrain => 0, 1525 pipe_autodrain => 0,
1384 ; 1526 ;
1385 1527
1386 } else { 1528 } else {
1387 # pure perl 1529 # pure perl
1388 1530
1389 # AE::Util has been loaded in signal 1531 # AE::Util has been loaded in signal
1390 $signal = sig2name $signal; 1532 $signal = sig2name $signal;
1391 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1533 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1392 1534
1393 $SIG{$signal} ||= sub { 1535 $SIG{$signal} ||= sub {
1394 local $!; 1536 local $!;
1395 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1537 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1396 undef $SIG_EV{$signal}; 1538 undef $SIG_EV{$signal};
1539 };
1540
1541 # can't do signal processing without introducing races in pure perl,
1542 # so limit the signal latency.
1543 _sig_add;
1544 }
1545
1546 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1397 }; 1547 };
1398 1548
1399 # can't do signal processing without introducing races in pure perl, 1549 *AnyEvent::Base::signal::DESTROY = sub {
1400 # so limit the signal latency. 1550 my ($signal, $cb) = @{$_[0]};
1551
1401 _sig_add; 1552 _sig_del;
1402 }
1403 1553
1404 bless [$signal, $arg{cb}], "AnyEvent::Base::signal" 1554 delete $SIG_CB{$signal}{$cb};
1405}
1406 1555
1407sub signal { 1556 $HAVE_ASYNC_INTERRUPT
1408 # probe for availability of Async::Interrupt 1557 ? delete $SIG_ASY{$signal}
1409 if (_have_async_interrupt) { 1558 : # delete doesn't work with older perls - they then
1410 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1559 # print weird messages, or just unconditionally exit
1411 1560 # instead of getting the default action.
1412 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1561 undef $SIG{$signal}
1413 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); 1562 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 } 1563 };
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 } 1564 };
1441 1565 die if $@;
1442 *signal = \&_signal;
1443 &signal 1566 &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} 1567}
1461 1568
1462# default implementation for ->child 1569# default implementation for ->child
1463 1570
1464our %PID_CB; 1571our %PID_CB;
1493 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1600 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1494 ? 1 1601 ? 1
1495 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1602 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1496 1603
1497 unless ($CHLD_W) { 1604 unless ($CHLD_W) {
1498 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1605 $CHLD_W = AE::signal CHLD => \&_sigchld;
1499 # child could be a zombie already, so make at least one round 1606 # child could be a zombie already, so make at least one round
1500 &_sigchld; 1607 &_sigchld;
1501 } 1608 }
1502 1609
1503 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1610 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1529 # never use more then 50% of the time for the idle watcher, 1636 # never use more then 50% of the time for the idle watcher,
1530 # within some limits 1637 # within some limits
1531 $w = 0.0001 if $w < 0.0001; 1638 $w = 0.0001 if $w < 0.0001;
1532 $w = 5 if $w > 5; 1639 $w = 5 if $w > 5;
1533 1640
1534 $w = AnyEvent->timer (after => $w, cb => $rcb); 1641 $w = AE::timer $w, 0, $rcb;
1535 } else { 1642 } else {
1536 # clean up... 1643 # clean up...
1537 undef $w; 1644 undef $w;
1538 undef $rcb; 1645 undef $rcb;
1539 } 1646 }
1540 }; 1647 };
1541 1648
1542 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1649 $w = AE::timer 0.05, 0, $rcb;
1543 1650
1544 bless \\$cb, "AnyEvent::Base::idle" 1651 bless \\$cb, "AnyEvent::Base::idle"
1545} 1652}
1546 1653
1547sub AnyEvent::Base::idle::DESTROY { 1654sub AnyEvent::Base::idle::DESTROY {
1601 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1708 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1602 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1709 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1603} 1710}
1604 1711
1605sub cb { 1712sub cb {
1606 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1713 my $cv = shift;
1714
1715 @_
1716 and $cv->{_ae_cb} = shift
1717 and $cv->{_ae_sent}
1718 and (delete $cv->{_ae_cb})->($cv);
1719
1607 $_[0]{_ae_cb} 1720 $cv->{_ae_cb}
1608} 1721}
1609 1722
1610sub begin { 1723sub begin {
1611 ++$_[0]{_ae_counter}; 1724 ++$_[0]{_ae_counter};
1612 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1725 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1821 warn "read: $input\n"; # output what has been read 1934 warn "read: $input\n"; # output what has been read
1822 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1935 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1823 }, 1936 },
1824 ); 1937 );
1825 1938
1826 my $time_watcher; # can only be used once
1827
1828 sub new_timer {
1829 $timer = AnyEvent->timer (after => 1, cb => sub { 1939 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1830 warn "timeout\n"; # print 'timeout' about every second 1940 warn "timeout\n"; # print 'timeout' at most every second
1831 &new_timer; # and restart the time
1832 }); 1941 });
1833 }
1834
1835 new_timer; # create first timer
1836 1942
1837 $cv->recv; # wait until user enters /^q/i 1943 $cv->recv; # wait until user enters /^q/i
1838 1944
1839=head1 REAL-WORLD EXAMPLE 1945=head1 REAL-WORLD EXAMPLE
1840 1946
1971through AnyEvent. The benchmark creates a lot of timers (with a zero 2077through AnyEvent. The benchmark creates a lot of timers (with a zero
1972timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2078timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1973which it is), lets them fire exactly once and destroys them again. 2079which it is), lets them fire exactly once and destroys them again.
1974 2080
1975Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2081Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1976distribution. 2082distribution. It uses the L<AE> interface, which makes a real difference
2083for the EV and Perl backends only.
1977 2084
1978=head3 Explanation of the columns 2085=head3 Explanation of the columns
1979 2086
1980I<watcher> is the number of event watchers created/destroyed. Since 2087I<watcher> is the number of event watchers created/destroyed. Since
1981different event models feature vastly different performances, each event 2088different event models feature vastly different performances, each event
2002watcher. 2109watcher.
2003 2110
2004=head3 Results 2111=head3 Results
2005 2112
2006 name watchers bytes create invoke destroy comment 2113 name watchers bytes create invoke destroy comment
2007 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2114 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 2115 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 2116 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 2117 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 2118 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 2119 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 2120 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 2121 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 2122 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 2123 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 2124 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 2125 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2019 2126
2020=head3 Discussion 2127=head3 Discussion
2021 2128
2022The benchmark does I<not> measure scalability of the event loop very 2129The 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) 2130well. For example, a select-based event loop (such as the pure perl one)
2035benchmark machine, handling an event takes roughly 1600 CPU cycles with 2142benchmark machine, handling an event takes roughly 1600 CPU cycles with
2036EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2143EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2037cycles with POE. 2144cycles with POE.
2038 2145
2039C<EV> is the sole leader regarding speed and memory use, which are both 2146C<EV> is the sole leader regarding speed and memory use, which are both
2040maximal/minimal, respectively. Even when going through AnyEvent, it uses 2147maximal/minimal, respectively. When using the L<AE> API there is zero
2148overhead (when going through the AnyEvent API create is about 5-6 times
2149slower, 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 2150any other event loop and is still faster than Event natively).
2042natively.
2043 2151
2044The pure perl implementation is hit in a few sweet spots (both the 2152The 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 2153constant timeout and the use of a single fd hit optimisations in the perl
2046interpreter and the backend itself). Nevertheless this shows that it 2154interpreter and the backend itself). Nevertheless this shows that it
2047adds very little overhead in itself. Like any select-based backend its 2155adds very little overhead in itself. Like any select-based backend its
2121In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2229In 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 2230(1%) are active. This mirrors the activity of large servers with many
2123connections, most of which are idle at any one point in time. 2231connections, most of which are idle at any one point in time.
2124 2232
2125Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2233Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2126distribution. 2234distribution. It uses the L<AE> interface, which makes a real difference
2235for the EV and Perl backends only.
2127 2236
2128=head3 Explanation of the columns 2237=head3 Explanation of the columns
2129 2238
2130I<sockets> is the number of sockets, and twice the number of "servers" (as 2239I<sockets> is the number of sockets, and twice the number of "servers" (as
2131each server has a read and write socket end). 2240each server has a read and write socket end).
2139a new one that moves the timeout into the future. 2248a new one that moves the timeout into the future.
2140 2249
2141=head3 Results 2250=head3 Results
2142 2251
2143 name sockets create request 2252 name sockets create request
2144 EV 20000 69.01 11.16 2253 EV 20000 62.66 7.99
2145 Perl 20000 73.32 35.87 2254 Perl 20000 68.32 32.64
2146 IOAsync 20000 157.00 98.14 epoll 2255 IOAsync 20000 174.06 101.15 epoll
2147 IOAsync 20000 159.31 616.06 poll 2256 IOAsync 20000 174.67 610.84 poll
2148 Event 20000 212.62 257.32 2257 Event 20000 202.69 242.91
2149 Glib 20000 651.16 1896.30 2258 Glib 20000 557.01 1689.52
2150 POE 20000 349.67 12317.24 uses POE::Loop::Event 2259 POE 20000 341.54 12086.32 uses POE::Loop::Event
2151 2260
2152=head3 Discussion 2261=head3 Discussion
2153 2262
2154This benchmark I<does> measure scalability and overall performance of the 2263This benchmark I<does> measure scalability and overall performance of the
2155particular event loop. 2264particular event loop.
2281As you can see, the AnyEvent + EV combination even beats the 2390As you can see, the AnyEvent + EV combination even beats the
2282hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2391hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2283backend easily beats IO::Lambda and POE. 2392backend easily beats IO::Lambda and POE.
2284 2393
2285And even the 100% non-blocking version written using the high-level (and 2394And 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 2395slow :) 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 2396higher level ("unoptimised") abstractions by a large margin, even though
2288in a non-blocking way. 2397it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2289 2398
2290The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2399The 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 2400F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2292part of the IO::lambda distribution and were used without any changes. 2401part of the IO::Lambda distribution and were used without any changes.
2293 2402
2294 2403
2295=head1 SIGNALS 2404=head1 SIGNALS
2296 2405
2297AnyEvent currently installs handlers for these signals: 2406AnyEvent currently installs handlers for these signals:
2386lot less memory), but otherwise doesn't affect guard operation much. It is 2495lot less memory), but otherwise doesn't affect guard operation much. It is
2387purely used for performance. 2496purely used for performance.
2388 2497
2389=item L<JSON> and L<JSON::XS> 2498=item L<JSON> and L<JSON::XS>
2390 2499
2391This module is required when you want to read or write JSON data via 2500One 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 2501via 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. 2502advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2394 2503
2395In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is 2504In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2396installed. 2505installed.
2397 2506

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines