1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - the DBI of event loop programming |
3 | AnyEvent - the DBI of event loop programming |
4 | |
4 | |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt, |
6 | and POE are various supported event loops/environments. |
6 | FLTK 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 | |
… | |
… | |
1049 | It should use C<postpone>: |
1049 | It should use C<postpone>: |
1050 | |
1050 | |
1051 | AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later |
1051 | AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later |
1052 | if $some_error_condition; |
1052 | if $some_error_condition; |
1053 | |
1053 | |
|
|
1054 | =item AnyEvent::log $level, $msg[, @args] |
|
|
1055 | |
|
|
1056 | Log the given C<$msg> at the given C<$level>. |
|
|
1057 | |
|
|
1058 | Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> - |
|
|
1059 | consequently, look at the L<AnyEvent::Log> documentation for details. |
|
|
1060 | |
|
|
1061 | If you want to sprinkle loads of logging calls around your code, consider |
|
|
1062 | creating a logger callback with the C<AnyEvent::Log::logger> function. |
|
|
1063 | |
1054 | =back |
1064 | =back |
1055 | |
1065 | |
1056 | =head1 WHAT TO DO IN A MODULE |
1066 | =head1 WHAT TO DO IN A MODULE |
1057 | |
1067 | |
1058 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
1068 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
… | |
… | |
1114 | |
1124 | |
1115 | |
1125 | |
1116 | =head1 OTHER MODULES |
1126 | =head1 OTHER MODULES |
1117 | |
1127 | |
1118 | The following is a non-exhaustive list of additional modules that use |
1128 | The following is a non-exhaustive list of additional modules that use |
1119 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
1129 | AnyEvent as a client and can therefore be mixed easily with other |
1120 | modules and other event loops in the same program. Some of the modules |
1130 | AnyEvent modules and other event loops in the same program. Some of the |
1121 | come as part of AnyEvent, the others are available via CPAN. |
1131 | modules come as part of AnyEvent, the others are available via CPAN (see |
|
|
1132 | L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for |
|
|
1133 | a longer non-exhaustive list), and the list is heavily biased towards |
|
|
1134 | modules of the AnyEvent author himself :) |
1122 | |
1135 | |
1123 | =over 4 |
1136 | =over 4 |
1124 | |
1137 | |
1125 | =item L<AnyEvent::Util> |
1138 | =item L<AnyEvent::Util> |
1126 | |
1139 | |
… | |
… | |
1206 | |
1219 | |
1207 | BEGIN { AnyEvent::common_sense } |
1220 | BEGIN { AnyEvent::common_sense } |
1208 | |
1221 | |
1209 | use Carp (); |
1222 | use Carp (); |
1210 | |
1223 | |
1211 | our $VERSION = '6.0'; |
1224 | our $VERSION = '6.01'; |
1212 | our $MODEL; |
1225 | our $MODEL; |
1213 | |
1226 | |
1214 | our @ISA; |
1227 | our @ISA; |
1215 | |
1228 | |
1216 | our @REGISTRY; |
1229 | our @REGISTRY; |
… | |
… | |
1223 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
1236 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
1224 | |
1237 | |
1225 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1238 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1226 | if ${^TAINT}; |
1239 | if ${^TAINT}; |
1227 | |
1240 | |
|
|
1241 | $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"} |
|
|
1242 | for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV; |
|
|
1243 | |
|
|
1244 | @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = () |
|
|
1245 | if ${^TAINT}; |
|
|
1246 | |
1228 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1247 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1229 | |
|
|
1230 | } |
1248 | } |
1231 | |
1249 | |
1232 | our $MAX_SIGNAL_LATENCY = 10; |
1250 | our $MAX_SIGNAL_LATENCY = 10; |
1233 | |
1251 | |
1234 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1252 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
… | |
… | |
1270 | push @POSTPONE, shift; |
1288 | push @POSTPONE, shift; |
1271 | |
1289 | |
1272 | $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); |
1290 | $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); |
1273 | |
1291 | |
1274 | () |
1292 | () |
|
|
1293 | } |
|
|
1294 | |
|
|
1295 | sub log($$;@) { |
|
|
1296 | # only load the bug bloated module when we actually are about to log something |
|
|
1297 | if ($_[0] <= $VERBOSE) { |
|
|
1298 | require AnyEvent::Log; |
|
|
1299 | # AnyEvent::Log overwrites this function |
|
|
1300 | goto &log; |
|
|
1301 | } |
|
|
1302 | } |
|
|
1303 | |
|
|
1304 | if (length $ENV{PERL_ANYEVENT_LOG}) { |
|
|
1305 | require AnyEvent::Log; # AnyEvent::Log does the thing for us |
1275 | } |
1306 | } |
1276 | |
1307 | |
1277 | our @models = ( |
1308 | our @models = ( |
1278 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1309 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1279 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], |
1310 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], |
… | |
… | |
1292 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect |
1323 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect |
1293 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
1324 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
1294 | [FLTK:: => AnyEvent::Impl::FLTK2::], |
1325 | [FLTK:: => AnyEvent::Impl::FLTK2::], |
1295 | ); |
1326 | ); |
1296 | |
1327 | |
|
|
1328 | our @isa_hook; |
|
|
1329 | |
|
|
1330 | sub _isa_set { |
|
|
1331 | my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL); |
|
|
1332 | |
|
|
1333 | @{"$pkg[$_-1]::ISA"} = $pkg[$_] |
|
|
1334 | for 1 .. $#pkg; |
|
|
1335 | |
|
|
1336 | grep $_ && $_->[1], @isa_hook |
|
|
1337 | and AE::_reset (); |
|
|
1338 | } |
|
|
1339 | |
|
|
1340 | # used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy |
|
|
1341 | sub _isa_hook($$;$) { |
|
|
1342 | my ($i, $pkg, $reset_ae) = @_; |
|
|
1343 | |
|
|
1344 | $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef; |
|
|
1345 | |
|
|
1346 | _isa_set; |
|
|
1347 | } |
|
|
1348 | |
1297 | # all autoloaded methods reserve the complete glob, not just the method slot. |
1349 | # all autoloaded methods reserve the complete glob, not just the method slot. |
1298 | # due to bugs in perls method cache implementation. |
1350 | # due to bugs in perls method cache implementation. |
1299 | our @methods = qw(io timer time now now_update signal child idle condvar); |
1351 | our @methods = qw(io timer time now now_update signal child idle condvar); |
1300 | |
1352 | |
1301 | sub detect() { |
1353 | sub detect() { |
|
|
1354 | return $MODEL if $MODEL; # some programs keep references to detect |
|
|
1355 | |
1302 | local $!; # for good measure |
1356 | local $!; # for good measure |
1303 | local $SIG{__DIE__}; # we use eval |
1357 | local $SIG{__DIE__}; # we use eval |
1304 | |
1358 | |
1305 | # free some memory |
1359 | # free some memory |
1306 | *detect = sub () { $MODEL }; |
1360 | *detect = sub () { $MODEL }; |
… | |
… | |
1314 | |
1368 | |
1315 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { |
1369 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { |
1316 | my $model = $1; |
1370 | my $model = $1; |
1317 | $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; |
1371 | $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; |
1318 | if (eval "require $model") { |
1372 | if (eval "require $model") { |
|
|
1373 | AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."; |
1319 | $MODEL = $model; |
1374 | $MODEL = $model; |
1320 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
|
|
1321 | } else { |
1375 | } else { |
1322 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
1376 | AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@"; |
1323 | } |
1377 | } |
1324 | } |
1378 | } |
1325 | |
1379 | |
1326 | # check for already loaded models |
1380 | # check for already loaded models |
1327 | unless ($MODEL) { |
1381 | unless ($MODEL) { |
1328 | for (@REGISTRY, @models) { |
1382 | for (@REGISTRY, @models) { |
1329 | my ($package, $model) = @$_; |
1383 | my ($package, $model) = @$_; |
1330 | if (${"$package\::VERSION"} > 0) { |
1384 | if (${"$package\::VERSION"} > 0) { |
1331 | if (eval "require $model") { |
1385 | if (eval "require $model") { |
|
|
1386 | AnyEvent::log 7 => "autodetected model '$model', using it."; |
1332 | $MODEL = $model; |
1387 | $MODEL = $model; |
1333 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
|
|
1334 | last; |
1388 | last; |
1335 | } |
1389 | } |
1336 | } |
1390 | } |
1337 | } |
1391 | } |
1338 | |
1392 | |
… | |
… | |
1344 | $autoload |
1398 | $autoload |
1345 | and eval "require $package" |
1399 | and eval "require $package" |
1346 | and ${"$package\::VERSION"} > 0 |
1400 | and ${"$package\::VERSION"} > 0 |
1347 | and eval "require $model" |
1401 | and eval "require $model" |
1348 | ) { |
1402 | ) { |
|
|
1403 | AnyEvent::log 7 => "autoloaded model '$model', using it."; |
1349 | $MODEL = $model; |
1404 | $MODEL = $model; |
1350 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
|
|
1351 | last; |
1405 | last; |
1352 | } |
1406 | } |
1353 | } |
1407 | } |
1354 | |
1408 | |
1355 | $MODEL |
1409 | $MODEL |
1356 | or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; |
1410 | or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?"; |
1357 | } |
1411 | } |
1358 | } |
1412 | } |
1359 | |
1413 | |
1360 | # free memory only needed for probing |
1414 | # free memory only needed for probing |
1361 | undef @models; |
1415 | undef @models; |
1362 | undef @REGISTRY; |
1416 | undef @REGISTRY; |
1363 | |
1417 | |
1364 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1418 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1365 | unshift @ISA, $MODEL; |
|
|
1366 | |
1419 | |
1367 | # now nuke some methods that are overridden by the backend. |
1420 | # now nuke some methods that are overridden by the backend. |
1368 | # SUPER usage is not allowed in these. |
1421 | # SUPER usage is not allowed in these. |
1369 | for (qw(time signal child idle)) { |
1422 | for (qw(time signal child idle)) { |
1370 | undef &{"AnyEvent::Base::$_"} |
1423 | undef &{"AnyEvent::Base::$_"} |
1371 | if defined &{"$MODEL\::$_"}; |
1424 | if defined &{"$MODEL\::$_"}; |
1372 | } |
1425 | } |
1373 | |
1426 | |
|
|
1427 | _isa_set; |
|
|
1428 | |
|
|
1429 | # we're officially open! |
|
|
1430 | |
1374 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
1431 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
1375 | require AnyEvent::Strict; |
1432 | require AnyEvent::Strict; |
1376 | } |
1433 | } |
1377 | |
1434 | |
1378 | if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) { |
1435 | if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) { |
1379 | require AnyEvent::Debug; |
1436 | require AnyEvent::Debug; |
1380 | AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP}); |
1437 | AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP}); |
1381 | } |
1438 | } |
1382 | |
1439 | |
1383 | if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) { |
1440 | if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) { |
1384 | require AnyEvent::Socket; |
1441 | require AnyEvent::Socket; |
1385 | require AnyEvent::Debug; |
1442 | require AnyEvent::Debug; |
1386 | |
1443 | |
1387 | my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL}; |
1444 | my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL}; |
1388 | $shell =~ s/\$\$/$$/g; |
1445 | $shell =~ s/\$\$/$$/g; |
1389 | |
1446 | |
1390 | my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell); |
1447 | my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell); |
1391 | $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service); |
1448 | $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service); |
1392 | } |
1449 | } |
|
|
1450 | |
|
|
1451 | # now the anyevent environment is set up as the user told us to, so |
|
|
1452 | # call the actual user code - post detects |
1393 | |
1453 | |
1394 | (shift @post_detect)->() while @post_detect; |
1454 | (shift @post_detect)->() while @post_detect; |
1395 | undef @post_detect; |
1455 | undef @post_detect; |
1396 | |
1456 | |
1397 | *post_detect = sub(&) { |
1457 | *post_detect = sub(&) { |
… | |
… | |
1484 | sub time() { |
1544 | sub time() { |
1485 | AnyEvent->time |
1545 | AnyEvent->time |
1486 | } |
1546 | } |
1487 | |
1547 | |
1488 | *postpone = \&AnyEvent::postpone; |
1548 | *postpone = \&AnyEvent::postpone; |
|
|
1549 | *log = \&AnyEvent::log; |
1489 | }; |
1550 | }; |
1490 | die if $@; |
1551 | die if $@; |
1491 | } |
1552 | } |
1492 | |
1553 | |
1493 | BEGIN { _reset } |
1554 | BEGIN { _reset } |
… | |
… | |
1498 | |
1559 | |
1499 | sub time { |
1560 | sub time { |
1500 | eval q{ # poor man's autoloading {} |
1561 | eval q{ # poor man's autoloading {} |
1501 | # probe for availability of Time::HiRes |
1562 | # probe for availability of Time::HiRes |
1502 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1563 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1503 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1564 | AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy." |
|
|
1565 | if $AnyEvent::VERBOSE >= 8; |
|
|
1566 | *time = sub { Time::HiRes::time () }; |
1504 | *AE::time = \&Time::HiRes::time; |
1567 | *AE::time = \& Time::HiRes::time ; |
1505 | # if (eval "use POSIX (); (POSIX::times())... |
1568 | # if (eval "use POSIX (); (POSIX::times())... |
1506 | } else { |
1569 | } else { |
1507 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1570 | AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!"; |
|
|
1571 | *time = sub { CORE::time }; |
1508 | *AE::time = sub (){ time }; # epic fail |
1572 | *AE::time = sub (){ CORE::time }; |
1509 | } |
1573 | } |
1510 | |
1574 | |
1511 | *time = sub { AE::time }; # different prototypes |
1575 | *now = \&time; |
1512 | }; |
1576 | }; |
1513 | die if $@; |
1577 | die if $@; |
1514 | |
1578 | |
1515 | &time |
1579 | &time |
1516 | } |
1580 | } |
1517 | |
1581 | |
1518 | *now = \&time; |
1582 | *now = \&time; |
1519 | |
|
|
1520 | sub now_update { } |
1583 | sub now_update { } |
1521 | |
1584 | |
1522 | sub _poll { |
1585 | sub _poll { |
1523 | Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; |
1586 | Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; |
1524 | } |
1587 | } |
… | |
… | |
1610 | |
1673 | |
1611 | sub signal { |
1674 | sub signal { |
1612 | eval q{ # poor man's autoloading {} |
1675 | eval q{ # poor man's autoloading {} |
1613 | # probe for availability of Async::Interrupt |
1676 | # probe for availability of Async::Interrupt |
1614 | if (_have_async_interrupt) { |
1677 | if (_have_async_interrupt) { |
1615 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
1678 | AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling." |
|
|
1679 | if $AnyEvent::VERBOSE >= 8; |
1616 | |
1680 | |
1617 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1681 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1618 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1682 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1619 | |
1683 | |
1620 | } else { |
1684 | } else { |
1621 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
1685 | AnyEvent::log 8 => "using emulated perl signal handling with latency timer." |
|
|
1686 | if $AnyEvent::VERBOSE >= 8; |
1622 | |
1687 | |
1623 | if (AnyEvent::WIN32) { |
1688 | if (AnyEvent::WIN32) { |
1624 | require AnyEvent::Util; |
1689 | require AnyEvent::Util; |
1625 | |
1690 | |
1626 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1691 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
… | |
… | |
1920 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
1985 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
1921 | so on. |
1986 | so on. |
1922 | |
1987 | |
1923 | =head1 ENVIRONMENT VARIABLES |
1988 | =head1 ENVIRONMENT VARIABLES |
1924 | |
1989 | |
1925 | The following environment variables are used by this module or its |
1990 | AnyEvent supports a number of environment variables that tune the |
1926 | submodules. |
1991 | runtime behaviour. They are usually evaluated when AnyEvent is |
|
|
1992 | loaded, initialised, or a submodule that uses them is loaded. Many of |
|
|
1993 | them also cause AnyEvent to load additional modules - for example, |
|
|
1994 | C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be |
|
|
1995 | loaded. |
1927 | |
1996 | |
1928 | Note that AnyEvent will remove I<all> environment variables starting with |
1997 | All the environment variables documented here start with |
1929 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
1998 | C<PERL_ANYEVENT_>, which is what AnyEvent considers its own |
1930 | enabled. |
1999 | namespace. Other modules are encouraged (but by no means required) to use |
|
|
2000 | C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule |
|
|
2001 | namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could |
|
|
2002 | be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env |
|
|
2003 | variables starting with C<AE_>, see below). |
|
|
2004 | |
|
|
2005 | All variables can also be set via the C<AE_> prefix, that is, instead |
|
|
2006 | of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In |
|
|
2007 | case there is a clash btween anyevent and another program that uses |
|
|
2008 | C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something> |
|
|
2009 | variable to the empty string, as those variables take precedence. |
|
|
2010 | |
|
|
2011 | When AnyEvent is first loaded, it copies all C<AE_xxx> env variables |
|
|
2012 | to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already |
|
|
2013 | exists. If taint mode is on, then AnyEvent will remove I<all> environment |
|
|
2014 | variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them |
|
|
2015 | with C<undef> or the empty string, if the corresaponding C<AE_> variable |
|
|
2016 | is set). |
|
|
2017 | |
|
|
2018 | The exact algorithm is currently: |
|
|
2019 | |
|
|
2020 | 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV |
|
|
2021 | 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists |
|
|
2022 | 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef. |
|
|
2023 | |
|
|
2024 | This ensures that child processes will not see the C<AE_> variables. |
|
|
2025 | |
|
|
2026 | The following environment variables are currently known to AnyEvent: |
1931 | |
2027 | |
1932 | =over 4 |
2028 | =over 4 |
1933 | |
2029 | |
1934 | =item C<PERL_ANYEVENT_VERBOSE> |
2030 | =item C<PERL_ANYEVENT_VERBOSE> |
1935 | |
2031 | |
1936 | By default, AnyEvent will be completely silent except in fatal |
2032 | By default, AnyEvent will be completely silent except in fatal |
1937 | conditions. You can set this environment variable to make AnyEvent more |
2033 | conditions. You can set this environment variable to make AnyEvent more |
1938 | talkative. |
2034 | talkative. If you want to do more than just set the global logging level |
|
|
2035 | you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more |
|
|
2036 | complex specifications. |
1939 | |
2037 | |
1940 | When set to C<1> or higher, causes AnyEvent to warn about unexpected |
2038 | When set to C<5> or higher, causes AnyEvent to warn about unexpected |
1941 | conditions, such as not being able to load the event model specified by |
2039 | conditions, such as not being able to load the event model specified by |
1942 | C<PERL_ANYEVENT_MODEL>. |
2040 | C<PERL_ANYEVENT_MODEL>. |
1943 | |
2041 | |
1944 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
2042 | When set to C<7> or higher, cause AnyEvent to report to STDERR which event |
1945 | model it chooses. |
2043 | model it chooses. |
1946 | |
2044 | |
1947 | When set to C<8> or higher, then AnyEvent will report extra information on |
2045 | When set to C<8> or higher, then AnyEvent will report extra information on |
1948 | which optional modules it loads and how it implements certain features. |
2046 | which optional modules it loads and how it implements certain features. |
|
|
2047 | |
|
|
2048 | =item C<PERL_ANYEVENT_LOG> |
|
|
2049 | |
|
|
2050 | Accepts rather complex logging specifications. For example, you could log |
|
|
2051 | all C<debug> messages of some module to stderr, warnings and above to |
|
|
2052 | stderr, and errors and above to syslog, with: |
|
|
2053 | |
|
|
2054 | PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog |
|
|
2055 | |
|
|
2056 | For the rather extensive details, see L<AnyEvent::Log>. |
|
|
2057 | |
|
|
2058 | Note that specifying this environment variable causes the L<AnyEvent::Log> |
|
|
2059 | module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only |
|
|
2060 | using the latter saves a few hundred kB of memory until the first message |
|
|
2061 | is being logged. |
1949 | |
2062 | |
1950 | =item C<PERL_ANYEVENT_STRICT> |
2063 | =item C<PERL_ANYEVENT_STRICT> |
1951 | |
2064 | |
1952 | AnyEvent does not do much argument checking by default, as thorough |
2065 | AnyEvent does not do much argument checking by default, as thorough |
1953 | argument checking is very costly. Setting this variable to a true value |
2066 | argument checking is very costly. Setting this variable to a true value |
… | |
… | |
1972 | This takes place when the first watcher is created. |
2085 | This takes place when the first watcher is created. |
1973 | |
2086 | |
1974 | For example, to bind a debug shell on a unix domain socket in |
2087 | For example, to bind a debug shell on a unix domain socket in |
1975 | F<< /tmp/debug<pid>.sock >>, you could use this: |
2088 | F<< /tmp/debug<pid>.sock >>, you could use this: |
1976 | |
2089 | |
1977 | PERL_ANYEVENT_DEBUG_SHELL=unix/:/tmp/debug\$\$.sock perlprog |
2090 | PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog |
1978 | |
2091 | |
1979 | Note that creating sockets in F</tmp> is very unsafe on multiuser |
2092 | Note that creating sockets in F</tmp> is very unsafe on multiuser |
1980 | systems. |
2093 | systems. |
1981 | |
2094 | |
1982 | =item C<PERL_ANYEVENT_DEBUG_WRAP> |
2095 | =item C<PERL_ANYEVENT_DEBUG_WRAP> |
… | |
… | |
2023 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
2136 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
2024 | - only support IPv4, never try to resolve or contact IPv6 |
2137 | - only support IPv4, never try to resolve or contact IPv6 |
2025 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
2138 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
2026 | IPv6, but prefer IPv6 over IPv4. |
2139 | IPv6, but prefer IPv6 over IPv4. |
2027 | |
2140 | |
|
|
2141 | =item C<PERL_ANYEVENT_HOSTS> |
|
|
2142 | |
|
|
2143 | This variable, if specified, overrides the F</etc/hosts> file used by |
|
|
2144 | L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read |
|
|
2145 | from that file instead. |
|
|
2146 | |
2028 | =item C<PERL_ANYEVENT_EDNS0> |
2147 | =item C<PERL_ANYEVENT_EDNS0> |
2029 | |
2148 | |
2030 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension |
2149 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for |
2031 | for DNS. This extension is generally useful to reduce DNS traffic, but |
2150 | DNS. This extension is generally useful to reduce DNS traffic, especially |
2032 | some (broken) firewalls drop such DNS packets, which is why it is off by |
2151 | when DNSSEC is involved, but some (broken) firewalls drop such DNS |
2033 | default. |
2152 | packets, which is why it is off by default. |
2034 | |
2153 | |
2035 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
2154 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
2036 | EDNS0 in its DNS requests. |
2155 | EDNS0 in its DNS requests. |
2037 | |
2156 | |
2038 | =item C<PERL_ANYEVENT_MAX_FORKS> |
2157 | =item C<PERL_ANYEVENT_MAX_FORKS> |
… | |
… | |
2046 | resolver - this is the maximum number of parallel DNS requests that are |
2165 | resolver - this is the maximum number of parallel DNS requests that are |
2047 | sent to the DNS server. |
2166 | sent to the DNS server. |
2048 | |
2167 | |
2049 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
2168 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
2050 | |
2169 | |
2051 | The file to use instead of F</etc/resolv.conf> (or OS-specific |
2170 | The absolute path to a F<resolv.conf>-style file to use instead of |
2052 | configuration) in the default resolver. When set to the empty string, no |
2171 | F</etc/resolv.conf> (or the OS-specific configuration) in the default |
2053 | default config will be used. |
2172 | resolver, or the empty string to select the default configuration. |
2054 | |
2173 | |
2055 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
2174 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
2056 | |
2175 | |
2057 | When neither C<ca_file> nor C<ca_path> was specified during |
2176 | When neither C<ca_file> nor C<ca_path> was specified during |
2058 | L<AnyEvent::TLS> context creation, and either of these environment |
2177 | L<AnyEvent::TLS> context creation, and either of these environment |
2059 | variables exist, they will be used to specify CA certificate locations |
2178 | variables are nonempty, they will be used to specify CA certificate |
2060 | instead of a system-dependent default. |
2179 | locations instead of a system-dependent default. |
2061 | |
2180 | |
2062 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
2181 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
2063 | |
2182 | |
2064 | When these are set to C<1>, then the respective modules are not |
2183 | When these are set to C<1>, then the respective modules are not |
2065 | loaded. Mostly good for testing AnyEvent itself. |
2184 | loaded. Mostly good for testing AnyEvent itself. |
… | |
… | |
2397 | (even when used without AnyEvent), but most event loops have acceptable |
2516 | (even when used without AnyEvent), but most event loops have acceptable |
2398 | performance with or without AnyEvent. |
2517 | performance with or without AnyEvent. |
2399 | |
2518 | |
2400 | =item * The overhead AnyEvent adds is usually much smaller than the overhead of |
2519 | =item * The overhead AnyEvent adds is usually much smaller than the overhead of |
2401 | the actual event loop, only with extremely fast event loops such as EV |
2520 | the actual event loop, only with extremely fast event loops such as EV |
2402 | adds AnyEvent significant overhead. |
2521 | does AnyEvent add significant overhead. |
2403 | |
2522 | |
2404 | =item * You should avoid POE like the plague if you want performance or |
2523 | =item * You should avoid POE like the plague if you want performance or |
2405 | reasonable memory usage. |
2524 | reasonable memory usage. |
2406 | |
2525 | |
2407 | =back |
2526 | =back |
… | |
… | |
2782 | |
2901 | |
2783 | Tutorial/Introduction: L<AnyEvent::Intro>. |
2902 | Tutorial/Introduction: L<AnyEvent::Intro>. |
2784 | |
2903 | |
2785 | FAQ: L<AnyEvent::FAQ>. |
2904 | FAQ: L<AnyEvent::FAQ>. |
2786 | |
2905 | |
2787 | Utility functions: L<AnyEvent::Util>. |
2906 | Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log> |
|
|
2907 | (simply logging). |
2788 | |
2908 | |
|
|
2909 | Development/Debugging: L<AnyEvent::Strict> (stricter checking), |
|
|
2910 | L<AnyEvent::Debug> (interactive shell, watcher tracing). |
|
|
2911 | |
2789 | Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>, |
2912 | Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, |
2790 | L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2913 | L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, |
|
|
2914 | L<Qt>, L<POE>, L<FLTK>. |
2791 | |
2915 | |
2792 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2916 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2793 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2917 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2794 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2918 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2795 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
2919 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>, |
|
|
2920 | L<AnyEvent::Impl::FLTK>. |
2796 | |
2921 | |
2797 | Non-blocking file handles, sockets, TCP clients and |
2922 | Non-blocking handles, pipes, stream sockets, TCP clients and |
2798 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2923 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2799 | |
2924 | |
2800 | Asynchronous DNS: L<AnyEvent::DNS>. |
2925 | Asynchronous DNS: L<AnyEvent::DNS>. |
2801 | |
2926 | |
2802 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
2927 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |