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.247 by root, Sat Jul 18 22:24:17 2009 UTC vs.
Revision 1.266 by root, Thu Jul 30 03:41:56 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
346Note that updating the time I<might> cause some events to be handled. 368Note that updating the time I<might> cause some events to be handled.
347 369
348=back 370=back
349 371
350=head2 SIGNAL WATCHERS 372=head2 SIGNAL WATCHERS
373
374 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
351 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
390currently, as POE does it's own workaround with one-second latency). With 414currently, as POE does it's own workaround with one-second latency). With
391those, you just have to suffer the delays. 415those, you just have to suffer the delays.
392 416
393=head2 CHILD PROCESS WATCHERS 417=head2 CHILD PROCESS WATCHERS
394 418
419 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
420
395You can also watch on a child process exit and catch its exit status. 421You can also watch on a child process exit and catch its exit status.
396 422
397The child process is specified by the C<pid> argument (if set to C<0>, it 423The child process is specified by the C<pid> argument (one some backends,
398watches for any child process exit). The watcher will triggered only when 424using C<0> watches for any child process exit, on others this will
399the child process has finished and an exit status is available, not on 425croak). The watcher will be triggered only when the child process has
400any trace events (stopped/continued). 426finished and an exit status is available, not on any trace events
427(stopped/continued).
401 428
402The callback will be called with the pid and exit status (as returned by 429The callback will be called with the pid and exit status (as returned by
403waitpid), so unlike other watcher types, you I<can> rely on child watcher 430waitpid), so unlike other watcher types, you I<can> rely on child watcher
404callback arguments. 431callback arguments.
405 432
446 # do something else, then wait for process exit 473 # do something else, then wait for process exit
447 $done->recv; 474 $done->recv;
448 475
449=head2 IDLE WATCHERS 476=head2 IDLE WATCHERS
450 477
478 $w = AnyEvent->idle (cb => <callback>);
479
451Sometimes there is a need to do something, but it is not so important 480Sometimes there is a need to do something, but it is not so important
452to do it instantly, but only when there is nothing better to do. This 481to do it instantly, but only when there is nothing better to do. This
453"nothing better to do" is usually defined to be "no other events need 482"nothing better to do" is usually defined to be "no other events need
454attention by the event loop". 483attention by the event loop".
455 484
481 }); 510 });
482 }); 511 });
483 512
484=head2 CONDITION VARIABLES 513=head2 CONDITION VARIABLES
485 514
515 $cv = AnyEvent->condvar;
516
517 $cv->send (<list>);
518 my @res = $cv->recv;
519
486If you are familiar with some event loops you will know that all of them 520If you are familiar with some event loops you will know that all of them
487require you to run some blocking "loop", "run" or similar function that 521require you to run some blocking "loop", "run" or similar function that
488will actively watch for new events and call your callbacks. 522will actively watch for new events and call your callbacks.
489 523
490AnyEvent is slightly different: it expects somebody else to run the event 524AnyEvent is slightly different: it expects somebody else to run the event
509Condition variables are similar to callbacks, except that you can 543Condition variables are similar to callbacks, except that you can
510optionally wait for them. They can also be called merge points - points 544optionally wait for them. They can also be called merge points - points
511in time where multiple outstanding events have been processed. And yet 545in time where multiple outstanding events have been processed. And yet
512another way to call them is transactions - each condition variable can be 546another way to call them is transactions - each condition variable can be
513used to represent a transaction, which finishes at some point and delivers 547used to represent a transaction, which finishes at some point and delivers
514a result. 548a result. And yet some people know them as "futures" - a promise to
549compute/deliver something that you can wait for.
515 550
516Condition variables are very useful to signal that something has finished, 551Condition variables are very useful to signal that something has finished,
517for example, if you write a module that does asynchronous http requests, 552for example, if you write a module that does asynchronous http requests,
518then a condition variable would be the ideal candidate to signal the 553then a condition variable would be the ideal candidate to signal the
519availability of results. The user can either act when the callback is 554availability of results. The user can either act when the callback is
787 822
788 AnyEvent::Impl::Glib based on Glib, slow but very stable. 823 AnyEvent::Impl::Glib based on Glib, slow but very stable.
789 AnyEvent::Impl::Tk based on Tk, very broken. 824 AnyEvent::Impl::Tk based on Tk, very broken.
790 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 825 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
791 AnyEvent::Impl::POE based on POE, very slow, some limitations. 826 AnyEvent::Impl::POE based on POE, very slow, some limitations.
827 AnyEvent::Impl::Irssi used when running within irssi.
792 828
793=item Backends with special needs. 829=item Backends with special needs.
794 830
795Qt requires the Qt::Application to be instantiated first, but will 831Qt requires the Qt::Application to be instantiated first, but will
796otherwise be picked up automatically. As long as the main program 832otherwise be picked up automatically. As long as the main program
870event module detection too early, for example, L<AnyEvent::AIO> creates 906event module detection too early, for example, L<AnyEvent::AIO> creates
871and installs the global L<IO::AIO> watcher in a C<post_detect> block to 907and installs the global L<IO::AIO> watcher in a C<post_detect> block to
872avoid autodetecting the event module at load time. 908avoid autodetecting the event module at load time.
873 909
874If called in scalar or list context, then it creates and returns an object 910If called in scalar or list context, then it creates and returns an object
875that automatically removes the callback again when it is destroyed. See 911that automatically removes the callback again when it is destroyed (or
912C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
876L<Coro::BDB> for a case where this is useful. 913a case where this is useful.
914
915Example: Create a watcher for the IO::AIO module and store it in
916C<$WATCHER>. Only do so after the event loop is initialised, though.
917
918 our WATCHER;
919
920 my $guard = AnyEvent::post_detect {
921 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
922 };
923
924 # the ||= is important in case post_detect immediately runs the block,
925 # as to not clobber the newly-created watcher. assigning both watcher and
926 # post_detect guard to the same variable has the advantage of users being
927 # able to just C<undef $WATCHER> if the watcher causes them grief.
928
929 $WATCHER ||= $guard;
877 930
878=item @AnyEvent::post_detect 931=item @AnyEvent::post_detect
879 932
880If there are any code references in this array (you can C<push> to it 933If there are any code references in this array (you can C<push> to it
881before or after loading AnyEvent), then they will called directly after 934before or after loading AnyEvent), then they will called directly after
1058 1111
1059BEGIN { AnyEvent::common_sense } 1112BEGIN { AnyEvent::common_sense }
1060 1113
1061use Carp (); 1114use Carp ();
1062 1115
1063our $VERSION = 4.85; 1116our $VERSION = 4.881;
1064our $MODEL; 1117our $MODEL;
1065 1118
1066our $AUTOLOAD; 1119our $AUTOLOAD;
1067our @ISA; 1120our @ISA;
1068 1121
1093 for reverse split /\s*,\s*/, 1146 for reverse split /\s*,\s*/,
1094 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1147 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1095} 1148}
1096 1149
1097my @models = ( 1150my @models = (
1098 [EV:: => AnyEvent::Impl::EV::], 1151 [EV:: => AnyEvent::Impl::EV:: , 1],
1099 [Event:: => AnyEvent::Impl::Event::], 1152 [Event:: => AnyEvent::Impl::Event::, 1],
1100 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1153 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1101 # everything below here will not be autoprobed 1154 # everything below here will not (normally) be autoprobed
1102 # as the pureperl backend should work everywhere 1155 # as the pureperl backend should work everywhere
1103 # and is usually faster 1156 # and is usually faster
1104 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1157 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1105 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1158 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1159 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1106 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1160 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1107 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1161 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1108 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1162 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1109 [Wx:: => AnyEvent::Impl::POE::], 1163 [Wx:: => AnyEvent::Impl::POE::],
1110 [Prima:: => AnyEvent::Impl::POE::], 1164 [Prima:: => AnyEvent::Impl::POE::],
1111 # IO::Async is just too broken - we would need workarounds for its 1165 # IO::Async is just too broken - we would need workarounds for its
1112 # byzantine signal and broken child handling, among others. 1166 # byzantine signal and broken child handling, among others.
1113 # IO::Async is rather hard to detect, as it doesn't have any 1167 # IO::Async is rather hard to detect, as it doesn't have any
1114 # obvious default class. 1168 # obvious default class.
1115# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1169# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1116# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1170# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1117# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1171# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1118); 1172);
1119 1173
1120our %method = map +($_ => 1), 1174our %method = map +($_ => 1),
1121 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1175 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1122 1176
1126 my ($cb) = @_; 1180 my ($cb) = @_;
1127 1181
1128 if ($MODEL) { 1182 if ($MODEL) {
1129 $cb->(); 1183 $cb->();
1130 1184
1131 1 1185 undef
1132 } else { 1186 } else {
1133 push @post_detect, $cb; 1187 push @post_detect, $cb;
1134 1188
1135 defined wantarray 1189 defined wantarray
1136 ? bless \$cb, "AnyEvent::Util::postdetect" 1190 ? bless \$cb, "AnyEvent::Util::postdetect"
1168 } 1222 }
1169 } 1223 }
1170 } 1224 }
1171 1225
1172 unless ($MODEL) { 1226 unless ($MODEL) {
1173 # try to load a model 1227 # try to autoload a model
1174
1175 for (@REGISTRY, @models) { 1228 for (@REGISTRY, @models) {
1176 my ($package, $model) = @$_; 1229 my ($package, $model, $autoload) = @$_;
1230 if (
1231 $autoload
1177 if (eval "require $package" 1232 and eval "require $package"
1178 and ${"$package\::VERSION"} > 0 1233 and ${"$package\::VERSION"} > 0
1179 and eval "require $model") { 1234 and eval "require $model"
1235 ) {
1180 $MODEL = $model; 1236 $MODEL = $model;
1181 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; 1237 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1182 last; 1238 last;
1183 } 1239 }
1184 } 1240 }
1185 1241
1186 $MODEL 1242 $MODEL
1258} 1314}
1259 1315
1260# default implementation for ->signal 1316# default implementation for ->signal
1261 1317
1262our $HAVE_ASYNC_INTERRUPT; 1318our $HAVE_ASYNC_INTERRUPT;
1319
1320sub _have_async_interrupt() {
1321 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1322 && eval "use Async::Interrupt 1.0 (); 1")
1323 unless defined $HAVE_ASYNC_INTERRUPT;
1324
1325 $HAVE_ASYNC_INTERRUPT
1326}
1327
1263our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1328our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1264our (%SIG_ASY, %SIG_ASY_W); 1329our (%SIG_ASY, %SIG_ASY_W);
1265our ($SIG_COUNT, $SIG_TW); 1330our ($SIG_COUNT, $SIG_TW);
1266 1331
1267sub _signal_exec { 1332sub _signal_exec {
1275 $_->() for values %{ $SIG_CB{$_} || {} }; 1340 $_->() for values %{ $SIG_CB{$_} || {} };
1276 } 1341 }
1277 } 1342 }
1278} 1343}
1279 1344
1280# install a dumym wakeupw atcher to reduce signal catching latency 1345# install a dummy wakeup watcher to reduce signal catching latency
1281sub _sig_add() { 1346sub _sig_add() {
1282 unless ($SIG_COUNT++) { 1347 unless ($SIG_COUNT++) {
1283 # try to align timer on a full-second boundary, if possible 1348 # try to align timer on a full-second boundary, if possible
1284 my $NOW = AnyEvent->now; 1349 my $NOW = AnyEvent->now;
1285 1350
1294sub _sig_del { 1359sub _sig_del {
1295 undef $SIG_TW 1360 undef $SIG_TW
1296 unless --$SIG_COUNT; 1361 unless --$SIG_COUNT;
1297} 1362}
1298 1363
1364our $_sig_name_init; $_sig_name_init = sub {
1365 eval q{ # poor man's autoloading
1366 undef $_sig_name_init;
1367
1368 if (_have_async_interrupt) {
1369 *sig2num = \&Async::Interrupt::sig2num;
1370 *sig2name = \&Async::Interrupt::sig2name;
1371 } else {
1372 require Config;
1373
1374 my %signame2num;
1375 @signame2num{ split ' ', $Config::Config{sig_name} }
1376 = split ' ', $Config::Config{sig_num};
1377
1378 my @signum2name;
1379 @signum2name[values %signame2num] = keys %signame2num;
1380
1381 *sig2num = sub($) {
1382 $_[0] > 0 ? shift : $signame2num{+shift}
1383 };
1384 *sig2name = sub ($) {
1385 $_[0] > 0 ? $signum2name[+shift] : shift
1386 };
1387 }
1388 };
1389 die if $@;
1390};
1391
1392sub sig2num ($) { &$_sig_name_init; &sig2num }
1393sub sig2name($) { &$_sig_name_init; &sig2name }
1394
1299sub _signal { 1395sub signal {
1396 eval q{ # poor man's autoloading {}
1397 # probe for availability of Async::Interrupt
1398 if (_have_async_interrupt) {
1399 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1400
1401 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1402 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1403
1404 } else {
1405 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1406
1407 require Fcntl;
1408
1409 if (AnyEvent::WIN32) {
1410 require AnyEvent::Util;
1411
1412 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1413 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1414 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1415 } else {
1416 pipe $SIGPIPE_R, $SIGPIPE_W;
1417 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1418 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1419
1420 # not strictly required, as $^F is normally 2, but let's make sure...
1421 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1422 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1423 }
1424
1425 $SIGPIPE_R
1426 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1427
1428 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1429 }
1430
1431 *signal = sub {
1300 my (undef, %arg) = @_; 1432 my (undef, %arg) = @_;
1301 1433
1302 my $signal = uc $arg{signal} 1434 my $signal = uc $arg{signal}
1303 or Carp::croak "required option 'signal' is missing"; 1435 or Carp::croak "required option 'signal' is missing";
1304 1436
1305 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1306
1307 if ($HAVE_ASYNC_INTERRUPT) { 1437 if ($HAVE_ASYNC_INTERRUPT) {
1308 # async::interrupt 1438 # async::interrupt
1309 1439
1310 $SIG_ASY{$signal} ||= do { 1440 $signal = sig2num $signal;
1311 my $asy = new Async::Interrupt 1441 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1442
1443 $SIG_ASY{$signal} ||= new Async::Interrupt
1312 cb => sub { undef $SIG_EV{$signal} }, 1444 cb => sub { undef $SIG_EV{$signal} },
1313 signal => $signal, 1445 signal => $signal,
1314 pipe => [$SIGPIPE_R->filenos], 1446 pipe => [$SIGPIPE_R->filenos],
1447 pipe_autodrain => 0,
1448 ;
1449
1450 } else {
1451 # pure perl
1452
1453 # AE::Util has been loaded in signal
1454 $signal = sig2name $signal;
1455 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1456
1457 $SIG{$signal} ||= sub {
1458 local $!;
1459 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1460 undef $SIG_EV{$signal};
1461 };
1462
1463 # can't do signal processing without introducing races in pure perl,
1464 # so limit the signal latency.
1465 _sig_add;
1315 ; 1466 }
1316 $asy->pipe_autodrain (0);
1317 1467
1318 $asy 1468 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1319 }; 1469 };
1320 1470
1321 } else { 1471 *AnyEvent::Base::signal::DESTROY = sub {
1322 # pure perl 1472 my ($signal, $cb) = @{$_[0]};
1323 1473
1324 $SIG{$signal} ||= sub { 1474 _sig_del;
1325 local $!; 1475
1326 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1476 delete $SIG_CB{$signal}{$cb};
1477
1478 $HAVE_ASYNC_INTERRUPT
1479 ? delete $SIG_ASY{$signal}
1480 : # delete doesn't work with older perls - they then
1481 # print weird messages, or just unconditionally exit
1482 # instead of getting the default action.
1327 undef $SIG_EV{$signal}; 1483 undef $SIG{$signal}
1484 unless keys %{ $SIG_CB{$signal} };
1328 }; 1485 };
1329
1330 # can't do signal processing without introducing races in pure perl,
1331 # so limit the signal latency.
1332 _sig_add;
1333 } 1486 };
1334 1487 die if $@;
1335 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1336}
1337
1338sub signal {
1339 # probe for availability of Async::Interrupt
1340 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1341 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1342
1343 $HAVE_ASYNC_INTERRUPT = 1;
1344 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1345 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1346
1347 } else {
1348 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1349
1350 require Fcntl;
1351
1352 if (AnyEvent::WIN32) {
1353 require AnyEvent::Util;
1354
1355 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1356 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1357 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1358 } else {
1359 pipe $SIGPIPE_R, $SIGPIPE_W;
1360 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1361 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1362
1363 # not strictly required, as $^F is normally 2, but let's make sure...
1364 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1365 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1366 }
1367
1368 $SIGPIPE_R
1369 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1370
1371 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1372 }
1373
1374 *signal = \&_signal;
1375 &signal 1488 &signal
1376}
1377
1378sub AnyEvent::Base::signal::DESTROY {
1379 my ($signal, $cb) = @{$_[0]};
1380
1381 _sig_del;
1382
1383 delete $SIG_CB{$signal}{$cb};
1384
1385 $HAVE_ASYNC_INTERRUPT
1386 ? delete $SIG_ASY{$signal}
1387 : # delete doesn't work with older perls - they then
1388 # print weird messages, or just unconditionally exit
1389 # instead of getting the default action.
1390 undef $SIG{$signal}
1391 unless keys %{ $SIG_CB{$signal} };
1392} 1489}
1393 1490
1394# default implementation for ->child 1491# default implementation for ->child
1395 1492
1396our %PID_CB; 1493our %PID_CB;
1397our $CHLD_W; 1494our $CHLD_W;
1398our $CHLD_DELAY_W; 1495our $CHLD_DELAY_W;
1399our $WNOHANG; 1496our $WNOHANG;
1400 1497
1498sub _emit_childstatus($$) {
1499 my (undef, $rpid, $rstatus) = @_;
1500
1501 $_->($rpid, $rstatus)
1502 for values %{ $PID_CB{$rpid} || {} },
1503 values %{ $PID_CB{0} || {} };
1504}
1505
1401sub _sigchld { 1506sub _sigchld {
1507 my $pid;
1508
1509 AnyEvent->_emit_childstatus ($pid, $?)
1402 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1510 while ($pid = waitpid -1, $WNOHANG) > 0;
1403 $_->($pid, $?)
1404 for values %{ $PID_CB{$pid} || {} },
1405 values %{ $PID_CB{0} || {} };
1406 }
1407} 1511}
1408 1512
1409sub child { 1513sub child {
1410 my (undef, %arg) = @_; 1514 my (undef, %arg) = @_;
1411 1515
1543} 1647}
1544 1648
1545# undocumented/compatibility with pre-3.4 1649# undocumented/compatibility with pre-3.4
1546*broadcast = \&send; 1650*broadcast = \&send;
1547*wait = \&_wait; 1651*wait = \&_wait;
1652
1653#############################################################################
1654# "new" API, currently only emulation of it
1655#############################################################################
1656
1657package AE;
1658
1659sub io($$$) {
1660 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1661}
1662
1663sub timer($$$) {
1664 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
1665}
1666
1667sub signal($$) {
1668 AnyEvent->signal (signal => $_[0], cb => $_[1]);
1669}
1670
1671sub child($$) {
1672 AnyEvent->child (pid => $_[0], cb => $_[1]);
1673}
1674
1675sub idle($) {
1676 AnyEvent->idle (cb => $_[0]);
1677}
1678
1679sub cv() {
1680 AnyEvent->condvar
1681}
1682
1683sub now() {
1684 AnyEvent->now
1685}
1686
1687sub now_update() {
1688 AnyEvent->now_update
1689}
1690
1691sub time() {
1692 AnyEvent->time
1693}
1548 1694
1549=head1 ERROR AND EXCEPTION HANDLING 1695=head1 ERROR AND EXCEPTION HANDLING
1550 1696
1551In general, AnyEvent does not do any error handling - it relies on the 1697In general, AnyEvent does not do any error handling - it relies on the
1552caller to do that if required. The L<AnyEvent::Strict> module (see also 1698caller to do that if required. The L<AnyEvent::Strict> module (see also
2313 2459
2314=item L<JSON> and L<JSON::XS> 2460=item L<JSON> and L<JSON::XS>
2315 2461
2316This module is required when you want to read or write JSON data via 2462This module is required when you want to read or write JSON data via
2317L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2463L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2318advantage of the ulta-high-speed L<JSON::XS> module when it is installed. 2464advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2319 2465
2320In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is 2466In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2321installed. 2467installed.
2322 2468
2323=item L<Net::SSLeay> 2469=item L<Net::SSLeay>
2390L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2536L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2391 2537
2392Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2538Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2393L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2539L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2394L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2540L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2395L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. 2541L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2396 2542
2397Non-blocking file handles, sockets, TCP clients and 2543Non-blocking file handles, sockets, TCP clients and
2398servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2544servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2399 2545
2400Asynchronous DNS: L<AnyEvent::DNS>. 2546Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines