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 | If L<AnyEvent::Log> is not loaded then this function makes a simple test |
|
|
1059 | to see whether the message will be logged. If the test succeeds it will |
|
|
1060 | load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at |
|
|
1061 | the L<AnyEvent::Log> documentation for details. |
|
|
1062 | |
|
|
1063 | If the test fails it will simply return. |
|
|
1064 | |
|
|
1065 | If you want to sprinkle loads of logging calls around your code, consider |
|
|
1066 | creating a logger callback with the C<AnyEvent::Log::logger> function, |
|
|
1067 | which can reduce typing, codesize and can reduce the logging overhead |
|
|
1068 | enourmously. |
|
|
1069 | |
1054 | =back |
1070 | =back |
1055 | |
1071 | |
1056 | =head1 WHAT TO DO IN A MODULE |
1072 | =head1 WHAT TO DO IN A MODULE |
1057 | |
1073 | |
1058 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
1074 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
… | |
… | |
1114 | |
1130 | |
1115 | |
1131 | |
1116 | =head1 OTHER MODULES |
1132 | =head1 OTHER MODULES |
1117 | |
1133 | |
1118 | The following is a non-exhaustive list of additional modules that use |
1134 | 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 |
1135 | 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 |
1136 | 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. |
1137 | modules come as part of AnyEvent, the others are available via CPAN (see |
|
|
1138 | L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for |
|
|
1139 | a longer non-exhaustive list), and the list is heavily biased towards |
|
|
1140 | modules of the AnyEvent author himself :) |
1122 | |
1141 | |
1123 | =over 4 |
1142 | =over 4 |
1124 | |
1143 | |
1125 | =item L<AnyEvent::Util> |
1144 | =item L<AnyEvent::Util> |
1126 | |
1145 | |
… | |
… | |
1223 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
1242 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
1224 | |
1243 | |
1225 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1244 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1226 | if ${^TAINT}; |
1245 | if ${^TAINT}; |
1227 | |
1246 | |
|
|
1247 | $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"} |
|
|
1248 | for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV; |
|
|
1249 | |
|
|
1250 | @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = () |
|
|
1251 | if ${^TAINT}; |
|
|
1252 | |
1228 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1253 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1229 | |
|
|
1230 | } |
1254 | } |
1231 | |
1255 | |
1232 | our $MAX_SIGNAL_LATENCY = 10; |
1256 | our $MAX_SIGNAL_LATENCY = 10; |
1233 | |
1257 | |
1234 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1258 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
… | |
… | |
1270 | push @POSTPONE, shift; |
1294 | push @POSTPONE, shift; |
1271 | |
1295 | |
1272 | $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); |
1296 | $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); |
1273 | |
1297 | |
1274 | () |
1298 | () |
|
|
1299 | } |
|
|
1300 | |
|
|
1301 | sub log($$;@) { |
|
|
1302 | # only load the big bloated module when we actually are about to log something |
|
|
1303 | if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!) |
|
|
1304 | require AnyEvent::Log; |
|
|
1305 | # AnyEvent::Log overwrites this function |
|
|
1306 | goto &log; |
|
|
1307 | } |
|
|
1308 | |
|
|
1309 | 0 # not logged |
|
|
1310 | } |
|
|
1311 | |
|
|
1312 | if (length $ENV{PERL_ANYEVENT_LOG}) { |
|
|
1313 | require AnyEvent::Log; # AnyEvent::Log does the thing for us |
1275 | } |
1314 | } |
1276 | |
1315 | |
1277 | our @models = ( |
1316 | our @models = ( |
1278 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1317 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1279 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], |
1318 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], |
… | |
… | |
1318 | # all autoloaded methods reserve the complete glob, not just the method slot. |
1357 | # all autoloaded methods reserve the complete glob, not just the method slot. |
1319 | # due to bugs in perls method cache implementation. |
1358 | # due to bugs in perls method cache implementation. |
1320 | our @methods = qw(io timer time now now_update signal child idle condvar); |
1359 | our @methods = qw(io timer time now now_update signal child idle condvar); |
1321 | |
1360 | |
1322 | sub detect() { |
1361 | sub detect() { |
|
|
1362 | return $MODEL if $MODEL; # some programs keep references to detect |
|
|
1363 | |
1323 | local $!; # for good measure |
1364 | local $!; # for good measure |
1324 | local $SIG{__DIE__}; # we use eval |
1365 | local $SIG{__DIE__}; # we use eval |
1325 | |
1366 | |
1326 | # free some memory |
1367 | # free some memory |
1327 | *detect = sub () { $MODEL }; |
1368 | *detect = sub () { $MODEL }; |
… | |
… | |
1335 | |
1376 | |
1336 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { |
1377 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { |
1337 | my $model = $1; |
1378 | my $model = $1; |
1338 | $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; |
1379 | $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; |
1339 | if (eval "require $model") { |
1380 | if (eval "require $model") { |
|
|
1381 | AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."; |
1340 | $MODEL = $model; |
1382 | $MODEL = $model; |
1341 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
|
|
1342 | } else { |
1383 | } else { |
1343 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
1384 | AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@"; |
1344 | } |
1385 | } |
1345 | } |
1386 | } |
1346 | |
1387 | |
1347 | # check for already loaded models |
1388 | # check for already loaded models |
1348 | unless ($MODEL) { |
1389 | unless ($MODEL) { |
1349 | for (@REGISTRY, @models) { |
1390 | for (@REGISTRY, @models) { |
1350 | my ($package, $model) = @$_; |
1391 | my ($package, $model) = @$_; |
1351 | if (${"$package\::VERSION"} > 0) { |
1392 | if (${"$package\::VERSION"} > 0) { |
1352 | if (eval "require $model") { |
1393 | if (eval "require $model") { |
|
|
1394 | AnyEvent::log 7 => "autodetected model '$model', using it."; |
1353 | $MODEL = $model; |
1395 | $MODEL = $model; |
1354 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
|
|
1355 | last; |
1396 | last; |
1356 | } |
1397 | } |
1357 | } |
1398 | } |
1358 | } |
1399 | } |
1359 | |
1400 | |
… | |
… | |
1365 | $autoload |
1406 | $autoload |
1366 | and eval "require $package" |
1407 | and eval "require $package" |
1367 | and ${"$package\::VERSION"} > 0 |
1408 | and ${"$package\::VERSION"} > 0 |
1368 | and eval "require $model" |
1409 | and eval "require $model" |
1369 | ) { |
1410 | ) { |
|
|
1411 | AnyEvent::log 7 => "autoloaded model '$model', using it."; |
1370 | $MODEL = $model; |
1412 | $MODEL = $model; |
1371 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
|
|
1372 | last; |
1413 | last; |
1373 | } |
1414 | } |
1374 | } |
1415 | } |
1375 | |
1416 | |
1376 | $MODEL |
1417 | $MODEL |
1377 | or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; |
1418 | or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?"; |
1378 | } |
1419 | } |
1379 | } |
1420 | } |
1380 | |
1421 | |
1381 | # free memory only needed for probing |
1422 | # free memory only needed for probing |
1382 | undef @models; |
1423 | undef @models; |
… | |
… | |
1391 | if defined &{"$MODEL\::$_"}; |
1432 | if defined &{"$MODEL\::$_"}; |
1392 | } |
1433 | } |
1393 | |
1434 | |
1394 | _isa_set; |
1435 | _isa_set; |
1395 | |
1436 | |
|
|
1437 | # we're officially open! |
|
|
1438 | |
1396 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
1439 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
1397 | require AnyEvent::Strict; |
1440 | require AnyEvent::Strict; |
1398 | } |
1441 | } |
1399 | |
1442 | |
1400 | if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) { |
1443 | if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) { |
1401 | require AnyEvent::Debug; |
1444 | require AnyEvent::Debug; |
1402 | AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP}); |
1445 | AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP}); |
1403 | } |
1446 | } |
1404 | |
1447 | |
1405 | if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) { |
1448 | if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) { |
1406 | require AnyEvent::Socket; |
1449 | require AnyEvent::Socket; |
1407 | require AnyEvent::Debug; |
1450 | require AnyEvent::Debug; |
1408 | |
1451 | |
1409 | my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL}; |
1452 | my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL}; |
1410 | $shell =~ s/\$\$/$$/g; |
1453 | $shell =~ s/\$\$/$$/g; |
1411 | |
1454 | |
1412 | my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell); |
1455 | my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell); |
1413 | $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service); |
1456 | $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service); |
1414 | } |
1457 | } |
|
|
1458 | |
|
|
1459 | # now the anyevent environment is set up as the user told us to, so |
|
|
1460 | # call the actual user code - post detects |
1415 | |
1461 | |
1416 | (shift @post_detect)->() while @post_detect; |
1462 | (shift @post_detect)->() while @post_detect; |
1417 | undef @post_detect; |
1463 | undef @post_detect; |
1418 | |
1464 | |
1419 | *post_detect = sub(&) { |
1465 | *post_detect = sub(&) { |
… | |
… | |
1506 | sub time() { |
1552 | sub time() { |
1507 | AnyEvent->time |
1553 | AnyEvent->time |
1508 | } |
1554 | } |
1509 | |
1555 | |
1510 | *postpone = \&AnyEvent::postpone; |
1556 | *postpone = \&AnyEvent::postpone; |
|
|
1557 | *log = \&AnyEvent::log; |
1511 | }; |
1558 | }; |
1512 | die if $@; |
1559 | die if $@; |
1513 | } |
1560 | } |
1514 | |
1561 | |
1515 | BEGIN { _reset } |
1562 | BEGIN { _reset } |
… | |
… | |
1520 | |
1567 | |
1521 | sub time { |
1568 | sub time { |
1522 | eval q{ # poor man's autoloading {} |
1569 | eval q{ # poor man's autoloading {} |
1523 | # probe for availability of Time::HiRes |
1570 | # probe for availability of Time::HiRes |
1524 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1571 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1525 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
|
|
1526 | *time = sub { Time::HiRes::time () }; |
1572 | *time = sub { Time::HiRes::time () }; |
1527 | *AE::time = \& Time::HiRes::time ; |
1573 | *AE::time = \& Time::HiRes::time ; |
|
|
1574 | *now = \&time; |
|
|
1575 | AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."; |
1528 | # if (eval "use POSIX (); (POSIX::times())... |
1576 | # if (eval "use POSIX (); (POSIX::times())... |
1529 | } else { |
1577 | } else { |
1530 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
|
|
1531 | *time = sub { CORE::time }; |
1578 | *time = sub { CORE::time }; |
1532 | *AE::time = sub (){ CORE::time }; |
1579 | *AE::time = sub (){ CORE::time }; |
|
|
1580 | *now = \&time; |
|
|
1581 | AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!"; |
1533 | } |
1582 | } |
1534 | |
|
|
1535 | *now = \&time; |
|
|
1536 | }; |
1583 | }; |
1537 | die if $@; |
1584 | die if $@; |
1538 | |
1585 | |
1539 | &time |
1586 | &time |
1540 | } |
1587 | } |
… | |
… | |
1633 | |
1680 | |
1634 | sub signal { |
1681 | sub signal { |
1635 | eval q{ # poor man's autoloading {} |
1682 | eval q{ # poor man's autoloading {} |
1636 | # probe for availability of Async::Interrupt |
1683 | # probe for availability of Async::Interrupt |
1637 | if (_have_async_interrupt) { |
1684 | if (_have_async_interrupt) { |
1638 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
1685 | AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."; |
1639 | |
1686 | |
1640 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1687 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1641 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1688 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1642 | |
1689 | |
1643 | } else { |
1690 | } else { |
1644 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
1691 | AnyEvent::log 8 => "using emulated perl signal handling with latency timer."; |
1645 | |
1692 | |
1646 | if (AnyEvent::WIN32) { |
1693 | if (AnyEvent::WIN32) { |
1647 | require AnyEvent::Util; |
1694 | require AnyEvent::Util; |
1648 | |
1695 | |
1649 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1696 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
… | |
… | |
1943 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
1990 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
1944 | so on. |
1991 | so on. |
1945 | |
1992 | |
1946 | =head1 ENVIRONMENT VARIABLES |
1993 | =head1 ENVIRONMENT VARIABLES |
1947 | |
1994 | |
1948 | The following environment variables are used by this module or its |
1995 | AnyEvent supports a number of environment variables that tune the |
1949 | submodules. |
1996 | runtime behaviour. They are usually evaluated when AnyEvent is |
|
|
1997 | loaded, initialised, or a submodule that uses them is loaded. Many of |
|
|
1998 | them also cause AnyEvent to load additional modules - for example, |
|
|
1999 | C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be |
|
|
2000 | loaded. |
1950 | |
2001 | |
1951 | Note that AnyEvent will remove I<all> environment variables starting with |
2002 | All the environment variables documented here start with |
1952 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
2003 | C<PERL_ANYEVENT_>, which is what AnyEvent considers its own |
1953 | enabled. |
2004 | namespace. Other modules are encouraged (but by no means required) to use |
|
|
2005 | C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule |
|
|
2006 | namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could |
|
|
2007 | be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env |
|
|
2008 | variables starting with C<AE_>, see below). |
|
|
2009 | |
|
|
2010 | All variables can also be set via the C<AE_> prefix, that is, instead |
|
|
2011 | of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In |
|
|
2012 | case there is a clash btween anyevent and another program that uses |
|
|
2013 | C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something> |
|
|
2014 | variable to the empty string, as those variables take precedence. |
|
|
2015 | |
|
|
2016 | When AnyEvent is first loaded, it copies all C<AE_xxx> env variables |
|
|
2017 | to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already |
|
|
2018 | exists. If taint mode is on, then AnyEvent will remove I<all> environment |
|
|
2019 | variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them |
|
|
2020 | with C<undef> or the empty string, if the corresaponding C<AE_> variable |
|
|
2021 | is set). |
|
|
2022 | |
|
|
2023 | The exact algorithm is currently: |
|
|
2024 | |
|
|
2025 | 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV |
|
|
2026 | 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists |
|
|
2027 | 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef. |
|
|
2028 | |
|
|
2029 | This ensures that child processes will not see the C<AE_> variables. |
|
|
2030 | |
|
|
2031 | The following environment variables are currently known to AnyEvent: |
1954 | |
2032 | |
1955 | =over 4 |
2033 | =over 4 |
1956 | |
2034 | |
1957 | =item C<PERL_ANYEVENT_VERBOSE> |
2035 | =item C<PERL_ANYEVENT_VERBOSE> |
1958 | |
2036 | |
1959 | By default, AnyEvent will be completely silent except in fatal |
2037 | By default, AnyEvent will be completely silent except in fatal |
1960 | conditions. You can set this environment variable to make AnyEvent more |
2038 | conditions. You can set this environment variable to make AnyEvent more |
1961 | talkative. |
2039 | talkative. If you want to do more than just set the global logging level |
|
|
2040 | you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more |
|
|
2041 | complex specifications. |
1962 | |
2042 | |
1963 | When set to C<1> or higher, causes AnyEvent to warn about unexpected |
2043 | When set to C<5> or higher (warn), causes AnyEvent to warn about unexpected |
1964 | conditions, such as not being able to load the event model specified by |
2044 | conditions, such as not being able to load the event model specified by |
1965 | C<PERL_ANYEVENT_MODEL>. |
2045 | C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this |
|
|
2046 | is the minimum recommended level. |
1966 | |
2047 | |
1967 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
2048 | When set to C<7> or higher (info), cause AnyEvent to report which event model it |
1968 | model it chooses. |
2049 | chooses. |
1969 | |
2050 | |
1970 | When set to C<8> or higher, then AnyEvent will report extra information on |
2051 | When set to C<8> or higher (debug), then AnyEvent will report extra information on |
1971 | which optional modules it loads and how it implements certain features. |
2052 | which optional modules it loads and how it implements certain features. |
|
|
2053 | |
|
|
2054 | =item C<PERL_ANYEVENT_LOG> |
|
|
2055 | |
|
|
2056 | Accepts rather complex logging specifications. For example, you could log |
|
|
2057 | all C<debug> messages of some module to stderr, warnings and above to |
|
|
2058 | stderr, and errors and above to syslog, with: |
|
|
2059 | |
|
|
2060 | PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog |
|
|
2061 | |
|
|
2062 | For the rather extensive details, see L<AnyEvent::Log>. |
|
|
2063 | |
|
|
2064 | This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded, |
|
|
2065 | so will take effect even before AnyEvent has initialised itself. |
|
|
2066 | |
|
|
2067 | Note that specifying this environment variable causes the L<AnyEvent::Log> |
|
|
2068 | module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only |
|
|
2069 | using the latter saves a few hundred kB of memory until the first message |
|
|
2070 | is being logged. |
1972 | |
2071 | |
1973 | =item C<PERL_ANYEVENT_STRICT> |
2072 | =item C<PERL_ANYEVENT_STRICT> |
1974 | |
2073 | |
1975 | AnyEvent does not do much argument checking by default, as thorough |
2074 | AnyEvent does not do much argument checking by default, as thorough |
1976 | argument checking is very costly. Setting this variable to a true value |
2075 | argument checking is very costly. Setting this variable to a true value |
… | |
… | |
1990 | If this env variable is set, then its contents will be interpreted by |
2089 | If this env variable is set, then its contents will be interpreted by |
1991 | C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of |
2090 | C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of |
1992 | C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on |
2091 | C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on |
1993 | that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>. |
2092 | that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>. |
1994 | |
2093 | |
1995 | This takes place when the first watcher is created. |
2094 | This happens when the first watcher is created. |
1996 | |
2095 | |
1997 | For example, to bind a debug shell on a unix domain socket in |
2096 | For example, to bind a debug shell on a unix domain socket in |
1998 | F<< /tmp/debug<pid>.sock >>, you could use this: |
2097 | F<< /tmp/debug<pid>.sock >>, you could use this: |
1999 | |
2098 | |
2000 | PERL_ANYEVENT_DEBUG_SHELL=unix/:/tmp/debug\$\$.sock perlprog |
2099 | PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog |
2001 | |
2100 | |
2002 | Note that creating sockets in F</tmp> is very unsafe on multiuser |
2101 | Note that creating sockets in F</tmp> is very unsafe on multiuser |
2003 | systems. |
2102 | systems. |
2004 | |
2103 | |
2005 | =item C<PERL_ANYEVENT_DEBUG_WRAP> |
2104 | =item C<PERL_ANYEVENT_DEBUG_WRAP> |
… | |
… | |
2046 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
2145 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
2047 | - only support IPv4, never try to resolve or contact IPv6 |
2146 | - only support IPv4, never try to resolve or contact IPv6 |
2048 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
2147 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
2049 | IPv6, but prefer IPv6 over IPv4. |
2148 | IPv6, but prefer IPv6 over IPv4. |
2050 | |
2149 | |
|
|
2150 | =item C<PERL_ANYEVENT_HOSTS> |
|
|
2151 | |
|
|
2152 | This variable, if specified, overrides the F</etc/hosts> file used by |
|
|
2153 | L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read |
|
|
2154 | from that file instead. |
|
|
2155 | |
2051 | =item C<PERL_ANYEVENT_EDNS0> |
2156 | =item C<PERL_ANYEVENT_EDNS0> |
2052 | |
2157 | |
2053 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension |
2158 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for |
2054 | for DNS. This extension is generally useful to reduce DNS traffic, but |
2159 | DNS. This extension is generally useful to reduce DNS traffic, especially |
2055 | some (broken) firewalls drop such DNS packets, which is why it is off by |
2160 | when DNSSEC is involved, but some (broken) firewalls drop such DNS |
2056 | default. |
2161 | packets, which is why it is off by default. |
2057 | |
2162 | |
2058 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
2163 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
2059 | EDNS0 in its DNS requests. |
2164 | EDNS0 in its DNS requests. |
2060 | |
2165 | |
2061 | =item C<PERL_ANYEVENT_MAX_FORKS> |
2166 | =item C<PERL_ANYEVENT_MAX_FORKS> |
… | |
… | |
2069 | resolver - this is the maximum number of parallel DNS requests that are |
2174 | resolver - this is the maximum number of parallel DNS requests that are |
2070 | sent to the DNS server. |
2175 | sent to the DNS server. |
2071 | |
2176 | |
2072 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
2177 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
2073 | |
2178 | |
2074 | The file to use instead of F</etc/resolv.conf> (or OS-specific |
2179 | The absolute path to a F<resolv.conf>-style file to use instead of |
2075 | configuration) in the default resolver. When set to the empty string, no |
2180 | F</etc/resolv.conf> (or the OS-specific configuration) in the default |
2076 | default config will be used. |
2181 | resolver, or the empty string to select the default configuration. |
2077 | |
2182 | |
2078 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
2183 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
2079 | |
2184 | |
2080 | When neither C<ca_file> nor C<ca_path> was specified during |
2185 | When neither C<ca_file> nor C<ca_path> was specified during |
2081 | L<AnyEvent::TLS> context creation, and either of these environment |
2186 | L<AnyEvent::TLS> context creation, and either of these environment |
2082 | variables exist, they will be used to specify CA certificate locations |
2187 | variables are nonempty, they will be used to specify CA certificate |
2083 | instead of a system-dependent default. |
2188 | locations instead of a system-dependent default. |
2084 | |
2189 | |
2085 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
2190 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
2086 | |
2191 | |
2087 | When these are set to C<1>, then the respective modules are not |
2192 | When these are set to C<1>, then the respective modules are not |
2088 | loaded. Mostly good for testing AnyEvent itself. |
2193 | loaded. Mostly good for testing AnyEvent itself. |
… | |
… | |
2805 | |
2910 | |
2806 | Tutorial/Introduction: L<AnyEvent::Intro>. |
2911 | Tutorial/Introduction: L<AnyEvent::Intro>. |
2807 | |
2912 | |
2808 | FAQ: L<AnyEvent::FAQ>. |
2913 | FAQ: L<AnyEvent::FAQ>. |
2809 | |
2914 | |
2810 | Utility functions: L<AnyEvent::Util>. |
2915 | Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log> |
|
|
2916 | (simply logging). |
2811 | |
2917 | |
|
|
2918 | Development/Debugging: L<AnyEvent::Strict> (stricter checking), |
|
|
2919 | L<AnyEvent::Debug> (interactive shell, watcher tracing). |
|
|
2920 | |
2812 | Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>, |
2921 | Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, |
2813 | L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2922 | L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, |
|
|
2923 | L<Qt>, L<POE>, L<FLTK>. |
2814 | |
2924 | |
2815 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2925 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2816 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2926 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2817 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2927 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2818 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
2928 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>, |
|
|
2929 | L<AnyEvent::Impl::FLTK>. |
2819 | |
2930 | |
2820 | Non-blocking file handles, sockets, TCP clients and |
2931 | Non-blocking handles, pipes, stream sockets, TCP clients and |
2821 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2932 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2822 | |
2933 | |
2823 | Asynchronous DNS: L<AnyEvent::DNS>. |
2934 | Asynchronous DNS: L<AnyEvent::DNS>. |
2824 | |
2935 | |
2825 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
2936 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |