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.246 by root, Sat Jul 18 15:51:52 2009 UTC vs.
Revision 1.265 by root, Wed Jul 29 13:10:58 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?
368 376
369This watcher might use C<%SIG> (depending on the event loop used), 377This watcher might use C<%SIG> (depending on the event loop used),
370so programs overwriting those signals directly will likely not work 378so programs overwriting those signals directly will likely not work
371correctly. 379correctly.
372 380
381Example: exit on SIGINT
382
383 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384
385=head3 Signal Races, Delays and Workarounds
386
373Also note that many event loops (e.g. Glib, Tk, Qt, IO::Async) do not 387Many 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 388callbacks to signals in a generic way, which is a pity, as you cannot do
375race-free signal handling in perl. AnyEvent will try to do it's best, but 389race-free signal handling in perl. AnyEvent will try to do it's best, but
376in some cases, signals will be delayed. The maximum time a signal might 390in some cases, signals will be delayed. The maximum time a signal might
377be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 391be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10
378seconds). This variable can be changed only before the first signal 392seconds). This variable can be changed only before the first signal
379watcher is created, and should be left alone otherwise. Higher values 393watcher is created, and should be left alone otherwise. Higher values
380will cause fewer spurious wake-ups, which is better for power and CPU 394will cause fewer spurious wake-ups, which is better for power and CPU
381saving. All these problems can be avoided by installing the optional 395saving. All these problems can be avoided by installing the optional
382L<Async::Interrupt> module. 396L<Async::Interrupt> module. This will not work with inherently broken
383 397event loops such as L<Event> or L<Event::Lib> (and not with L<POE>
384Example: exit on SIGINT 398currently, as POE does it's own workaround with one-second latency). With
385 399those, you just have to suffer the delays.
386 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
387 400
388=head2 CHILD PROCESS WATCHERS 401=head2 CHILD PROCESS WATCHERS
389 402
390You can also watch on a child process exit and catch its exit status. 403You can also watch on a child process exit and catch its exit status.
391 404
392The child process is specified by the C<pid> argument (if set to C<0>, it 405The child process is specified by the C<pid> argument (one some backends,
393watches for any child process exit). The watcher will triggered only when 406using 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 407croak). The watcher will be triggered only when the child process has
395any trace events (stopped/continued). 408finished and an exit status is available, not on any trace events
409(stopped/continued).
396 410
397The callback will be called with the pid and exit status (as returned by 411The 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 412waitpid), so unlike other watcher types, you I<can> rely on child watcher
399callback arguments. 413callback arguments.
400 414
504Condition variables are similar to callbacks, except that you can 518Condition variables are similar to callbacks, except that you can
505optionally wait for them. They can also be called merge points - points 519optionally wait for them. They can also be called merge points - points
506in time where multiple outstanding events have been processed. And yet 520in time where multiple outstanding events have been processed. And yet
507another way to call them is transactions - each condition variable can be 521another way to call them is transactions - each condition variable can be
508used to represent a transaction, which finishes at some point and delivers 522used to represent a transaction, which finishes at some point and delivers
509a result. 523a result. And yet some people know them as "futures" - a promise to
524compute/deliver something that you can wait for.
510 525
511Condition variables are very useful to signal that something has finished, 526Condition variables are very useful to signal that something has finished,
512for example, if you write a module that does asynchronous http requests, 527for example, if you write a module that does asynchronous http requests,
513then a condition variable would be the ideal candidate to signal the 528then a condition variable would be the ideal candidate to signal the
514availability of results. The user can either act when the callback is 529availability of results. The user can either act when the callback is
782 797
783 AnyEvent::Impl::Glib based on Glib, slow but very stable. 798 AnyEvent::Impl::Glib based on Glib, slow but very stable.
784 AnyEvent::Impl::Tk based on Tk, very broken. 799 AnyEvent::Impl::Tk based on Tk, very broken.
785 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 800 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
786 AnyEvent::Impl::POE based on POE, very slow, some limitations. 801 AnyEvent::Impl::POE based on POE, very slow, some limitations.
802 AnyEvent::Impl::Irssi used when running within irssi.
787 803
788=item Backends with special needs. 804=item Backends with special needs.
789 805
790Qt requires the Qt::Application to be instantiated first, but will 806Qt requires the Qt::Application to be instantiated first, but will
791otherwise be picked up automatically. As long as the main program 807otherwise be picked up automatically. As long as the main program
865event module detection too early, for example, L<AnyEvent::AIO> creates 881event 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 882and installs the global L<IO::AIO> watcher in a C<post_detect> block to
867avoid autodetecting the event module at load time. 883avoid autodetecting the event module at load time.
868 884
869If called in scalar or list context, then it creates and returns an object 885If called in scalar or list context, then it creates and returns an object
870that automatically removes the callback again when it is destroyed. See 886that automatically removes the callback again when it is destroyed (or
887C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
871L<Coro::BDB> for a case where this is useful. 888a case where this is useful.
889
890Example: Create a watcher for the IO::AIO module and store it in
891C<$WATCHER>. Only do so after the event loop is initialised, though.
892
893 our WATCHER;
894
895 my $guard = AnyEvent::post_detect {
896 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
897 };
898
899 # the ||= is important in case post_detect immediately runs the block,
900 # as to not clobber the newly-created watcher. assigning both watcher and
901 # post_detect guard to the same variable has the advantage of users being
902 # able to just C<undef $WATCHER> if the watcher causes them grief.
903
904 $WATCHER ||= $guard;
872 905
873=item @AnyEvent::post_detect 906=item @AnyEvent::post_detect
874 907
875If there are any code references in this array (you can C<push> to it 908If 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 909before or after loading AnyEvent), then they will called directly after
1053 1086
1054BEGIN { AnyEvent::common_sense } 1087BEGIN { AnyEvent::common_sense }
1055 1088
1056use Carp (); 1089use Carp ();
1057 1090
1058our $VERSION = 4.85; 1091our $VERSION = 4.881;
1059our $MODEL; 1092our $MODEL;
1060 1093
1061our $AUTOLOAD; 1094our $AUTOLOAD;
1062our @ISA; 1095our @ISA;
1063 1096
1088 for reverse split /\s*,\s*/, 1121 for reverse split /\s*,\s*/,
1089 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1122 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1090} 1123}
1091 1124
1092my @models = ( 1125my @models = (
1093 [EV:: => AnyEvent::Impl::EV::], 1126 [EV:: => AnyEvent::Impl::EV:: , 1],
1094 [Event:: => AnyEvent::Impl::Event::], 1127 [Event:: => AnyEvent::Impl::Event::, 1],
1095 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1128 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1096 # everything below here will not be autoprobed 1129 # everything below here will not (normally) be autoprobed
1097 # as the pureperl backend should work everywhere 1130 # as the pureperl backend should work everywhere
1098 # and is usually faster 1131 # and is usually faster
1099 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1132 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1100 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1133 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1134 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1101 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1135 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1102 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1136 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1103 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1137 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1104 [Wx:: => AnyEvent::Impl::POE::], 1138 [Wx:: => AnyEvent::Impl::POE::],
1105 [Prima:: => AnyEvent::Impl::POE::], 1139 [Prima:: => AnyEvent::Impl::POE::],
1106 # IO::Async is just too broken - we would need workarounds for its 1140 # IO::Async is just too broken - we would need workarounds for its
1107 # byzantine signal and broken child handling, among others. 1141 # byzantine signal and broken child handling, among others.
1108 # IO::Async is rather hard to detect, as it doesn't have any 1142 # IO::Async is rather hard to detect, as it doesn't have any
1109 # obvious default class. 1143 # obvious default class.
1110# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1144# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1111# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1145# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1112# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1146# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1113); 1147);
1114 1148
1115our %method = map +($_ => 1), 1149our %method = map +($_ => 1),
1116 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1150 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1117 1151
1121 my ($cb) = @_; 1155 my ($cb) = @_;
1122 1156
1123 if ($MODEL) { 1157 if ($MODEL) {
1124 $cb->(); 1158 $cb->();
1125 1159
1126 1 1160 undef
1127 } else { 1161 } else {
1128 push @post_detect, $cb; 1162 push @post_detect, $cb;
1129 1163
1130 defined wantarray 1164 defined wantarray
1131 ? bless \$cb, "AnyEvent::Util::postdetect" 1165 ? bless \$cb, "AnyEvent::Util::postdetect"
1163 } 1197 }
1164 } 1198 }
1165 } 1199 }
1166 1200
1167 unless ($MODEL) { 1201 unless ($MODEL) {
1168 # try to load a model 1202 # try to autoload a model
1169
1170 for (@REGISTRY, @models) { 1203 for (@REGISTRY, @models) {
1171 my ($package, $model) = @$_; 1204 my ($package, $model, $autoload) = @$_;
1205 if (
1206 $autoload
1172 if (eval "require $package" 1207 and eval "require $package"
1173 and ${"$package\::VERSION"} > 0 1208 and ${"$package\::VERSION"} > 0
1174 and eval "require $model") { 1209 and eval "require $model"
1210 ) {
1175 $MODEL = $model; 1211 $MODEL = $model;
1176 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; 1212 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1177 last; 1213 last;
1178 } 1214 }
1179 } 1215 }
1180 1216
1181 $MODEL 1217 $MODEL
1253} 1289}
1254 1290
1255# default implementation for ->signal 1291# default implementation for ->signal
1256 1292
1257our $HAVE_ASYNC_INTERRUPT; 1293our $HAVE_ASYNC_INTERRUPT;
1294
1295sub _have_async_interrupt() {
1296 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1297 && eval "use Async::Interrupt 1.0 (); 1")
1298 unless defined $HAVE_ASYNC_INTERRUPT;
1299
1300 $HAVE_ASYNC_INTERRUPT
1301}
1302
1258our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1303our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1259our (%SIG_ASY, %SIG_ASY_W); 1304our (%SIG_ASY, %SIG_ASY_W);
1260our ($SIG_COUNT, $SIG_TW); 1305our ($SIG_COUNT, $SIG_TW);
1261 1306
1262sub _signal_exec { 1307sub _signal_exec {
1270 $_->() for values %{ $SIG_CB{$_} || {} }; 1315 $_->() for values %{ $SIG_CB{$_} || {} };
1271 } 1316 }
1272 } 1317 }
1273} 1318}
1274 1319
1275# install a dumym wakeupw atcher to reduce signal catching latency 1320# install a dummy wakeup watcher to reduce signal catching latency
1276sub _sig_add() { 1321sub _sig_add() {
1277 unless ($SIG_COUNT++) { 1322 unless ($SIG_COUNT++) {
1278 # try to align timer on a full-second boundary, if possible 1323 # try to align timer on a full-second boundary, if possible
1279 my $NOW = AnyEvent->now; 1324 my $NOW = AnyEvent->now;
1280 1325
1289sub _sig_del { 1334sub _sig_del {
1290 undef $SIG_TW 1335 undef $SIG_TW
1291 unless --$SIG_COUNT; 1336 unless --$SIG_COUNT;
1292} 1337}
1293 1338
1339our $_sig_name_init; $_sig_name_init = sub {
1340 eval q{ # poor man's autoloading
1341 undef $_sig_name_init;
1342
1343 if (_have_async_interrupt) {
1344 *sig2num = \&Async::Interrupt::sig2num;
1345 *sig2name = \&Async::Interrupt::sig2name;
1346 } else {
1347 require Config;
1348
1349 my %signame2num;
1350 @signame2num{ split ' ', $Config::Config{sig_name} }
1351 = split ' ', $Config::Config{sig_num};
1352
1353 my @signum2name;
1354 @signum2name[values %signame2num] = keys %signame2num;
1355
1356 *sig2num = sub($) {
1357 $_[0] > 0 ? shift : $signame2num{+shift}
1358 };
1359 *sig2name = sub ($) {
1360 $_[0] > 0 ? $signum2name[+shift] : shift
1361 };
1362 }
1363 };
1364 die if $@;
1365};
1366
1367sub sig2num ($) { &$_sig_name_init; &sig2num }
1368sub sig2name($) { &$_sig_name_init; &sig2name }
1369
1294sub _signal { 1370sub signal {
1371 eval q{ # poor man's autoloading {}
1372 # probe for availability of Async::Interrupt
1373 if (_have_async_interrupt) {
1374 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1375
1376 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1377 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1378
1379 } else {
1380 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1381
1382 require Fcntl;
1383
1384 if (AnyEvent::WIN32) {
1385 require AnyEvent::Util;
1386
1387 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1388 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1389 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1390 } else {
1391 pipe $SIGPIPE_R, $SIGPIPE_W;
1392 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1393 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1394
1395 # not strictly required, as $^F is normally 2, but let's make sure...
1396 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1397 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1398 }
1399
1400 $SIGPIPE_R
1401 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1402
1403 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1404 }
1405
1406 *signal = sub {
1295 my (undef, %arg) = @_; 1407 my (undef, %arg) = @_;
1296 1408
1297 my $signal = uc $arg{signal} 1409 my $signal = uc $arg{signal}
1298 or Carp::croak "required option 'signal' is missing"; 1410 or Carp::croak "required option 'signal' is missing";
1299 1411
1300 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1301
1302 if ($HAVE_ASYNC_INTERRUPT) { 1412 if ($HAVE_ASYNC_INTERRUPT) {
1303 # async::interrupt 1413 # async::interrupt
1304 1414
1305 $SIG_ASY{$signal} ||= do { 1415 $signal = sig2num $signal;
1306 my $asy = new Async::Interrupt 1416 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1417
1418 $SIG_ASY{$signal} ||= new Async::Interrupt
1307 cb => sub { undef $SIG_EV{$signal} }, 1419 cb => sub { undef $SIG_EV{$signal} },
1308 signal => $signal, 1420 signal => $signal,
1309 pipe => [$SIGPIPE_R->filenos], 1421 pipe => [$SIGPIPE_R->filenos],
1422 pipe_autodrain => 0,
1423 ;
1424
1425 } else {
1426 # pure perl
1427
1428 # AE::Util has been loaded in signal
1429 $signal = sig2name $signal;
1430 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1431
1432 $SIG{$signal} ||= sub {
1433 local $!;
1434 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1435 undef $SIG_EV{$signal};
1436 };
1437
1438 # can't do signal processing without introducing races in pure perl,
1439 # so limit the signal latency.
1440 _sig_add;
1310 ; 1441 }
1311 $asy->pipe_autodrain (0);
1312 1442
1313 $asy 1443 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1314 }; 1444 };
1315 1445
1316 } else { 1446 *AnyEvent::Base::signal::DESTROY = sub {
1317 # pure perl 1447 my ($signal, $cb) = @{$_[0]};
1318 1448
1319 $SIG{$signal} ||= sub { 1449 _sig_del;
1320 local $!; 1450
1321 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1451 delete $SIG_CB{$signal}{$cb};
1452
1453 $HAVE_ASYNC_INTERRUPT
1454 ? delete $SIG_ASY{$signal}
1455 : # delete doesn't work with older perls - they then
1456 # print weird messages, or just unconditionally exit
1457 # instead of getting the default action.
1322 undef $SIG_EV{$signal}; 1458 undef $SIG{$signal}
1459 unless keys %{ $SIG_CB{$signal} };
1323 }; 1460 };
1324
1325 # can't do signal processing without introducing races in pure perl,
1326 # so limit the signal latency.
1327 _sig_add;
1328 } 1461 };
1329 1462 die if $@;
1330 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1331}
1332
1333sub signal {
1334 # probe for availability of Async::Interrupt
1335 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1336 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1337
1338 $HAVE_ASYNC_INTERRUPT = 1;
1339 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1340 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1341
1342 } else {
1343 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1344
1345 require Fcntl;
1346
1347 if (AnyEvent::WIN32) {
1348 require AnyEvent::Util;
1349
1350 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1351 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1352 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1353 } else {
1354 pipe $SIGPIPE_R, $SIGPIPE_W;
1355 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1356 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1357
1358 # not strictly required, as $^F is normally 2, but let's make sure...
1359 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1360 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1361 }
1362
1363 $SIGPIPE_R
1364 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1365
1366 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1367 }
1368
1369 *signal = \&_signal;
1370 &signal 1463 &signal
1371}
1372
1373sub AnyEvent::Base::signal::DESTROY {
1374 my ($signal, $cb) = @{$_[0]};
1375
1376 _sig_del;
1377
1378 delete $SIG_CB{$signal}{$cb};
1379
1380 $HAVE_ASYNC_INTERRUPT
1381 ? delete $SIG_ASY{$signal}
1382 : # delete doesn't work with older perls - they then
1383 # print weird messages, or just unconditionally exit
1384 # instead of getting the default action.
1385 undef $SIG{$signal}
1386 unless keys %{ $SIG_CB{$signal} };
1387} 1464}
1388 1465
1389# default implementation for ->child 1466# default implementation for ->child
1390 1467
1391our %PID_CB; 1468our %PID_CB;
1392our $CHLD_W; 1469our $CHLD_W;
1393our $CHLD_DELAY_W; 1470our $CHLD_DELAY_W;
1394our $WNOHANG; 1471our $WNOHANG;
1395 1472
1473sub _emit_childstatus($$) {
1474 my (undef, $rpid, $rstatus) = @_;
1475
1476 $_->($rpid, $rstatus)
1477 for values %{ $PID_CB{$rpid} || {} },
1478 values %{ $PID_CB{0} || {} };
1479}
1480
1396sub _sigchld { 1481sub _sigchld {
1482 my $pid;
1483
1484 AnyEvent->_emit_childstatus ($pid, $?)
1397 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1485 while ($pid = waitpid -1, $WNOHANG) > 0;
1398 $_->($pid, $?)
1399 for values %{ $PID_CB{$pid} || {} },
1400 values %{ $PID_CB{0} || {} };
1401 }
1402} 1486}
1403 1487
1404sub child { 1488sub child {
1405 my (undef, %arg) = @_; 1489 my (undef, %arg) = @_;
1406 1490
2270 2354
2271This slightly arcane module is used to implement fast signal handling: To 2355This slightly arcane module is used to implement fast signal handling: To
2272my knowledge, there is no way to do completely race-free and quick 2356my knowledge, there is no way to do completely race-free and quick
2273signal handling in pure perl. To ensure that signals still get 2357signal handling in pure perl. To ensure that signals still get
2274delivered, AnyEvent will start an interval timer to wake up perl (and 2358delivered, AnyEvent will start an interval timer to wake up perl (and
2275catch the signals) with soemd elay (default is 10 seconds, look for 2359catch the signals) with some delay (default is 10 seconds, look for
2276C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2360C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2277 2361
2278If this module is available, then it will be used to implement signal 2362If this module is available, then it will be used to implement signal
2279catching, which means that signals will not be delayed, and the event loop 2363catching, which means that signals will not be delayed, and the event loop
2280will not be interrupted regularly, which is more efficient (And good for 2364will not be interrupted regularly, which is more efficient (And good for
2281battery life on laptops). 2365battery life on laptops).
2282 2366
2283This affects not just the pure-perl event loop, but also other event loops 2367This affects not just the pure-perl event loop, but also other event loops
2284that have no signal handling on their own (e.g. Glib, Tk, Qt). 2368that have no signal handling on their own (e.g. Glib, Tk, Qt).
2369
2370Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
2371and either employ their own workarounds (POE) or use AnyEvent's workaround
2372(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
2373does nothing for those backends.
2285 2374
2286=item L<EV> 2375=item L<EV>
2287 2376
2288This module isn't really "optional", as it is simply one of the backend 2377This module isn't really "optional", as it is simply one of the backend
2289event loops that AnyEvent can use. However, it is simply the best event 2378event loops that AnyEvent can use. However, it is simply the best event
2303 2392
2304=item L<JSON> and L<JSON::XS> 2393=item L<JSON> and L<JSON::XS>
2305 2394
2306This module is required when you want to read or write JSON data via 2395This module is required when you want to read or write JSON data via
2307L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2396L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2308advantage of the ulta-high-speed L<JSON::XS> module when it is installed. 2397advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2309 2398
2310In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is 2399In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2311installed. 2400installed.
2312 2401
2313=item L<Net::SSLeay> 2402=item L<Net::SSLeay>
2380L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2469L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2381 2470
2382Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2471Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2383L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2472L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2384L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2473L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2385L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. 2474L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2386 2475
2387Non-blocking file handles, sockets, TCP clients and 2476Non-blocking file handles, sockets, TCP clients and
2388servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2477servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2389 2478
2390Asynchronous DNS: L<AnyEvent::DNS>. 2479Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines