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.249 by root, Mon Jul 20 06:00:42 2009 UTC vs.
Revision 1.279 by root, Sun Aug 9 16:05:11 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
517Condition variables are similar to callbacks, except that you can 547Condition variables are similar to callbacks, except that you can
518optionally wait for them. They can also be called merge points - points 548optionally wait for them. They can also be called merge points - points
519in time where multiple outstanding events have been processed. And yet 549in time where multiple outstanding events have been processed. And yet
520another way to call them is transactions - each condition variable can be 550another way to call them is transactions - each condition variable can be
521used to represent a transaction, which finishes at some point and delivers 551used to represent a transaction, which finishes at some point and delivers
522a result. 552a result. And yet some people know them as "futures" - a promise to
553compute/deliver something that you can wait for.
523 554
524Condition variables are very useful to signal that something has finished, 555Condition variables are very useful to signal that something has finished,
525for example, if you write a module that does asynchronous http requests, 556for example, if you write a module that does asynchronous http requests,
526then a condition variable would be the ideal candidate to signal the 557then a condition variable would be the ideal candidate to signal the
527availability of results. The user can either act when the callback is 558availability of results. The user can either act when the callback is
759=item $cb = $cv->cb ($cb->($cv)) 790=item $cb = $cv->cb ($cb->($cv))
760 791
761This is a mutator function that returns the callback set and optionally 792This is a mutator function that returns the callback set and optionally
762replaces it before doing so. 793replaces it before doing so.
763 794
764The callback will be called when the condition becomes "true", i.e. when 795The callback will be called when the condition becomes (or already was)
765C<send> or C<croak> are called, with the only argument being the condition 796"true", i.e. when C<send> or C<croak> are called (or were called), with
766variable itself. Calling C<recv> inside the callback or at any later time 797the only argument being the condition variable itself. Calling C<recv>
767is guaranteed not to block. 798inside the callback or at any later time is guaranteed not to block.
768 799
769=back 800=back
770 801
771=head1 SUPPORTED EVENT LOOPS/BACKENDS 802=head1 SUPPORTED EVENT LOOPS/BACKENDS
772 803
775=over 4 806=over 4
776 807
777=item Backends that are autoprobed when no other event loop can be found. 808=item Backends that are autoprobed when no other event loop can be found.
778 809
779EV is the preferred backend when no other event loop seems to be in 810EV is the preferred backend when no other event loop seems to be in
780use. If EV is not installed, then AnyEvent will try Event, and, failing 811use. If EV is not installed, then AnyEvent will fall back to its own
781that, will fall back to its own pure-perl implementation, which is 812pure-perl implementation, which is available everywhere as it comes with
782available everywhere as it comes with AnyEvent itself. 813AnyEvent itself.
783 814
784 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 815 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
785 AnyEvent::Impl::Event based on Event, very stable, few glitches.
786 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 816 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
787 817
788=item Backends that are transparently being picked up when they are used. 818=item Backends that are transparently being picked up when they are used.
789 819
790These will be used when they are currently loaded when the first watcher 820These will be used when they are currently loaded when the first watcher
791is created, in which case it is assumed that the application is using 821is created, in which case it is assumed that the application is using
792them. This means that AnyEvent will automatically pick the right backend 822them. This means that AnyEvent will automatically pick the right backend
793when the main program loads an event module before anything starts to 823when the main program loads an event module before anything starts to
794create watchers. Nothing special needs to be done by the main program. 824create watchers. Nothing special needs to be done by the main program.
795 825
826 AnyEvent::Impl::Event based on Event, very stable, few glitches.
796 AnyEvent::Impl::Glib based on Glib, slow but very stable. 827 AnyEvent::Impl::Glib based on Glib, slow but very stable.
797 AnyEvent::Impl::Tk based on Tk, very broken. 828 AnyEvent::Impl::Tk based on Tk, very broken.
798 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 829 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
799 AnyEvent::Impl::POE based on POE, very slow, some limitations. 830 AnyEvent::Impl::POE based on POE, very slow, some limitations.
831 AnyEvent::Impl::Irssi used when running within irssi.
800 832
801=item Backends with special needs. 833=item Backends with special needs.
802 834
803Qt requires the Qt::Application to be instantiated first, but will 835Qt requires the Qt::Application to be instantiated first, but will
804otherwise be picked up automatically. As long as the main program 836otherwise be picked up automatically. As long as the main program
878event module detection too early, for example, L<AnyEvent::AIO> creates 910event module detection too early, for example, L<AnyEvent::AIO> creates
879and installs the global L<IO::AIO> watcher in a C<post_detect> block to 911and installs the global L<IO::AIO> watcher in a C<post_detect> block to
880avoid autodetecting the event module at load time. 912avoid autodetecting the event module at load time.
881 913
882If called in scalar or list context, then it creates and returns an object 914If called in scalar or list context, then it creates and returns an object
883that automatically removes the callback again when it is destroyed. See 915that automatically removes the callback again when it is destroyed (or
916C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
884L<Coro::BDB> for a case where this is useful. 917a case where this is useful.
918
919Example: Create a watcher for the IO::AIO module and store it in
920C<$WATCHER>. Only do so after the event loop is initialised, though.
921
922 our WATCHER;
923
924 my $guard = AnyEvent::post_detect {
925 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
926 };
927
928 # the ||= is important in case post_detect immediately runs the block,
929 # as to not clobber the newly-created watcher. assigning both watcher and
930 # post_detect guard to the same variable has the advantage of users being
931 # able to just C<undef $WATCHER> if the watcher causes them grief.
932
933 $WATCHER ||= $guard;
885 934
886=item @AnyEvent::post_detect 935=item @AnyEvent::post_detect
887 936
888If there are any code references in this array (you can C<push> to it 937If there are any code references in this array (you can C<push> to it
889before or after loading AnyEvent), then they will called directly after 938before or after loading AnyEvent), then they will called directly after
1066 1115
1067BEGIN { AnyEvent::common_sense } 1116BEGIN { AnyEvent::common_sense }
1068 1117
1069use Carp (); 1118use Carp ();
1070 1119
1071our $VERSION = 4.85; 1120our $VERSION = '5.0';
1072our $MODEL; 1121our $MODEL;
1073 1122
1074our $AUTOLOAD; 1123our $AUTOLOAD;
1075our @ISA; 1124our @ISA;
1076 1125
1101 for reverse split /\s*,\s*/, 1150 for reverse split /\s*,\s*/,
1102 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1151 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1103} 1152}
1104 1153
1105my @models = ( 1154my @models = (
1106 [EV:: => AnyEvent::Impl::EV::], 1155 [EV:: => AnyEvent::Impl::EV:: , 1],
1107 [Event:: => AnyEvent::Impl::Event::],
1108 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1156 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1109 # everything below here will not be autoprobed 1157 # everything below here will not (normally) be autoprobed
1110 # as the pureperl backend should work everywhere 1158 # as the pureperl backend should work everywhere
1111 # and is usually faster 1159 # and is usually faster
1160 [Event:: => AnyEvent::Impl::Event::, 1],
1112 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1161 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1113 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1162 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1163 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1114 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1164 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1115 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1165 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1116 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1166 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1117 [Wx:: => AnyEvent::Impl::POE::], 1167 [Wx:: => AnyEvent::Impl::POE::],
1118 [Prima:: => AnyEvent::Impl::POE::], 1168 [Prima:: => AnyEvent::Impl::POE::],
1119 # IO::Async is just too broken - we would need workarounds for its 1169 # IO::Async is just too broken - we would need workarounds for its
1120 # byzantine signal and broken child handling, among others. 1170 # byzantine signal and broken child handling, among others.
1121 # IO::Async is rather hard to detect, as it doesn't have any 1171 # IO::Async is rather hard to detect, as it doesn't have any
1122 # obvious default class. 1172 # obvious default class.
1123# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1173 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1124# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1174 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1125# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1175 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1176 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1126); 1177);
1127 1178
1128our %method = map +($_ => 1), 1179our %method = map +($_ => 1),
1129 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1180 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1130 1181
1134 my ($cb) = @_; 1185 my ($cb) = @_;
1135 1186
1136 if ($MODEL) { 1187 if ($MODEL) {
1137 $cb->(); 1188 $cb->();
1138 1189
1139 1 1190 undef
1140 } else { 1191 } else {
1141 push @post_detect, $cb; 1192 push @post_detect, $cb;
1142 1193
1143 defined wantarray 1194 defined wantarray
1144 ? bless \$cb, "AnyEvent::Util::postdetect" 1195 ? bless \$cb, "AnyEvent::Util::postdetect"
1176 } 1227 }
1177 } 1228 }
1178 } 1229 }
1179 1230
1180 unless ($MODEL) { 1231 unless ($MODEL) {
1181 # try to load a model 1232 # try to autoload a model
1182
1183 for (@REGISTRY, @models) { 1233 for (@REGISTRY, @models) {
1184 my ($package, $model) = @$_; 1234 my ($package, $model, $autoload) = @$_;
1235 if (
1236 $autoload
1185 if (eval "require $package" 1237 and eval "require $package"
1186 and ${"$package\::VERSION"} > 0 1238 and ${"$package\::VERSION"} > 0
1187 and eval "require $model") { 1239 and eval "require $model"
1240 ) {
1188 $MODEL = $model; 1241 $MODEL = $model;
1189 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; 1242 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1190 last; 1243 last;
1191 } 1244 }
1192 } 1245 }
1193 1246
1194 $MODEL 1247 $MODEL
1233 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,"; 1286 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1234 1287
1235 # we assume CLOEXEC is already set by perl in all important cases 1288 # we assume CLOEXEC is already set by perl in all important cases
1236 1289
1237 ($fh2, $rw) 1290 ($fh2, $rw)
1291}
1292
1293=head1 SIMPLIFIED AE API
1294
1295Starting with version 5.0, AnyEvent officially supports a second, much
1296simpler, API that is designed to reduce the calling, typing and memory
1297overhead.
1298
1299See the L<AE> manpage for details.
1300
1301=cut
1302
1303package AE;
1304
1305our $VERSION = $AnyEvent::VERSION;
1306
1307sub io($$$) {
1308 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1309}
1310
1311sub timer($$$) {
1312 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1313}
1314
1315sub signal($$) {
1316 AnyEvent->signal (signal => $_[0], cb => $_[1])
1317}
1318
1319sub child($$) {
1320 AnyEvent->child (pid => $_[0], cb => $_[1])
1321}
1322
1323sub idle($) {
1324 AnyEvent->idle (cb => $_[0])
1325}
1326
1327sub cv(;&) {
1328 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1329}
1330
1331sub now() {
1332 AnyEvent->now
1333}
1334
1335sub now_update() {
1336 AnyEvent->now_update
1337}
1338
1339sub time() {
1340 AnyEvent->time
1238} 1341}
1239 1342
1240package AnyEvent::Base; 1343package AnyEvent::Base;
1241 1344
1242# default implementations for many methods 1345# default implementations for many methods
1266} 1369}
1267 1370
1268# default implementation for ->signal 1371# default implementation for ->signal
1269 1372
1270our $HAVE_ASYNC_INTERRUPT; 1373our $HAVE_ASYNC_INTERRUPT;
1374
1375sub _have_async_interrupt() {
1376 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1377 && eval "use Async::Interrupt 1.0 (); 1")
1378 unless defined $HAVE_ASYNC_INTERRUPT;
1379
1380 $HAVE_ASYNC_INTERRUPT
1381}
1382
1271our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1383our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1272our (%SIG_ASY, %SIG_ASY_W); 1384our (%SIG_ASY, %SIG_ASY_W);
1273our ($SIG_COUNT, $SIG_TW); 1385our ($SIG_COUNT, $SIG_TW);
1274 1386
1275sub _signal_exec { 1387sub _signal_exec {
1283 $_->() for values %{ $SIG_CB{$_} || {} }; 1395 $_->() for values %{ $SIG_CB{$_} || {} };
1284 } 1396 }
1285 } 1397 }
1286} 1398}
1287 1399
1288# install a dumym wakeupw atcher to reduce signal catching latency 1400# install a dummy wakeup watcher to reduce signal catching latency
1289sub _sig_add() { 1401sub _sig_add() {
1290 unless ($SIG_COUNT++) { 1402 unless ($SIG_COUNT++) {
1291 # try to align timer on a full-second boundary, if possible 1403 # try to align timer on a full-second boundary, if possible
1292 my $NOW = AnyEvent->now; 1404 my $NOW = AE::now;
1293 1405
1294 $SIG_TW = AnyEvent->timer ( 1406 $SIG_TW = AE::timer
1295 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1407 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1296 interval => $MAX_SIGNAL_LATENCY, 1408 $MAX_SIGNAL_LATENCY,
1297 cb => sub { }, # just for the PERL_ASYNC_CHECK 1409 sub { } # just for the PERL_ASYNC_CHECK
1298 ); 1410 ;
1299 } 1411 }
1300} 1412}
1301 1413
1302sub _sig_del { 1414sub _sig_del {
1303 undef $SIG_TW 1415 undef $SIG_TW
1304 unless --$SIG_COUNT; 1416 unless --$SIG_COUNT;
1305} 1417}
1306 1418
1419our $_sig_name_init; $_sig_name_init = sub {
1420 eval q{ # poor man's autoloading
1421 undef $_sig_name_init;
1422
1423 if (_have_async_interrupt) {
1424 *sig2num = \&Async::Interrupt::sig2num;
1425 *sig2name = \&Async::Interrupt::sig2name;
1426 } else {
1427 require Config;
1428
1429 my %signame2num;
1430 @signame2num{ split ' ', $Config::Config{sig_name} }
1431 = split ' ', $Config::Config{sig_num};
1432
1433 my @signum2name;
1434 @signum2name[values %signame2num] = keys %signame2num;
1435
1436 *sig2num = sub($) {
1437 $_[0] > 0 ? shift : $signame2num{+shift}
1438 };
1439 *sig2name = sub ($) {
1440 $_[0] > 0 ? $signum2name[+shift] : shift
1441 };
1442 }
1443 };
1444 die if $@;
1445};
1446
1447sub sig2num ($) { &$_sig_name_init; &sig2num }
1448sub sig2name($) { &$_sig_name_init; &sig2name }
1449
1307sub _signal { 1450sub signal {
1451 eval q{ # poor man's autoloading {}
1452 # probe for availability of Async::Interrupt
1453 if (_have_async_interrupt) {
1454 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1455
1456 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1457 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1458
1459 } else {
1460 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1461
1462 require Fcntl;
1463
1464 if (AnyEvent::WIN32) {
1465 require AnyEvent::Util;
1466
1467 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1468 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1469 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1470 } else {
1471 pipe $SIGPIPE_R, $SIGPIPE_W;
1472 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1473 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1474
1475 # not strictly required, as $^F is normally 2, but let's make sure...
1476 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1477 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1478 }
1479
1480 $SIGPIPE_R
1481 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1482
1483 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1484 }
1485
1486 *signal = sub {
1308 my (undef, %arg) = @_; 1487 my (undef, %arg) = @_;
1309 1488
1310 my $signal = uc $arg{signal} 1489 my $signal = uc $arg{signal}
1311 or Carp::croak "required option 'signal' is missing"; 1490 or Carp::croak "required option 'signal' is missing";
1312 1491
1313 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1314
1315 if ($HAVE_ASYNC_INTERRUPT) { 1492 if ($HAVE_ASYNC_INTERRUPT) {
1316 # async::interrupt 1493 # async::interrupt
1317 1494
1318 $SIG_ASY{$signal} ||= do { 1495 $signal = sig2num $signal;
1319 my $asy = new Async::Interrupt 1496 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1497
1498 $SIG_ASY{$signal} ||= new Async::Interrupt
1320 cb => sub { undef $SIG_EV{$signal} }, 1499 cb => sub { undef $SIG_EV{$signal} },
1321 signal => $signal, 1500 signal => $signal,
1322 pipe => [$SIGPIPE_R->filenos], 1501 pipe => [$SIGPIPE_R->filenos],
1502 pipe_autodrain => 0,
1503 ;
1504
1505 } else {
1506 # pure perl
1507
1508 # AE::Util has been loaded in signal
1509 $signal = sig2name $signal;
1510 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1511
1512 $SIG{$signal} ||= sub {
1513 local $!;
1514 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1515 undef $SIG_EV{$signal};
1516 };
1517
1518 # can't do signal processing without introducing races in pure perl,
1519 # so limit the signal latency.
1520 _sig_add;
1323 ; 1521 }
1324 $asy->pipe_autodrain (0);
1325 1522
1326 $asy 1523 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1327 }; 1524 };
1328 1525
1329 } else { 1526 *AnyEvent::Base::signal::DESTROY = sub {
1330 # pure perl 1527 my ($signal, $cb) = @{$_[0]};
1331 1528
1332 $SIG{$signal} ||= sub { 1529 _sig_del;
1333 local $!; 1530
1334 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1531 delete $SIG_CB{$signal}{$cb};
1532
1533 $HAVE_ASYNC_INTERRUPT
1534 ? delete $SIG_ASY{$signal}
1535 : # delete doesn't work with older perls - they then
1536 # print weird messages, or just unconditionally exit
1537 # instead of getting the default action.
1335 undef $SIG_EV{$signal}; 1538 undef $SIG{$signal}
1539 unless keys %{ $SIG_CB{$signal} };
1336 }; 1540 };
1337
1338 # can't do signal processing without introducing races in pure perl,
1339 # so limit the signal latency.
1340 _sig_add;
1341 } 1541 };
1342 1542 die if $@;
1343 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1344}
1345
1346sub signal {
1347 # probe for availability of Async::Interrupt
1348 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1349 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1350
1351 $HAVE_ASYNC_INTERRUPT = 1;
1352 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1353 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1354
1355 } else {
1356 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1357
1358 require Fcntl;
1359
1360 if (AnyEvent::WIN32) {
1361 require AnyEvent::Util;
1362
1363 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1364 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1365 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1366 } else {
1367 pipe $SIGPIPE_R, $SIGPIPE_W;
1368 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1369 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1370
1371 # not strictly required, as $^F is normally 2, but let's make sure...
1372 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1373 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1374 }
1375
1376 $SIGPIPE_R
1377 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1378
1379 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1380 }
1381
1382 *signal = \&_signal;
1383 &signal 1543 &signal
1384}
1385
1386sub AnyEvent::Base::signal::DESTROY {
1387 my ($signal, $cb) = @{$_[0]};
1388
1389 _sig_del;
1390
1391 delete $SIG_CB{$signal}{$cb};
1392
1393 $HAVE_ASYNC_INTERRUPT
1394 ? delete $SIG_ASY{$signal}
1395 : # delete doesn't work with older perls - they then
1396 # print weird messages, or just unconditionally exit
1397 # instead of getting the default action.
1398 undef $SIG{$signal}
1399 unless keys %{ $SIG_CB{$signal} };
1400} 1544}
1401 1545
1402# default implementation for ->child 1546# default implementation for ->child
1403 1547
1404our %PID_CB; 1548our %PID_CB;
1405our $CHLD_W; 1549our $CHLD_W;
1406our $CHLD_DELAY_W; 1550our $CHLD_DELAY_W;
1407our $WNOHANG; 1551our $WNOHANG;
1408 1552
1553sub _emit_childstatus($$) {
1554 my (undef, $rpid, $rstatus) = @_;
1555
1556 $_->($rpid, $rstatus)
1557 for values %{ $PID_CB{$rpid} || {} },
1558 values %{ $PID_CB{0} || {} };
1559}
1560
1409sub _sigchld { 1561sub _sigchld {
1562 my $pid;
1563
1564 AnyEvent->_emit_childstatus ($pid, $?)
1410 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1565 while ($pid = waitpid -1, $WNOHANG) > 0;
1411 $_->($pid, $?)
1412 for values %{ $PID_CB{$pid} || {} },
1413 values %{ $PID_CB{0} || {} };
1414 }
1415} 1566}
1416 1567
1417sub child { 1568sub child {
1418 my (undef, %arg) = @_; 1569 my (undef, %arg) = @_;
1419 1570
1426 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1577 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1427 ? 1 1578 ? 1
1428 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1579 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1429 1580
1430 unless ($CHLD_W) { 1581 unless ($CHLD_W) {
1431 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1582 $CHLD_W = AE::signal CHLD => \&_sigchld;
1432 # child could be a zombie already, so make at least one round 1583 # child could be a zombie already, so make at least one round
1433 &_sigchld; 1584 &_sigchld;
1434 } 1585 }
1435 1586
1436 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1587 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1462 # never use more then 50% of the time for the idle watcher, 1613 # never use more then 50% of the time for the idle watcher,
1463 # within some limits 1614 # within some limits
1464 $w = 0.0001 if $w < 0.0001; 1615 $w = 0.0001 if $w < 0.0001;
1465 $w = 5 if $w > 5; 1616 $w = 5 if $w > 5;
1466 1617
1467 $w = AnyEvent->timer (after => $w, cb => $rcb); 1618 $w = AE::timer $w, 0, $rcb;
1468 } else { 1619 } else {
1469 # clean up... 1620 # clean up...
1470 undef $w; 1621 undef $w;
1471 undef $rcb; 1622 undef $rcb;
1472 } 1623 }
1473 }; 1624 };
1474 1625
1475 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1626 $w = AE::timer 0.05, 0, $rcb;
1476 1627
1477 bless \\$cb, "AnyEvent::Base::idle" 1628 bless \\$cb, "AnyEvent::Base::idle"
1478} 1629}
1479 1630
1480sub AnyEvent::Base::idle::DESTROY { 1631sub AnyEvent::Base::idle::DESTROY {
1534 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1685 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1535 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1686 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1536} 1687}
1537 1688
1538sub cb { 1689sub cb {
1539 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1690 my $cv = shift;
1691
1692 @_
1693 and $cv->{_ae_cb} = shift
1694 and $cv->{_ae_sent}
1695 and (delete $cv->{_ae_cb})->($cv);
1696
1540 $_[0]{_ae_cb} 1697 $cv->{_ae_cb}
1541} 1698}
1542 1699
1543sub begin { 1700sub begin {
1544 ++$_[0]{_ae_counter}; 1701 ++$_[0]{_ae_counter};
1545 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1702 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1904through AnyEvent. The benchmark creates a lot of timers (with a zero 2061through AnyEvent. The benchmark creates a lot of timers (with a zero
1905timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2062timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1906which it is), lets them fire exactly once and destroys them again. 2063which it is), lets them fire exactly once and destroys them again.
1907 2064
1908Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2065Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1909distribution. 2066distribution. It uses the L<AE> interface, which makes a real difference
2067for the EV and Perl backends only.
1910 2068
1911=head3 Explanation of the columns 2069=head3 Explanation of the columns
1912 2070
1913I<watcher> is the number of event watchers created/destroyed. Since 2071I<watcher> is the number of event watchers created/destroyed. Since
1914different event models feature vastly different performances, each event 2072different event models feature vastly different performances, each event
1935watcher. 2093watcher.
1936 2094
1937=head3 Results 2095=head3 Results
1938 2096
1939 name watchers bytes create invoke destroy comment 2097 name watchers bytes create invoke destroy comment
1940 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2098 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1941 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2099 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1942 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2100 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1943 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2101 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1944 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2102 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1945 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2103 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1946 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 2104 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1947 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 2105 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1948 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2106 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1949 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2107 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1950 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2108 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1951 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2109 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1952 2110
1953=head3 Discussion 2111=head3 Discussion
1954 2112
1955The benchmark does I<not> measure scalability of the event loop very 2113The benchmark does I<not> measure scalability of the event loop very
1956well. For example, a select-based event loop (such as the pure perl one) 2114well. For example, a select-based event loop (such as the pure perl one)
1968benchmark machine, handling an event takes roughly 1600 CPU cycles with 2126benchmark machine, handling an event takes roughly 1600 CPU cycles with
1969EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2127EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1970cycles with POE. 2128cycles with POE.
1971 2129
1972C<EV> is the sole leader regarding speed and memory use, which are both 2130C<EV> is the sole leader regarding speed and memory use, which are both
1973maximal/minimal, respectively. Even when going through AnyEvent, it uses 2131maximal/minimal, respectively. When using the L<AE> API there is zero
2132overhead (when going through the AnyEvent API create is about 5-6 times
2133slower, with other times being equal, so still uses far less memory than
1974far less memory than any other event loop and is still faster than Event 2134any other event loop and is still faster than Event natively).
1975natively.
1976 2135
1977The pure perl implementation is hit in a few sweet spots (both the 2136The pure perl implementation is hit in a few sweet spots (both the
1978constant timeout and the use of a single fd hit optimisations in the perl 2137constant timeout and the use of a single fd hit optimisations in the perl
1979interpreter and the backend itself). Nevertheless this shows that it 2138interpreter and the backend itself). Nevertheless this shows that it
1980adds very little overhead in itself. Like any select-based backend its 2139adds very little overhead in itself. Like any select-based backend its
2054In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2213In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2055(1%) are active. This mirrors the activity of large servers with many 2214(1%) are active. This mirrors the activity of large servers with many
2056connections, most of which are idle at any one point in time. 2215connections, most of which are idle at any one point in time.
2057 2216
2058Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2217Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2059distribution. 2218distribution. It uses the L<AE> interface, which makes a real difference
2219for the EV and Perl backends only.
2060 2220
2061=head3 Explanation of the columns 2221=head3 Explanation of the columns
2062 2222
2063I<sockets> is the number of sockets, and twice the number of "servers" (as 2223I<sockets> is the number of sockets, and twice the number of "servers" (as
2064each server has a read and write socket end). 2224each server has a read and write socket end).
2072a new one that moves the timeout into the future. 2232a new one that moves the timeout into the future.
2073 2233
2074=head3 Results 2234=head3 Results
2075 2235
2076 name sockets create request 2236 name sockets create request
2077 EV 20000 69.01 11.16 2237 EV 20000 62.66 7.99
2078 Perl 20000 73.32 35.87 2238 Perl 20000 68.32 32.64
2079 IOAsync 20000 157.00 98.14 epoll 2239 IOAsync 20000 174.06 101.15 epoll
2080 IOAsync 20000 159.31 616.06 poll 2240 IOAsync 20000 174.67 610.84 poll
2081 Event 20000 212.62 257.32 2241 Event 20000 202.69 242.91
2082 Glib 20000 651.16 1896.30 2242 Glib 20000 557.01 1689.52
2083 POE 20000 349.67 12317.24 uses POE::Loop::Event 2243 POE 20000 341.54 12086.32 uses POE::Loop::Event
2084 2244
2085=head3 Discussion 2245=head3 Discussion
2086 2246
2087This benchmark I<does> measure scalability and overall performance of the 2247This benchmark I<does> measure scalability and overall performance of the
2088particular event loop. 2248particular event loop.
2398L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2558L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2399 2559
2400Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2560Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2401L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2561L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2402L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2562L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2403L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. 2563L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2404 2564
2405Non-blocking file handles, sockets, TCP clients and 2565Non-blocking file handles, sockets, TCP clients and
2406servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2566servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2407 2567
2408Asynchronous DNS: L<AnyEvent::DNS>. 2568Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines