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.395 by root, Tue Jan 31 19:03:16 2012 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
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 Ö<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
878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 876 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
879 AnyEvent::Impl::POE based on POE, very slow, some limitations. 877 AnyEvent::Impl::POE based on POE, very slow, some limitations.
880 AnyEvent::Impl::Irssi used when running within irssi. 878 AnyEvent::Impl::Irssi used when running within irssi.
881 AnyEvent::Impl::IOAsync based on IO::Async. 879 AnyEvent::Impl::IOAsync based on IO::Async.
882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. 880 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
883 AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding). 881 AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
884 882
885=item Backends with special needs. 883=item Backends with special needs.
886 884
887Qt requires the Qt::Application to be instantiated first, but will 885Qt requires the Qt::Application to be instantiated first, but will
888otherwise be picked up automatically. As long as the main program 886otherwise be picked up automatically. As long as the main program
1053 1051
1054=item AnyEvent::log $level, $msg[, @args] 1052=item AnyEvent::log $level, $msg[, @args]
1055 1053
1056Log the given C<$msg> at the given C<$level>. 1054Log the given C<$msg> at the given C<$level>.
1057 1055
1058Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> - 1056If L<AnyEvent::Log> is not loaded then this function makes a simple test
1057to see whether the message will be logged. If the test succeeds it will
1058load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
1059consequently, look at the L<AnyEvent::Log> documentation for details. 1059the L<AnyEvent::Log> documentation for details.
1060
1061If the test fails it will simply return. Right now this happens when a
1062numerical loglevel is used and it is larger than the level specified via
1063C<$ENV{PERL_ANYEVENT_VERBOSE}>.
1060 1064
1061If you want to sprinkle loads of logging calls around your code, consider 1065If you want to sprinkle loads of logging calls around your code, consider
1062creating a logger callback with the C<AnyEvent::Log::logger< function. 1066creating a logger callback with the C<AnyEvent::Log::logger> function,
1067which can reduce typing, codesize and can reduce the logging overhead
1068enourmously.
1063 1069
1064=back 1070=back
1065 1071
1066=head1 WHAT TO DO IN A MODULE 1072=head1 WHAT TO DO IN A MODULE
1067 1073
1124 1130
1125 1131
1126=head1 OTHER MODULES 1132=head1 OTHER MODULES
1127 1133
1128The following is a non-exhaustive list of additional modules that use 1134The following is a non-exhaustive list of additional modules that use
1129AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1135AnyEvent as a client and can therefore be mixed easily with other
1130modules and other event loops in the same program. Some of the modules 1136AnyEvent modules and other event loops in the same program. Some of the
1131come as part of AnyEvent, the others are available via CPAN. 1137modules come as part of AnyEvent, the others are available via CPAN (see
1138L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
1139a longer non-exhaustive list), and the list is heavily biased towards
1140modules of the AnyEvent author himself :)
1132 1141
1133=over 4 1142=over 4
1134 1143
1135=item L<AnyEvent::Util> 1144=item L<AnyEvent::Util>
1136 1145
1156=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> 1165=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1157 1166
1158Implement event-based interfaces to the protocols of the same name (for 1167Implement event-based interfaces to the protocols of the same name (for
1159the curious, IGS is the International Go Server and FCP is the Freenet 1168the curious, IGS is the International Go Server and FCP is the Freenet
1160Client Protocol). 1169Client 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 1170
1184=item L<AnyEvent::AIO> 1171=item L<AnyEvent::AIO>
1185 1172
1186Truly asynchronous (as opposed to non-blocking) I/O, should be in the 1173Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1187toolbox of every event programmer. AnyEvent::AIO transparently fuses 1174toolbox of every event programmer. AnyEvent::AIO transparently fuses
1188L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based 1175L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1189file I/O, and much more. 1176file I/O, and much more.
1190 1177
1178=item L<AnyEvent::Filesys::Notify>
1179
1180AnyEvent is good for non-blocking stuff, but it can't detect file or
1181path changes (e.g. "watch this directory for new files", "watch this
1182file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
1183do just that in a portbale fashion, supporting inotify on GNU/Linux and
1184some weird, without doubt broken, stuff on OS X to monitor files. It can
1185fall back to blocking scans at regular intervals transparently on other
1186platforms, so it's about as portable as it gets.
1187
1188(I haven't used it myself, but I haven't heard anybody complaining about
1189it yet).
1190
1191=item L<AnyEvent::DBI>
1192
1193Executes L<DBI> requests asynchronously in a proxy process for you,
1194notifying you in an event-based way when the operation is finished.
1195
1191=item L<AnyEvent::HTTPD> 1196=item L<AnyEvent::HTTPD>
1192 1197
1193A simple embedded webserver. 1198A simple embedded webserver.
1194 1199
1195=item L<AnyEvent::FastPing> 1200=item L<AnyEvent::FastPing>
1196 1201
1197The fastest ping in the west. 1202The fastest ping in the west.
1198 1203
1199=item L<Coro> 1204=item L<Coro>
1200 1205
1201Has special support for AnyEvent via L<Coro::AnyEvent>. 1206Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
1207to simply invert the flow control - don't call us, we will call you:
1208
1209 async {
1210 Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
1211 print "5 seconds later!\n";
1212
1213 Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
1214 my $line = <STDIN>; # works for ttys
1215
1216 AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
1217 my ($body, $hdr) = Coro::rouse_wait;
1218 };
1202 1219
1203=back 1220=back
1204 1221
1205=cut 1222=cut
1206 1223
1216 1233
1217BEGIN { AnyEvent::common_sense } 1234BEGIN { AnyEvent::common_sense }
1218 1235
1219use Carp (); 1236use Carp ();
1220 1237
1221our $VERSION = '6.01'; 1238our $VERSION = '6.14';
1222our $MODEL; 1239our $MODEL;
1223
1224our @ISA; 1240our @ISA;
1225
1226our @REGISTRY; 1241our @REGISTRY;
1227
1228our $VERBOSE; 1242our $VERBOSE;
1243our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1244our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} || 10; # executes after the BEGIN block below (tainting!)
1229 1245
1230BEGIN { 1246BEGIN {
1231 require "AnyEvent/constants.pl"; 1247 require "AnyEvent/constants.pl";
1232 1248
1233 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1249 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1234 1250
1235 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1251 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1236 if ${^TAINT}; 1252 if ${^TAINT};
1237 1253
1238 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1254 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1239} 1255 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1240 1256
1241our $MAX_SIGNAL_LATENCY = 10; 1257 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1258 if ${^TAINT};
1242 1259
1243our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1260 # $ENV{PERL_ANYEVENT_xxx} now valid
1244 1261
1245{ 1262 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1263
1246 my $idx; 1264 my $idx;
1247 $PROTOCOL{$_} = ++$idx 1265 $PROTOCOL{$_} = ++$idx
1248 for reverse split /\s*,\s*/, 1266 for reverse split /\s*,\s*/,
1249 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1267 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1250} 1268}
1282 1300
1283 () 1301 ()
1284} 1302}
1285 1303
1286sub log($$;@) { 1304sub log($$;@) {
1287 require AnyEvent::Log; 1305 # only load the big bloated module when we actually are about to log something
1306 if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal
1307 local ($!, $@);
1308 require AnyEvent::Log; # among other things, sets $VERBOSE to 9
1288 # AnyEvent::Log overwrites this function 1309 # AnyEvent::Log overwrites this function
1289 goto &log; 1310 goto &log;
1311 }
1312
1313 0 # not logged
1314}
1315
1316sub _logger($;$) {
1317 my ($level, $renabled) = @_;
1318
1319 $$renabled = $level <= $VERBOSE;
1320
1321 my $logger = [(caller)[0], $level, $renabled];
1322
1323 $AnyEvent::Log::LOGGER{$logger+0} = $logger;
1324
1325# return unless defined wantarray;
1326#
1327# require AnyEvent::Util;
1328# my $guard = AnyEvent::Util::guard (sub {
1329# # "clean up"
1330# delete $LOGGER{$logger+0};
1331# });
1332#
1333# sub {
1334# return 0 unless $$renabled;
1335#
1336# $guard if 0; # keep guard alive, but don't cause runtime overhead
1337# require AnyEvent::Log unless $AnyEvent::Log::VERSION;
1338# package AnyEvent::Log;
1339# _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
1340# }
1341}
1342
1343if (length $ENV{PERL_ANYEVENT_LOG}) {
1344 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1290} 1345}
1291 1346
1292our @models = ( 1347our @models = (
1293 [EV:: => AnyEvent::Impl::EV:: , 1], 1348 [EV:: => AnyEvent::Impl::EV::],
1294 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], 1349 [AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1295 # everything below here will not (normally) be autoprobed 1350 # everything below here will not (normally) be autoprobed
1296 # as the pure perl backend should work everywhere 1351 # as the pure perl backend should work everywhere
1297 # and is usually faster 1352 # and is usually faster
1353 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
1298 [Event:: => AnyEvent::Impl::Event::, 1], 1354 [Event:: => AnyEvent::Impl::Event::], # slow, stable
1299 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1355 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1356 # everything below here should not be autoloaded
1300 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1357 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1301 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1302 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1358 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1303 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1359 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1304 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1360 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1305 [Wx:: => AnyEvent::Impl::POE::], 1361 [Wx:: => AnyEvent::Impl::POE::],
1306 [Prima:: => AnyEvent::Impl::POE::], 1362 [Prima:: => AnyEvent::Impl::POE::],
1307 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect 1363 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1308 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1364 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1309 [FLTK:: => AnyEvent::Impl::FLTK2::], 1365 [FLTK:: => AnyEvent::Impl::FLTK::],
1310); 1366);
1311 1367
1312our @isa_hook; 1368our @isa_hook;
1313 1369
1314sub _isa_set { 1370sub _isa_set {
1334# due to bugs in perls method cache implementation. 1390# due to bugs in perls method cache implementation.
1335our @methods = qw(io timer time now now_update signal child idle condvar); 1391our @methods = qw(io timer time now now_update signal child idle condvar);
1336 1392
1337sub detect() { 1393sub detect() {
1338 return $MODEL if $MODEL; # some programs keep references to detect 1394 return $MODEL if $MODEL; # some programs keep references to detect
1395
1396 # IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
1397 # the author knows about the problems and what it does to AnyEvent as a whole
1398 # (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
1399 # anyway.
1400 AnyEvent::log fatal => "AnyEvent: IO::Async::Loop::AnyEvent detected - that module is broken by\n"
1401 . "design, abuses internals and breaks AnyEvent - will not continue."
1402 if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
1339 1403
1340 local $!; # for good measure 1404 local $!; # for good measure
1341 local $SIG{__DIE__}; # we use eval 1405 local $SIG{__DIE__}; # we use eval
1342 1406
1343 # free some memory 1407 # free some memory
1352 1416
1353 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { 1417 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1354 my $model = $1; 1418 my $model = $1;
1355 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; 1419 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1356 if (eval "require $model") { 1420 if (eval "require $model") {
1421 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1357 $MODEL = $model; 1422 $MODEL = $model;
1358 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."
1359 if $VERBOSE >= 7;
1360 } else { 1423 } else {
1361 AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@"; 1424 AnyEvent::log 4 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1362 } 1425 }
1363 } 1426 }
1364 1427
1365 # check for already loaded models 1428 # check for already loaded models
1366 unless ($MODEL) { 1429 unless ($MODEL) {
1367 for (@REGISTRY, @models) { 1430 for (@REGISTRY, @models) {
1368 my ($package, $model) = @$_; 1431 my ($package, $model) = @$_;
1369 if (${"$package\::VERSION"} > 0) { 1432 if (${"$package\::VERSION"} > 0) {
1370 if (eval "require $model") { 1433 if (eval "require $model") {
1434 AnyEvent::log 7 => "autodetected model '$model', using it.";
1371 $MODEL = $model; 1435 $MODEL = $model;
1436 last;
1437 } else {
1438 AnyEvent::log 8 => "detected event loop $package, but cannot load '$model', skipping: $@";
1439 }
1440 }
1441 }
1442
1443 unless ($MODEL) {
1444 # try to autoload a model
1445 for (@REGISTRY, @models) {
1446 my ($package, $model) = @$_;
1447 if (
1448 eval "require $package"
1449 and ${"$package\::VERSION"} > 0
1450 and eval "require $model"
1451 ) {
1372 AnyEvent::log 7 => "autodetected model '$model', using it." 1452 AnyEvent::log 7 => "autoloaded model '$model', using it.";
1373 if $VERBOSE >= 7; 1453 $MODEL = $model;
1374 last; 1454 last;
1375 } 1455 }
1376 } 1456 }
1377 }
1378
1379 unless ($MODEL) {
1380 # try to autoload a model
1381 for (@REGISTRY, @models) {
1382 my ($package, $model, $autoload) = @$_;
1383 if (
1384 $autoload
1385 and eval "require $package"
1386 and ${"$package\::VERSION"} > 0
1387 and eval "require $model"
1388 ) {
1389 $MODEL = $model;
1390 AnyEvent::log 7 => "autoloaded model '$model', using it."
1391 if $VERBOSE >= 7;
1392 last;
1393 }
1394 }
1395 1457
1396 $MODEL 1458 $MODEL
1397 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?"; 1459 or AnyEvent::log fatal => "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1398 } 1460 }
1399 } 1461 }
1400 1462
1401 # free memory only needed for probing 1463 # free memory only needed for probing
1402 undef @models; 1464 undef @models;
1546 1608
1547sub time { 1609sub time {
1548 eval q{ # poor man's autoloading {} 1610 eval q{ # poor man's autoloading {}
1549 # probe for availability of Time::HiRes 1611 # probe for availability of Time::HiRes
1550 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1612 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 () }; 1613 *time = sub { Time::HiRes::time () };
1554 *AE::time = \& Time::HiRes::time ; 1614 *AE::time = \& Time::HiRes::time ;
1615 *now = \&time;
1616 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1555 # if (eval "use POSIX (); (POSIX::times())... 1617 # if (eval "use POSIX (); (POSIX::times())...
1556 } else { 1618 } else {
1557 AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
1558 *time = sub { CORE::time }; 1619 *time = sub { CORE::time };
1559 *AE::time = sub (){ CORE::time }; 1620 *AE::time = sub (){ CORE::time };
1621 *now = \&time;
1622 AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1560 } 1623 }
1561
1562 *now = \&time;
1563 }; 1624 };
1564 die if $@; 1625 die if $@;
1565 1626
1566 &time 1627 &time
1567} 1628}
1660 1721
1661sub signal { 1722sub signal {
1662 eval q{ # poor man's autoloading {} 1723 eval q{ # poor man's autoloading {}
1663 # probe for availability of Async::Interrupt 1724 # probe for availability of Async::Interrupt
1664 if (_have_async_interrupt) { 1725 if (_have_async_interrupt) {
1665 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling." 1726 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1666 if $AnyEvent::VERBOSE >= 8;
1667 1727
1668 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1728 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1669 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1729 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1670 1730
1671 } else { 1731 } else {
1672 AnyEvent::log 8 => "using emulated perl signal handling with latency timer." 1732 AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1673 if $AnyEvent::VERBOSE >= 8;
1674 1733
1675 if (AnyEvent::WIN32) { 1734 if (AnyEvent::WIN32) {
1676 require AnyEvent::Util; 1735 require AnyEvent::Util;
1677 1736
1678 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1737 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1972$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 2031$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1973so on. 2032so on.
1974 2033
1975=head1 ENVIRONMENT VARIABLES 2034=head1 ENVIRONMENT VARIABLES
1976 2035
1977The following environment variables are used by this module or its 2036AnyEvent supports a number of environment variables that tune the
1978submodules. 2037runtime behaviour. They are usually evaluated when AnyEvent is
2038loaded, initialised, or a submodule that uses them is loaded. Many of
2039them also cause AnyEvent to load additional modules - for example,
2040C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
2041loaded.
1979 2042
1980Note that AnyEvent will remove I<all> environment variables starting with 2043All the environment variables documented here start with
1981C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 2044C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1982enabled. 2045namespace. Other modules are encouraged (but by no means required) to use
2046C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
2047namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
2048be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
2049variables starting with C<AE_>, see below).
2050
2051All variables can also be set via the C<AE_> prefix, that is, instead
2052of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
2053case there is a clash btween anyevent and another program that uses
2054C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
2055variable to the empty string, as those variables take precedence.
2056
2057When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
2058to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
2059exists. If taint mode is on, then AnyEvent will remove I<all> environment
2060variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
2061with C<undef> or the empty string, if the corresaponding C<AE_> variable
2062is set).
2063
2064The exact algorithm is currently:
2065
2066 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
2067 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
2068 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
2069
2070This ensures that child processes will not see the C<AE_> variables.
2071
2072The following environment variables are currently known to AnyEvent:
1983 2073
1984=over 4 2074=over 4
1985 2075
1986=item C<PERL_ANYEVENT_VERBOSE> 2076=item C<PERL_ANYEVENT_VERBOSE>
1987 2077
1988By default, AnyEvent will be completely silent except in fatal 2078By default, AnyEvent will only log messages with loglevel C<3>
1989conditions. You can set this environment variable to make AnyEvent more 2079(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
2080environment variable to a numerical loglevel to make AnyEvent more (or
1990talkative. 2081less) talkative.
1991 2082
2083If you want to do more than just set the global logging level
2084you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2085complex specifications.
2086
2087When set to C<0> (C<off>), then no messages whatsoever will be logged with
2088the default logging settings.
2089
1992When set to C<5> or higher, causes AnyEvent to warn about unexpected 2090When 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 2091unexpected conditions, such as not being able to load the event model
1994C<PERL_ANYEVENT_MODEL>. 2092specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
2093exception - this is the minimum recommended level.
1995 2094
1996When set to C<7> or higher, cause AnyEvent to report to STDERR which event 2095When set to C<7> or higher (info), cause AnyEvent to report which event model it
1997model it chooses. 2096chooses.
1998 2097
1999When set to C<8> or higher, then AnyEvent will report extra information on 2098When 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. 2099which optional modules it loads and how it implements certain features.
2100
2101=item C<PERL_ANYEVENT_LOG>
2102
2103Accepts rather complex logging specifications. For example, you could log
2104all C<debug> messages of some module to stderr, warnings and above to
2105stderr, and errors and above to syslog, with:
2106
2107 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
2108
2109For the rather extensive details, see L<AnyEvent::Log>.
2110
2111This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2112so will take effect even before AnyEvent has initialised itself.
2113
2114Note that specifying this environment variable causes the L<AnyEvent::Log>
2115module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2116using the latter saves a few hundred kB of memory until the first message
2117is being logged.
2001 2118
2002=item C<PERL_ANYEVENT_STRICT> 2119=item C<PERL_ANYEVENT_STRICT>
2003 2120
2004AnyEvent does not do much argument checking by default, as thorough 2121AnyEvent does not do much argument checking by default, as thorough
2005argument checking is very costly. Setting this variable to a true value 2122argument checking is very costly. Setting this variable to a true value
2014C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2131C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
2015can be very useful, however. 2132can be very useful, however.
2016 2133
2017=item C<PERL_ANYEVENT_DEBUG_SHELL> 2134=item C<PERL_ANYEVENT_DEBUG_SHELL>
2018 2135
2019If this env variable is set, then its contents will be interpreted by 2136If this env variable is nonempty, then its contents will be interpreted by
2020C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of 2137C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
2021C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on 2138replacing every occurance of C<$$> by the process pid). The shell object
2022that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>. 2139is saved in C<$AnyEvent::Debug::SHELL>.
2023 2140
2024This takes place when the first watcher is created. 2141This happens when the first watcher is created.
2025 2142
2026For example, to bind a debug shell on a unix domain socket in 2143For example, to bind a debug shell on a unix domain socket in
2027F<< /tmp/debug<pid>.sock >>, you could use this: 2144F<< /tmp/debug<pid>.sock >>, you could use this:
2028 2145
2029 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog 2146 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2147 # connect with e.g.: socat readline /tmp/debug123.sock
2030 2148
2149Or to bind to tcp port 4545 on localhost:
2150
2151 PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
2152 # connect with e.g.: telnet localhost 4545
2153
2031Note that creating sockets in F</tmp> is very unsafe on multiuser 2154Note that creating sockets in F</tmp> or on localhost is very unsafe on
2032systems. 2155multiuser systems.
2033 2156
2034=item C<PERL_ANYEVENT_DEBUG_WRAP> 2157=item C<PERL_ANYEVENT_DEBUG_WRAP>
2035 2158
2036Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for 2159Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2037debugging purposes. See C<AnyEvent::Debug::wrap> for details. 2160debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2075but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 2198but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
2076- only support IPv4, never try to resolve or contact IPv6 2199- only support IPv4, never try to resolve or contact IPv6
2077addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2200addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
2078IPv6, but prefer IPv6 over IPv4. 2201IPv6, but prefer IPv6 over IPv4.
2079 2202
2203=item C<PERL_ANYEVENT_HOSTS>
2204
2205This variable, if specified, overrides the F</etc/hosts> file used by
2206L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2207from that file instead.
2208
2080=item C<PERL_ANYEVENT_EDNS0> 2209=item C<PERL_ANYEVENT_EDNS0>
2081 2210
2082Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension 2211Used 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 2212DNS. This extension is generally useful to reduce DNS traffic, especially
2084some (broken) firewalls drop such DNS packets, which is why it is off by 2213when DNSSEC is involved, but some (broken) firewalls drop such DNS
2085default. 2214packets, which is why it is off by default.
2086 2215
2087Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce 2216Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
2088EDNS0 in its DNS requests. 2217EDNS0 in its DNS requests.
2089 2218
2090=item C<PERL_ANYEVENT_MAX_FORKS> 2219=item C<PERL_ANYEVENT_MAX_FORKS>
2096 2225
2097The default value for the C<max_outstanding> parameter for the default DNS 2226The default value for the C<max_outstanding> parameter for the default DNS
2098resolver - this is the maximum number of parallel DNS requests that are 2227resolver - this is the maximum number of parallel DNS requests that are
2099sent to the DNS server. 2228sent to the DNS server.
2100 2229
2230=item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY>
2231
2232Perl has inherently racy signal handling (you can basically choose between
2233losing signals and memory corruption) - pure perl event loops (including
2234C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore
2235have to poll regularly to avoid losing signals.
2236
2237Some event loops are racy, but don't poll regularly, and some event loops
2238are written in C but are still racy. For those event loops, AnyEvent
2239installs a timer that regularly wakes up the event loop.
2240
2241By default, the interval for this timer is C<10> seconds, but you can
2242override this delay with this environment variable (or by setting
2243the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal
2244watchers).
2245
2246Lower values increase CPU (and energy) usage, higher values can introduce
2247long delays when reaping children or waiting for signals.
2248
2249The L<AnyEvent::Async> module, if available, will be used to avoid this
2250polling (with most event loops).
2251
2101=item C<PERL_ANYEVENT_RESOLV_CONF> 2252=item C<PERL_ANYEVENT_RESOLV_CONF>
2102 2253
2103The file to use instead of F</etc/resolv.conf> (or OS-specific 2254The 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 2255F</etc/resolv.conf> (or the OS-specific configuration) in the default
2105default config will be used. 2256resolver, or the empty string to select the default configuration.
2106 2257
2107=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. 2258=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
2108 2259
2109When neither C<ca_file> nor C<ca_path> was specified during 2260When neither C<ca_file> nor C<ca_path> was specified during
2110L<AnyEvent::TLS> context creation, and either of these environment 2261L<AnyEvent::TLS> context creation, and either of these environment
2111variables exist, they will be used to specify CA certificate locations 2262variables are nonempty, they will be used to specify CA certificate
2112instead of a system-dependent default. 2263locations instead of a system-dependent default.
2113 2264
2114=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> 2265=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
2115 2266
2116When these are set to C<1>, then the respective modules are not 2267When these are set to C<1>, then the respective modules are not
2117loaded. Mostly good for testing AnyEvent itself. 2268loaded. Mostly good for testing AnyEvent itself.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines