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.253 by root, Tue Jul 21 06:00:47 2009 UTC vs.
Revision 1.286 by root, Fri Aug 21 11:59:25 2009 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - events independent of event loop implementation 3AnyEvent - the DBI of event loop programming
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported 5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6event loops. 6and POE are various supported event loops/environments.
7 7
8=head1 SYNOPSIS 8=head1 SYNOPSIS
9 9
10 use AnyEvent; 10 use AnyEvent;
11 11
47 47
48There is a mailinglist for discussing all things AnyEvent, and an IRC 48There is a mailinglist for discussing all things AnyEvent, and an IRC
49channel, too. 49channel, too.
50 50
51See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software 51See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52Respository>, at L<http://anyevent.schmorp.de>, for more info. 52Repository>, at L<http://anyevent.schmorp.de>, for more info.
53 53
54=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 54=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
55 55
56Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 56Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
57nowadays. So what is different about AnyEvent? 57nowadays. So what is different about AnyEvent?
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
402 422
423 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
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 (if set to C<0>, it 427The child process is specified by the C<pid> argument (one some backends,
406watches for any child process exit). The watcher will triggered only when 428using C<0> watches for any child process exit, on others this will
407the child process has finished and an exit status is available, not on 429croak). The watcher will be triggered only when the child process has
408any trace events (stopped/continued). 430finished and an exit status is available, not on any trace events
431(stopped/continued).
409 432
410The callback will be called with the pid and exit status (as returned by 433The callback will be called with the pid and exit status (as returned by
411waitpid), so unlike other watcher types, you I<can> rely on child watcher 434waitpid), so unlike other watcher types, you I<can> rely on child watcher
412callback arguments. 435callback arguments.
413 436
454 # do something else, then wait for process exit 477 # do something else, then wait for process exit
455 $done->recv; 478 $done->recv;
456 479
457=head2 IDLE WATCHERS 480=head2 IDLE WATCHERS
458 481
482 $w = AnyEvent->idle (cb => <callback>);
483
459Sometimes 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
460to 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
461"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
462attention by the event loop". 487attention by the event loop".
463 488
489 }); 514 });
490 }); 515 });
491 516
492=head2 CONDITION VARIABLES 517=head2 CONDITION VARIABLES
493 518
519 $cv = AnyEvent->condvar;
520
521 $cv->send (<list>);
522 my @res = $cv->recv;
523
494If 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
495require you to run some blocking "loop", "run" or similar function that 525require you to run some blocking "loop", "run" or similar function that
496will actively watch for new events and call your callbacks. 526will actively watch for new events and call your callbacks.
497 527
498AnyEvent is slightly different: it expects somebody else to run the event 528AnyEvent is slightly different: it expects somebody else to run the event
562 after => 1, 592 after => 1,
563 cb => sub { $result_ready->send }, 593 cb => sub { $result_ready->send },
564 ); 594 );
565 595
566 # this "blocks" (while handling events) till the callback 596 # this "blocks" (while handling events) till the callback
567 # calls -<send 597 # calls ->send
568 $result_ready->recv; 598 $result_ready->recv;
569 599
570Example: 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
571variables are also callable directly. 601variables are also callable directly.
572 602
636one. 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
637to use a condition variable for the whole process. 667to use a condition variable for the whole process.
638 668
639Every 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
640C<< ->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
641>>, 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
642is 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
643callback 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.
644 675
645You 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
646sends), 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
647condition (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).
648 679
675begung can potentially be zero: 706begung can potentially be zero:
676 707
677 my $cv = AnyEvent->condvar; 708 my $cv = AnyEvent->condvar;
678 709
679 my %result; 710 my %result;
680 $cv->begin (sub { $cv->send (\%result) }); 711 $cv->begin (sub { shift->send (\%result) });
681 712
682 for my $host (@list_of_hosts) { 713 for my $host (@list_of_hosts) {
683 $cv->begin; 714 $cv->begin;
684 ping_host_then_call_callback $host, sub { 715 ping_host_then_call_callback $host, sub {
685 $result{$host} = ...; 716 $result{$host} = ...;
760=item $cb = $cv->cb ($cb->($cv)) 791=item $cb = $cv->cb ($cb->($cv))
761 792
762This is a mutator function that returns the callback set and optionally 793This is a mutator function that returns the callback set and optionally
763replaces it before doing so. 794replaces it before doing so.
764 795
765The callback will be called when the condition becomes "true", i.e. when 796The callback will be called when the condition becomes (or already was)
766C<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
767variable itself. Calling C<recv> inside the callback or at any later time 798the only argument being the condition variable itself. Calling C<recv>
768is guaranteed not to block. 799inside the callback or at any later time is guaranteed not to block.
769 800
770=back 801=back
771 802
772=head1 SUPPORTED EVENT LOOPS/BACKENDS 803=head1 SUPPORTED EVENT LOOPS/BACKENDS
773 804
776=over 4 807=over 4
777 808
778=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.
779 810
780EV 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
781use. 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
782that, will fall back to its own pure-perl implementation, which is 813pure-perl implementation, which is available everywhere as it comes with
783available everywhere as it comes with AnyEvent itself. 814AnyEvent itself.
784 815
785 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 816 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
786 AnyEvent::Impl::Event based on Event, very stable, few glitches.
787 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 817 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
788 818
789=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.
790 820
791These 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
792is 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
793them. This means that AnyEvent will automatically pick the right backend 823them. This means that AnyEvent will automatically pick the right backend
794when the main program loads an event module before anything starts to 824when the main program loads an event module before anything starts to
795create watchers. Nothing special needs to be done by the main program. 825create watchers. Nothing special needs to be done by the main program.
796 826
827 AnyEvent::Impl::Event based on Event, very stable, few glitches.
797 AnyEvent::Impl::Glib based on Glib, slow but very stable. 828 AnyEvent::Impl::Glib based on Glib, slow but very stable.
798 AnyEvent::Impl::Tk based on Tk, very broken. 829 AnyEvent::Impl::Tk based on Tk, very broken.
799 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 830 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
800 AnyEvent::Impl::POE based on POE, very slow, some limitations. 831 AnyEvent::Impl::POE based on POE, very slow, some limitations.
832 AnyEvent::Impl::Irssi used when running within irssi.
801 833
802=item Backends with special needs. 834=item Backends with special needs.
803 835
804Qt requires the Qt::Application to be instantiated first, but will 836Qt requires the Qt::Application to be instantiated first, but will
805otherwise be picked up automatically. As long as the main program 837otherwise be picked up automatically. As long as the main program
1084 1116
1085BEGIN { AnyEvent::common_sense } 1117BEGIN { AnyEvent::common_sense }
1086 1118
1087use Carp (); 1119use Carp ();
1088 1120
1089our $VERSION = 4.86; 1121our $VERSION = '5.112';
1090our $MODEL; 1122our $MODEL;
1091 1123
1092our $AUTOLOAD; 1124our $AUTOLOAD;
1093our @ISA; 1125our @ISA;
1094 1126
1119 for reverse split /\s*,\s*/, 1151 for reverse split /\s*,\s*/,
1120 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1152 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1121} 1153}
1122 1154
1123my @models = ( 1155my @models = (
1124 [EV:: => AnyEvent::Impl::EV::], 1156 [EV:: => AnyEvent::Impl::EV:: , 1],
1125 [Event:: => AnyEvent::Impl::Event::],
1126 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1157 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1127 # everything below here will not be autoprobed 1158 # everything below here will not (normally) be autoprobed
1128 # as the pureperl backend should work everywhere 1159 # as the pureperl backend should work everywhere
1129 # and is usually faster 1160 # and is usually faster
1161 [Event:: => AnyEvent::Impl::Event::, 1],
1130 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1162 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1131 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1163 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1164 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1132 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1165 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1133 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1166 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1134 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1167 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1135 [Wx:: => AnyEvent::Impl::POE::], 1168 [Wx:: => AnyEvent::Impl::POE::],
1136 [Prima:: => AnyEvent::Impl::POE::], 1169 [Prima:: => AnyEvent::Impl::POE::],
1137 # 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
1138 # byzantine signal and broken child handling, among others. 1171 # byzantine signal and broken child handling, among others.
1139 # 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
1140 # obvious default class. 1173 # obvious default class.
1141# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1174 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1142# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1175 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1143# [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
1144); 1178);
1145 1179
1146our %method = map +($_ => 1), 1180our %method = map +($_ => 1),
1147 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);
1148 1182
1194 } 1228 }
1195 } 1229 }
1196 } 1230 }
1197 1231
1198 unless ($MODEL) { 1232 unless ($MODEL) {
1199 # try to load a model 1233 # try to autoload a model
1200
1201 for (@REGISTRY, @models) { 1234 for (@REGISTRY, @models) {
1202 my ($package, $model) = @$_; 1235 my ($package, $model, $autoload) = @$_;
1236 if (
1237 $autoload
1203 if (eval "require $package" 1238 and eval "require $package"
1204 and ${"$package\::VERSION"} > 0 1239 and ${"$package\::VERSION"} > 0
1205 and eval "require $model") { 1240 and eval "require $model"
1241 ) {
1206 $MODEL = $model; 1242 $MODEL = $model;
1207 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; 1243 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1208 last; 1244 last;
1209 } 1245 }
1210 } 1246 }
1211 1247
1212 $MODEL 1248 $MODEL
1251 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,"; 1287 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1252 1288
1253 # 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
1254 1290
1255 ($fh2, $rw) 1291 ($fh2, $rw)
1292}
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
1256} 1342}
1257 1343
1258package AnyEvent::Base; 1344package AnyEvent::Base;
1259 1345
1260# default implementations for many methods 1346# default implementations for many methods
1284} 1370}
1285 1371
1286# default implementation for ->signal 1372# default implementation for ->signal
1287 1373
1288our $HAVE_ASYNC_INTERRUPT; 1374our $HAVE_ASYNC_INTERRUPT;
1375
1376sub _have_async_interrupt() {
1377 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1378 && eval "use Async::Interrupt 1.0 (); 1")
1379 unless defined $HAVE_ASYNC_INTERRUPT;
1380
1381 $HAVE_ASYNC_INTERRUPT
1382}
1383
1289our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1384our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1290our (%SIG_ASY, %SIG_ASY_W); 1385our (%SIG_ASY, %SIG_ASY_W);
1291our ($SIG_COUNT, $SIG_TW); 1386our ($SIG_COUNT, $SIG_TW);
1292 1387
1293sub _signal_exec { 1388sub _signal_exec {
1301 $_->() for values %{ $SIG_CB{$_} || {} }; 1396 $_->() for values %{ $SIG_CB{$_} || {} };
1302 } 1397 }
1303 } 1398 }
1304} 1399}
1305 1400
1306# install a dumym wakeupw atcher to reduce signal catching latency 1401# install a dummy wakeup watcher to reduce signal catching latency
1307sub _sig_add() { 1402sub _sig_add() {
1308 unless ($SIG_COUNT++) { 1403 unless ($SIG_COUNT++) {
1309 # try to align timer on a full-second boundary, if possible 1404 # try to align timer on a full-second boundary, if possible
1310 my $NOW = AnyEvent->now; 1405 my $NOW = AE::now;
1311 1406
1312 $SIG_TW = AnyEvent->timer ( 1407 $SIG_TW = AE::timer
1313 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1408 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1314 interval => $MAX_SIGNAL_LATENCY, 1409 $MAX_SIGNAL_LATENCY,
1315 cb => sub { }, # just for the PERL_ASYNC_CHECK 1410 sub { } # just for the PERL_ASYNC_CHECK
1316 ); 1411 ;
1317 } 1412 }
1318} 1413}
1319 1414
1320sub _sig_del { 1415sub _sig_del {
1321 undef $SIG_TW 1416 undef $SIG_TW
1322 unless --$SIG_COUNT; 1417 unless --$SIG_COUNT;
1323} 1418}
1324 1419
1420our $_sig_name_init; $_sig_name_init = sub {
1421 eval q{ # poor man's autoloading
1422 undef $_sig_name_init;
1423
1424 if (_have_async_interrupt) {
1425 *sig2num = \&Async::Interrupt::sig2num;
1426 *sig2name = \&Async::Interrupt::sig2name;
1427 } else {
1428 require Config;
1429
1430 my %signame2num;
1431 @signame2num{ split ' ', $Config::Config{sig_name} }
1432 = split ' ', $Config::Config{sig_num};
1433
1434 my @signum2name;
1435 @signum2name[values %signame2num] = keys %signame2num;
1436
1437 *sig2num = sub($) {
1438 $_[0] > 0 ? shift : $signame2num{+shift}
1439 };
1440 *sig2name = sub ($) {
1441 $_[0] > 0 ? $signum2name[+shift] : shift
1442 };
1443 }
1444 };
1445 die if $@;
1446};
1447
1448sub sig2num ($) { &$_sig_name_init; &sig2num }
1449sub sig2name($) { &$_sig_name_init; &sig2name }
1450
1325sub _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 {
1326 my (undef, %arg) = @_; 1488 my (undef, %arg) = @_;
1327 1489
1328 my $signal = uc $arg{signal} 1490 my $signal = uc $arg{signal}
1329 or Carp::croak "required option 'signal' is missing"; 1491 or Carp::croak "required option 'signal' is missing";
1330 1492
1331 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1332
1333 if ($HAVE_ASYNC_INTERRUPT) { 1493 if ($HAVE_ASYNC_INTERRUPT) {
1334 # async::interrupt 1494 # async::interrupt
1335 1495
1336 $SIG_ASY{$signal} ||= do { 1496 $signal = sig2num $signal;
1337 my $asy = new Async::Interrupt 1497 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1498
1499 $SIG_ASY{$signal} ||= new Async::Interrupt
1338 cb => sub { undef $SIG_EV{$signal} }, 1500 cb => sub { undef $SIG_EV{$signal} },
1339 signal => $signal, 1501 signal => $signal,
1340 pipe => [$SIGPIPE_R->filenos], 1502 pipe => [$SIGPIPE_R->filenos],
1503 pipe_autodrain => 0,
1504 ;
1505
1506 } else {
1507 # pure perl
1508
1509 # AE::Util has been loaded in signal
1510 $signal = sig2name $signal;
1511 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1512
1513 $SIG{$signal} ||= sub {
1514 local $!;
1515 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
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;
1341 ; 1522 }
1342 $asy->pipe_autodrain (0);
1343 1523
1344 $asy 1524 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1345 }; 1525 };
1346 1526
1347 } else { 1527 *AnyEvent::Base::signal::DESTROY = sub {
1348 # pure perl 1528 my ($signal, $cb) = @{$_[0]};
1349 1529
1350 $SIG{$signal} ||= sub { 1530 _sig_del;
1351 local $!; 1531
1352 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1532 delete $SIG_CB{$signal}{$cb};
1533
1534 $HAVE_ASYNC_INTERRUPT
1535 ? delete $SIG_ASY{$signal}
1536 : # delete doesn't work with older perls - they then
1537 # print weird messages, or just unconditionally exit
1538 # instead of getting the default action.
1353 undef $SIG_EV{$signal}; 1539 undef $SIG{$signal}
1540 unless keys %{ $SIG_CB{$signal} };
1354 }; 1541 };
1355
1356 # can't do signal processing without introducing races in pure perl,
1357 # so limit the signal latency.
1358 _sig_add;
1359 } 1542 };
1360 1543 die if $@;
1361 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1362}
1363
1364sub signal {
1365 # probe for availability of Async::Interrupt
1366 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1367 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1368
1369 $HAVE_ASYNC_INTERRUPT = 1;
1370 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1371 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1372
1373 } else {
1374 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1375
1376 require Fcntl;
1377
1378 if (AnyEvent::WIN32) {
1379 require AnyEvent::Util;
1380
1381 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1382 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1383 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1384 } else {
1385 pipe $SIGPIPE_R, $SIGPIPE_W;
1386 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1387 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1388
1389 # not strictly required, as $^F is normally 2, but let's make sure...
1390 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1391 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1392 }
1393
1394 $SIGPIPE_R
1395 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1396
1397 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1398 }
1399
1400 *signal = \&_signal;
1401 &signal 1544 &signal
1402}
1403
1404sub AnyEvent::Base::signal::DESTROY {
1405 my ($signal, $cb) = @{$_[0]};
1406
1407 _sig_del;
1408
1409 delete $SIG_CB{$signal}{$cb};
1410
1411 $HAVE_ASYNC_INTERRUPT
1412 ? delete $SIG_ASY{$signal}
1413 : # delete doesn't work with older perls - they then
1414 # print weird messages, or just unconditionally exit
1415 # instead of getting the default action.
1416 undef $SIG{$signal}
1417 unless keys %{ $SIG_CB{$signal} };
1418} 1545}
1419 1546
1420# default implementation for ->child 1547# default implementation for ->child
1421 1548
1422our %PID_CB; 1549our %PID_CB;
1423our $CHLD_W; 1550our $CHLD_W;
1424our $CHLD_DELAY_W; 1551our $CHLD_DELAY_W;
1425our $WNOHANG; 1552our $WNOHANG;
1426 1553
1554sub _emit_childstatus($$) {
1555 my (undef, $rpid, $rstatus) = @_;
1556
1557 $_->($rpid, $rstatus)
1558 for values %{ $PID_CB{$rpid} || {} },
1559 values %{ $PID_CB{0} || {} };
1560}
1561
1427sub _sigchld { 1562sub _sigchld {
1563 my $pid;
1564
1565 AnyEvent->_emit_childstatus ($pid, $?)
1428 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1566 while ($pid = waitpid -1, $WNOHANG) > 0;
1429 $_->($pid, $?)
1430 for values %{ $PID_CB{$pid} || {} },
1431 values %{ $PID_CB{0} || {} };
1432 }
1433} 1567}
1434 1568
1435sub child { 1569sub child {
1436 my (undef, %arg) = @_; 1570 my (undef, %arg) = @_;
1437 1571
1444 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1578 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1445 ? 1 1579 ? 1
1446 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1580 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1447 1581
1448 unless ($CHLD_W) { 1582 unless ($CHLD_W) {
1449 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1583 $CHLD_W = AE::signal CHLD => \&_sigchld;
1450 # 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
1451 &_sigchld; 1585 &_sigchld;
1452 } 1586 }
1453 1587
1454 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1588 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1480 # 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,
1481 # within some limits 1615 # within some limits
1482 $w = 0.0001 if $w < 0.0001; 1616 $w = 0.0001 if $w < 0.0001;
1483 $w = 5 if $w > 5; 1617 $w = 5 if $w > 5;
1484 1618
1485 $w = AnyEvent->timer (after => $w, cb => $rcb); 1619 $w = AE::timer $w, 0, $rcb;
1486 } else { 1620 } else {
1487 # clean up... 1621 # clean up...
1488 undef $w; 1622 undef $w;
1489 undef $rcb; 1623 undef $rcb;
1490 } 1624 }
1491 }; 1625 };
1492 1626
1493 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1627 $w = AE::timer 0.05, 0, $rcb;
1494 1628
1495 bless \\$cb, "AnyEvent::Base::idle" 1629 bless \\$cb, "AnyEvent::Base::idle"
1496} 1630}
1497 1631
1498sub AnyEvent::Base::idle::DESTROY { 1632sub AnyEvent::Base::idle::DESTROY {
1552 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1686 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1553 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1687 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1554} 1688}
1555 1689
1556sub cb { 1690sub cb {
1557 $_[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
1558 $_[0]{_ae_cb} 1698 $cv->{_ae_cb}
1559} 1699}
1560 1700
1561sub begin { 1701sub begin {
1562 ++$_[0]{_ae_counter}; 1702 ++$_[0]{_ae_counter};
1563 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1703 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1922through AnyEvent. The benchmark creates a lot of timers (with a zero 2062through AnyEvent. The benchmark creates a lot of timers (with a zero
1923timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2063timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1924which it is), lets them fire exactly once and destroys them again. 2064which it is), lets them fire exactly once and destroys them again.
1925 2065
1926Source 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
1927distribution. 2067distribution. It uses the L<AE> interface, which makes a real difference
2068for the EV and Perl backends only.
1928 2069
1929=head3 Explanation of the columns 2070=head3 Explanation of the columns
1930 2071
1931I<watcher> is the number of event watchers created/destroyed. Since 2072I<watcher> is the number of event watchers created/destroyed. Since
1932different event models feature vastly different performances, each event 2073different event models feature vastly different performances, each event
1953watcher. 2094watcher.
1954 2095
1955=head3 Results 2096=head3 Results
1956 2097
1957 name watchers bytes create invoke destroy comment 2098 name watchers bytes create invoke destroy comment
1958 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
1959 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
1960 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
1961 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
1962 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
1963 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
1964 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
1965 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
1966 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
1967 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
1968 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
1969 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
1970 2111
1971=head3 Discussion 2112=head3 Discussion
1972 2113
1973The benchmark does I<not> measure scalability of the event loop very 2114The benchmark does I<not> measure scalability of the event loop very
1974well. 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)
1986benchmark machine, handling an event takes roughly 1600 CPU cycles with 2127benchmark machine, handling an event takes roughly 1600 CPU cycles with
1987EV, 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
1988cycles with POE. 2129cycles with POE.
1989 2130
1990C<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
1991maximal/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
1992far less memory than any other event loop and is still faster than Event 2135any other event loop and is still faster than Event natively).
1993natively.
1994 2136
1995The 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
1996constant 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
1997interpreter and the backend itself). Nevertheless this shows that it 2139interpreter and the backend itself). Nevertheless this shows that it
1998adds very little overhead in itself. Like any select-based backend its 2140adds very little overhead in itself. Like any select-based backend its
2072In 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
2073(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
2074connections, most of which are idle at any one point in time. 2216connections, most of which are idle at any one point in time.
2075 2217
2076Source 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
2077distribution. 2219distribution. It uses the L<AE> interface, which makes a real difference
2220for the EV and Perl backends only.
2078 2221
2079=head3 Explanation of the columns 2222=head3 Explanation of the columns
2080 2223
2081I<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
2082each server has a read and write socket end). 2225each server has a read and write socket end).
2090a new one that moves the timeout into the future. 2233a new one that moves the timeout into the future.
2091 2234
2092=head3 Results 2235=head3 Results
2093 2236
2094 name sockets create request 2237 name sockets create request
2095 EV 20000 69.01 11.16 2238 EV 20000 62.66 7.99
2096 Perl 20000 73.32 35.87 2239 Perl 20000 68.32 32.64
2097 IOAsync 20000 157.00 98.14 epoll 2240 IOAsync 20000 174.06 101.15 epoll
2098 IOAsync 20000 159.31 616.06 poll 2241 IOAsync 20000 174.67 610.84 poll
2099 Event 20000 212.62 257.32 2242 Event 20000 202.69 242.91
2100 Glib 20000 651.16 1896.30 2243 Glib 20000 557.01 1689.52
2101 POE 20000 349.67 12317.24 uses POE::Loop::Event 2244 POE 20000 341.54 12086.32 uses POE::Loop::Event
2102 2245
2103=head3 Discussion 2246=head3 Discussion
2104 2247
2105This benchmark I<does> measure scalability and overall performance of the 2248This benchmark I<does> measure scalability and overall performance of the
2106particular event loop. 2249particular event loop.
2416L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2559L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2417 2560
2418Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2561Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2419L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2562L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2420L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2563L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2421L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. 2564L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2422 2565
2423Non-blocking file handles, sockets, TCP clients and 2566Non-blocking file handles, sockets, TCP clients and
2424servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2567servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2425 2568
2426Asynchronous DNS: L<AnyEvent::DNS>. 2569Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines