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.357 by root, Sat Aug 13 02:20:29 2011 UTC vs.
Revision 1.387 by root, Sat Oct 1 22:39:29 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::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
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 @ISA; 1240our @ISA;
1211
1212our @REGISTRY; 1241our @REGISTRY;
1213
1214our $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!)
1215 1245
1216BEGIN { 1246BEGIN {
1217 require "AnyEvent/constants.pl"; 1247 require "AnyEvent/constants.pl";
1218 1248
1219 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1249 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1220 1250
1221 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1251 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1222 if ${^TAINT}; 1252 if ${^TAINT};
1223 1253
1224 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1254 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1255 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1225 1256
1226} 1257 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1258 if ${^TAINT};
1227 1259
1228our $MAX_SIGNAL_LATENCY = 10; 1260 # $ENV{PERL_ANYEVENT_xxx} now valid
1229 1261
1230our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1262 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1231 1263
1232{
1233 my $idx; 1264 my $idx;
1234 $PROTOCOL{$_} = ++$idx 1265 $PROTOCOL{$_} = ++$idx
1235 for reverse split /\s*,\s*/, 1266 for reverse split /\s*,\s*/,
1236 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1267 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1237} 1268}
1268 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); 1299 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1269 1300
1270 () 1301 ()
1271} 1302}
1272 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 require AnyEvent::Log; # among other things, sets $VERBOSE to 9
1308 # AnyEvent::Log overwrites this function
1309 goto &log;
1310 }
1311
1312 0 # not logged
1313}
1314
1315sub logger($;$) {
1316 package AnyEvent::Log;
1317
1318 my ($level, $renabled) = @_;
1319
1320 $$renabled = $level <= $VERBOSE;
1321
1322 my $pkg = (caller)[0];
1323
1324 my $logger = [$pkg, $level, $renabled];
1325
1326 our %LOGGER;
1327 $LOGGER{$logger+0} = $logger;
1328
1329 require AnyEvent::Util;
1330 my $guard = AnyEvent::Util::guard (sub {
1331 # "clean up"
1332 delete $LOGGER{$logger+0};
1333 });
1334
1335 sub {
1336 return 0 unless $$renabled;
1337
1338 $guard if 0; # keep guard alive, but don't cause runtime overhead
1339 require AnyEvent::Log unless $AnyEvent::Log::VERSION;
1340 package AnyEvent::Log;
1341 _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
1342 }
1343}
1344
1345if (length $ENV{PERL_ANYEVENT_LOG}) {
1346 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1347}
1348
1273our @models = ( 1349our @models = (
1274 [EV:: => AnyEvent::Impl::EV:: , 1], 1350 [EV:: => AnyEvent::Impl::EV::],
1275 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], 1351 [AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1276 # everything below here will not (normally) be autoprobed 1352 # everything below here will not (normally) be autoprobed
1277 # as the pure perl backend should work everywhere 1353 # as the pure perl backend should work everywhere
1278 # and is usually faster 1354 # and is usually faster
1355 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
1279 [Event:: => AnyEvent::Impl::Event::, 1], 1356 [Event:: => AnyEvent::Impl::Event::], # slow, stable
1280 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1357 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1358 # everything below here should not be autoloaded
1281 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1359 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1282 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1283 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1360 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1284 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1361 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1285 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1362 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1286 [Wx:: => AnyEvent::Impl::POE::], 1363 [Wx:: => AnyEvent::Impl::POE::],
1287 [Prima:: => AnyEvent::Impl::POE::], 1364 [Prima:: => AnyEvent::Impl::POE::],
1288 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect 1365 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1289 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1366 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1290 [FLTK:: => AnyEvent::Impl::FLTK2::], 1367 [FLTK:: => AnyEvent::Impl::FLTK::],
1291); 1368);
1369
1370our @isa_hook;
1371
1372sub _isa_set {
1373 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1374
1375 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1376 for 1 .. $#pkg;
1377
1378 grep $_ && $_->[1], @isa_hook
1379 and AE::_reset ();
1380}
1381
1382# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1383sub _isa_hook($$;$) {
1384 my ($i, $pkg, $reset_ae) = @_;
1385
1386 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1387
1388 _isa_set;
1389}
1292 1390
1293# all autoloaded methods reserve the complete glob, not just the method slot. 1391# all autoloaded methods reserve the complete glob, not just the method slot.
1294# due to bugs in perls method cache implementation. 1392# due to bugs in perls method cache implementation.
1295our @methods = qw(io timer time now now_update signal child idle condvar); 1393our @methods = qw(io timer time now now_update signal child idle condvar);
1296 1394
1297sub detect() { 1395sub detect() {
1396 return $MODEL if $MODEL; # some programs keep references to detect
1397
1398 # IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
1399 # the author knows about the problems and what it does to AnyEvent as a whole
1400 # (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
1401 # anyway.
1402 AnyEvent::log fatal => "AnyEvent: IO::Async::Loop::AnyEvent detected - this module is broken by design,\n"
1403 . "abuses internals and breaks AnyEvent, will not continue."
1404 if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
1405
1298 local $!; # for good measure 1406 local $!; # for good measure
1299 local $SIG{__DIE__}; # we use eval 1407 local $SIG{__DIE__}; # we use eval
1300 1408
1301 # free some memory 1409 # free some memory
1302 *detect = sub () { $MODEL }; 1410 *detect = sub () { $MODEL };
1310 1418
1311 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { 1419 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1312 my $model = $1; 1420 my $model = $1;
1313 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; 1421 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1314 if (eval "require $model") { 1422 if (eval "require $model") {
1423 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1315 $MODEL = $model; 1424 $MODEL = $model;
1316 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1317 } else { 1425 } else {
1318 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1426 AnyEvent::log 4 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1319 } 1427 }
1320 } 1428 }
1321 1429
1322 # check for already loaded models 1430 # check for already loaded models
1323 unless ($MODEL) { 1431 unless ($MODEL) {
1324 for (@REGISTRY, @models) { 1432 for (@REGISTRY, @models) {
1325 my ($package, $model) = @$_; 1433 my ($package, $model) = @$_;
1326 if (${"$package\::VERSION"} > 0) { 1434 if (${"$package\::VERSION"} > 0) {
1327 if (eval "require $model") { 1435 if (eval "require $model") {
1436 AnyEvent::log 7 => "autodetected model '$model', using it.";
1328 $MODEL = $model; 1437 $MODEL = $model;
1329 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1330 last; 1438 last;
1331 } 1439 }
1332 } 1440 }
1333 } 1441 }
1334 1442
1335 unless ($MODEL) { 1443 unless ($MODEL) {
1336 # try to autoload a model 1444 # try to autoload a model
1337 for (@REGISTRY, @models) { 1445 for (@REGISTRY, @models) {
1338 my ($package, $model, $autoload) = @$_; 1446 my ($package, $model) = @$_;
1339 if ( 1447 if (
1340 $autoload
1341 and eval "require $package" 1448 eval "require $package"
1342 and ${"$package\::VERSION"} > 0 1449 and ${"$package\::VERSION"} > 0
1343 and eval "require $model" 1450 and eval "require $model"
1344 ) { 1451 ) {
1452 AnyEvent::log 7 => "autoloaded model '$model', using it.";
1345 $MODEL = $model; 1453 $MODEL = $model;
1346 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1347 last; 1454 last;
1348 } 1455 }
1349 } 1456 }
1350 1457
1351 $MODEL 1458 $MODEL
1352 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; 1459 or AnyEvent::log fatal => "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1353 } 1460 }
1354 } 1461 }
1355 1462
1356 # free memory only needed for probing 1463 # free memory only needed for probing
1357 undef @models; 1464 undef @models;
1358 undef @REGISTRY; 1465 undef @REGISTRY;
1359 1466
1360 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1467 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1361 unshift @ISA, $MODEL;
1362 1468
1363 # now nuke some methods that are overridden by the backend. 1469 # now nuke some methods that are overridden by the backend.
1364 # SUPER usage is not allowed in these. 1470 # SUPER usage is not allowed in these.
1365 for (qw(time signal child idle)) { 1471 for (qw(time signal child idle)) {
1366 undef &{"AnyEvent::Base::$_"} 1472 undef &{"AnyEvent::Base::$_"}
1367 if defined &{"$MODEL\::$_"}; 1473 if defined &{"$MODEL\::$_"};
1368 } 1474 }
1369 1475
1476 _isa_set;
1477
1478 # we're officially open!
1479
1370 if ($ENV{PERL_ANYEVENT_STRICT}) { 1480 if ($ENV{PERL_ANYEVENT_STRICT}) {
1371 require AnyEvent::Strict; 1481 require AnyEvent::Strict;
1372 } 1482 }
1373 1483
1374 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) { 1484 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1375 require AnyEvent::Debug; 1485 require AnyEvent::Debug;
1376 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP}); 1486 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1377 } 1487 }
1378 1488
1379 if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) { 1489 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1490 require AnyEvent::Socket;
1380 require AnyEvent::Debug; 1491 require AnyEvent::Debug;
1381 #d# 1492
1493 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1494 $shell =~ s/\$\$/$$/g;
1495
1496 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1497 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1382 } 1498 }
1499
1500 # now the anyevent environment is set up as the user told us to, so
1501 # call the actual user code - post detects
1383 1502
1384 (shift @post_detect)->() while @post_detect; 1503 (shift @post_detect)->() while @post_detect;
1385 undef @post_detect; 1504 undef @post_detect;
1386 1505
1387 *post_detect = sub(&) { 1506 *post_detect = sub(&) {
1474 sub time() { 1593 sub time() {
1475 AnyEvent->time 1594 AnyEvent->time
1476 } 1595 }
1477 1596
1478 *postpone = \&AnyEvent::postpone; 1597 *postpone = \&AnyEvent::postpone;
1598 *log = \&AnyEvent::log;
1479 }; 1599 };
1480 die if $@; 1600 die if $@;
1481} 1601}
1482 1602
1483BEGIN { _reset } 1603BEGIN { _reset }
1488 1608
1489sub time { 1609sub time {
1490 eval q{ # poor man's autoloading {} 1610 eval q{ # poor man's autoloading {}
1491 # probe for availability of Time::HiRes 1611 # probe for availability of Time::HiRes
1492 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1612 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1493 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1613 *time = sub { Time::HiRes::time () };
1494 *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.";
1495 # if (eval "use POSIX (); (POSIX::times())... 1617 # if (eval "use POSIX (); (POSIX::times())...
1496 } else { 1618 } else {
1619 *time = sub { CORE::time };
1620 *AE::time = sub (){ CORE::time };
1621 *now = \&time;
1497 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1622 AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1498 *AE::time = sub (){ time }; # epic fail
1499 } 1623 }
1500
1501 *time = sub { AE::time }; # different prototypes
1502 }; 1624 };
1503 die if $@; 1625 die if $@;
1504 1626
1505 &time 1627 &time
1506} 1628}
1507 1629
1508*now = \&time; 1630*now = \&time;
1509
1510sub now_update { } 1631sub now_update { }
1511 1632
1512sub _poll { 1633sub _poll {
1513 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; 1634 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1514} 1635}
1600 1721
1601sub signal { 1722sub signal {
1602 eval q{ # poor man's autoloading {} 1723 eval q{ # poor man's autoloading {}
1603 # probe for availability of Async::Interrupt 1724 # probe for availability of Async::Interrupt
1604 if (_have_async_interrupt) { 1725 if (_have_async_interrupt) {
1605 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1726 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1606 1727
1607 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1728 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1608 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1729 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1609 1730
1610 } else { 1731 } else {
1611 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1732 AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1612 1733
1613 if (AnyEvent::WIN32) { 1734 if (AnyEvent::WIN32) {
1614 require AnyEvent::Util; 1735 require AnyEvent::Util;
1615 1736
1616 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1737 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1910$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 2031$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1911so on. 2032so on.
1912 2033
1913=head1 ENVIRONMENT VARIABLES 2034=head1 ENVIRONMENT VARIABLES
1914 2035
1915The following environment variables are used by this module or its 2036AnyEvent supports a number of environment variables that tune the
1916submodules. 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.
1917 2042
1918Note that AnyEvent will remove I<all> environment variables starting with 2043All the environment variables documented here start with
1919C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 2044C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1920enabled. 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:
1921 2073
1922=over 4 2074=over 4
1923 2075
1924=item C<PERL_ANYEVENT_VERBOSE> 2076=item C<PERL_ANYEVENT_VERBOSE>
1925 2077
1926By default, AnyEvent will be completely silent except in fatal 2078By default, AnyEvent will only log messages with loglevel C<3>
1927conditions. 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
1928talkative. 2081less) talkative.
1929 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
1930When set to C<1> or higher, causes AnyEvent to warn about unexpected 2090When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1931conditions, such as not being able to load the event model specified by 2091unexpected conditions, such as not being able to load the event model
1932C<PERL_ANYEVENT_MODEL>. 2092specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
2093exception - this is the minimum recommended level.
1933 2094
1934When set to C<2> 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
1935model it chooses. 2096chooses.
1936 2097
1937When 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
1938which 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.
1939 2118
1940=item C<PERL_ANYEVENT_STRICT> 2119=item C<PERL_ANYEVENT_STRICT>
1941 2120
1942AnyEvent does not do much argument checking by default, as thorough 2121AnyEvent does not do much argument checking by default, as thorough
1943argument checking is very costly. Setting this variable to a true value 2122argument checking is very costly. Setting this variable to a true value
1950Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> 2129Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1951>>, it is definitely recommended to keep it off in production. Keeping 2130>>, it is definitely recommended to keep it off in production. Keeping
1952C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2131C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1953can be very useful, however. 2132can be very useful, however.
1954 2133
2134=item C<PERL_ANYEVENT_DEBUG_SHELL>
2135
2136If this env variable is nonempty, then its contents will be interpreted by
2137C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
2138replacing every occurance of C<$$> by the process pid). The shell object
2139is saved in C<$AnyEvent::Debug::SHELL>.
2140
2141This happens when the first watcher is created.
2142
2143For example, to bind a debug shell on a unix domain socket in
2144F<< /tmp/debug<pid>.sock >>, you could use this:
2145
2146 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2147 # connect with e.g.: socat readline /tmp/debug123.sock
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
2154Note that creating sockets in F</tmp> or on localhost is very unsafe on
2155multiuser systems.
2156
2157=item C<PERL_ANYEVENT_DEBUG_WRAP>
2158
2159Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2160debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2161
1955=item C<PERL_ANYEVENT_MODEL> 2162=item C<PERL_ANYEVENT_MODEL>
1956 2163
1957This can be used to specify the event model to be used by AnyEvent, before 2164This can be used to specify the event model to be used by AnyEvent, before
1958auto detection and -probing kicks in. 2165auto detection and -probing kicks in.
1959 2166
1991but 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>
1992- only support IPv4, never try to resolve or contact IPv6 2199- only support IPv4, never try to resolve or contact IPv6
1993addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2200addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1994IPv6, but prefer IPv6 over IPv4. 2201IPv6, but prefer IPv6 over IPv4.
1995 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
1996=item C<PERL_ANYEVENT_EDNS0> 2209=item C<PERL_ANYEVENT_EDNS0>
1997 2210
1998Used 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
1999for DNS. This extension is generally useful to reduce DNS traffic, but 2212DNS. This extension is generally useful to reduce DNS traffic, especially
2000some (broken) firewalls drop such DNS packets, which is why it is off by 2213when DNSSEC is involved, but some (broken) firewalls drop such DNS
2001default. 2214packets, which is why it is off by default.
2002 2215
2003Setting 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
2004EDNS0 in its DNS requests. 2217EDNS0 in its DNS requests.
2005 2218
2006=item C<PERL_ANYEVENT_MAX_FORKS> 2219=item C<PERL_ANYEVENT_MAX_FORKS>
2012 2225
2013The 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
2014resolver - this is the maximum number of parallel DNS requests that are 2227resolver - this is the maximum number of parallel DNS requests that are
2015sent to the DNS server. 2228sent to the DNS server.
2016 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
2017=item C<PERL_ANYEVENT_RESOLV_CONF> 2252=item C<PERL_ANYEVENT_RESOLV_CONF>
2018 2253
2019The 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
2020configuration) in the default resolver. When set to the empty string, no 2255F</etc/resolv.conf> (or the OS-specific configuration) in the default
2021default config will be used. 2256resolver, or the empty string to select the default configuration.
2022 2257
2023=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. 2258=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
2024 2259
2025When neither C<ca_file> nor C<ca_path> was specified during 2260When neither C<ca_file> nor C<ca_path> was specified during
2026L<AnyEvent::TLS> context creation, and either of these environment 2261L<AnyEvent::TLS> context creation, and either of these environment
2027variables exist, they will be used to specify CA certificate locations 2262variables are nonempty, they will be used to specify CA certificate
2028instead of a system-dependent default. 2263locations instead of a system-dependent default.
2029 2264
2030=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>
2031 2266
2032When 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
2033loaded. Mostly good for testing AnyEvent itself. 2268loaded. Mostly good for testing AnyEvent itself.
2365(even when used without AnyEvent), but most event loops have acceptable 2600(even when used without AnyEvent), but most event loops have acceptable
2366performance with or without AnyEvent. 2601performance with or without AnyEvent.
2367 2602
2368=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2603=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2369the actual event loop, only with extremely fast event loops such as EV 2604the actual event loop, only with extremely fast event loops such as EV
2370adds AnyEvent significant overhead. 2605does AnyEvent add significant overhead.
2371 2606
2372=item * You should avoid POE like the plague if you want performance or 2607=item * You should avoid POE like the plague if you want performance or
2373reasonable memory usage. 2608reasonable memory usage.
2374 2609
2375=back 2610=back
2750 2985
2751Tutorial/Introduction: L<AnyEvent::Intro>. 2986Tutorial/Introduction: L<AnyEvent::Intro>.
2752 2987
2753FAQ: L<AnyEvent::FAQ>. 2988FAQ: L<AnyEvent::FAQ>.
2754 2989
2755Utility functions: L<AnyEvent::Util>. 2990Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2991(simply logging).
2756 2992
2993Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2994L<AnyEvent::Debug> (interactive shell, watcher tracing).
2995
2757Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>, 2996Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2758L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2997L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
2998L<Qt>, L<POE>, L<FLTK>.
2759 2999
2760Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 3000Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2761L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 3001L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2762L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 3002L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2763L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 3003L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
3004L<AnyEvent::Impl::FLTK>.
2764 3005
2765Non-blocking file handles, sockets, TCP clients and 3006Non-blocking handles, pipes, stream sockets, TCP clients and
2766servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 3007servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2767 3008
2768Asynchronous DNS: L<AnyEvent::DNS>. 3009Asynchronous DNS: L<AnyEvent::DNS>.
2769 3010
2770Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 3011Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines