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.367 by root, Wed Aug 17 02:14:17 2011 UTC vs.
Revision 1.381 by root, Thu Sep 1 22:09:25 2011 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - the DBI of event loop programming 3AnyEvent - the DBI of event loop programming
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt 5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt,
6and POE are various supported event loops/environments. 6FLTK 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
… …
878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
879 AnyEvent::Impl::POE based on POE, very slow, some limitations. 879 AnyEvent::Impl::POE based on POE, very slow, some limitations.
880 AnyEvent::Impl::Irssi used when running within irssi. 880 AnyEvent::Impl::Irssi used when running within irssi.
881 AnyEvent::Impl::IOAsync based on IO::Async. 881 AnyEvent::Impl::IOAsync based on IO::Async.
882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. 882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
883 AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding). 883 AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
884 884
885=item Backends with special needs. 885=item Backends with special needs.
886 886
887Qt requires the Qt::Application to be instantiated first, but will 887Qt requires the Qt::Application to be instantiated first, but will
888otherwise be picked up automatically. As long as the main program 888otherwise be picked up automatically. As long as the main program
… …
1053 1053
1054=item AnyEvent::log $level, $msg[, @args] 1054=item AnyEvent::log $level, $msg[, @args]
1055 1055
1056Log the given C<$msg> at the given C<$level>. 1056Log the given C<$msg> at the given C<$level>.
1057 1057
1058Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> - 1058If L<AnyEvent::Log> is not loaded then this function makes a simple test
1059to see whether the message will be logged. If the test succeeds it will
1060load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
1059consequently, look at the L<AnyEvent::Log> documentation for details. 1061the L<AnyEvent::Log> documentation for details.
1062
1063If the test fails it will simply return. Right now this happens when a
1064numerical loglevel is used and it is larger than the level specified via
1065C<$ENV{PERL_ANYEVENT_VERBOSE}>.
1060 1066
1061If you want to sprinkle loads of logging calls around your code, consider 1067If you want to sprinkle loads of logging calls around your code, consider
1062creating a logger callback with the C<AnyEvent::Log::logger< function. 1068creating a logger callback with the C<AnyEvent::Log::logger> function,
1069which can reduce typing, codesize and can reduce the logging overhead
1070enourmously.
1063 1071
1064=back 1072=back
1065 1073
1066=head1 WHAT TO DO IN A MODULE 1074=head1 WHAT TO DO IN A MODULE
1067 1075
… …
1124 1132
1125 1133
1126=head1 OTHER MODULES 1134=head1 OTHER MODULES
1127 1135
1128The following is a non-exhaustive list of additional modules that use 1136The following is a non-exhaustive list of additional modules that use
1129AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1137AnyEvent as a client and can therefore be mixed easily with other
1130modules and other event loops in the same program. Some of the modules 1138AnyEvent modules and other event loops in the same program. Some of the
1131come as part of AnyEvent, the others are available via CPAN. 1139modules come as part of AnyEvent, the others are available via CPAN (see
1140L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
1141a longer non-exhaustive list), and the list is heavily biased towards
1142modules of the AnyEvent author himself :)
1132 1143
1133=over 4 1144=over 4
1134 1145
1135=item L<AnyEvent::Util> 1146=item L<AnyEvent::Util>
1136 1147
… …
1156=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> 1167=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1157 1168
1158Implement event-based interfaces to the protocols of the same name (for 1169Implement event-based interfaces to the protocols of the same name (for
1159the curious, IGS is the International Go Server and FCP is the Freenet 1170the curious, IGS is the International Go Server and FCP is the Freenet
1160Client Protocol). 1171Client Protocol).
1161
1162=item L<AnyEvent::Handle::UDP>
1163
1164Here be danger!
1165
1166As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1167there are so many things wrong with AnyEvent::Handle::UDP, most notably
1168its use of a stream-based API with a protocol that isn't streamable, that
1169the only way to improve it is to delete it.
1170
1171It features data corruption (but typically only under load) and general
1172confusion. On top, the author is not only clueless about UDP but also
1173fact-resistant - some gems of his understanding: "connect doesn't work
1174with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1175packets", "I don't need to implement proper error checking as UDP doesn't
1176support error checking" and so on - he doesn't even understand what's
1177wrong with his module when it is explained to him.
1178
1179=item L<AnyEvent::DBI>
1180
1181Executes L<DBI> requests asynchronously in a proxy process for you,
1182notifying you in an event-based way when the operation is finished.
1183 1172
1184=item L<AnyEvent::AIO> 1173=item L<AnyEvent::AIO>
1185 1174
1186Truly asynchronous (as opposed to non-blocking) I/O, should be in the 1175Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1187toolbox of every event programmer. AnyEvent::AIO transparently fuses 1176toolbox of every event programmer. AnyEvent::AIO transparently fuses
1188L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based 1177L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1189file I/O, and much more. 1178file I/O, and much more.
1190 1179
1180=item L<AnyEvent::Filesys::Notify>
1181
1182AnyEvent is good for non-blocking stuff, but it can't detect file or
1183path changes (e.g. "watch this directory for new files", "watch this
1184file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
1185do just that in a portbale fashion, supporting inotify on GNU/Linux and
1186some weird, without doubt broken, stuff on OS X to monitor files. It can
1187fall back to blocking scans at regular intervals transparently on other
1188platforms, so it's about as portable as it gets.
1189
1190(I haven't used it myself, but I haven't heard anybody complaining about
1191it yet).
1192
1193=item L<AnyEvent::DBI>
1194
1195Executes L<DBI> requests asynchronously in a proxy process for you,
1196notifying you in an event-based way when the operation is finished.
1197
1191=item L<AnyEvent::HTTPD> 1198=item L<AnyEvent::HTTPD>
1192 1199
1193A simple embedded webserver. 1200A simple embedded webserver.
1194 1201
1195=item L<AnyEvent::FastPing> 1202=item L<AnyEvent::FastPing>
1196 1203
1197The fastest ping in the west. 1204The fastest ping in the west.
1198 1205
1199=item L<Coro> 1206=item L<Coro>
1200 1207
1201Has special support for AnyEvent via L<Coro::AnyEvent>. 1208Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
1209to simply invert the flow control - don't call us, we will call you:
1210
1211 async {
1212 Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
1213 print "5 seconds later!\n";
1214
1215 Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
1216 my $line = <STDIN>; # works for ttys
1217
1218 AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
1219 my ($body, $hdr) = Coro::rouse_wait;
1220 };
1202 1221
1203=back 1222=back
1204 1223
1205=cut 1224=cut
1206 1225
… …
1216 1235
1217BEGIN { AnyEvent::common_sense } 1236BEGIN { AnyEvent::common_sense }
1218 1237
1219use Carp (); 1238use Carp ();
1220 1239
1221our $VERSION = '6.01'; 1240our $VERSION = '6.02';
1222our $MODEL; 1241our $MODEL;
1223 1242
1224our @ISA; 1243our @ISA;
1225 1244
1226our @REGISTRY; 1245our @REGISTRY;
… …
1233 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1252 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1234 1253
1235 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1254 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1236 if ${^TAINT}; 1255 if ${^TAINT};
1237 1256
1238 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1257 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1258 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1259
1260 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1261 if ${^TAINT};
1262
1263 # $ENV{PERL_ANYEVENT_xxx} now valid
1264
1265 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 3;
1239} 1266}
1240 1267
1241our $MAX_SIGNAL_LATENCY = 10; 1268our $MAX_SIGNAL_LATENCY = 10;
1242 1269
1243our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1270our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
… …
1282 1309
1283 () 1310 ()
1284} 1311}
1285 1312
1286sub log($$;@) { 1313sub log($$;@) {
1314 # only load the big bloated module when we actually are about to log something
1315 if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!)
1287 require AnyEvent::Log; 1316 require AnyEvent::Log;
1288 # AnyEvent::Log overwrites this function 1317 # AnyEvent::Log overwrites this function
1289 goto &log; 1318 goto &log;
1319 }
1320
1321 0 # not logged
1322}
1323
1324if (length $ENV{PERL_ANYEVENT_LOG}) {
1325 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1290} 1326}
1291 1327
1292our @models = ( 1328our @models = (
1293 [EV:: => AnyEvent::Impl::EV:: , 1], 1329 [EV:: => AnyEvent::Impl::EV:: , 1],
1294 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], 1330 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
… …
1304 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1340 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1305 [Wx:: => AnyEvent::Impl::POE::], 1341 [Wx:: => AnyEvent::Impl::POE::],
1306 [Prima:: => AnyEvent::Impl::POE::], 1342 [Prima:: => AnyEvent::Impl::POE::],
1307 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect 1343 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1308 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1344 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1309 [FLTK:: => AnyEvent::Impl::FLTK2::], 1345 [FLTK:: => AnyEvent::Impl::FLTK::],
1310); 1346);
1311 1347
1312our @isa_hook; 1348our @isa_hook;
1313 1349
1314sub _isa_set { 1350sub _isa_set {
… …
1352 1388
1353 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { 1389 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1354 my $model = $1; 1390 my $model = $1;
1355 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; 1391 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1356 if (eval "require $model") { 1392 if (eval "require $model") {
1393 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1357 $MODEL = $model; 1394 $MODEL = $model;
1358 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."
1359 if $VERBOSE >= 7;
1360 } else { 1395 } else {
1361 AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@"; 1396 AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1362 } 1397 }
1363 } 1398 }
1364 1399
1365 # check for already loaded models 1400 # check for already loaded models
1366 unless ($MODEL) { 1401 unless ($MODEL) {
1367 for (@REGISTRY, @models) { 1402 for (@REGISTRY, @models) {
1368 my ($package, $model) = @$_; 1403 my ($package, $model) = @$_;
1369 if (${"$package\::VERSION"} > 0) { 1404 if (${"$package\::VERSION"} > 0) {
1370 if (eval "require $model") { 1405 if (eval "require $model") {
1406 AnyEvent::log 7 => "autodetected model '$model', using it.";
1371 $MODEL = $model; 1407 $MODEL = $model;
1372 AnyEvent::log 7 => "autodetected model '$model', using it."
1373 if $VERBOSE >= 7;
1374 last; 1408 last;
1375 } 1409 }
1376 } 1410 }
1377 } 1411 }
1378 1412
… …
1384 $autoload 1418 $autoload
1385 and eval "require $package" 1419 and eval "require $package"
1386 and ${"$package\::VERSION"} > 0 1420 and ${"$package\::VERSION"} > 0
1387 and eval "require $model" 1421 and eval "require $model"
1388 ) { 1422 ) {
1423 AnyEvent::log 7 => "autoloaded model '$model', using it.";
1389 $MODEL = $model; 1424 $MODEL = $model;
1390 AnyEvent::log 7 => "autoloaded model '$model', using it."
1391 if $VERBOSE >= 7;
1392 last; 1425 last;
1393 } 1426 }
1394 } 1427 }
1395 1428
1396 $MODEL 1429 $MODEL
… …
1546 1579
1547sub time { 1580sub time {
1548 eval q{ # poor man's autoloading {} 1581 eval q{ # poor man's autoloading {}
1549 # probe for availability of Time::HiRes 1582 # probe for availability of Time::HiRes
1550 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1583 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1551 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."
1552 if $AnyEvent::VERBOSE >= 8;
1553 *time = sub { Time::HiRes::time () }; 1584 *time = sub { Time::HiRes::time () };
1554 *AE::time = \& Time::HiRes::time ; 1585 *AE::time = \& Time::HiRes::time ;
1586 *now = \&time;
1587 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1555 # if (eval "use POSIX (); (POSIX::times())... 1588 # if (eval "use POSIX (); (POSIX::times())...
1556 } else { 1589 } else {
1557 AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
1558 *time = sub { CORE::time }; 1590 *time = sub { CORE::time };
1559 *AE::time = sub (){ CORE::time }; 1591 *AE::time = sub (){ CORE::time };
1592 *now = \&time;
1593 AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1560 } 1594 }
1561
1562 *now = \&time;
1563 }; 1595 };
1564 die if $@; 1596 die if $@;
1565 1597
1566 &time 1598 &time
1567} 1599}
… …
1660 1692
1661sub signal { 1693sub signal {
1662 eval q{ # poor man's autoloading {} 1694 eval q{ # poor man's autoloading {}
1663 # probe for availability of Async::Interrupt 1695 # probe for availability of Async::Interrupt
1664 if (_have_async_interrupt) { 1696 if (_have_async_interrupt) {
1665 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling." 1697 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1666 if $AnyEvent::VERBOSE >= 8;
1667 1698
1668 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1699 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1669 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1700 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1670 1701
1671 } else { 1702 } else {
1672 AnyEvent::log 8 => "using emulated perl signal handling with latency timer." 1703 AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1673 if $AnyEvent::VERBOSE >= 8;
1674 1704
1675 if (AnyEvent::WIN32) { 1705 if (AnyEvent::WIN32) {
1676 require AnyEvent::Util; 1706 require AnyEvent::Util;
1677 1707
1678 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1708 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
… …
1972$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 2002$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1973so on. 2003so on.
1974 2004
1975=head1 ENVIRONMENT VARIABLES 2005=head1 ENVIRONMENT VARIABLES
1976 2006
1977The following environment variables are used by this module or its 2007AnyEvent supports a number of environment variables that tune the
1978submodules. 2008runtime behaviour. They are usually evaluated when AnyEvent is
2009loaded, initialised, or a submodule that uses them is loaded. Many of
2010them also cause AnyEvent to load additional modules - for example,
2011C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
2012loaded.
1979 2013
1980Note that AnyEvent will remove I<all> environment variables starting with 2014All the environment variables documented here start with
1981C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 2015C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1982enabled. 2016namespace. Other modules are encouraged (but by no means required) to use
2017C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
2018namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
2019be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
2020variables starting with C<AE_>, see below).
2021
2022All variables can also be set via the C<AE_> prefix, that is, instead
2023of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
2024case there is a clash btween anyevent and another program that uses
2025C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
2026variable to the empty string, as those variables take precedence.
2027
2028When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
2029to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
2030exists. If taint mode is on, then AnyEvent will remove I<all> environment
2031variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
2032with C<undef> or the empty string, if the corresaponding C<AE_> variable
2033is set).
2034
2035The exact algorithm is currently:
2036
2037 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
2038 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
2039 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
2040
2041This ensures that child processes will not see the C<AE_> variables.
2042
2043The following environment variables are currently known to AnyEvent:
1983 2044
1984=over 4 2045=over 4
1985 2046
1986=item C<PERL_ANYEVENT_VERBOSE> 2047=item C<PERL_ANYEVENT_VERBOSE>
1987 2048
1988By default, AnyEvent will be completely silent except in fatal 2049By default, AnyEvent will only log messages with loglevel C<3>
1989conditions. You can set this environment variable to make AnyEvent more 2050(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
2051environment variable to a numerical loglevel to make AnyEvent more (or
1990talkative. 2052less) talkative.
1991 2053
2054If you want to do more than just set the global logging level
2055you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2056complex specifications.
2057
2058When set to C<0> (C<off>), then no messages whatsoever will be logged with
2059the default logging settings.
2060
1992When set to C<5> or higher, causes AnyEvent to warn about unexpected 2061When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1993conditions, such as not being able to load the event model specified by 2062unexpected conditions, such as not being able to load the event model
1994C<PERL_ANYEVENT_MODEL>. 2063specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
2064exception - this is the minimum recommended level.
1995 2065
1996When set to C<7> or higher, cause AnyEvent to report to STDERR which event 2066When set to C<7> or higher (info), cause AnyEvent to report which event model it
1997model it chooses. 2067chooses.
1998 2068
1999When set to C<8> or higher, then AnyEvent will report extra information on 2069When set to C<8> or higher (debug), then AnyEvent will report extra information on
2000which optional modules it loads and how it implements certain features. 2070which optional modules it loads and how it implements certain features.
2071
2072=item C<PERL_ANYEVENT_LOG>
2073
2074Accepts rather complex logging specifications. For example, you could log
2075all C<debug> messages of some module to stderr, warnings and above to
2076stderr, and errors and above to syslog, with:
2077
2078 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
2079
2080For the rather extensive details, see L<AnyEvent::Log>.
2081
2082This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2083so will take effect even before AnyEvent has initialised itself.
2084
2085Note that specifying this environment variable causes the L<AnyEvent::Log>
2086module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2087using the latter saves a few hundred kB of memory until the first message
2088is being logged.
2001 2089
2002=item C<PERL_ANYEVENT_STRICT> 2090=item C<PERL_ANYEVENT_STRICT>
2003 2091
2004AnyEvent does not do much argument checking by default, as thorough 2092AnyEvent does not do much argument checking by default, as thorough
2005argument checking is very costly. Setting this variable to a true value 2093argument checking is very costly. Setting this variable to a true value
… …
2019If this env variable is set, then its contents will be interpreted by 2107If this env variable is set, then its contents will be interpreted by
2020C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of 2108C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
2021C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on 2109C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
2022that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>. 2110that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
2023 2111
2024This takes place when the first watcher is created. 2112This happens when the first watcher is created.
2025 2113
2026For example, to bind a debug shell on a unix domain socket in 2114For example, to bind a debug shell on a unix domain socket in
2027F<< /tmp/debug<pid>.sock >>, you could use this: 2115F<< /tmp/debug<pid>.sock >>, you could use this:
2028 2116
2029 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog 2117 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
… …
2075but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 2163but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
2076- only support IPv4, never try to resolve or contact IPv6 2164- only support IPv4, never try to resolve or contact IPv6
2077addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2165addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
2078IPv6, but prefer IPv6 over IPv4. 2166IPv6, but prefer IPv6 over IPv4.
2079 2167
2168=item C<PERL_ANYEVENT_HOSTS>
2169
2170This variable, if specified, overrides the F</etc/hosts> file used by
2171L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2172from that file instead.
2173
2080=item C<PERL_ANYEVENT_EDNS0> 2174=item C<PERL_ANYEVENT_EDNS0>
2081 2175
2082Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension 2176Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
2083for DNS. This extension is generally useful to reduce DNS traffic, but 2177DNS. This extension is generally useful to reduce DNS traffic, especially
2084some (broken) firewalls drop such DNS packets, which is why it is off by 2178when DNSSEC is involved, but some (broken) firewalls drop such DNS
2085default. 2179packets, which is why it is off by default.
2086 2180
2087Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce 2181Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
2088EDNS0 in its DNS requests. 2182EDNS0 in its DNS requests.
2089 2183
2090=item C<PERL_ANYEVENT_MAX_FORKS> 2184=item C<PERL_ANYEVENT_MAX_FORKS>
… …
2098resolver - this is the maximum number of parallel DNS requests that are 2192resolver - this is the maximum number of parallel DNS requests that are
2099sent to the DNS server. 2193sent to the DNS server.
2100 2194
2101=item C<PERL_ANYEVENT_RESOLV_CONF> 2195=item C<PERL_ANYEVENT_RESOLV_CONF>
2102 2196
2103The file to use instead of F</etc/resolv.conf> (or OS-specific 2197The absolute path to a F<resolv.conf>-style file to use instead of
2104configuration) in the default resolver. When set to the empty string, no 2198F</etc/resolv.conf> (or the OS-specific configuration) in the default
2105default config will be used. 2199resolver, or the empty string to select the default configuration.
2106 2200
2107=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. 2201=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
2108 2202
2109When neither C<ca_file> nor C<ca_path> was specified during 2203When neither C<ca_file> nor C<ca_path> was specified during
2110L<AnyEvent::TLS> context creation, and either of these environment 2204L<AnyEvent::TLS> context creation, and either of these environment
2111variables exist, they will be used to specify CA certificate locations 2205variables are nonempty, they will be used to specify CA certificate
2112instead of a system-dependent default. 2206locations instead of a system-dependent default.
2113 2207
2114=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> 2208=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
2115 2209
2116When these are set to C<1>, then the respective modules are not 2210When these are set to C<1>, then the respective modules are not
2117loaded. Mostly good for testing AnyEvent itself. 2211loaded. Mostly good for testing AnyEvent itself.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines