1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - events independent of event loop implementation |
3 | AnyEvent - the DBI of event loop programming |
4 | |
4 | |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt |
6 | event loops. |
6 | and 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 | |
48 | There is a mailinglist for discussing all things AnyEvent, and an IRC |
48 | There is a mailinglist for discussing all things AnyEvent, and an IRC |
49 | channel, too. |
49 | channel, too. |
50 | |
50 | |
51 | See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software |
51 | See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software |
52 | Respository>, at L<http://anyevent.schmorp.de>, for more info. |
52 | Repository>, 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 | |
56 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
56 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
57 | nowadays. So what is different about AnyEvent? |
57 | nowadays. So what is different about AnyEvent? |
… | |
… | |
400 | |
400 | |
401 | =head2 CHILD PROCESS WATCHERS |
401 | =head2 CHILD PROCESS WATCHERS |
402 | |
402 | |
403 | You can also watch on a child process exit and catch its exit status. |
403 | You can also watch on a child process exit and catch its exit status. |
404 | |
404 | |
405 | The child process is specified by the C<pid> argument (if set to C<0>, it |
405 | The child process is specified by the C<pid> argument (one some backends, |
406 | watches for any child process exit). The watcher will triggered only when |
406 | using C<0> watches for any child process exit, on others this will |
407 | the child process has finished and an exit status is available, not on |
407 | croak). The watcher will be triggered only when the child process has |
408 | any trace events (stopped/continued). |
408 | finished and an exit status is available, not on any trace events |
|
|
409 | (stopped/continued). |
409 | |
410 | |
410 | The callback will be called with the pid and exit status (as returned by |
411 | The callback will be called with the pid and exit status (as returned by |
411 | waitpid), so unlike other watcher types, you I<can> rely on child watcher |
412 | waitpid), so unlike other watcher types, you I<can> rely on child watcher |
412 | callback arguments. |
413 | callback arguments. |
413 | |
414 | |
… | |
… | |
796 | |
797 | |
797 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
798 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
798 | AnyEvent::Impl::Tk based on Tk, very broken. |
799 | AnyEvent::Impl::Tk based on Tk, very broken. |
799 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
800 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
800 | 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. |
801 | |
803 | |
802 | =item Backends with special needs. |
804 | =item Backends with special needs. |
803 | |
805 | |
804 | Qt requires the Qt::Application to be instantiated first, but will |
806 | Qt requires the Qt::Application to be instantiated first, but will |
805 | otherwise be picked up automatically. As long as the main program |
807 | otherwise be picked up automatically. As long as the main program |
… | |
… | |
1084 | |
1086 | |
1085 | BEGIN { AnyEvent::common_sense } |
1087 | BEGIN { AnyEvent::common_sense } |
1086 | |
1088 | |
1087 | use Carp (); |
1089 | use Carp (); |
1088 | |
1090 | |
1089 | our $VERSION = 4.86; |
1091 | our $VERSION = 4.881; |
1090 | our $MODEL; |
1092 | our $MODEL; |
1091 | |
1093 | |
1092 | our $AUTOLOAD; |
1094 | our $AUTOLOAD; |
1093 | our @ISA; |
1095 | our @ISA; |
1094 | |
1096 | |
… | |
… | |
1119 | for reverse split /\s*,\s*/, |
1121 | for reverse split /\s*,\s*/, |
1120 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1122 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1121 | } |
1123 | } |
1122 | |
1124 | |
1123 | my @models = ( |
1125 | my @models = ( |
1124 | [EV:: => AnyEvent::Impl::EV::], |
1126 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1125 | [Event:: => AnyEvent::Impl::Event::], |
1127 | [Event:: => AnyEvent::Impl::Event::, 1], |
1126 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
1128 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], |
1127 | # everything below here will not be autoprobed |
1129 | # everything below here will not (normally) be autoprobed |
1128 | # as the pureperl backend should work everywhere |
1130 | # as the pureperl backend should work everywhere |
1129 | # and is usually faster |
1131 | # and is usually faster |
1130 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
1132 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1131 | [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 |
1132 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1135 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1133 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1136 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1134 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1137 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1135 | [Wx:: => AnyEvent::Impl::POE::], |
1138 | [Wx:: => AnyEvent::Impl::POE::], |
1136 | [Prima:: => AnyEvent::Impl::POE::], |
1139 | [Prima:: => AnyEvent::Impl::POE::], |
1137 | # 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 |
1138 | # byzantine signal and broken child handling, among others. |
1141 | # byzantine signal and broken child handling, among others. |
1139 | # 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 |
1140 | # obvious default class. |
1143 | # obvious default class. |
1141 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1144 | # [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1142 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1145 | # [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1143 | # [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1146 | # [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1144 | ); |
1147 | ); |
1145 | |
1148 | |
1146 | our %method = map +($_ => 1), |
1149 | our %method = map +($_ => 1), |
1147 | 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); |
1148 | |
1151 | |
… | |
… | |
1194 | } |
1197 | } |
1195 | } |
1198 | } |
1196 | } |
1199 | } |
1197 | |
1200 | |
1198 | unless ($MODEL) { |
1201 | unless ($MODEL) { |
1199 | # try to load a model |
1202 | # try to autoload a model |
1200 | |
|
|
1201 | for (@REGISTRY, @models) { |
1203 | for (@REGISTRY, @models) { |
1202 | my ($package, $model) = @$_; |
1204 | my ($package, $model, $autoload) = @$_; |
|
|
1205 | if ( |
|
|
1206 | $autoload |
1203 | if (eval "require $package" |
1207 | and eval "require $package" |
1204 | and ${"$package\::VERSION"} > 0 |
1208 | and ${"$package\::VERSION"} > 0 |
1205 | and eval "require $model") { |
1209 | and eval "require $model" |
|
|
1210 | ) { |
1206 | $MODEL = $model; |
1211 | $MODEL = $model; |
1207 | warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; |
1212 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
1208 | last; |
1213 | last; |
1209 | } |
1214 | } |
1210 | } |
1215 | } |
1211 | |
1216 | |
1212 | $MODEL |
1217 | $MODEL |
… | |
… | |
1284 | } |
1289 | } |
1285 | |
1290 | |
1286 | # default implementation for ->signal |
1291 | # default implementation for ->signal |
1287 | |
1292 | |
1288 | our $HAVE_ASYNC_INTERRUPT; |
1293 | our $HAVE_ASYNC_INTERRUPT; |
|
|
1294 | |
|
|
1295 | sub _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 | |
1289 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1303 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1290 | our (%SIG_ASY, %SIG_ASY_W); |
1304 | our (%SIG_ASY, %SIG_ASY_W); |
1291 | our ($SIG_COUNT, $SIG_TW); |
1305 | our ($SIG_COUNT, $SIG_TW); |
1292 | |
1306 | |
1293 | sub _signal_exec { |
1307 | sub _signal_exec { |
… | |
… | |
1301 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1315 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1302 | } |
1316 | } |
1303 | } |
1317 | } |
1304 | } |
1318 | } |
1305 | |
1319 | |
1306 | # install a dumym wakeupw atcher to reduce signal catching latency |
1320 | # install a dummy wakeup watcher to reduce signal catching latency |
1307 | sub _sig_add() { |
1321 | sub _sig_add() { |
1308 | unless ($SIG_COUNT++) { |
1322 | unless ($SIG_COUNT++) { |
1309 | # try to align timer on a full-second boundary, if possible |
1323 | # try to align timer on a full-second boundary, if possible |
1310 | my $NOW = AnyEvent->now; |
1324 | my $NOW = AnyEvent->now; |
1311 | |
1325 | |
… | |
… | |
1320 | sub _sig_del { |
1334 | sub _sig_del { |
1321 | undef $SIG_TW |
1335 | undef $SIG_TW |
1322 | unless --$SIG_COUNT; |
1336 | unless --$SIG_COUNT; |
1323 | } |
1337 | } |
1324 | |
1338 | |
|
|
1339 | our $_sig_name_init; $_sig_name_init = sub { |
|
|
1340 | undef $_sig_name_init; |
|
|
1341 | |
|
|
1342 | if (_have_async_interrupt) { |
|
|
1343 | *sig2num = \&Async::Interrupt::sig2num; |
|
|
1344 | *sig2name = \&Async::Interrupt::sig2name; |
|
|
1345 | } else { |
|
|
1346 | require Config; |
|
|
1347 | |
|
|
1348 | my %signame2num; |
|
|
1349 | @signame2num{ split ' ', $Config::Config{sig_name} } |
|
|
1350 | = split ' ', $Config::Config{sig_num}; |
|
|
1351 | |
|
|
1352 | my @signum2name; |
|
|
1353 | @signum2name[values %signame2num] = keys %signame2num; |
|
|
1354 | |
|
|
1355 | *sig2num = sub($) { |
|
|
1356 | $_[0] > 0 ? shift : $signame2num{+shift} |
|
|
1357 | }; |
|
|
1358 | *sig2name = sub ($) { |
|
|
1359 | $_[0] > 0 ? $signum2name[+shift] : shift |
|
|
1360 | }; |
|
|
1361 | } |
|
|
1362 | }; |
|
|
1363 | |
|
|
1364 | sub sig2num ($) { &$_sig_name_init; &sig2num } |
|
|
1365 | sub sig2name($) { &$_sig_name_init; &sig2name } |
|
|
1366 | |
1325 | sub _signal { |
1367 | sub _signal { |
1326 | my (undef, %arg) = @_; |
1368 | my (undef, %arg) = @_; |
1327 | |
1369 | |
1328 | my $signal = uc $arg{signal} |
1370 | my $signal = uc $arg{signal} |
1329 | or Carp::croak "required option 'signal' is missing"; |
1371 | or Carp::croak "required option 'signal' is missing"; |
1330 | |
1372 | |
1331 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1332 | |
|
|
1333 | if ($HAVE_ASYNC_INTERRUPT) { |
1373 | if ($HAVE_ASYNC_INTERRUPT) { |
1334 | # async::interrupt |
1374 | # async::interrupt |
1335 | |
1375 | |
1336 | $SIG_ASY{$signal} ||= do { |
1376 | $signal = sig2num $signal; |
1337 | my $asy = new Async::Interrupt |
1377 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1378 | |
|
|
1379 | $SIG_ASY{$signal} ||= new Async::Interrupt |
1338 | cb => sub { undef $SIG_EV{$signal} }, |
1380 | cb => sub { undef $SIG_EV{$signal} }, |
1339 | signal => $signal, |
1381 | signal => $signal, |
1340 | pipe => [$SIGPIPE_R->filenos], |
1382 | pipe => [$SIGPIPE_R->filenos], |
1341 | ; |
|
|
1342 | $asy->pipe_autodrain (0); |
1383 | pipe_autodrain => 0, |
1343 | |
|
|
1344 | $asy |
|
|
1345 | }; |
1384 | ; |
1346 | |
1385 | |
1347 | } else { |
1386 | } else { |
1348 | # pure perl |
1387 | # pure perl |
|
|
1388 | |
|
|
1389 | # AE::Util has been loaded in signal |
|
|
1390 | $signal = sig2name $signal; |
|
|
1391 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1349 | |
1392 | |
1350 | $SIG{$signal} ||= sub { |
1393 | $SIG{$signal} ||= sub { |
1351 | local $!; |
1394 | local $!; |
1352 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1395 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1353 | undef $SIG_EV{$signal}; |
1396 | undef $SIG_EV{$signal}; |
… | |
… | |
1361 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
1404 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
1362 | } |
1405 | } |
1363 | |
1406 | |
1364 | sub signal { |
1407 | sub signal { |
1365 | # probe for availability of Async::Interrupt |
1408 | # probe for availability of Async::Interrupt |
1366 | if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") { |
1409 | if (_have_async_interrupt) { |
1367 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
1410 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
1368 | |
1411 | |
1369 | $HAVE_ASYNC_INTERRUPT = 1; |
|
|
1370 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1412 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1371 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); |
1413 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); |
1372 | |
1414 | |
1373 | } else { |
1415 | } else { |
1374 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
1416 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
… | |
… | |
1422 | our %PID_CB; |
1464 | our %PID_CB; |
1423 | our $CHLD_W; |
1465 | our $CHLD_W; |
1424 | our $CHLD_DELAY_W; |
1466 | our $CHLD_DELAY_W; |
1425 | our $WNOHANG; |
1467 | our $WNOHANG; |
1426 | |
1468 | |
|
|
1469 | sub _emit_childstatus($$) { |
|
|
1470 | my (undef, $rpid, $rstatus) = @_; |
|
|
1471 | |
|
|
1472 | $_->($rpid, $rstatus) |
|
|
1473 | for values %{ $PID_CB{$rpid} || {} }, |
|
|
1474 | values %{ $PID_CB{0} || {} }; |
|
|
1475 | } |
|
|
1476 | |
1427 | sub _sigchld { |
1477 | sub _sigchld { |
|
|
1478 | my $pid; |
|
|
1479 | |
|
|
1480 | AnyEvent->_emit_childstatus ($pid, $?) |
1428 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1481 | while ($pid = waitpid -1, $WNOHANG) > 0; |
1429 | $_->($pid, $?) |
|
|
1430 | for values %{ $PID_CB{$pid} || {} }, |
|
|
1431 | values %{ $PID_CB{0} || {} }; |
|
|
1432 | } |
|
|
1433 | } |
1482 | } |
1434 | |
1483 | |
1435 | sub child { |
1484 | sub child { |
1436 | my (undef, %arg) = @_; |
1485 | my (undef, %arg) = @_; |
1437 | |
1486 | |
… | |
… | |
2416 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2465 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2417 | |
2466 | |
2418 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2467 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2419 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2468 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2420 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2469 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2421 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. |
2470 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
2422 | |
2471 | |
2423 | Non-blocking file handles, sockets, TCP clients and |
2472 | Non-blocking file handles, sockets, TCP clients and |
2424 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2473 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2425 | |
2474 | |
2426 | Asynchronous DNS: L<AnyEvent::DNS>. |
2475 | Asynchronous DNS: L<AnyEvent::DNS>. |