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.377 by root, Thu Aug 25 23:20:17 2011 UTC vs.
Revision 1.408 by root, Thu Dec 6 12:04:23 2012 UTC

… …
415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's 415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
416pure perl implementation). 416pure perl implementation).
417 417
418=head3 Safe/Unsafe Signals 418=head3 Safe/Unsafe Signals
419 419
420Perl signals can be either "safe" (synchronous to opcode handling) or 420Perl signals can be either "safe" (synchronous to opcode handling)
421"unsafe" (asynchronous) - the former might get delayed indefinitely, the 421or "unsafe" (asynchronous) - the former might delay signal delivery
422latter might corrupt your memory. 422indefinitely, the latter might corrupt your memory.
423 423
424AnyEvent signal handlers are, in addition, synchronous to the event loop, 424AnyEvent signal handlers are, in addition, synchronous to the event loop,
425i.e. they will not interrupt your running perl program but will only be 425i.e. they will not interrupt your running perl program but will only be
426called as part of the normal event handling (just like timer, I/O etc. 426called as part of the normal event handling (just like timer, I/O etc.
427callbacks, too). 427callbacks, too).
428 428
429=head3 Signal Races, Delays and Workarounds 429=head3 Signal Races, Delays and Workarounds
430 430
431Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 431Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support
432callbacks to signals in a generic way, which is a pity, as you cannot 432attaching callbacks to signals in a generic way, which is a pity,
433do race-free signal handling in perl, requiring C libraries for 433as you cannot do race-free signal handling in perl, requiring
434this. AnyEvent will try to do its best, which means in some cases, 434C libraries for this. AnyEvent will try to do its best, which
435signals will be delayed. The maximum time a signal might be delayed is 435means in some cases, signals will be delayed. The maximum time
436specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This 436a signal might be delayed is 10 seconds by default, but can
437variable can be changed only before the first signal watcher is created, 437be overriden via C<$ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY}> or
438and should be left alone otherwise. This variable determines how often 438C<$AnyEvent::MAX_SIGNAL_LATENCY> - see the L<ENVIRONMENT VARIABLES>
439AnyEvent polls for signals (in case a wake-up was missed). Higher values 439section for details.
440will cause fewer spurious wake-ups, which is better for power and CPU
441saving.
442 440
443All these problems can be avoided by installing the optional 441All these problems can be avoided by installing the optional
444L<Async::Interrupt> module, which works with most event loops. It will not 442L<Async::Interrupt> module, which works with most event loops. It will not
445work with inherently broken event loops such as L<Event> or L<Event::Lib> 443work with inherently broken event loops such as L<Event> or L<Event::Lib>
446(and not with L<POE> currently, as POE does its own workaround with 444(and not with L<POE> currently). For those, you just have to suffer the
447one-second latency). For those, you just have to suffer the delays. 445delays.
448 446
449=head2 CHILD PROCESS WATCHERS 447=head2 CHILD PROCESS WATCHERS
450 448
451 $w = AnyEvent->child (pid => <process id>, cb => <callback>); 449 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
452 450
… …
765 }; 763 };
766 } 764 }
767 765
768 $cv->end; 766 $cv->end;
769 767
768 ...
769
770 my $results = $cv->recv;
771
770This code fragment supposedly pings a number of hosts and calls 772This code fragment supposedly pings a number of hosts and calls
771C<send> after results for all then have have been gathered - in any 773C<send> after results for all then have have been gathered - in any
772order. To achieve this, the code issues a call to C<begin> when it starts 774order. To achieve this, the code issues a call to C<begin> when it starts
773each ping request and calls C<end> when it has received some result for 775each ping request and calls C<end> when it has received some result for
774it. Since C<begin> and C<end> only maintain a counter, the order in which 776it. Since C<begin> and C<end> only maintain a counter, the order in which
… …
878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 880 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
879 AnyEvent::Impl::POE based on POE, very slow, some limitations. 881 AnyEvent::Impl::POE based on POE, very slow, some limitations.
880 AnyEvent::Impl::Irssi used when running within irssi. 882 AnyEvent::Impl::Irssi used when running within irssi.
881 AnyEvent::Impl::IOAsync based on IO::Async. 883 AnyEvent::Impl::IOAsync based on IO::Async.
882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. 884 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
883 AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding). 885 AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
884 886
885=item Backends with special needs. 887=item Backends with special needs.
886 888
887Qt requires the Qt::Application to be instantiated first, but will 889Qt requires the Qt::Application to be instantiated first, but will
888otherwise be picked up automatically. As long as the main program 890otherwise be picked up automatically. As long as the main program
… …
1058If L<AnyEvent::Log> is not loaded then this function makes a simple test 1060If 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 1061to 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 1062load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
1061the L<AnyEvent::Log> documentation for details. 1063the L<AnyEvent::Log> documentation for details.
1062 1064
1063If the test fails it will simply return. 1065If the test fails it will simply return. Right now this happens when a
1066numerical loglevel is used and it is larger than the level specified via
1067C<$ENV{PERL_ANYEVENT_VERBOSE}>.
1064 1068
1065If you want to sprinkle loads of logging calls around your code, consider 1069If you want to sprinkle loads of logging calls around your code, consider
1066creating a logger callback with the C<AnyEvent::Log::logger> function, 1070creating a logger callback with the C<AnyEvent::Log::logger> function,
1067which can reduce typing, codesize and can reduce the logging overhead 1071which can reduce typing, codesize and can reduce the logging overhead
1068enourmously. 1072enourmously.
… …
1223 1227
1224package AnyEvent; 1228package AnyEvent;
1225 1229
1226# basically a tuned-down version of common::sense 1230# basically a tuned-down version of common::sense
1227sub common_sense { 1231sub common_sense {
1228 # from common:.sense 3.4 1232 # from common:.sense 3.5
1233 local $^W;
1229 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00"; 1234 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1230 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) 1235 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1231 $^H |= 0x00000600; 1236 $^H |= 0x00000600;
1232} 1237}
1233 1238
1234BEGIN { AnyEvent::common_sense } 1239BEGIN { AnyEvent::common_sense }
1235 1240
1236use Carp (); 1241use Carp ();
1237 1242
1238our $VERSION = '6.01'; 1243our $VERSION = '7.04';
1239our $MODEL; 1244our $MODEL;
1240
1241our @ISA; 1245our @ISA;
1242
1243our @REGISTRY; 1246our @REGISTRY;
1244
1245our $VERBOSE; 1247our $VERBOSE;
1248our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1249our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} || 10; # executes after the BEGIN block below (tainting!)
1246 1250
1247BEGIN { 1251BEGIN {
1248 require "AnyEvent/constants.pl"; 1252 require "AnyEvent/constants.pl";
1249 1253
1250 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1254 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
… …
1256 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV; 1260 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1257 1261
1258 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = () 1262 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1259 if ${^TAINT}; 1263 if ${^TAINT};
1260 1264
1261 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1265 # $ENV{PERL_ANYEVENT_xxx} now valid
1262}
1263 1266
1264our $MAX_SIGNAL_LATENCY = 10; 1267 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1265 1268
1266our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1267
1268{
1269 my $idx; 1269 my $idx;
1270 $PROTOCOL{$_} = ++$idx 1270 $PROTOCOL{$_} = ++$idx
1271 for reverse split /\s*,\s*/, 1271 for reverse split /\s*,\s*/,
1272 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1272 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1273} 1273}
… …
1306 () 1306 ()
1307} 1307}
1308 1308
1309sub log($$;@) { 1309sub log($$;@) {
1310 # only load the big bloated module when we actually are about to log something 1310 # only load the big bloated module when we actually are about to log something
1311 if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!) 1311 if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal
1312 require AnyEvent::Log; 1312 local ($!, $@);
1313 require AnyEvent::Log; # among other things, sets $VERBOSE to 9
1313 # AnyEvent::Log overwrites this function 1314 # AnyEvent::Log overwrites this function
1314 goto &log; 1315 goto &log;
1315 } 1316 }
1316 1317
1317 0 # not logged 1318 0 # not logged
1318} 1319}
1319 1320
1321sub _logger($;$) {
1322 my ($level, $renabled) = @_;
1323
1324 $$renabled = $level <= $VERBOSE;
1325
1326 my $logger = [(caller)[0], $level, $renabled];
1327
1328 $AnyEvent::Log::LOGGER{$logger+0} = $logger;
1329
1330# return unless defined wantarray;
1331#
1332# require AnyEvent::Util;
1333# my $guard = AnyEvent::Util::guard (sub {
1334# # "clean up"
1335# delete $LOGGER{$logger+0};
1336# });
1337#
1338# sub {
1339# return 0 unless $$renabled;
1340#
1341# $guard if 0; # keep guard alive, but don't cause runtime overhead
1342# require AnyEvent::Log unless $AnyEvent::Log::VERSION;
1343# package AnyEvent::Log;
1344# _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
1345# }
1346}
1347
1320if (length $ENV{PERL_ANYEVENT_LOG}) { 1348if (length $ENV{PERL_ANYEVENT_LOG}) {
1321 require AnyEvent::Log; # AnyEvent::Log does the thing for us 1349 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1322} 1350}
1323 1351
1324our @models = ( 1352our @models = (
1325 [EV:: => AnyEvent::Impl::EV:: , 1], 1353 [EV:: => AnyEvent::Impl::EV::],
1326 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], 1354 [AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1327 # everything below here will not (normally) be autoprobed 1355 # everything below here will not (normally) be autoprobed
1328 # as the pure perl backend should work everywhere 1356 # as the pure perl backend should work everywhere
1329 # and is usually faster 1357 # and is usually faster
1358 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
1330 [Event:: => AnyEvent::Impl::Event::, 1], 1359 [Event:: => AnyEvent::Impl::Event::], # slow, stable
1331 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1360 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1361 # everything below here should not be autoloaded
1332 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1362 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1333 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1334 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1363 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1335 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1364 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1336 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1365 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1337 [Wx:: => AnyEvent::Impl::POE::], 1366 [Wx:: => AnyEvent::Impl::POE::],
1338 [Prima:: => AnyEvent::Impl::POE::], 1367 [Prima:: => AnyEvent::Impl::POE::],
1339 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect 1368 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1340 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1369 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1341 [FLTK:: => AnyEvent::Impl::FLTK2::], 1370 [FLTK:: => AnyEvent::Impl::FLTK::],
1342); 1371);
1343 1372
1344our @isa_hook; 1373our @isa_hook;
1345 1374
1346sub _isa_set { 1375sub _isa_set {
… …
1366# due to bugs in perls method cache implementation. 1395# due to bugs in perls method cache implementation.
1367our @methods = qw(io timer time now now_update signal child idle condvar); 1396our @methods = qw(io timer time now now_update signal child idle condvar);
1368 1397
1369sub detect() { 1398sub detect() {
1370 return $MODEL if $MODEL; # some programs keep references to detect 1399 return $MODEL if $MODEL; # some programs keep references to detect
1400
1401 # IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
1402 # the author knows about the problems and what it does to AnyEvent as a whole
1403 # (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
1404 # anyway.
1405 AnyEvent::log fatal => "IO::Async::Loop::AnyEvent detected - that module is broken by\n"
1406 . "design, abuses internals and breaks AnyEvent - will not continue."
1407 if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
1371 1408
1372 local $!; # for good measure 1409 local $!; # for good measure
1373 local $SIG{__DIE__}; # we use eval 1410 local $SIG{__DIE__}; # we use eval
1374 1411
1375 # free some memory 1412 # free some memory
… …
1384 1421
1385 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { 1422 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1386 my $model = $1; 1423 my $model = $1;
1387 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; 1424 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1388 if (eval "require $model") { 1425 if (eval "require $model") {
1389 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."; 1426 AnyEvent::log 7 => "Loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1390 $MODEL = $model; 1427 $MODEL = $model;
1391 } else { 1428 } else {
1392 AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@"; 1429 AnyEvent::log 4 => "Unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1393 } 1430 }
1394 } 1431 }
1395 1432
1396 # check for already loaded models 1433 # check for already loaded models
1397 unless ($MODEL) { 1434 unless ($MODEL) {
1398 for (@REGISTRY, @models) { 1435 for (@REGISTRY, @models) {
1399 my ($package, $model) = @$_; 1436 my ($package, $model) = @$_;
1400 if (${"$package\::VERSION"} > 0) { 1437 if (${"$package\::VERSION"} > 0) {
1401 if (eval "require $model") { 1438 if (eval "require $model") {
1402 AnyEvent::log 7 => "autodetected model '$model', using it."; 1439 AnyEvent::log 7 => "Autodetected model '$model', using it.";
1440 $MODEL = $model;
1441 last;
1442 } else {
1443 AnyEvent::log 8 => "Detected event loop $package, but cannot load '$model', skipping: $@";
1444 }
1445 }
1446 }
1447
1448 unless ($MODEL) {
1449 # try to autoload a model
1450 for (@REGISTRY, @models) {
1451 my ($package, $model) = @$_;
1452 if (
1453 eval "require $package"
1454 and ${"$package\::VERSION"} > 0
1455 and eval "require $model"
1456 ) {
1457 AnyEvent::log 7 => "Autoloaded model '$model', using it.";
1403 $MODEL = $model; 1458 $MODEL = $model;
1404 last; 1459 last;
1405 } 1460 }
1406 } 1461 }
1407 }
1408
1409 unless ($MODEL) {
1410 # try to autoload a model
1411 for (@REGISTRY, @models) {
1412 my ($package, $model, $autoload) = @$_;
1413 if (
1414 $autoload
1415 and eval "require $package"
1416 and ${"$package\::VERSION"} > 0
1417 and eval "require $model"
1418 ) {
1419 AnyEvent::log 7 => "autoloaded model '$model', using it.";
1420 $MODEL = $model;
1421 last;
1422 }
1423 }
1424 1462
1425 $MODEL 1463 $MODEL
1426 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?"; 1464 or AnyEvent::log fatal => "Backend autodetection failed - did you properly install AnyEvent?";
1427 } 1465 }
1428 } 1466 }
1429 1467
1430 # free memory only needed for probing 1468 # free memory only needed for probing
1431 undef @models; 1469 undef @models;
… …
1578 # probe for availability of Time::HiRes 1616 # probe for availability of Time::HiRes
1579 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1617 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1580 *time = sub { Time::HiRes::time () }; 1618 *time = sub { Time::HiRes::time () };
1581 *AE::time = \& Time::HiRes::time ; 1619 *AE::time = \& Time::HiRes::time ;
1582 *now = \&time; 1620 *now = \&time;
1583 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."; 1621 AnyEvent::log 8 => "using Time::HiRes for sub-second timing accuracy.";
1584 # if (eval "use POSIX (); (POSIX::times())... 1622 # if (eval "use POSIX (); (POSIX::times())...
1585 } else { 1623 } else {
1586 *time = sub { CORE::time }; 1624 *time = sub { CORE::time };
1587 *AE::time = sub (){ CORE::time }; 1625 *AE::time = sub (){ CORE::time };
1588 *now = \&time; 1626 *now = \&time;
1589 AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!"; 1627 AnyEvent::log 3 => "Using built-in time(), no sub-second resolution!";
1590 } 1628 }
1591 }; 1629 };
1592 die if $@; 1630 die if $@;
1593 1631
1594 &time 1632 &time
… …
1688 1726
1689sub signal { 1727sub signal {
1690 eval q{ # poor man's autoloading {} 1728 eval q{ # poor man's autoloading {}
1691 # probe for availability of Async::Interrupt 1729 # probe for availability of Async::Interrupt
1692 if (_have_async_interrupt) { 1730 if (_have_async_interrupt) {
1693 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."; 1731 AnyEvent::log 8 => "Using Async::Interrupt for race-free signal handling.";
1694 1732
1695 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1733 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1696 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1734 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1697 1735
1698 } else { 1736 } else {
1699 AnyEvent::log 8 => "using emulated perl signal handling with latency timer."; 1737 AnyEvent::log 8 => "Using emulated perl signal handling with latency timer.";
1700 1738
1701 if (AnyEvent::WIN32) { 1739 if (AnyEvent::WIN32) {
1702 require AnyEvent::Util; 1740 require AnyEvent::Util;
1703 1741
1704 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1742 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
… …
2040 2078
2041=over 4 2079=over 4
2042 2080
2043=item C<PERL_ANYEVENT_VERBOSE> 2081=item C<PERL_ANYEVENT_VERBOSE>
2044 2082
2045By default, AnyEvent will be completely silent except in fatal 2083By default, AnyEvent will log messages with loglevel C<4> (C<error>) or
2046conditions. You can set this environment variable to make AnyEvent more 2084higher (see L<AnyEvent::Log>). You can set this environment variable to a
2085numerical loglevel to make AnyEvent more (or less) talkative.
2086
2047talkative. If you want to do more than just set the global logging level 2087If you want to do more than just set the global logging level
2048you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more 2088you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2049complex specifications. 2089complex specifications.
2050 2090
2091When set to C<0> (C<off>), then no messages whatsoever will be logged with
2092everything else at defaults.
2093
2051When set to C<5> or higher (warn), causes AnyEvent to warn about unexpected 2094When set to C<5> or higher (C<warn>), AnyEvent warns about unexpected
2052conditions, such as not being able to load the event model specified by 2095conditions, such as not being able to load the event model specified by
2053C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this 2096C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this
2054is the minimum recommended level. 2097is the minimum recommended level for use during development.
2055 2098
2056When set to C<7> or higher (info), cause AnyEvent to report which event model it 2099When set to C<7> or higher (info), AnyEvent reports which event model it
2057chooses. 2100chooses.
2058 2101
2059When set to C<8> or higher (debug), then AnyEvent will report extra information on 2102When set to C<8> or higher (debug), then AnyEvent will report extra
2060which optional modules it loads and how it implements certain features. 2103information on which optional modules it loads and how it implements
2104certain features.
2061 2105
2062=item C<PERL_ANYEVENT_LOG> 2106=item C<PERL_ANYEVENT_LOG>
2063 2107
2064Accepts rather complex logging specifications. For example, you could log 2108Accepts rather complex logging specifications. For example, you could log
2065all C<debug> messages of some module to stderr, warnings and above to 2109all C<debug> messages of some module to stderr, warnings and above to
… …
2072This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded, 2116This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2073so will take effect even before AnyEvent has initialised itself. 2117so will take effect even before AnyEvent has initialised itself.
2074 2118
2075Note that specifying this environment variable causes the L<AnyEvent::Log> 2119Note that specifying this environment variable causes the L<AnyEvent::Log>
2076module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only 2120module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2077using the latter saves a few hundred kB of memory until the first message 2121using the latter saves a few hundred kB of memory unless a module
2078is being logged. 2122explicitly needs the extra features of AnyEvent::Log.
2079 2123
2080=item C<PERL_ANYEVENT_STRICT> 2124=item C<PERL_ANYEVENT_STRICT>
2081 2125
2082AnyEvent does not do much argument checking by default, as thorough 2126AnyEvent does not do much argument checking by default, as thorough
2083argument checking is very costly. Setting this variable to a true value 2127argument checking is very costly. Setting this variable to a true value
… …
2092C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2136C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
2093can be very useful, however. 2137can be very useful, however.
2094 2138
2095=item C<PERL_ANYEVENT_DEBUG_SHELL> 2139=item C<PERL_ANYEVENT_DEBUG_SHELL>
2096 2140
2097If this env variable is set, then its contents will be interpreted by 2141If this env variable is nonempty, then its contents will be interpreted by
2098C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of 2142C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
2099C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on 2143replacing every occurance of C<$$> by the process pid). The shell object
2100that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>. 2144is saved in C<$AnyEvent::Debug::SHELL>.
2101 2145
2102This happens when the first watcher is created. 2146This happens when the first watcher is created.
2103 2147
2104For example, to bind a debug shell on a unix domain socket in 2148For example, to bind a debug shell on a unix domain socket in
2105F<< /tmp/debug<pid>.sock >>, you could use this: 2149F<< /tmp/debug<pid>.sock >>, you could use this:
2106 2150
2107 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog 2151 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2152 # connect with e.g.: socat readline /tmp/debug123.sock
2108 2153
2154Or to bind to tcp port 4545 on localhost:
2155
2156 PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
2157 # connect with e.g.: telnet localhost 4545
2158
2109Note that creating sockets in F</tmp> is very unsafe on multiuser 2159Note that creating sockets in F</tmp> or on localhost is very unsafe on
2110systems. 2160multiuser systems.
2111 2161
2112=item C<PERL_ANYEVENT_DEBUG_WRAP> 2162=item C<PERL_ANYEVENT_DEBUG_WRAP>
2113 2163
2114Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for 2164Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2115debugging purposes. See C<AnyEvent::Debug::wrap> for details. 2165debugging purposes. See C<AnyEvent::Debug::wrap> for details.
… …
2132For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you 2182For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
2133could start your program like this: 2183could start your program like this:
2134 2184
2135 PERL_ANYEVENT_MODEL=Perl perl ... 2185 PERL_ANYEVENT_MODEL=Perl perl ...
2136 2186
2187=item C<PERL_ANYEVENT_IO_MODEL>
2188
2189The current file I/O model - see L<AnyEvent::IO> for more info.
2190
2191At the moment, only C<Perl> (small, pure-perl, synchronous) and
2192C<IOAIO> (truly asynchronous) are supported. The default is C<IOAIO> if
2193L<AnyEvent::AIO> can be loaded, otherwise it is C<Perl>.
2194
2137=item C<PERL_ANYEVENT_PROTOCOLS> 2195=item C<PERL_ANYEVENT_PROTOCOLS>
2138 2196
2139Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences 2197Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
2140for IPv4 or IPv6. The default is unspecified (and might change, or be the result 2198for IPv4 or IPv6. The default is unspecified (and might change, or be the result
2141of auto probing). 2199of auto probing).
… …
2179=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS> 2237=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
2180 2238
2181The default value for the C<max_outstanding> parameter for the default DNS 2239The default value for the C<max_outstanding> parameter for the default DNS
2182resolver - this is the maximum number of parallel DNS requests that are 2240resolver - this is the maximum number of parallel DNS requests that are
2183sent to the DNS server. 2241sent to the DNS server.
2242
2243=item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY>
2244
2245Perl has inherently racy signal handling (you can basically choose between
2246losing signals and memory corruption) - pure perl event loops (including
2247C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore
2248have to poll regularly to avoid losing signals.
2249
2250Some event loops are racy, but don't poll regularly, and some event loops
2251are written in C but are still racy. For those event loops, AnyEvent
2252installs a timer that regularly wakes up the event loop.
2253
2254By default, the interval for this timer is C<10> seconds, but you can
2255override this delay with this environment variable (or by setting
2256the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal
2257watchers).
2258
2259Lower values increase CPU (and energy) usage, higher values can introduce
2260long delays when reaping children or waiting for signals.
2261
2262The L<AnyEvent::Async> module, if available, will be used to avoid this
2263polling (with most event loops).
2184 2264
2185=item C<PERL_ANYEVENT_RESOLV_CONF> 2265=item C<PERL_ANYEVENT_RESOLV_CONF>
2186 2266
2187The absolute path to a F<resolv.conf>-style file to use instead of 2267The absolute path to a F<resolv.conf>-style file to use instead of
2188F</etc/resolv.conf> (or the OS-specific configuration) in the default 2268F</etc/resolv.conf> (or the OS-specific configuration) in the default
… …
2937L<AnyEvent::Impl::FLTK>. 3017L<AnyEvent::Impl::FLTK>.
2938 3018
2939Non-blocking handles, pipes, stream sockets, TCP clients and 3019Non-blocking handles, pipes, stream sockets, TCP clients and
2940servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 3020servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2941 3021
3022Asynchronous File I/O: L<AnyEvent::IO>.
3023
2942Asynchronous DNS: L<AnyEvent::DNS>. 3024Asynchronous DNS: L<AnyEvent::DNS>.
2943 3025
2944Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 3026Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2945 3027
2946Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>, 3028Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
… …
2948 3030
2949 3031
2950=head1 AUTHOR 3032=head1 AUTHOR
2951 3033
2952 Marc Lehmann <schmorp@schmorp.de> 3034 Marc Lehmann <schmorp@schmorp.de>
2953 http://home.schmorp.de/ 3035 http://anyevent.schmorp.de
2954 3036
2955=cut 3037=cut
2956 3038
29571 30391
2958 3040

Diff Legend

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