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.252 by root, Tue Jul 21 03:30:02 2009 UTC vs.
Revision 1.269 by root, Fri Jul 31 20:16:29 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
760=item $cb = $cv->cb ($cb->($cv)) 790=item $cb = $cv->cb ($cb->($cv))
761 791
762This is a mutator function that returns the callback set and optionally 792This is a mutator function that returns the callback set and optionally
763replaces it before doing so. 793replaces it before doing so.
764 794
765The callback will be called when the condition becomes "true", i.e. when 795The callback will be called when the condition becomes (or already was)
766C<send> or C<croak> are called, with the only argument being the condition 796"true", i.e. when C<send> or C<croak> are called (or were called), with
767variable itself. Calling C<recv> inside the callback or at any later time 797the only argument being the condition variable itself. Calling C<recv>
768is guaranteed not to block. 798inside the callback or at any later time is guaranteed not to block.
769 799
770=back 800=back
771 801
772=head1 SUPPORTED EVENT LOOPS/BACKENDS 802=head1 SUPPORTED EVENT LOOPS/BACKENDS
773 803
796 826
797 AnyEvent::Impl::Glib based on Glib, slow but very stable. 827 AnyEvent::Impl::Glib based on Glib, slow but very stable.
798 AnyEvent::Impl::Tk based on Tk, very broken. 828 AnyEvent::Impl::Tk based on Tk, very broken.
799 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 829 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
800 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.
801 832
802=item Backends with special needs. 833=item Backends with special needs.
803 834
804Qt requires the Qt::Application to be instantiated first, but will 835Qt requires the Qt::Application to be instantiated first, but will
805otherwise be picked up automatically. As long as the main program 836otherwise be picked up automatically. As long as the main program
1084 1115
1085BEGIN { AnyEvent::common_sense } 1116BEGIN { AnyEvent::common_sense }
1086 1117
1087use Carp (); 1118use Carp ();
1088 1119
1089our $VERSION = 4.86; 1120our $VERSION = 4.9;
1090our $MODEL; 1121our $MODEL;
1091 1122
1092our $AUTOLOAD; 1123our $AUTOLOAD;
1093our @ISA; 1124our @ISA;
1094 1125
1119 for reverse split /\s*,\s*/, 1150 for reverse split /\s*,\s*/,
1120 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1151 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1121} 1152}
1122 1153
1123my @models = ( 1154my @models = (
1124 [EV:: => AnyEvent::Impl::EV::], 1155 [EV:: => AnyEvent::Impl::EV:: , 1],
1125 [Event:: => AnyEvent::Impl::Event::], 1156 [Event:: => AnyEvent::Impl::Event::, 1],
1126 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1157 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1127 # everything below here will not be autoprobed 1158 # everything below here will not (normally) be autoprobed
1128 # as the pureperl backend should work everywhere 1159 # as the pureperl backend should work everywhere
1129 # and is usually faster 1160 # and is usually faster
1130 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1161 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1131 [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
1132 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1164 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1133 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1165 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1134 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1166 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1135 [Wx:: => AnyEvent::Impl::POE::], 1167 [Wx:: => AnyEvent::Impl::POE::],
1136 [Prima:: => AnyEvent::Impl::POE::], 1168 [Prima:: => AnyEvent::Impl::POE::],
1137 # 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
1138 # byzantine signal and broken child handling, among others. 1170 # byzantine signal and broken child handling, among others.
1139 # 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
1140 # obvious default class. 1172 # obvious default class.
1141# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1173# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1142# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1174# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1143# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1175# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1144); 1176);
1145 1177
1146our %method = map +($_ => 1), 1178our %method = map +($_ => 1),
1147 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1179 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1148 1180
1152 my ($cb) = @_; 1184 my ($cb) = @_;
1153 1185
1154 if ($MODEL) { 1186 if ($MODEL) {
1155 $cb->(); 1187 $cb->();
1156 1188
1157 1 1189 undef
1158 } else { 1190 } else {
1159 push @post_detect, $cb; 1191 push @post_detect, $cb;
1160 1192
1161 defined wantarray 1193 defined wantarray
1162 ? bless \$cb, "AnyEvent::Util::postdetect" 1194 ? bless \$cb, "AnyEvent::Util::postdetect"
1194 } 1226 }
1195 } 1227 }
1196 } 1228 }
1197 1229
1198 unless ($MODEL) { 1230 unless ($MODEL) {
1199 # try to load a model 1231 # try to autoload a model
1200
1201 for (@REGISTRY, @models) { 1232 for (@REGISTRY, @models) {
1202 my ($package, $model) = @$_; 1233 my ($package, $model, $autoload) = @$_;
1234 if (
1235 $autoload
1203 if (eval "require $package" 1236 and eval "require $package"
1204 and ${"$package\::VERSION"} > 0 1237 and ${"$package\::VERSION"} > 0
1205 and eval "require $model") { 1238 and eval "require $model"
1239 ) {
1206 $MODEL = $model; 1240 $MODEL = $model;
1207 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; 1241 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1208 last; 1242 last;
1209 } 1243 }
1210 } 1244 }
1211 1245
1212 $MODEL 1246 $MODEL
1284} 1318}
1285 1319
1286# default implementation for ->signal 1320# default implementation for ->signal
1287 1321
1288our $HAVE_ASYNC_INTERRUPT; 1322our $HAVE_ASYNC_INTERRUPT;
1323
1324sub _have_async_interrupt() {
1325 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1326 && eval "use Async::Interrupt 1.0 (); 1")
1327 unless defined $HAVE_ASYNC_INTERRUPT;
1328
1329 $HAVE_ASYNC_INTERRUPT
1330}
1331
1289our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1332our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1290our (%SIG_ASY, %SIG_ASY_W); 1333our (%SIG_ASY, %SIG_ASY_W);
1291our ($SIG_COUNT, $SIG_TW); 1334our ($SIG_COUNT, $SIG_TW);
1292 1335
1293sub _signal_exec { 1336sub _signal_exec {
1301 $_->() for values %{ $SIG_CB{$_} || {} }; 1344 $_->() for values %{ $SIG_CB{$_} || {} };
1302 } 1345 }
1303 } 1346 }
1304} 1347}
1305 1348
1306# install a dumym wakeupw atcher to reduce signal catching latency 1349# install a dummy wakeup watcher to reduce signal catching latency
1307sub _sig_add() { 1350sub _sig_add() {
1308 unless ($SIG_COUNT++) { 1351 unless ($SIG_COUNT++) {
1309 # try to align timer on a full-second boundary, if possible 1352 # try to align timer on a full-second boundary, if possible
1310 my $NOW = AnyEvent->now; 1353 my $NOW = AnyEvent->now;
1311 1354
1320sub _sig_del { 1363sub _sig_del {
1321 undef $SIG_TW 1364 undef $SIG_TW
1322 unless --$SIG_COUNT; 1365 unless --$SIG_COUNT;
1323} 1366}
1324 1367
1368our $_sig_name_init; $_sig_name_init = sub {
1369 eval q{ # poor man's autoloading
1370 undef $_sig_name_init;
1371
1372 if (_have_async_interrupt) {
1373 *sig2num = \&Async::Interrupt::sig2num;
1374 *sig2name = \&Async::Interrupt::sig2name;
1375 } else {
1376 require Config;
1377
1378 my %signame2num;
1379 @signame2num{ split ' ', $Config::Config{sig_name} }
1380 = split ' ', $Config::Config{sig_num};
1381
1382 my @signum2name;
1383 @signum2name[values %signame2num] = keys %signame2num;
1384
1385 *sig2num = sub($) {
1386 $_[0] > 0 ? shift : $signame2num{+shift}
1387 };
1388 *sig2name = sub ($) {
1389 $_[0] > 0 ? $signum2name[+shift] : shift
1390 };
1391 }
1392 };
1393 die if $@;
1394};
1395
1396sub sig2num ($) { &$_sig_name_init; &sig2num }
1397sub sig2name($) { &$_sig_name_init; &sig2name }
1398
1325sub _signal { 1399sub signal {
1400 eval q{ # poor man's autoloading {}
1401 # probe for availability of Async::Interrupt
1402 if (_have_async_interrupt) {
1403 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1404
1405 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1406 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1407
1408 } else {
1409 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1410
1411 require Fcntl;
1412
1413 if (AnyEvent::WIN32) {
1414 require AnyEvent::Util;
1415
1416 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1417 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1418 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1419 } else {
1420 pipe $SIGPIPE_R, $SIGPIPE_W;
1421 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1422 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1423
1424 # not strictly required, as $^F is normally 2, but let's make sure...
1425 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1426 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1427 }
1428
1429 $SIGPIPE_R
1430 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1431
1432 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1433 }
1434
1435 *signal = sub {
1326 my (undef, %arg) = @_; 1436 my (undef, %arg) = @_;
1327 1437
1328 my $signal = uc $arg{signal} 1438 my $signal = uc $arg{signal}
1329 or Carp::croak "required option 'signal' is missing"; 1439 or Carp::croak "required option 'signal' is missing";
1330 1440
1331 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1332
1333 if ($HAVE_ASYNC_INTERRUPT) { 1441 if ($HAVE_ASYNC_INTERRUPT) {
1334 # async::interrupt 1442 # async::interrupt
1335 1443
1336 $SIG_ASY{$signal} ||= do { 1444 $signal = sig2num $signal;
1337 my $asy = new Async::Interrupt 1445 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1446
1447 $SIG_ASY{$signal} ||= new Async::Interrupt
1338 cb => sub { undef $SIG_EV{$signal} }, 1448 cb => sub { undef $SIG_EV{$signal} },
1339 signal => $signal, 1449 signal => $signal,
1340 pipe => [$SIGPIPE_R->filenos], 1450 pipe => [$SIGPIPE_R->filenos],
1451 pipe_autodrain => 0,
1452 ;
1453
1454 } else {
1455 # pure perl
1456
1457 # AE::Util has been loaded in signal
1458 $signal = sig2name $signal;
1459 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1460
1461 $SIG{$signal} ||= sub {
1462 local $!;
1463 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1464 undef $SIG_EV{$signal};
1465 };
1466
1467 # can't do signal processing without introducing races in pure perl,
1468 # so limit the signal latency.
1469 _sig_add;
1341 ; 1470 }
1342 $asy->pipe_autodrain (0);
1343 1471
1344 $asy 1472 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1345 }; 1473 };
1346 1474
1347 } else { 1475 *AnyEvent::Base::signal::DESTROY = sub {
1348 # pure perl 1476 my ($signal, $cb) = @{$_[0]};
1349 1477
1350 $SIG{$signal} ||= sub { 1478 _sig_del;
1351 local $!; 1479
1352 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1480 delete $SIG_CB{$signal}{$cb};
1481
1482 $HAVE_ASYNC_INTERRUPT
1483 ? delete $SIG_ASY{$signal}
1484 : # delete doesn't work with older perls - they then
1485 # print weird messages, or just unconditionally exit
1486 # instead of getting the default action.
1353 undef $SIG_EV{$signal}; 1487 undef $SIG{$signal}
1488 unless keys %{ $SIG_CB{$signal} };
1354 }; 1489 };
1355
1356 # can't do signal processing without introducing races in pure perl,
1357 # so limit the signal latency.
1358 _sig_add;
1359 } 1490 };
1360 1491 die if $@;
1361 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1362}
1363
1364sub signal {
1365 # probe for availability of Async::Interrupt
1366 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1367 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1368
1369 $HAVE_ASYNC_INTERRUPT = 1;
1370 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1371 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1372
1373 } else {
1374 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1375
1376 require Fcntl;
1377
1378 if (AnyEvent::WIN32) {
1379 require AnyEvent::Util;
1380
1381 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1382 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1383 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1384 } else {
1385 pipe $SIGPIPE_R, $SIGPIPE_W;
1386 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1387 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1388
1389 # not strictly required, as $^F is normally 2, but let's make sure...
1390 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1391 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1392 }
1393
1394 $SIGPIPE_R
1395 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1396
1397 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1398 }
1399
1400 *signal = \&_signal;
1401 &signal 1492 &signal
1402}
1403
1404sub AnyEvent::Base::signal::DESTROY {
1405 my ($signal, $cb) = @{$_[0]};
1406
1407 _sig_del;
1408
1409 delete $SIG_CB{$signal}{$cb};
1410
1411 $HAVE_ASYNC_INTERRUPT
1412 ? delete $SIG_ASY{$signal}
1413 : # delete doesn't work with older perls - they then
1414 # print weird messages, or just unconditionally exit
1415 # instead of getting the default action.
1416 undef $SIG{$signal}
1417 unless keys %{ $SIG_CB{$signal} };
1418} 1493}
1419 1494
1420# default implementation for ->child 1495# default implementation for ->child
1421 1496
1422our %PID_CB; 1497our %PID_CB;
1423our $CHLD_W; 1498our $CHLD_W;
1424our $CHLD_DELAY_W; 1499our $CHLD_DELAY_W;
1425our $WNOHANG; 1500our $WNOHANG;
1426 1501
1502sub _emit_childstatus($$) {
1503 my (undef, $rpid, $rstatus) = @_;
1504
1505 $_->($rpid, $rstatus)
1506 for values %{ $PID_CB{$rpid} || {} },
1507 values %{ $PID_CB{0} || {} };
1508}
1509
1427sub _sigchld { 1510sub _sigchld {
1511 my $pid;
1512
1513 AnyEvent->_emit_childstatus ($pid, $?)
1428 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1514 while ($pid = waitpid -1, $WNOHANG) > 0;
1429 $_->($pid, $?)
1430 for values %{ $PID_CB{$pid} || {} },
1431 values %{ $PID_CB{0} || {} };
1432 }
1433} 1515}
1434 1516
1435sub child { 1517sub child {
1436 my (undef, %arg) = @_; 1518 my (undef, %arg) = @_;
1437 1519
1552 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1634 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1553 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1635 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1554} 1636}
1555 1637
1556sub cb { 1638sub cb {
1557 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1639 my $cv = shift;
1640
1641 @_
1642 and $cv->{_ae_cb} = shift
1643 and $cv->{_ae_sent}
1644 and (delete $cv->{_ae_cb})->($cv);
1558 $_[0]{_ae_cb} 1645 $cv->{_ae_cb}
1559} 1646}
1560 1647
1561sub begin { 1648sub begin {
1562 ++$_[0]{_ae_counter}; 1649 ++$_[0]{_ae_counter};
1563 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1650 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1569} 1656}
1570 1657
1571# undocumented/compatibility with pre-3.4 1658# undocumented/compatibility with pre-3.4
1572*broadcast = \&send; 1659*broadcast = \&send;
1573*wait = \&_wait; 1660*wait = \&_wait;
1661
1662#############################################################################
1663# "new" API, currently only emulation of it
1664#############################################################################
1665
1666package AE;
1667
1668sub io($$$) {
1669 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1670}
1671
1672sub timer($$$) {
1673 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
1674}
1675
1676sub signal($$) {
1677 AnyEvent->signal (signal => $_[0], cb => $_[1]);
1678}
1679
1680sub child($$) {
1681 AnyEvent->child (pid => $_[0], cb => $_[1]);
1682}
1683
1684sub idle($) {
1685 AnyEvent->idle (cb => $_[0]);
1686}
1687
1688sub cv() {
1689 AnyEvent->condvar
1690}
1691
1692sub now() {
1693 AnyEvent->now
1694}
1695
1696sub now_update() {
1697 AnyEvent->now_update
1698}
1699
1700sub time() {
1701 AnyEvent->time
1702}
1574 1703
1575=head1 ERROR AND EXCEPTION HANDLING 1704=head1 ERROR AND EXCEPTION HANDLING
1576 1705
1577In general, AnyEvent does not do any error handling - it relies on the 1706In general, AnyEvent does not do any error handling - it relies on the
1578caller to do that if required. The L<AnyEvent::Strict> module (see also 1707caller to do that if required. The L<AnyEvent::Strict> module (see also
2416L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2545L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2417 2546
2418Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2547Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2419L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2548L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2420L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2549L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2421L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. 2550L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2422 2551
2423Non-blocking file handles, sockets, TCP clients and 2552Non-blocking file handles, sockets, TCP clients and
2424servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2553servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2425 2554
2426Asynchronous DNS: L<AnyEvent::DNS>. 2555Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines