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.244 by root, Fri Jul 17 23:15:57 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 - provide framework for multiple event loops 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
40=head1 INTRODUCTION/TUTORIAL 40=head1 INTRODUCTION/TUTORIAL
41 41
42This manpage is mainly a reference manual. If you are interested 42This manpage is mainly a reference manual. If you are interested
43in a tutorial or some gentle introduction, have a look at the 43in a tutorial or some gentle introduction, have a look at the
44L<AnyEvent::Intro> manpage. 44L<AnyEvent::Intro> manpage.
45
46=head1 SUPPORT
47
48There is a mailinglist for discussing all things AnyEvent, and an IRC
49channel, too.
50
51See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52Repository>, at L<http://anyevent.schmorp.de>, for more info.
45 53
46=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 54=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
47 55
48Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 56Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
49nowadays. So what is different about AnyEvent? 57nowadays. So what is different about AnyEvent?
173my variables are only visible after the statement in which they are 181my variables are only visible after the statement in which they are
174declared. 182declared.
175 183
176=head2 I/O WATCHERS 184=head2 I/O WATCHERS
177 185
186 $w = AnyEvent->io (
187 fh => <filehandle_or_fileno>,
188 poll => <"r" or "w">,
189 cb => <callback>,
190 );
191
178You 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
179with the following mandatory key-value pairs as arguments: 193with the following mandatory key-value pairs as arguments:
180 194
181C<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
182for 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
211 undef $w; 225 undef $w;
212 }); 226 });
213 227
214=head2 TIME WATCHERS 228=head2 TIME WATCHERS
215 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
216You can create a time watcher by calling the C<< AnyEvent->timer >> 238You can create a time watcher by calling the C<< AnyEvent->timer >>
217method with the following mandatory arguments: 239method with the following mandatory arguments:
218 240
219C<after> specifies after how many seconds (fractional values are 241C<after> specifies after how many seconds (fractional values are
220supported) 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
347 369
348=back 370=back
349 371
350=head2 SIGNAL WATCHERS 372=head2 SIGNAL WATCHERS
351 373
374 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
375
352You 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
353I<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
354callback to be invoked whenever a signal occurs. 378callback to be invoked whenever a signal occurs.
355 379
356Although the callback might get passed parameters, their value and 380Although the callback might get passed parameters, their value and
368 392
369This watcher might use C<%SIG> (depending on the event loop used), 393This watcher might use C<%SIG> (depending on the event loop used),
370so programs overwriting those signals directly will likely not work 394so programs overwriting those signals directly will likely not work
371correctly. 395correctly.
372 396
397Example: exit on SIGINT
398
399 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
400
401=head3 Signal Races, Delays and Workarounds
402
373Also note that many event loops (e.g. Glib, Tk, Qt, IO::Async) do not 403Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
374support attaching callbacks to signals, which is a pity, as you cannot do 404callbacks to signals in a generic way, which is a pity, as you cannot
375race-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,
376in 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
377be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 408specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
378seconds). This variable can be changed only before the first signal 409variable can be changed only before the first signal watcher is created,
379watcher 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
380will 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
381saving. All these problems can be avoided by installing the optional 415All these problems can be avoided by installing the optional
382L<Async::Interrupt> module. 416L<Async::Interrupt> module, which works with most event loops. It will not
383 417work with inherently broken event loops such as L<Event> or L<Event::Lib>
384Example: exit on SIGINT 418(and not with L<POE> currently, as POE does it's own workaround with
385 419one-second latency). For those, you just have to suffer the delays.
386 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
387 420
388=head2 CHILD PROCESS WATCHERS 421=head2 CHILD PROCESS WATCHERS
389 422
423 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
424
390You 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.
391 426
392The 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,
393watches for any child process exit). The watcher will triggered only when 428using C<0> watches for any child process exit, on others this will
394the child process has finished and an exit status is available, not on 429croak). The watcher will be triggered only when the child process has
395any trace events (stopped/continued). 430finished and an exit status is available, not on any trace events
431(stopped/continued).
396 432
397The 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
398waitpid), 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
399callback arguments. 435callback arguments.
400 436
441 # do something else, then wait for process exit 477 # do something else, then wait for process exit
442 $done->recv; 478 $done->recv;
443 479
444=head2 IDLE WATCHERS 480=head2 IDLE WATCHERS
445 481
482 $w = AnyEvent->idle (cb => <callback>);
483
446Sometimes 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
447to 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
448"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
449attention by the event loop". 487attention by the event loop".
450 488
476 }); 514 });
477 }); 515 });
478 516
479=head2 CONDITION VARIABLES 517=head2 CONDITION VARIABLES
480 518
519 $cv = AnyEvent->condvar;
520
521 $cv->send (<list>);
522 my @res = $cv->recv;
523
481If 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
482require you to run some blocking "loop", "run" or similar function that 525require you to run some blocking "loop", "run" or similar function that
483will actively watch for new events and call your callbacks. 526will actively watch for new events and call your callbacks.
484 527
485AnyEvent is slightly different: it expects somebody else to run the event 528AnyEvent is slightly different: it expects somebody else to run the event
504Condition variables are similar to callbacks, except that you can 547Condition variables are similar to callbacks, except that you can
505optionally wait for them. They can also be called merge points - points 548optionally wait for them. They can also be called merge points - points
506in time where multiple outstanding events have been processed. And yet 549in time where multiple outstanding events have been processed. And yet
507another way to call them is transactions - each condition variable can be 550another way to call them is transactions - each condition variable can be
508used to represent a transaction, which finishes at some point and delivers 551used to represent a transaction, which finishes at some point and delivers
509a result. 552a result. And yet some people know them as "futures" - a promise to
553compute/deliver something that you can wait for.
510 554
511Condition variables are very useful to signal that something has finished, 555Condition variables are very useful to signal that something has finished,
512for example, if you write a module that does asynchronous http requests, 556for example, if you write a module that does asynchronous http requests,
513then a condition variable would be the ideal candidate to signal the 557then a condition variable would be the ideal candidate to signal the
514availability of results. The user can either act when the callback is 558availability of results. The user can either act when the callback is
548 after => 1, 592 after => 1,
549 cb => sub { $result_ready->send }, 593 cb => sub { $result_ready->send },
550 ); 594 );
551 595
552 # this "blocks" (while handling events) till the callback 596 # this "blocks" (while handling events) till the callback
553 # calls -<send 597 # calls ->send
554 $result_ready->recv; 598 $result_ready->recv;
555 599
556Example: 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
557variables are also callable directly. 601variables are also callable directly.
558 602
622one. 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
623to use a condition variable for the whole process. 667to use a condition variable for the whole process.
624 668
625Every 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
626C<< ->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
627>>, 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
628is 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
629callback 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.
630 675
631You 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
632sends), 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
633condition (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).
634 679
661begung can potentially be zero: 706begung can potentially be zero:
662 707
663 my $cv = AnyEvent->condvar; 708 my $cv = AnyEvent->condvar;
664 709
665 my %result; 710 my %result;
666 $cv->begin (sub { $cv->send (\%result) }); 711 $cv->begin (sub { shift->send (\%result) });
667 712
668 for my $host (@list_of_hosts) { 713 for my $host (@list_of_hosts) {
669 $cv->begin; 714 $cv->begin;
670 ping_host_then_call_callback $host, sub { 715 ping_host_then_call_callback $host, sub {
671 $result{$host} = ...; 716 $result{$host} = ...;
746=item $cb = $cv->cb ($cb->($cv)) 791=item $cb = $cv->cb ($cb->($cv))
747 792
748This is a mutator function that returns the callback set and optionally 793This is a mutator function that returns the callback set and optionally
749replaces it before doing so. 794replaces it before doing so.
750 795
751The callback will be called when the condition becomes "true", i.e. when 796The callback will be called when the condition becomes (or already was)
752C<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
753variable itself. Calling C<recv> inside the callback or at any later time 798the only argument being the condition variable itself. Calling C<recv>
754is guaranteed not to block. 799inside the callback or at any later time is guaranteed not to block.
755 800
756=back 801=back
757 802
758=head1 SUPPORTED EVENT LOOPS/BACKENDS 803=head1 SUPPORTED EVENT LOOPS/BACKENDS
759 804
762=over 4 807=over 4
763 808
764=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.
765 810
766EV 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
767use. 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
768that, will fall back to its own pure-perl implementation, which is 813pure-perl implementation, which is available everywhere as it comes with
769available everywhere as it comes with AnyEvent itself. 814AnyEvent itself.
770 815
771 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 816 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
772 AnyEvent::Impl::Event based on Event, very stable, few glitches.
773 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 817 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
774 818
775=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.
776 820
777These 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
778is 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
779them. This means that AnyEvent will automatically pick the right backend 823them. This means that AnyEvent will automatically pick the right backend
780when the main program loads an event module before anything starts to 824when the main program loads an event module before anything starts to
781create watchers. Nothing special needs to be done by the main program. 825create watchers. Nothing special needs to be done by the main program.
782 826
827 AnyEvent::Impl::Event based on Event, very stable, few glitches.
783 AnyEvent::Impl::Glib based on Glib, slow but very stable. 828 AnyEvent::Impl::Glib based on Glib, slow but very stable.
784 AnyEvent::Impl::Tk based on Tk, very broken. 829 AnyEvent::Impl::Tk based on Tk, very broken.
785 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 830 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
786 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.
787 833
788=item Backends with special needs. 834=item Backends with special needs.
789 835
790Qt requires the Qt::Application to be instantiated first, but will 836Qt requires the Qt::Application to be instantiated first, but will
791otherwise be picked up automatically. As long as the main program 837otherwise be picked up automatically. As long as the main program
865event module detection too early, for example, L<AnyEvent::AIO> creates 911event module detection too early, for example, L<AnyEvent::AIO> creates
866and installs the global L<IO::AIO> watcher in a C<post_detect> block to 912and installs the global L<IO::AIO> watcher in a C<post_detect> block to
867avoid autodetecting the event module at load time. 913avoid autodetecting the event module at load time.
868 914
869If called in scalar or list context, then it creates and returns an object 915If called in scalar or list context, then it creates and returns an object
870that automatically removes the callback again when it is destroyed. See 916that automatically removes the callback again when it is destroyed (or
917C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
871L<Coro::BDB> for a case where this is useful. 918a case where this is useful.
919
920Example: Create a watcher for the IO::AIO module and store it in
921C<$WATCHER>. Only do so after the event loop is initialised, though.
922
923 our WATCHER;
924
925 my $guard = AnyEvent::post_detect {
926 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
927 };
928
929 # the ||= is important in case post_detect immediately runs the block,
930 # as to not clobber the newly-created watcher. assigning both watcher and
931 # post_detect guard to the same variable has the advantage of users being
932 # able to just C<undef $WATCHER> if the watcher causes them grief.
933
934 $WATCHER ||= $guard;
872 935
873=item @AnyEvent::post_detect 936=item @AnyEvent::post_detect
874 937
875If there are any code references in this array (you can C<push> to it 938If there are any code references in this array (you can C<push> to it
876before or after loading AnyEvent), then they will called directly after 939before or after loading AnyEvent), then they will called directly after
1053 1116
1054BEGIN { AnyEvent::common_sense } 1117BEGIN { AnyEvent::common_sense }
1055 1118
1056use Carp (); 1119use Carp ();
1057 1120
1058our $VERSION = 4.83; 1121our $VERSION = '5.112';
1059our $MODEL; 1122our $MODEL;
1060 1123
1061our $AUTOLOAD; 1124our $AUTOLOAD;
1062our @ISA; 1125our @ISA;
1063 1126
1088 for reverse split /\s*,\s*/, 1151 for reverse split /\s*,\s*/,
1089 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1152 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1090} 1153}
1091 1154
1092my @models = ( 1155my @models = (
1093 [EV:: => AnyEvent::Impl::EV::], 1156 [EV:: => AnyEvent::Impl::EV:: , 1],
1094 [Event:: => AnyEvent::Impl::Event::],
1095 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1157 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1096 # everything below here will not be autoprobed 1158 # everything below here will not (normally) be autoprobed
1097 # as the pureperl backend should work everywhere 1159 # as the pureperl backend should work everywhere
1098 # and is usually faster 1160 # and is usually faster
1161 [Event:: => AnyEvent::Impl::Event::, 1],
1099 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1162 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1100 [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
1101 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1165 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1102 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1166 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1103 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1167 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1104 [Wx:: => AnyEvent::Impl::POE::], 1168 [Wx:: => AnyEvent::Impl::POE::],
1105 [Prima:: => AnyEvent::Impl::POE::], 1169 [Prima:: => AnyEvent::Impl::POE::],
1106 # 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
1107 # byzantine signal and broken child handling, among others. 1171 # byzantine signal and broken child handling, among others.
1108 # 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
1109 # obvious default class. 1173 # obvious default class.
1110# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1174 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1111# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1175 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1112# [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
1113); 1178);
1114 1179
1115our %method = map +($_ => 1), 1180our %method = map +($_ => 1),
1116 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);
1117 1182
1121 my ($cb) = @_; 1186 my ($cb) = @_;
1122 1187
1123 if ($MODEL) { 1188 if ($MODEL) {
1124 $cb->(); 1189 $cb->();
1125 1190
1126 1 1191 undef
1127 } else { 1192 } else {
1128 push @post_detect, $cb; 1193 push @post_detect, $cb;
1129 1194
1130 defined wantarray 1195 defined wantarray
1131 ? bless \$cb, "AnyEvent::Util::postdetect" 1196 ? bless \$cb, "AnyEvent::Util::postdetect"
1163 } 1228 }
1164 } 1229 }
1165 } 1230 }
1166 1231
1167 unless ($MODEL) { 1232 unless ($MODEL) {
1168 # try to load a model 1233 # try to autoload a model
1169
1170 for (@REGISTRY, @models) { 1234 for (@REGISTRY, @models) {
1171 my ($package, $model) = @$_; 1235 my ($package, $model, $autoload) = @$_;
1236 if (
1237 $autoload
1172 if (eval "require $package" 1238 and eval "require $package"
1173 and ${"$package\::VERSION"} > 0 1239 and ${"$package\::VERSION"} > 0
1174 and eval "require $model") { 1240 and eval "require $model"
1241 ) {
1175 $MODEL = $model; 1242 $MODEL = $model;
1176 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; 1243 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1177 last; 1244 last;
1178 } 1245 }
1179 } 1246 }
1180 1247
1181 $MODEL 1248 $MODEL
1220 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,"; 1287 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1221 1288
1222 # 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
1223 1290
1224 ($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
1225} 1342}
1226 1343
1227package AnyEvent::Base; 1344package AnyEvent::Base;
1228 1345
1229# default implementations for many methods 1346# default implementations for many methods
1253} 1370}
1254 1371
1255# default implementation for ->signal 1372# default implementation for ->signal
1256 1373
1257our $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
1258our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1384our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1259our (%SIG_ASY, %SIG_ASY_W); 1385our (%SIG_ASY, %SIG_ASY_W);
1260our ($SIG_COUNT, $SIG_TW); 1386our ($SIG_COUNT, $SIG_TW);
1261 1387
1262sub _signal_exec { 1388sub _signal_exec {
1270 $_->() for values %{ $SIG_CB{$_} || {} }; 1396 $_->() for values %{ $SIG_CB{$_} || {} };
1271 } 1397 }
1272 } 1398 }
1273} 1399}
1274 1400
1401# install a dummy wakeup watcher to reduce signal catching latency
1275sub _signal { 1402sub _sig_add() {
1276 my (undef, %arg) = @_; 1403 unless ($SIG_COUNT++) {
1404 # try to align timer on a full-second boundary, if possible
1405 my $NOW = AE::now;
1277 1406
1278 my $signal = uc $arg{signal} 1407 $SIG_TW = AE::timer
1279 or Carp::croak "required option 'signal' is missing"; 1408 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1280 1409 $MAX_SIGNAL_LATENCY,
1281 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1410 sub { } # just for the PERL_ASYNC_CHECK
1282
1283 if ($HAVE_ASYNC_INTERRUPT) {
1284 # async::interrupt
1285
1286 $SIG_ASY{$signal} ||= do {
1287 my $asy = new Async::Interrupt
1288 cb => sub { undef $SIG_EV{$signal} },
1289 signal => $signal,
1290 pipe => [$SIGPIPE_R->filenos],
1291 ;
1292 $asy->pipe_autodrain (0);
1293
1294 $asy
1295 }; 1411 ;
1296
1297 } else {
1298 # pure perl
1299
1300 $SIG{$signal} ||= sub {
1301 local $!;
1302 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1303 undef $SIG_EV{$signal};
1304 };
1305
1306 # can't do signal processing without introducing races in pure perl,
1307 # so limit the signal latency.
1308 ++$SIG_COUNT;
1309 $SIG_TW ||= AnyEvent->timer (
1310 after => $MAX_SIGNAL_LATENCY,
1311 interval => $MAX_SIGNAL_LATENCY,
1312 cb => sub { }, # just for the PERL_ASYNC_CHECK
1313 );
1314 } 1412 }
1315
1316 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1317} 1413}
1318 1414
1319sub signal { 1415sub _sig_del {
1320 # probe for availability of Async::Interrupt
1321 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1322 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1323
1324 $HAVE_ASYNC_INTERRUPT = 1;
1325 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1326 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1327
1328 } else {
1329 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1330
1331 require Fcntl;
1332
1333 if (AnyEvent::WIN32) {
1334 require AnyEvent::Util;
1335
1336 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1337 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1338 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1339 } else {
1340 pipe $SIGPIPE_R, $SIGPIPE_W;
1341 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1342 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1343
1344 # not strictly required, as $^F is normally 2, but let's make sure...
1345 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1346 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1347 }
1348
1349 $SIGPIPE_R
1350 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1351
1352 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1353 }
1354
1355 *signal = \&_signal;
1356 &signal
1357}
1358
1359sub AnyEvent::Base::signal::DESTROY {
1360 my ($signal, $cb) = @{$_[0]};
1361
1362 undef $SIG_TW 1416 undef $SIG_TW
1363 unless --$SIG_COUNT; 1417 unless --$SIG_COUNT;
1418}
1364 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
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 {
1488 my (undef, %arg) = @_;
1489
1490 my $signal = uc $arg{signal}
1491 or Carp::croak "required option 'signal' is missing";
1492
1493 if ($HAVE_ASYNC_INTERRUPT) {
1494 # async::interrupt
1495
1496 $signal = sig2num $signal;
1497 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1498
1499 $SIG_ASY{$signal} ||= new Async::Interrupt
1500 cb => sub { undef $SIG_EV{$signal} },
1501 signal => $signal,
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;
1522 }
1523
1524 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1525 };
1526
1527 *AnyEvent::Base::signal::DESTROY = sub {
1528 my ($signal, $cb) = @{$_[0]};
1529
1530 _sig_del;
1531
1365 delete $SIG_CB{$signal}{$cb}; 1532 delete $SIG_CB{$signal}{$cb};
1366 1533
1534 $HAVE_ASYNC_INTERRUPT
1535 ? delete $SIG_ASY{$signal}
1367 # delete doesn't work with older perls - they then 1536 : # delete doesn't work with older perls - they then
1368 # print weird messages, or just unconditionally exit 1537 # print weird messages, or just unconditionally exit
1369 # instead of getting the default action. 1538 # instead of getting the default action.
1370 undef $SIG{$signal} 1539 undef $SIG{$signal}
1371 unless keys %{ $SIG_CB{$signal} }; 1540 unless keys %{ $SIG_CB{$signal} };
1541 };
1542 };
1543 die if $@;
1544 &signal
1372} 1545}
1373 1546
1374# default implementation for ->child 1547# default implementation for ->child
1375 1548
1376our %PID_CB; 1549our %PID_CB;
1377our $CHLD_W; 1550our $CHLD_W;
1378our $CHLD_DELAY_W; 1551our $CHLD_DELAY_W;
1379our $WNOHANG; 1552our $WNOHANG;
1380 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
1381sub _sigchld { 1562sub _sigchld {
1563 my $pid;
1564
1565 AnyEvent->_emit_childstatus ($pid, $?)
1382 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1566 while ($pid = waitpid -1, $WNOHANG) > 0;
1383 $_->($pid, $?)
1384 for values %{ $PID_CB{$pid} || {} },
1385 values %{ $PID_CB{0} || {} };
1386 }
1387} 1567}
1388 1568
1389sub child { 1569sub child {
1390 my (undef, %arg) = @_; 1570 my (undef, %arg) = @_;
1391 1571
1398 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1578 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1399 ? 1 1579 ? 1
1400 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1580 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1401 1581
1402 unless ($CHLD_W) { 1582 unless ($CHLD_W) {
1403 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1583 $CHLD_W = AE::signal CHLD => \&_sigchld;
1404 # 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
1405 &_sigchld; 1585 &_sigchld;
1406 } 1586 }
1407 1587
1408 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1588 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1434 # 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,
1435 # within some limits 1615 # within some limits
1436 $w = 0.0001 if $w < 0.0001; 1616 $w = 0.0001 if $w < 0.0001;
1437 $w = 5 if $w > 5; 1617 $w = 5 if $w > 5;
1438 1618
1439 $w = AnyEvent->timer (after => $w, cb => $rcb); 1619 $w = AE::timer $w, 0, $rcb;
1440 } else { 1620 } else {
1441 # clean up... 1621 # clean up...
1442 undef $w; 1622 undef $w;
1443 undef $rcb; 1623 undef $rcb;
1444 } 1624 }
1445 }; 1625 };
1446 1626
1447 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1627 $w = AE::timer 0.05, 0, $rcb;
1448 1628
1449 bless \\$cb, "AnyEvent::Base::idle" 1629 bless \\$cb, "AnyEvent::Base::idle"
1450} 1630}
1451 1631
1452sub AnyEvent::Base::idle::DESTROY { 1632sub AnyEvent::Base::idle::DESTROY {
1506 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1686 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1507 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1687 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1508} 1688}
1509 1689
1510sub cb { 1690sub cb {
1511 $_[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
1512 $_[0]{_ae_cb} 1698 $cv->{_ae_cb}
1513} 1699}
1514 1700
1515sub begin { 1701sub begin {
1516 ++$_[0]{_ae_counter}; 1702 ++$_[0]{_ae_counter};
1517 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1703 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1876through AnyEvent. The benchmark creates a lot of timers (with a zero 2062through AnyEvent. The benchmark creates a lot of timers (with a zero
1877timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2063timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1878which it is), lets them fire exactly once and destroys them again. 2064which it is), lets them fire exactly once and destroys them again.
1879 2065
1880Source 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
1881distribution. 2067distribution. It uses the L<AE> interface, which makes a real difference
2068for the EV and Perl backends only.
1882 2069
1883=head3 Explanation of the columns 2070=head3 Explanation of the columns
1884 2071
1885I<watcher> is the number of event watchers created/destroyed. Since 2072I<watcher> is the number of event watchers created/destroyed. Since
1886different event models feature vastly different performances, each event 2073different event models feature vastly different performances, each event
1907watcher. 2094watcher.
1908 2095
1909=head3 Results 2096=head3 Results
1910 2097
1911 name watchers bytes create invoke destroy comment 2098 name watchers bytes create invoke destroy comment
1912 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
1913 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
1914 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
1915 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
1916 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
1917 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
1918 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
1919 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
1920 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
1921 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
1922 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
1923 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
1924 2111
1925=head3 Discussion 2112=head3 Discussion
1926 2113
1927The benchmark does I<not> measure scalability of the event loop very 2114The benchmark does I<not> measure scalability of the event loop very
1928well. 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)
1940benchmark machine, handling an event takes roughly 1600 CPU cycles with 2127benchmark machine, handling an event takes roughly 1600 CPU cycles with
1941EV, 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
1942cycles with POE. 2129cycles with POE.
1943 2130
1944C<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
1945maximal/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
1946far less memory than any other event loop and is still faster than Event 2135any other event loop and is still faster than Event natively).
1947natively.
1948 2136
1949The 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
1950constant 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
1951interpreter and the backend itself). Nevertheless this shows that it 2139interpreter and the backend itself). Nevertheless this shows that it
1952adds very little overhead in itself. Like any select-based backend its 2140adds very little overhead in itself. Like any select-based backend its
2026In 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
2027(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
2028connections, most of which are idle at any one point in time. 2216connections, most of which are idle at any one point in time.
2029 2217
2030Source 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
2031distribution. 2219distribution. It uses the L<AE> interface, which makes a real difference
2220for the EV and Perl backends only.
2032 2221
2033=head3 Explanation of the columns 2222=head3 Explanation of the columns
2034 2223
2035I<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
2036each server has a read and write socket end). 2225each server has a read and write socket end).
2044a new one that moves the timeout into the future. 2233a new one that moves the timeout into the future.
2045 2234
2046=head3 Results 2235=head3 Results
2047 2236
2048 name sockets create request 2237 name sockets create request
2049 EV 20000 69.01 11.16 2238 EV 20000 62.66 7.99
2050 Perl 20000 73.32 35.87 2239 Perl 20000 68.32 32.64
2051 IOAsync 20000 157.00 98.14 epoll 2240 IOAsync 20000 174.06 101.15 epoll
2052 IOAsync 20000 159.31 616.06 poll 2241 IOAsync 20000 174.67 610.84 poll
2053 Event 20000 212.62 257.32 2242 Event 20000 202.69 242.91
2054 Glib 20000 651.16 1896.30 2243 Glib 20000 557.01 1689.52
2055 POE 20000 349.67 12317.24 uses POE::Loop::Event 2244 POE 20000 341.54 12086.32 uses POE::Loop::Event
2056 2245
2057=head3 Discussion 2246=head3 Discussion
2058 2247
2059This benchmark I<does> measure scalability and overall performance of the 2248This benchmark I<does> measure scalability and overall performance of the
2060particular event loop. 2249particular event loop.
2255 2444
2256This slightly arcane module is used to implement fast signal handling: To 2445This slightly arcane module is used to implement fast signal handling: To
2257my knowledge, there is no way to do completely race-free and quick 2446my knowledge, there is no way to do completely race-free and quick
2258signal handling in pure perl. To ensure that signals still get 2447signal handling in pure perl. To ensure that signals still get
2259delivered, AnyEvent will start an interval timer to wake up perl (and 2448delivered, AnyEvent will start an interval timer to wake up perl (and
2260catch the signals) with soemd elay (default is 10 seconds, look for 2449catch the signals) with some delay (default is 10 seconds, look for
2261C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2450C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2262 2451
2263If this module is available, then it will be used to implement signal 2452If this module is available, then it will be used to implement signal
2264catching, which means that signals will not be delayed, and the event loop 2453catching, which means that signals will not be delayed, and the event loop
2265will not be interrupted regularly, which is more efficient (And good for 2454will not be interrupted regularly, which is more efficient (And good for
2266battery life on laptops). 2455battery life on laptops).
2267 2456
2268This affects not just the pure-perl event loop, but also other event loops 2457This affects not just the pure-perl event loop, but also other event loops
2269that have no signal handling on their own (e.g. Glib, Tk, Qt). 2458that have no signal handling on their own (e.g. Glib, Tk, Qt).
2459
2460Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
2461and either employ their own workarounds (POE) or use AnyEvent's workaround
2462(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
2463does nothing for those backends.
2270 2464
2271=item L<EV> 2465=item L<EV>
2272 2466
2273This module isn't really "optional", as it is simply one of the backend 2467This module isn't really "optional", as it is simply one of the backend
2274event loops that AnyEvent can use. However, it is simply the best event 2468event loops that AnyEvent can use. However, it is simply the best event
2288 2482
2289=item L<JSON> and L<JSON::XS> 2483=item L<JSON> and L<JSON::XS>
2290 2484
2291This module is required when you want to read or write JSON data via 2485This module is required when you want to read or write JSON data via
2292L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2486L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2293advantage of the ulta-high-speed L<JSON::XS> module when it is installed. 2487advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2294 2488
2295In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is 2489In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2296installed. 2490installed.
2297 2491
2298=item L<Net::SSLeay> 2492=item L<Net::SSLeay>
2365L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2559L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2366 2560
2367Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2561Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2368L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2562L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2369L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2563L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2370L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. 2564L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2371 2565
2372Non-blocking file handles, sockets, TCP clients and 2566Non-blocking file handles, sockets, TCP clients and
2373servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2567servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2374 2568
2375Asynchronous DNS: L<AnyEvent::DNS>. 2569Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines