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.354 by root, Thu Aug 11 21:26:39 2011 UTC vs.
Revision 1.388 by root, Sun Oct 2 01:22:01 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
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::FLTK based on FLTK. 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
933 931
934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 932Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
935if necessary. You should only call this function right before you would 933if necessary. You should only call this function right before you would
936have created an AnyEvent watcher anyway, that is, as late as possible at 934have created an AnyEvent watcher anyway, that is, as late as possible at
937runtime, and not e.g. during initialisation of your module. 935runtime, and not e.g. during initialisation of your module.
936
937The effect of calling this function is as if a watcher had been created
938(specifically, actions that happen "when the first watcher is created"
939happen when calling detetc as well).
938 940
939If you need to do some initialisation before AnyEvent watchers are 941If you need to do some initialisation before AnyEvent watchers are
940created, use C<post_detect>. 942created, use C<post_detect>.
941 943
942=item $guard = AnyEvent::post_detect { BLOCK } 944=item $guard = AnyEvent::post_detect { BLOCK }
1045It should use C<postpone>: 1047It should use C<postpone>:
1046 1048
1047 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later 1049 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1048 if $some_error_condition; 1050 if $some_error_condition;
1049 1051
1052=item AnyEvent::log $level, $msg[, @args]
1053
1054Log the given C<$msg> at the given C<$level>.
1055
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
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}>.
1064
1065If you want to sprinkle loads of logging calls around your code, consider
1066creating a logger callback with the C<AnyEvent::Log::logger> function,
1067which can reduce typing, codesize and can reduce the logging overhead
1068enourmously.
1069
1050=back 1070=back
1051 1071
1052=head1 WHAT TO DO IN A MODULE 1072=head1 WHAT TO DO IN A MODULE
1053 1073
1054As a module author, you should C<use AnyEvent> and call AnyEvent methods 1074As a module author, you should C<use AnyEvent> and call AnyEvent methods
1110 1130
1111 1131
1112=head1 OTHER MODULES 1132=head1 OTHER MODULES
1113 1133
1114The following is a non-exhaustive list of additional modules that use 1134The following is a non-exhaustive list of additional modules that use
1115AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1135AnyEvent as a client and can therefore be mixed easily with other
1116modules 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
1117come 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 :)
1118 1141
1119=over 4 1142=over 4
1120 1143
1121=item L<AnyEvent::Util> 1144=item L<AnyEvent::Util>
1122 1145
1142=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>
1143 1166
1144Implement event-based interfaces to the protocols of the same name (for 1167Implement event-based interfaces to the protocols of the same name (for
1145the 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
1146Client Protocol). 1169Client Protocol).
1147
1148=item L<AnyEvent::Handle::UDP>
1149
1150Here be danger!
1151
1152As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1153there are so many things wrong with AnyEvent::Handle::UDP, most notably
1154its use of a stream-based API with a protocol that isn't streamable, that
1155the only way to improve it is to delete it.
1156
1157It features data corruption (but typically only under load) and general
1158confusion. On top, the author is not only clueless about UDP but also
1159fact-resistant - some gems of his understanding: "connect doesn't work
1160with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1161packets", "I don't need to implement proper error checking as UDP doesn't
1162support error checking" and so on - he doesn't even understand what's
1163wrong with his module when it is explained to him.
1164
1165=item L<AnyEvent::DBI>
1166
1167Executes L<DBI> requests asynchronously in a proxy process for you,
1168notifying you in an event-based way when the operation is finished.
1169 1170
1170=item L<AnyEvent::AIO> 1171=item L<AnyEvent::AIO>
1171 1172
1172Truly 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
1173toolbox of every event programmer. AnyEvent::AIO transparently fuses 1174toolbox of every event programmer. AnyEvent::AIO transparently fuses
1174L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based 1175L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1175file I/O, and much more. 1176file I/O, and much more.
1176 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
1177=item L<AnyEvent::HTTPD> 1196=item L<AnyEvent::HTTPD>
1178 1197
1179A simple embedded webserver. 1198A simple embedded webserver.
1180 1199
1181=item L<AnyEvent::FastPing> 1200=item L<AnyEvent::FastPing>
1182 1201
1183The fastest ping in the west. 1202The fastest ping in the west.
1184 1203
1185=item L<Coro> 1204=item L<Coro>
1186 1205
1187Has 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 };
1188 1219
1189=back 1220=back
1190 1221
1191=cut 1222=cut
1192 1223
1202 1233
1203BEGIN { AnyEvent::common_sense } 1234BEGIN { AnyEvent::common_sense }
1204 1235
1205use Carp (); 1236use Carp ();
1206 1237
1207our $VERSION = '5.34'; 1238our $VERSION = '6.02';
1208our $MODEL; 1239our $MODEL;
1209
1210our $AUTOLOAD;
1211our @ISA; 1240our @ISA;
1212
1213our @REGISTRY; 1241our @REGISTRY;
1214
1215our $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!)
1216 1245
1217BEGIN { 1246BEGIN {
1218 require "AnyEvent/constants.pl"; 1247 require "AnyEvent/constants.pl";
1219 1248
1220 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1249 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1221 1250
1222 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1251 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1223 if ${^TAINT}; 1252 if ${^TAINT};
1224 1253
1225 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1254 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1255 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1226 1256
1227} 1257 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1258 if ${^TAINT};
1228 1259
1229our $MAX_SIGNAL_LATENCY = 10; 1260 # $ENV{PERL_ANYEVENT_xxx} now valid
1230 1261
1231our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1262 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1232 1263
1233{
1234 my $idx; 1264 my $idx;
1235 $PROTOCOL{$_} = ++$idx 1265 $PROTOCOL{$_} = ++$idx
1236 for reverse split /\s*,\s*/, 1266 for reverse split /\s*,\s*/,
1237 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1267 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1238} 1268}
1239 1269
1270our @post_detect;
1271
1272sub post_detect(&) {
1273 my ($cb) = @_;
1274
1275 push @post_detect, $cb;
1276
1277 defined wantarray
1278 ? bless \$cb, "AnyEvent::Util::postdetect"
1279 : ()
1280}
1281
1282sub AnyEvent::Util::postdetect::DESTROY {
1283 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1284}
1285
1286our $POSTPONE_W;
1287our @POSTPONE;
1288
1289sub _postpone_exec {
1290 undef $POSTPONE_W;
1291
1292 &{ shift @POSTPONE }
1293 while @POSTPONE;
1294}
1295
1296sub postpone(&) {
1297 push @POSTPONE, shift;
1298
1299 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1300
1301 ()
1302}
1303
1304sub 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
1309 # AnyEvent::Log overwrites this function
1310 goto &log;
1311 }
1312
1313 0 # not logged
1314}
1315
1316sub logger($;$) {
1317 package AnyEvent::Log;
1318
1319 my ($level, $renabled) = @_;
1320
1321 $$renabled = $level <= $VERBOSE;
1322
1323 my $pkg = (caller)[0];
1324
1325 my $logger = [$pkg, $level, $renabled];
1326
1327 our %LOGGER;
1328 $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
1348if (length $ENV{PERL_ANYEVENT_LOG}) {
1349 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1350}
1351
1240my @models = ( 1352our @models = (
1241 [EV:: => AnyEvent::Impl::EV:: , 1], 1353 [EV:: => AnyEvent::Impl::EV::],
1242 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], 1354 [AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1243 # everything below here will not (normally) be autoprobed 1355 # everything below here will not (normally) be autoprobed
1244 # as the pure perl backend should work everywhere 1356 # as the pure perl backend should work everywhere
1245 # 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
1246 [Event:: => AnyEvent::Impl::Event::, 1], 1359 [Event:: => AnyEvent::Impl::Event::], # slow, stable
1247 [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
1248 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1362 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1249 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1250 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1363 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1251 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1364 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1252 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1365 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1253 [Wx:: => AnyEvent::Impl::POE::], 1366 [Wx:: => AnyEvent::Impl::POE::],
1254 [Prima:: => AnyEvent::Impl::POE::], 1367 [Prima:: => AnyEvent::Impl::POE::],
1255 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], 1368 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1256 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1369 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1257 [FLTK:: => AnyEvent::Impl::FLTK::], 1370 [FLTK:: => AnyEvent::Impl::FLTK::],
1258); 1371);
1259 1372
1260our %method = map +($_ => 1), 1373our @isa_hook;
1374
1375sub _isa_set {
1376 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1377
1378 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1379 for 1 .. $#pkg;
1380
1381 grep $_ && $_->[1], @isa_hook
1382 and AE::_reset ();
1383}
1384
1385# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1386sub _isa_hook($$;$) {
1387 my ($i, $pkg, $reset_ae) = @_;
1388
1389 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1390
1391 _isa_set;
1392}
1393
1394# all autoloaded methods reserve the complete glob, not just the method slot.
1395# due to bugs in perls method cache implementation.
1261 qw(io timer time now now_update signal child idle condvar DESTROY); 1396our @methods = qw(io timer time now now_update signal child idle condvar);
1262
1263our @post_detect;
1264
1265sub post_detect(&) {
1266 my ($cb) = @_;
1267
1268 push @post_detect, $cb;
1269
1270 defined wantarray
1271 ? bless \$cb, "AnyEvent::Util::postdetect"
1272 : ()
1273}
1274
1275sub AnyEvent::Util::postdetect::DESTROY {
1276 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1277}
1278 1397
1279sub detect() { 1398sub 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 => "AnyEvent: IO::Async::Loop::AnyEvent detected - this module is broken by design,\n"
1406 . "abuses internals and breaks AnyEvent, will not continue."
1407 if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
1408
1409 local $!; # for good measure
1410 local $SIG{__DIE__}; # we use eval
1411
1280 # free some memory 1412 # free some memory
1281 *detect = sub () { $MODEL }; 1413 *detect = sub () { $MODEL };
1414 # undef &func doesn't correctly update the method cache. grmbl.
1415 # so we delete the whole glob. grmbl.
1416 # otoh, perl doesn't let me undef an active usb, but it lets me free
1417 # a glob with an active sub. hrm. i hope it works, but perl is
1418 # usually buggy in this department. sigh.
1419 delete @{"AnyEvent::"}{@methods};
1420 undef @methods;
1282 1421
1283 local $!; # for good measure
1284 local $SIG{__DIE__};
1285
1286 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1422 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1287 my $model = "AnyEvent::Impl::$1"; 1423 my $model = $1;
1424 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1288 if (eval "require $model") { 1425 if (eval "require $model") {
1426 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1289 $MODEL = $model; 1427 $MODEL = $model;
1290 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1291 } else { 1428 } else {
1292 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1429 AnyEvent::log 4 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1293 } 1430 }
1294 } 1431 }
1295 1432
1296 # check for already loaded models 1433 # check for already loaded models
1297 unless ($MODEL) { 1434 unless ($MODEL) {
1298 for (@REGISTRY, @models) { 1435 for (@REGISTRY, @models) {
1299 my ($package, $model) = @$_; 1436 my ($package, $model) = @$_;
1300 if (${"$package\::VERSION"} > 0) { 1437 if (${"$package\::VERSION"} > 0) {
1301 if (eval "require $model") { 1438 if (eval "require $model") {
1439 AnyEvent::log 7 => "autodetected model '$model', using it.";
1302 $MODEL = $model; 1440 $MODEL = $model;
1303 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1304 last; 1441 last;
1305 } 1442 }
1306 } 1443 }
1307 } 1444 }
1308 1445
1309 unless ($MODEL) { 1446 unless ($MODEL) {
1310 # try to autoload a model 1447 # try to autoload a model
1311 for (@REGISTRY, @models) { 1448 for (@REGISTRY, @models) {
1312 my ($package, $model, $autoload) = @$_; 1449 my ($package, $model) = @$_;
1313 if ( 1450 if (
1314 $autoload
1315 and eval "require $package" 1451 eval "require $package"
1316 and ${"$package\::VERSION"} > 0 1452 and ${"$package\::VERSION"} > 0
1317 and eval "require $model" 1453 and eval "require $model"
1318 ) { 1454 ) {
1455 AnyEvent::log 7 => "autoloaded model '$model', using it.";
1319 $MODEL = $model; 1456 $MODEL = $model;
1320 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1321 last; 1457 last;
1322 } 1458 }
1323 } 1459 }
1324 1460
1325 $MODEL 1461 $MODEL
1326 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; 1462 or AnyEvent::log fatal => "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1327 } 1463 }
1328 } 1464 }
1329 1465
1330 @models = (); # free probe data 1466 # free memory only needed for probing
1467 undef @models;
1468 undef @REGISTRY;
1331 1469
1332 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1470 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1333 unshift @ISA, $MODEL;
1334 1471
1335 # now nuke some methods that are overridden by the backend. 1472 # now nuke some methods that are overridden by the backend.
1336 # SUPER is not allowed. 1473 # SUPER usage is not allowed in these.
1337 for (qw(time signal child idle)) { 1474 for (qw(time signal child idle)) {
1338 undef &{"AnyEvent::Base::$_"} 1475 undef &{"AnyEvent::Base::$_"}
1339 if defined &{"$MODEL\::$_"}; 1476 if defined &{"$MODEL\::$_"};
1340 } 1477 }
1341 1478
1479 _isa_set;
1480
1481 # we're officially open!
1482
1342 if ($ENV{PERL_ANYEVENT_STRICT}) { 1483 if ($ENV{PERL_ANYEVENT_STRICT}) {
1343 eval { require AnyEvent::Strict }; 1484 require AnyEvent::Strict;
1344 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1345 if $@ && $VERBOSE;
1346 } 1485 }
1347 1486
1487 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1488 require AnyEvent::Debug;
1489 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1490 }
1491
1492 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1493 require AnyEvent::Socket;
1494 require AnyEvent::Debug;
1495
1496 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1497 $shell =~ s/\$\$/$$/g;
1498
1499 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1500 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1501 }
1502
1503 # now the anyevent environment is set up as the user told us to, so
1504 # call the actual user code - post detects
1505
1348 (shift @post_detect)->() while @post_detect; 1506 (shift @post_detect)->() while @post_detect;
1507 undef @post_detect;
1349 1508
1350 *post_detect = sub(&) { 1509 *post_detect = sub(&) {
1351 shift->(); 1510 shift->();
1352 1511
1353 undef 1512 undef
1354 }; 1513 };
1355 1514
1356 $MODEL 1515 $MODEL
1357} 1516}
1358 1517
1359sub AUTOLOAD { 1518for my $name (@methods) {
1360 (my $func = $AUTOLOAD) =~ s/.*://; 1519 *$name = sub {
1361
1362 $method{$func}
1363 or Carp::croak "$func: not a valid AnyEvent class method";
1364
1365 detect; 1520 detect;
1366 1521 # we use goto because
1367 my $class = shift; 1522 # a) it makes the thunk more transparent
1368 $class->$func (@_); 1523 # b) it allows us to delete the thunk later
1369} 1524 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1370 1525 };
1371our $POSTPONE_W;
1372our @POSTPONE;
1373
1374sub _postpone_exec {
1375 undef $POSTPONE_W;
1376 (pop @POSTPONE)->()
1377 while @POSTPONE;
1378}
1379
1380sub postpone(&) {
1381 push @POSTPONE, shift;
1382
1383 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1384
1385 ()
1386} 1526}
1387 1527
1388# utility function to dup a filehandle. this is used by many backends 1528# utility function to dup a filehandle. this is used by many backends
1389# to support binding more than one watcher per filehandle (they usually 1529# to support binding more than one watcher per filehandle (they usually
1390# allow only one watcher per fd, so we dup it to get a different one). 1530# allow only one watcher per fd, so we dup it to get a different one).
1414 1554
1415package AE; 1555package AE;
1416 1556
1417our $VERSION = $AnyEvent::VERSION; 1557our $VERSION = $AnyEvent::VERSION;
1418 1558
1559sub _reset() {
1560 eval q{
1419# fall back to the main API by default - backends and AnyEvent::Base 1561 # fall back to the main API by default - backends and AnyEvent::Base
1420# implementations can overwrite these. 1562 # implementations can overwrite these.
1421 1563
1422sub io($$$) { 1564 sub io($$$) {
1423 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1565 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1424} 1566 }
1425 1567
1426sub timer($$$) { 1568 sub timer($$$) {
1427 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1569 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1428} 1570 }
1429 1571
1430sub signal($$) { 1572 sub signal($$) {
1431 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1573 AnyEvent->signal (signal => $_[0], cb => $_[1])
1432} 1574 }
1433 1575
1434sub child($$) { 1576 sub child($$) {
1435 AnyEvent->child (pid => $_[0], cb => $_[1]) 1577 AnyEvent->child (pid => $_[0], cb => $_[1])
1436} 1578 }
1437 1579
1438sub idle($) { 1580 sub idle($) {
1439 AnyEvent->idle (cb => $_[0]) 1581 AnyEvent->idle (cb => $_[0]);
1440} 1582 }
1441 1583
1442sub cv(;&) { 1584 sub cv(;&) {
1443 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1585 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1444} 1586 }
1445 1587
1446sub now() { 1588 sub now() {
1447 AnyEvent->now 1589 AnyEvent->now
1448} 1590 }
1449 1591
1450sub now_update() { 1592 sub now_update() {
1451 AnyEvent->now_update 1593 AnyEvent->now_update
1452} 1594 }
1453 1595
1454sub time() { 1596 sub time() {
1455 AnyEvent->time 1597 AnyEvent->time
1456} 1598 }
1457 1599
1458*postpone = \&AnyEvent::postpone; 1600 *postpone = \&AnyEvent::postpone;
1601 *log = \&AnyEvent::log;
1602 };
1603 die if $@;
1604}
1605
1606BEGIN { _reset }
1459 1607
1460package AnyEvent::Base; 1608package AnyEvent::Base;
1461 1609
1462# default implementations for many methods 1610# default implementations for many methods
1463 1611
1464sub time { 1612sub time {
1465 eval q{ # poor man's autoloading {} 1613 eval q{ # poor man's autoloading {}
1466 # probe for availability of Time::HiRes 1614 # probe for availability of Time::HiRes
1467 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1615 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1468 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1616 *time = sub { Time::HiRes::time () };
1469 *AE::time = \&Time::HiRes::time; 1617 *AE::time = \& Time::HiRes::time ;
1618 *now = \&time;
1619 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1470 # if (eval "use POSIX (); (POSIX::times())... 1620 # if (eval "use POSIX (); (POSIX::times())...
1471 } else { 1621 } else {
1622 *time = sub { CORE::time };
1623 *AE::time = sub (){ CORE::time };
1624 *now = \&time;
1472 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1625 AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1473 *AE::time = sub (){ time }; # epic fail
1474 } 1626 }
1475
1476 *time = sub { AE::time }; # different prototypes
1477 }; 1627 };
1478 die if $@; 1628 die if $@;
1479 1629
1480 &time 1630 &time
1481} 1631}
1482 1632
1483*now = \&time; 1633*now = \&time;
1484
1485sub now_update { } 1634sub now_update { }
1486 1635
1487sub _poll { 1636sub _poll {
1488 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; 1637 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1489} 1638}
1575 1724
1576sub signal { 1725sub signal {
1577 eval q{ # poor man's autoloading {} 1726 eval q{ # poor man's autoloading {}
1578 # probe for availability of Async::Interrupt 1727 # probe for availability of Async::Interrupt
1579 if (_have_async_interrupt) { 1728 if (_have_async_interrupt) {
1580 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1729 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1581 1730
1582 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1731 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1583 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1732 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1584 1733
1585 } else { 1734 } else {
1586 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1735 AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1587 1736
1588 if (AnyEvent::WIN32) { 1737 if (AnyEvent::WIN32) {
1589 require AnyEvent::Util; 1738 require AnyEvent::Util;
1590 1739
1591 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1740 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1667 : sysread $SIGPIPE_R, (my $dummy), 9; 1816 : sysread $SIGPIPE_R, (my $dummy), 9;
1668 1817
1669 while (%SIG_EV) { 1818 while (%SIG_EV) {
1670 for (keys %SIG_EV) { 1819 for (keys %SIG_EV) {
1671 delete $SIG_EV{$_}; 1820 delete $SIG_EV{$_};
1672 $_->() for values %{ $SIG_CB{$_} || {} }; 1821 &$_ for values %{ $SIG_CB{$_} || {} };
1673 } 1822 }
1674 } 1823 }
1675 }; 1824 };
1676 }; 1825 };
1677 die if $@; 1826 die if $@;
1744 1893
1745 my ($cb, $w, $rcb) = $arg{cb}; 1894 my ($cb, $w, $rcb) = $arg{cb};
1746 1895
1747 $rcb = sub { 1896 $rcb = sub {
1748 if ($cb) { 1897 if ($cb) {
1749 $w = _time; 1898 $w = AE::time;
1750 &$cb; 1899 &$cb;
1751 $w = _time - $w; 1900 $w = AE::time - $w;
1752 1901
1753 # never use more then 50% of the time for the idle watcher, 1902 # never use more then 50% of the time for the idle watcher,
1754 # within some limits 1903 # within some limits
1755 $w = 0.0001 if $w < 0.0001; 1904 $w = 0.0001 if $w < 0.0001;
1756 $w = 5 if $w > 5; 1905 $w = 5 if $w > 5;
1885$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 2034$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1886so on. 2035so on.
1887 2036
1888=head1 ENVIRONMENT VARIABLES 2037=head1 ENVIRONMENT VARIABLES
1889 2038
1890The following environment variables are used by this module or its 2039AnyEvent supports a number of environment variables that tune the
1891submodules. 2040runtime behaviour. They are usually evaluated when AnyEvent is
2041loaded, initialised, or a submodule that uses them is loaded. Many of
2042them also cause AnyEvent to load additional modules - for example,
2043C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
2044loaded.
1892 2045
1893Note that AnyEvent will remove I<all> environment variables starting with 2046All the environment variables documented here start with
1894C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 2047C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1895enabled. 2048namespace. Other modules are encouraged (but by no means required) to use
2049C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
2050namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
2051be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
2052variables starting with C<AE_>, see below).
2053
2054All variables can also be set via the C<AE_> prefix, that is, instead
2055of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
2056case there is a clash btween anyevent and another program that uses
2057C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
2058variable to the empty string, as those variables take precedence.
2059
2060When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
2061to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
2062exists. If taint mode is on, then AnyEvent will remove I<all> environment
2063variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
2064with C<undef> or the empty string, if the corresaponding C<AE_> variable
2065is set).
2066
2067The exact algorithm is currently:
2068
2069 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
2070 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
2071 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
2072
2073This ensures that child processes will not see the C<AE_> variables.
2074
2075The following environment variables are currently known to AnyEvent:
1896 2076
1897=over 4 2077=over 4
1898 2078
1899=item C<PERL_ANYEVENT_VERBOSE> 2079=item C<PERL_ANYEVENT_VERBOSE>
1900 2080
1901By default, AnyEvent will be completely silent except in fatal 2081By default, AnyEvent will only log messages with loglevel C<3>
1902conditions. You can set this environment variable to make AnyEvent more 2082(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
2083environment variable to a numerical loglevel to make AnyEvent more (or
1903talkative. 2084less) talkative.
1904 2085
2086If you want to do more than just set the global logging level
2087you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2088complex specifications.
2089
2090When set to C<0> (C<off>), then no messages whatsoever will be logged with
2091the default logging settings.
2092
1905When set to C<1> or higher, causes AnyEvent to warn about unexpected 2093When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1906conditions, such as not being able to load the event model specified by 2094unexpected conditions, such as not being able to load the event model
1907C<PERL_ANYEVENT_MODEL>. 2095specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
2096exception - this is the minimum recommended level.
1908 2097
1909When set to C<2> or higher, cause AnyEvent to report to STDERR which event 2098When set to C<7> or higher (info), cause AnyEvent to report which event model it
1910model it chooses. 2099chooses.
1911 2100
1912When set to C<8> or higher, then AnyEvent will report extra information on 2101When set to C<8> or higher (debug), then AnyEvent will report extra information on
1913which optional modules it loads and how it implements certain features. 2102which optional modules it loads and how it implements certain features.
2103
2104=item C<PERL_ANYEVENT_LOG>
2105
2106Accepts rather complex logging specifications. For example, you could log
2107all C<debug> messages of some module to stderr, warnings and above to
2108stderr, and errors and above to syslog, with:
2109
2110 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
2111
2112For the rather extensive details, see L<AnyEvent::Log>.
2113
2114This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2115so will take effect even before AnyEvent has initialised itself.
2116
2117Note that specifying this environment variable causes the L<AnyEvent::Log>
2118module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2119using the latter saves a few hundred kB of memory until the first message
2120is being logged.
1914 2121
1915=item C<PERL_ANYEVENT_STRICT> 2122=item C<PERL_ANYEVENT_STRICT>
1916 2123
1917AnyEvent does not do much argument checking by default, as thorough 2124AnyEvent does not do much argument checking by default, as thorough
1918argument checking is very costly. Setting this variable to a true value 2125argument checking is very costly. Setting this variable to a true value
1925Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> 2132Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1926>>, it is definitely recommended to keep it off in production. Keeping 2133>>, it is definitely recommended to keep it off in production. Keeping
1927C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2134C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1928can be very useful, however. 2135can be very useful, however.
1929 2136
2137=item C<PERL_ANYEVENT_DEBUG_SHELL>
2138
2139If this env variable is nonempty, then its contents will be interpreted by
2140C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
2141replacing every occurance of C<$$> by the process pid). The shell object
2142is saved in C<$AnyEvent::Debug::SHELL>.
2143
2144This happens when the first watcher is created.
2145
2146For example, to bind a debug shell on a unix domain socket in
2147F<< /tmp/debug<pid>.sock >>, you could use this:
2148
2149 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2150 # connect with e.g.: socat readline /tmp/debug123.sock
2151
2152Or to bind to tcp port 4545 on localhost:
2153
2154 PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
2155 # connect with e.g.: telnet localhost 4545
2156
2157Note that creating sockets in F</tmp> or on localhost is very unsafe on
2158multiuser systems.
2159
2160=item C<PERL_ANYEVENT_DEBUG_WRAP>
2161
2162Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2163debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2164
1930=item C<PERL_ANYEVENT_MODEL> 2165=item C<PERL_ANYEVENT_MODEL>
1931 2166
1932This can be used to specify the event model to be used by AnyEvent, before 2167This can be used to specify the event model to be used by AnyEvent, before
1933auto detection and -probing kicks in. It must be a string consisting 2168auto detection and -probing kicks in.
1934entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2169
2170It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2171or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1935and the resulting module name is loaded and if the load was successful, 2172resulting module name is loaded and - if the load was successful - used as
1936used as event model. If it fails to load AnyEvent will proceed with 2173event model backend. If it fails to load then AnyEvent will proceed with
1937auto detection and -probing. 2174auto detection and -probing.
1938 2175
1939This functionality might change in future versions. 2176If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2177nothing gets prepended and the module name is used as-is (hint: C<::> at
2178the end of a string designates a module name and quotes it appropriately).
1940 2179
1941For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you 2180For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1942could start your program like this: 2181could start your program like this:
1943 2182
1944 PERL_ANYEVENT_MODEL=Perl perl ... 2183 PERL_ANYEVENT_MODEL=Perl perl ...
1962but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 2201but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1963- only support IPv4, never try to resolve or contact IPv6 2202- only support IPv4, never try to resolve or contact IPv6
1964addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2203addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1965IPv6, but prefer IPv6 over IPv4. 2204IPv6, but prefer IPv6 over IPv4.
1966 2205
2206=item C<PERL_ANYEVENT_HOSTS>
2207
2208This variable, if specified, overrides the F</etc/hosts> file used by
2209L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2210from that file instead.
2211
1967=item C<PERL_ANYEVENT_EDNS0> 2212=item C<PERL_ANYEVENT_EDNS0>
1968 2213
1969Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension 2214Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1970for DNS. This extension is generally useful to reduce DNS traffic, but 2215DNS. This extension is generally useful to reduce DNS traffic, especially
1971some (broken) firewalls drop such DNS packets, which is why it is off by 2216when DNSSEC is involved, but some (broken) firewalls drop such DNS
1972default. 2217packets, which is why it is off by default.
1973 2218
1974Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce 2219Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1975EDNS0 in its DNS requests. 2220EDNS0 in its DNS requests.
1976 2221
1977=item C<PERL_ANYEVENT_MAX_FORKS> 2222=item C<PERL_ANYEVENT_MAX_FORKS>
1983 2228
1984The default value for the C<max_outstanding> parameter for the default DNS 2229The default value for the C<max_outstanding> parameter for the default DNS
1985resolver - this is the maximum number of parallel DNS requests that are 2230resolver - this is the maximum number of parallel DNS requests that are
1986sent to the DNS server. 2231sent to the DNS server.
1987 2232
2233=item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY>
2234
2235Perl has inherently racy signal handling (you can basically choose between
2236losing signals and memory corruption) - pure perl event loops (including
2237C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore
2238have to poll regularly to avoid losing signals.
2239
2240Some event loops are racy, but don't poll regularly, and some event loops
2241are written in C but are still racy. For those event loops, AnyEvent
2242installs a timer that regularly wakes up the event loop.
2243
2244By default, the interval for this timer is C<10> seconds, but you can
2245override this delay with this environment variable (or by setting
2246the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal
2247watchers).
2248
2249Lower values increase CPU (and energy) usage, higher values can introduce
2250long delays when reaping children or waiting for signals.
2251
2252The L<AnyEvent::Async> module, if available, will be used to avoid this
2253polling (with most event loops).
2254
1988=item C<PERL_ANYEVENT_RESOLV_CONF> 2255=item C<PERL_ANYEVENT_RESOLV_CONF>
1989 2256
1990The file to use instead of F</etc/resolv.conf> (or OS-specific 2257The absolute path to a F<resolv.conf>-style file to use instead of
1991configuration) in the default resolver. When set to the empty string, no 2258F</etc/resolv.conf> (or the OS-specific configuration) in the default
1992default config will be used. 2259resolver, or the empty string to select the default configuration.
1993 2260
1994=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. 2261=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1995 2262
1996When neither C<ca_file> nor C<ca_path> was specified during 2263When neither C<ca_file> nor C<ca_path> was specified during
1997L<AnyEvent::TLS> context creation, and either of these environment 2264L<AnyEvent::TLS> context creation, and either of these environment
1998variables exist, they will be used to specify CA certificate locations 2265variables are nonempty, they will be used to specify CA certificate
1999instead of a system-dependent default. 2266locations instead of a system-dependent default.
2000 2267
2001=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> 2268=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
2002 2269
2003When these are set to C<1>, then the respective modules are not 2270When these are set to C<1>, then the respective modules are not
2004loaded. Mostly good for testing AnyEvent itself. 2271loaded. Mostly good for testing AnyEvent itself.
2336(even when used without AnyEvent), but most event loops have acceptable 2603(even when used without AnyEvent), but most event loops have acceptable
2337performance with or without AnyEvent. 2604performance with or without AnyEvent.
2338 2605
2339=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2606=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2340the actual event loop, only with extremely fast event loops such as EV 2607the actual event loop, only with extremely fast event loops such as EV
2341adds AnyEvent significant overhead. 2608does AnyEvent add significant overhead.
2342 2609
2343=item * You should avoid POE like the plague if you want performance or 2610=item * You should avoid POE like the plague if you want performance or
2344reasonable memory usage. 2611reasonable memory usage.
2345 2612
2346=back 2613=back
2721 2988
2722Tutorial/Introduction: L<AnyEvent::Intro>. 2989Tutorial/Introduction: L<AnyEvent::Intro>.
2723 2990
2724FAQ: L<AnyEvent::FAQ>. 2991FAQ: L<AnyEvent::FAQ>.
2725 2992
2726Utility functions: L<AnyEvent::Util>. 2993Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2994(simply logging).
2727 2995
2996Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2997L<AnyEvent::Debug> (interactive shell, watcher tracing).
2998
2728Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>, 2999Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2729L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 3000L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
3001L<Qt>, L<POE>, L<FLTK>.
2730 3002
2731Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 3003Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2732L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 3004L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2733L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 3005L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2734L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 3006L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
3007L<AnyEvent::Impl::FLTK>.
2735 3008
2736Non-blocking file handles, sockets, TCP clients and 3009Non-blocking handles, pipes, stream sockets, TCP clients and
2737servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 3010servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2738 3011
2739Asynchronous DNS: L<AnyEvent::DNS>. 3012Asynchronous DNS: L<AnyEvent::DNS>.
2740 3013
2741Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 3014Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines