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.375 by root, Thu Aug 25 05:39:47 2011 UTC vs.
Revision 1.410 by root, Fri Mar 1 06:03:21 2013 UTC

415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's 415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
416pure perl implementation). 416pure perl implementation).
417 417
418=head3 Safe/Unsafe Signals 418=head3 Safe/Unsafe Signals
419 419
420Perl signals can be either "safe" (synchronous to opcode handling) or 420Perl signals can be either "safe" (synchronous to opcode handling)
421"unsafe" (asynchronous) - the former might get delayed indefinitely, the 421or "unsafe" (asynchronous) - the former might delay signal delivery
422latter might corrupt your memory. 422indefinitely, the latter might corrupt your memory.
423 423
424AnyEvent signal handlers are, in addition, synchronous to the event loop, 424AnyEvent signal handlers are, in addition, synchronous to the event loop,
425i.e. they will not interrupt your running perl program but will only be 425i.e. they will not interrupt your running perl program but will only be
426called as part of the normal event handling (just like timer, I/O etc. 426called as part of the normal event handling (just like timer, I/O etc.
427callbacks, too). 427callbacks, too).
428 428
429=head3 Signal Races, Delays and Workarounds 429=head3 Signal Races, Delays and Workarounds
430 430
431Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 431Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support
432callbacks to signals in a generic way, which is a pity, as you cannot 432attaching callbacks to signals in a generic way, which is a pity,
433do race-free signal handling in perl, requiring C libraries for 433as you cannot do race-free signal handling in perl, requiring
434this. AnyEvent will try to do its best, which means in some cases, 434C libraries for this. AnyEvent will try to do its best, which
435signals will be delayed. The maximum time a signal might be delayed is 435means in some cases, signals will be delayed. The maximum time
436specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This 436a signal might be delayed is 10 seconds by default, but can
437variable can be changed only before the first signal watcher is created, 437be overriden via C<$ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY}> or
438and should be left alone otherwise. This variable determines how often 438C<$AnyEvent::MAX_SIGNAL_LATENCY> - see the L<ENVIRONMENT VARIABLES>
439AnyEvent polls for signals (in case a wake-up was missed). Higher values 439section for details.
440will cause fewer spurious wake-ups, which is better for power and CPU
441saving.
442 440
443All these problems can be avoided by installing the optional 441All these problems can be avoided by installing the optional
444L<Async::Interrupt> module, which works with most event loops. It will not 442L<Async::Interrupt> module, which works with most event loops. It will not
445work with inherently broken event loops such as L<Event> or L<Event::Lib> 443work with inherently broken event loops such as L<Event> or L<Event::Lib>
446(and not with L<POE> currently, as POE does its own workaround with 444(and not with L<POE> currently). For those, you just have to suffer the
447one-second latency). For those, you just have to suffer the delays. 445delays.
448 446
449=head2 CHILD PROCESS WATCHERS 447=head2 CHILD PROCESS WATCHERS
450 448
451 $w = AnyEvent->child (pid => <process id>, cb => <callback>); 449 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
452 450
765 }; 763 };
766 } 764 }
767 765
768 $cv->end; 766 $cv->end;
769 767
768 ...
769
770 my $results = $cv->recv;
771
770This code fragment supposedly pings a number of hosts and calls 772This code fragment supposedly pings a number of hosts and calls
771C<send> after results for all then have have been gathered - in any 773C<send> after results for all then have have been gathered - in any
772order. To achieve this, the code issues a call to C<begin> when it starts 774order. To achieve this, the code issues a call to C<begin> when it starts
773each ping request and calls C<end> when it has received some result for 775each ping request and calls C<end> when it has received some result for
774it. Since C<begin> and C<end> only maintain a counter, the order in which 776it. Since C<begin> and C<end> only maintain a counter, the order in which
809 811
810In list context, all parameters passed to C<send> will be returned, 812In list context, all parameters passed to C<send> will be returned,
811in scalar context only the first one will be returned. 813in scalar context only the first one will be returned.
812 814
813Note that doing a blocking wait in a callback is not supported by any 815Note that doing a blocking wait in a callback is not supported by any
814event loop, that is, recursive invocation of a blocking C<< ->recv 816event loop, that is, recursive invocation of a blocking C<< ->recv >> is
815>> is not allowed, and the C<recv> call will C<croak> if such a 817not allowed and the C<recv> call will C<croak> if such a condition is
816condition is detected. This condition can be slightly loosened by using 818detected. This requirement can be dropped by relying on L<Coro::AnyEvent>
817L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from 819, which allows you to do a blocking C<< ->recv >> from any thread
818any thread that doesn't run the event loop itself. 820that doesn't run the event loop itself. L<Coro::AnyEvent> is loaded
821automatically when L<Coro> is used with L<AnyEvent>, so code does not need
822to do anything special to take advantage of that: any code that would
823normally block your program because it calls C<recv>, be executed in an
824C<async> thread instead without blocking other threads.
819 825
820Not all event models support a blocking wait - some die in that case 826Not all event models support a blocking wait - some die in that case
821(programs might want to do that to stay interactive), so I<if you are 827(programs might want to do that to stay interactive), so I<if you are
822using this from a module, never require a blocking wait>. Instead, let the 828using this from a module, never require a blocking wait>. Instead, let the
823caller decide whether the call will block or not (for example, by coupling 829caller decide whether the call will block or not (for example, by coupling
878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 884 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
879 AnyEvent::Impl::POE based on POE, very slow, some limitations. 885 AnyEvent::Impl::POE based on POE, very slow, some limitations.
880 AnyEvent::Impl::Irssi used when running within irssi. 886 AnyEvent::Impl::Irssi used when running within irssi.
881 AnyEvent::Impl::IOAsync based on IO::Async. 887 AnyEvent::Impl::IOAsync based on IO::Async.
882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. 888 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
883 AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding). 889 AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
884 890
885=item Backends with special needs. 891=item Backends with special needs.
886 892
887Qt requires the Qt::Application to be instantiated first, but will 893Qt requires the Qt::Application to be instantiated first, but will
888otherwise be picked up automatically. As long as the main program 894otherwise be picked up automatically. As long as the main program
1053 1059
1054=item AnyEvent::log $level, $msg[, @args] 1060=item AnyEvent::log $level, $msg[, @args]
1055 1061
1056Log the given C<$msg> at the given C<$level>. 1062Log the given C<$msg> at the given C<$level>.
1057 1063
1058Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> - 1064If L<AnyEvent::Log> is not loaded then this function makes a simple test
1065to see whether the message will be logged. If the test succeeds it will
1066load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
1059consequently, look at the L<AnyEvent::Log> documentation for details. 1067the L<AnyEvent::Log> documentation for details.
1068
1069If the test fails it will simply return. Right now this happens when a
1070numerical loglevel is used and it is larger than the level specified via
1071C<$ENV{PERL_ANYEVENT_VERBOSE}>.
1060 1072
1061If you want to sprinkle loads of logging calls around your code, consider 1073If you want to sprinkle loads of logging calls around your code, consider
1062creating a logger callback with the C<AnyEvent::Log::logger> function. 1074creating a logger callback with the C<AnyEvent::Log::logger> function,
1075which can reduce typing, codesize and can reduce the logging overhead
1076enourmously.
1063 1077
1064=back 1078=back
1065 1079
1066=head1 WHAT TO DO IN A MODULE 1080=head1 WHAT TO DO IN A MODULE
1067 1081
1160 1174
1161Implement event-based interfaces to the protocols of the same name (for 1175Implement event-based interfaces to the protocols of the same name (for
1162the curious, IGS is the International Go Server and FCP is the Freenet 1176the curious, IGS is the International Go Server and FCP is the Freenet
1163Client Protocol). 1177Client Protocol).
1164 1178
1165=item L<AnyEvent::Handle::UDP>
1166
1167Here be danger!
1168
1169As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1170there are so many things wrong with AnyEvent::Handle::UDP, most notably
1171its use of a stream-based API with a protocol that isn't streamable, that
1172the only way to improve it is to delete it.
1173
1174It features data corruption (but typically only under load) and general
1175confusion. On top, the author is not only clueless about UDP but also
1176fact-resistant - some gems of his understanding: "connect doesn't work
1177with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1178packets", "I don't need to implement proper error checking as UDP doesn't
1179support error checking" and so on - he doesn't even understand what's
1180wrong with his module when it is explained to him.
1181
1182=item L<AnyEvent::DBI>
1183
1184Executes L<DBI> requests asynchronously in a proxy process for you,
1185notifying you in an event-based way when the operation is finished.
1186
1187=item L<AnyEvent::AIO> 1179=item L<AnyEvent::AIO>
1188 1180
1189Truly asynchronous (as opposed to non-blocking) I/O, should be in the 1181Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1190toolbox of every event programmer. AnyEvent::AIO transparently fuses 1182toolbox of every event programmer. AnyEvent::AIO transparently fuses
1191L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based 1183L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1192file I/O, and much more. 1184file I/O, and much more.
1193 1185
1186=item L<AnyEvent::Filesys::Notify>
1187
1188AnyEvent is good for non-blocking stuff, but it can't detect file or
1189path changes (e.g. "watch this directory for new files", "watch this
1190file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
1191do just that in a portbale fashion, supporting inotify on GNU/Linux and
1192some weird, without doubt broken, stuff on OS X to monitor files. It can
1193fall back to blocking scans at regular intervals transparently on other
1194platforms, so it's about as portable as it gets.
1195
1196(I haven't used it myself, but I haven't heard anybody complaining about
1197it yet).
1198
1199=item L<AnyEvent::DBI>
1200
1201Executes L<DBI> requests asynchronously in a proxy process for you,
1202notifying you in an event-based way when the operation is finished.
1203
1194=item L<AnyEvent::HTTPD> 1204=item L<AnyEvent::HTTPD>
1195 1205
1196A simple embedded webserver. 1206A simple embedded webserver.
1197 1207
1198=item L<AnyEvent::FastPing> 1208=item L<AnyEvent::FastPing>
1199 1209
1200The fastest ping in the west. 1210The fastest ping in the west.
1201 1211
1202=item L<Coro> 1212=item L<Coro>
1203 1213
1204Has special support for AnyEvent via L<Coro::AnyEvent>. 1214Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
1215to simply invert the flow control - don't call us, we will call you:
1216
1217 async {
1218 Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
1219 print "5 seconds later!\n";
1220
1221 Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
1222 my $line = <STDIN>; # works for ttys
1223
1224 AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
1225 my ($body, $hdr) = Coro::rouse_wait;
1226 };
1205 1227
1206=back 1228=back
1207 1229
1208=cut 1230=cut
1209 1231
1210package AnyEvent; 1232package AnyEvent;
1211 1233
1212# basically a tuned-down version of common::sense 1234# basically a tuned-down version of common::sense
1213sub common_sense { 1235sub common_sense {
1214 # from common:.sense 3.4 1236 # from common:.sense 3.5
1237 local $^W;
1215 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00"; 1238 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1216 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) 1239 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1217 $^H |= 0x00000600; 1240 $^H |= 0x00000600;
1218} 1241}
1219 1242
1220BEGIN { AnyEvent::common_sense } 1243BEGIN { AnyEvent::common_sense }
1221 1244
1222use Carp (); 1245use Carp ();
1223 1246
1224our $VERSION = '6.01'; 1247our $VERSION = '7.04';
1225our $MODEL; 1248our $MODEL;
1226
1227our @ISA; 1249our @ISA;
1228
1229our @REGISTRY; 1250our @REGISTRY;
1230
1231our $VERBOSE; 1251our $VERBOSE;
1252our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1253our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} || 10; # executes after the BEGIN block below (tainting!)
1232 1254
1233BEGIN { 1255BEGIN {
1234 require "AnyEvent/constants.pl"; 1256 require "AnyEvent/constants.pl";
1235 1257
1236 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1258 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1242 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV; 1264 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1243 1265
1244 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = () 1266 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1245 if ${^TAINT}; 1267 if ${^TAINT};
1246 1268
1247 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1269 # $ENV{PERL_ANYEVENT_xxx} now valid
1248}
1249 1270
1250our $MAX_SIGNAL_LATENCY = 10; 1271 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1251 1272
1252our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1253
1254{
1255 my $idx; 1273 my $idx;
1256 $PROTOCOL{$_} = ++$idx 1274 $PROTOCOL{$_} = ++$idx
1257 for reverse split /\s*,\s*/, 1275 for reverse split /\s*,\s*/,
1258 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1276 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1259} 1277}
1291 1309
1292 () 1310 ()
1293} 1311}
1294 1312
1295sub log($$;@) { 1313sub log($$;@) {
1296 # only load the bug bloated module when we actually are about to log something 1314 # only load the big bloated module when we actually are about to log something
1297 if ($_[0] <= $VERBOSE) { 1315 if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal
1298 require AnyEvent::Log; 1316 local ($!, $@);
1317 require AnyEvent::Log; # among other things, sets $VERBOSE to 9
1299 # AnyEvent::Log overwrites this function 1318 # AnyEvent::Log overwrites this function
1300 goto &log; 1319 goto &log;
1301 } 1320 }
1321
1322 0 # not logged
1323}
1324
1325sub _logger($;$) {
1326 my ($level, $renabled) = @_;
1327
1328 $$renabled = $level <= $VERBOSE;
1329
1330 my $logger = [(caller)[0], $level, $renabled];
1331
1332 $AnyEvent::Log::LOGGER{$logger+0} = $logger;
1333
1334# return unless defined wantarray;
1335#
1336# require AnyEvent::Util;
1337# my $guard = AnyEvent::Util::guard (sub {
1338# # "clean up"
1339# delete $LOGGER{$logger+0};
1340# });
1341#
1342# sub {
1343# return 0 unless $$renabled;
1344#
1345# $guard if 0; # keep guard alive, but don't cause runtime overhead
1346# require AnyEvent::Log unless $AnyEvent::Log::VERSION;
1347# package AnyEvent::Log;
1348# _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
1349# }
1302} 1350}
1303 1351
1304if (length $ENV{PERL_ANYEVENT_LOG}) { 1352if (length $ENV{PERL_ANYEVENT_LOG}) {
1305 require AnyEvent::Log; # AnyEvent::Log does the thing for us 1353 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1306} 1354}
1307 1355
1308our @models = ( 1356our @models = (
1309 [EV:: => AnyEvent::Impl::EV:: , 1], 1357 [EV:: => AnyEvent::Impl::EV::],
1310 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], 1358 [AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1311 # everything below here will not (normally) be autoprobed 1359 # everything below here will not (normally) be autoprobed
1312 # as the pure perl backend should work everywhere 1360 # as the pure perl backend should work everywhere
1313 # and is usually faster 1361 # and is usually faster
1362 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
1314 [Event:: => AnyEvent::Impl::Event::, 1], 1363 [Event:: => AnyEvent::Impl::Event::], # slow, stable
1315 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1364 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1365 # everything below here should not be autoloaded
1316 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1366 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1317 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1318 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1367 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1319 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1368 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1320 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1369 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1321 [Wx:: => AnyEvent::Impl::POE::], 1370 [Wx:: => AnyEvent::Impl::POE::],
1322 [Prima:: => AnyEvent::Impl::POE::], 1371 [Prima:: => AnyEvent::Impl::POE::],
1323 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect 1372 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1324 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1373 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1325 [FLTK:: => AnyEvent::Impl::FLTK2::], 1374 [FLTK:: => AnyEvent::Impl::FLTK::],
1326); 1375);
1327 1376
1328our @isa_hook; 1377our @isa_hook;
1329 1378
1330sub _isa_set { 1379sub _isa_set {
1350# due to bugs in perls method cache implementation. 1399# due to bugs in perls method cache implementation.
1351our @methods = qw(io timer time now now_update signal child idle condvar); 1400our @methods = qw(io timer time now now_update signal child idle condvar);
1352 1401
1353sub detect() { 1402sub detect() {
1354 return $MODEL if $MODEL; # some programs keep references to detect 1403 return $MODEL if $MODEL; # some programs keep references to detect
1404
1405 # IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
1406 # the author knows about the problems and what it does to AnyEvent as a whole
1407 # (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
1408 # anyway.
1409 AnyEvent::log fatal => "IO::Async::Loop::AnyEvent detected - that module is broken by\n"
1410 . "design, abuses internals and breaks AnyEvent - will not continue."
1411 if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
1355 1412
1356 local $!; # for good measure 1413 local $!; # for good measure
1357 local $SIG{__DIE__}; # we use eval 1414 local $SIG{__DIE__}; # we use eval
1358 1415
1359 # free some memory 1416 # free some memory
1368 1425
1369 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { 1426 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1370 my $model = $1; 1427 my $model = $1;
1371 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; 1428 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1372 if (eval "require $model") { 1429 if (eval "require $model") {
1373 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."; 1430 AnyEvent::log 7 => "Loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1374 $MODEL = $model; 1431 $MODEL = $model;
1375 } else { 1432 } else {
1376 AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@"; 1433 AnyEvent::log 4 => "Unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1377 } 1434 }
1378 } 1435 }
1379 1436
1380 # check for already loaded models 1437 # check for already loaded models
1381 unless ($MODEL) { 1438 unless ($MODEL) {
1382 for (@REGISTRY, @models) { 1439 for (@REGISTRY, @models) {
1383 my ($package, $model) = @$_; 1440 my ($package, $model) = @$_;
1384 if (${"$package\::VERSION"} > 0) { 1441 if (${"$package\::VERSION"} > 0) {
1385 if (eval "require $model") { 1442 if (eval "require $model") {
1386 AnyEvent::log 7 => "autodetected model '$model', using it."; 1443 AnyEvent::log 7 => "Autodetected model '$model', using it.";
1444 $MODEL = $model;
1445 last;
1446 } else {
1447 AnyEvent::log 8 => "Detected event loop $package, but cannot load '$model', skipping: $@";
1448 }
1449 }
1450 }
1451
1452 unless ($MODEL) {
1453 # try to autoload a model
1454 for (@REGISTRY, @models) {
1455 my ($package, $model) = @$_;
1456 if (
1457 eval "require $package"
1458 and ${"$package\::VERSION"} > 0
1459 and eval "require $model"
1460 ) {
1461 AnyEvent::log 7 => "Autoloaded model '$model', using it.";
1387 $MODEL = $model; 1462 $MODEL = $model;
1388 last; 1463 last;
1389 } 1464 }
1390 } 1465 }
1391 }
1392
1393 unless ($MODEL) {
1394 # try to autoload a model
1395 for (@REGISTRY, @models) {
1396 my ($package, $model, $autoload) = @$_;
1397 if (
1398 $autoload
1399 and eval "require $package"
1400 and ${"$package\::VERSION"} > 0
1401 and eval "require $model"
1402 ) {
1403 AnyEvent::log 7 => "autoloaded model '$model', using it.";
1404 $MODEL = $model;
1405 last;
1406 }
1407 }
1408 1466
1409 $MODEL 1467 $MODEL
1410 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?"; 1468 or AnyEvent::log fatal => "Backend autodetection failed - did you properly install AnyEvent?";
1411 } 1469 }
1412 } 1470 }
1413 1471
1414 # free memory only needed for probing 1472 # free memory only needed for probing
1415 undef @models; 1473 undef @models;
1559 1617
1560sub time { 1618sub time {
1561 eval q{ # poor man's autoloading {} 1619 eval q{ # poor man's autoloading {}
1562 # probe for availability of Time::HiRes 1620 # probe for availability of Time::HiRes
1563 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1621 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1564 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."
1565 if $AnyEvent::VERBOSE >= 8;
1566 *time = sub { Time::HiRes::time () }; 1622 *time = sub { Time::HiRes::time () };
1567 *AE::time = \& Time::HiRes::time ; 1623 *AE::time = \& Time::HiRes::time ;
1624 *now = \&time;
1625 AnyEvent::log 8 => "using Time::HiRes for sub-second timing accuracy.";
1568 # if (eval "use POSIX (); (POSIX::times())... 1626 # if (eval "use POSIX (); (POSIX::times())...
1569 } else { 1627 } else {
1570 AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
1571 *time = sub { CORE::time }; 1628 *time = sub { CORE::time };
1572 *AE::time = sub (){ CORE::time }; 1629 *AE::time = sub (){ CORE::time };
1630 *now = \&time;
1631 AnyEvent::log 3 => "Using built-in time(), no sub-second resolution!";
1573 } 1632 }
1574
1575 *now = \&time;
1576 }; 1633 };
1577 die if $@; 1634 die if $@;
1578 1635
1579 &time 1636 &time
1580} 1637}
1673 1730
1674sub signal { 1731sub signal {
1675 eval q{ # poor man's autoloading {} 1732 eval q{ # poor man's autoloading {}
1676 # probe for availability of Async::Interrupt 1733 # probe for availability of Async::Interrupt
1677 if (_have_async_interrupt) { 1734 if (_have_async_interrupt) {
1678 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling." 1735 AnyEvent::log 8 => "Using Async::Interrupt for race-free signal handling.";
1679 if $AnyEvent::VERBOSE >= 8;
1680 1736
1681 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1737 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1682 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1738 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1683 1739
1684 } else { 1740 } else {
1685 AnyEvent::log 8 => "using emulated perl signal handling with latency timer." 1741 AnyEvent::log 8 => "Using emulated perl signal handling with latency timer.";
1686 if $AnyEvent::VERBOSE >= 8;
1687 1742
1688 if (AnyEvent::WIN32) { 1743 if (AnyEvent::WIN32) {
1689 require AnyEvent::Util; 1744 require AnyEvent::Util;
1690 1745
1691 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1746 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
2027 2082
2028=over 4 2083=over 4
2029 2084
2030=item C<PERL_ANYEVENT_VERBOSE> 2085=item C<PERL_ANYEVENT_VERBOSE>
2031 2086
2032By default, AnyEvent will be completely silent except in fatal 2087By default, AnyEvent will log messages with loglevel C<4> (C<error>) or
2033conditions. You can set this environment variable to make AnyEvent more 2088higher (see L<AnyEvent::Log>). You can set this environment variable to a
2089numerical loglevel to make AnyEvent more (or less) talkative.
2090
2034talkative. If you want to do more than just set the global logging level 2091If you want to do more than just set the global logging level
2035you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more 2092you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2036complex specifications. 2093complex specifications.
2037 2094
2095When set to C<0> (C<off>), then no messages whatsoever will be logged with
2096everything else at defaults.
2097
2038When set to C<5> or higher, causes AnyEvent to warn about unexpected 2098When set to C<5> or higher (C<warn>), AnyEvent warns about unexpected
2039conditions, such as not being able to load the event model specified by 2099conditions, such as not being able to load the event model specified by
2040C<PERL_ANYEVENT_MODEL>. 2100C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this
2101is the minimum recommended level for use during development.
2041 2102
2042When set to C<7> or higher, cause AnyEvent to report to STDERR which event 2103When set to C<7> or higher (info), AnyEvent reports which event model it
2043model it chooses. 2104chooses.
2044 2105
2045When set to C<8> or higher, then AnyEvent will report extra information on 2106When set to C<8> or higher (debug), then AnyEvent will report extra
2046which optional modules it loads and how it implements certain features. 2107information on which optional modules it loads and how it implements
2108certain features.
2047 2109
2048=item C<PERL_ANYEVENT_LOG> 2110=item C<PERL_ANYEVENT_LOG>
2049 2111
2050Accepts rather complex logging specifications. For example, you could log 2112Accepts rather complex logging specifications. For example, you could log
2051all C<debug> messages of some module to stderr, warnings and above to 2113all C<debug> messages of some module to stderr, warnings and above to
2058This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded, 2120This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2059so will take effect even before AnyEvent has initialised itself. 2121so will take effect even before AnyEvent has initialised itself.
2060 2122
2061Note that specifying this environment variable causes the L<AnyEvent::Log> 2123Note that specifying this environment variable causes the L<AnyEvent::Log>
2062module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only 2124module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2063using the latter saves a few hundred kB of memory until the first message 2125using the latter saves a few hundred kB of memory unless a module
2064is being logged. 2126explicitly needs the extra features of AnyEvent::Log.
2065 2127
2066=item C<PERL_ANYEVENT_STRICT> 2128=item C<PERL_ANYEVENT_STRICT>
2067 2129
2068AnyEvent does not do much argument checking by default, as thorough 2130AnyEvent does not do much argument checking by default, as thorough
2069argument checking is very costly. Setting this variable to a true value 2131argument checking is very costly. Setting this variable to a true value
2078C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2140C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
2079can be very useful, however. 2141can be very useful, however.
2080 2142
2081=item C<PERL_ANYEVENT_DEBUG_SHELL> 2143=item C<PERL_ANYEVENT_DEBUG_SHELL>
2082 2144
2083If this env variable is set, then its contents will be interpreted by 2145If this env variable is nonempty, then its contents will be interpreted by
2084C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of 2146C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
2085C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on 2147replacing every occurance of C<$$> by the process pid). The shell object
2086that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>. 2148is saved in C<$AnyEvent::Debug::SHELL>.
2087 2149
2088This happens when the first watcher is created. 2150This happens when the first watcher is created.
2089 2151
2090For example, to bind a debug shell on a unix domain socket in 2152For example, to bind a debug shell on a unix domain socket in
2091F<< /tmp/debug<pid>.sock >>, you could use this: 2153F<< /tmp/debug<pid>.sock >>, you could use this:
2092 2154
2093 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog 2155 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2156 # connect with e.g.: socat readline /tmp/debug123.sock
2094 2157
2158Or to bind to tcp port 4545 on localhost:
2159
2160 PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
2161 # connect with e.g.: telnet localhost 4545
2162
2095Note that creating sockets in F</tmp> is very unsafe on multiuser 2163Note that creating sockets in F</tmp> or on localhost is very unsafe on
2096systems. 2164multiuser systems.
2097 2165
2098=item C<PERL_ANYEVENT_DEBUG_WRAP> 2166=item C<PERL_ANYEVENT_DEBUG_WRAP>
2099 2167
2100Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for 2168Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2101debugging purposes. See C<AnyEvent::Debug::wrap> for details. 2169debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2118For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you 2186For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
2119could start your program like this: 2187could start your program like this:
2120 2188
2121 PERL_ANYEVENT_MODEL=Perl perl ... 2189 PERL_ANYEVENT_MODEL=Perl perl ...
2122 2190
2191=item C<PERL_ANYEVENT_IO_MODEL>
2192
2193The current file I/O model - see L<AnyEvent::IO> for more info.
2194
2195At the moment, only C<Perl> (small, pure-perl, synchronous) and
2196C<IOAIO> (truly asynchronous) are supported. The default is C<IOAIO> if
2197L<AnyEvent::AIO> can be loaded, otherwise it is C<Perl>.
2198
2123=item C<PERL_ANYEVENT_PROTOCOLS> 2199=item C<PERL_ANYEVENT_PROTOCOLS>
2124 2200
2125Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences 2201Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
2126for IPv4 or IPv6. The default is unspecified (and might change, or be the result 2202for IPv4 or IPv6. The default is unspecified (and might change, or be the result
2127of auto probing). 2203of auto probing).
2165=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS> 2241=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
2166 2242
2167The default value for the C<max_outstanding> parameter for the default DNS 2243The default value for the C<max_outstanding> parameter for the default DNS
2168resolver - this is the maximum number of parallel DNS requests that are 2244resolver - this is the maximum number of parallel DNS requests that are
2169sent to the DNS server. 2245sent to the DNS server.
2246
2247=item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY>
2248
2249Perl has inherently racy signal handling (you can basically choose between
2250losing signals and memory corruption) - pure perl event loops (including
2251C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore
2252have to poll regularly to avoid losing signals.
2253
2254Some event loops are racy, but don't poll regularly, and some event loops
2255are written in C but are still racy. For those event loops, AnyEvent
2256installs a timer that regularly wakes up the event loop.
2257
2258By default, the interval for this timer is C<10> seconds, but you can
2259override this delay with this environment variable (or by setting
2260the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal
2261watchers).
2262
2263Lower values increase CPU (and energy) usage, higher values can introduce
2264long delays when reaping children or waiting for signals.
2265
2266The L<AnyEvent::Async> module, if available, will be used to avoid this
2267polling (with most event loops).
2170 2268
2171=item C<PERL_ANYEVENT_RESOLV_CONF> 2269=item C<PERL_ANYEVENT_RESOLV_CONF>
2172 2270
2173The absolute path to a F<resolv.conf>-style file to use instead of 2271The absolute path to a F<resolv.conf>-style file to use instead of
2174F</etc/resolv.conf> (or the OS-specific configuration) in the default 2272F</etc/resolv.conf> (or the OS-specific configuration) in the default
2831This module is part of perl since release 5.008. It will be used when the 2929This module is part of perl since release 5.008. It will be used when the
2832chosen event library does not come with a timing source of its own. The 2930chosen event library does not come with a timing source of its own. The
2833pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to 2931pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2834try to use a monotonic clock for timing stability. 2932try to use a monotonic clock for timing stability.
2835 2933
2934=item L<AnyEvent::AIO> (and L<IO::AIO>)
2935
2936The default implementation of L<AnyEvent::IO> is to do I/O synchronously,
2937stopping programs while they access the disk, which is fine for a lot of
2938programs.
2939
2940Installing AnyEvent::AIO (and its IO::AIO dependency) makes it switch to
2941a true asynchronous implementation, so event processing can continue even
2942while waiting for disk I/O.
2943
2836=back 2944=back
2837 2945
2838 2946
2839=head1 FORK 2947=head1 FORK
2840 2948
2923L<AnyEvent::Impl::FLTK>. 3031L<AnyEvent::Impl::FLTK>.
2924 3032
2925Non-blocking handles, pipes, stream sockets, TCP clients and 3033Non-blocking handles, pipes, stream sockets, TCP clients and
2926servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 3034servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2927 3035
3036Asynchronous File I/O: L<AnyEvent::IO>.
3037
2928Asynchronous DNS: L<AnyEvent::DNS>. 3038Asynchronous DNS: L<AnyEvent::DNS>.
2929 3039
2930Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 3040Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2931 3041
2932Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>, 3042Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2934 3044
2935 3045
2936=head1 AUTHOR 3046=head1 AUTHOR
2937 3047
2938 Marc Lehmann <schmorp@schmorp.de> 3048 Marc Lehmann <schmorp@schmorp.de>
2939 http://home.schmorp.de/ 3049 http://anyevent.schmorp.de
2940 3050
2941=cut 3051=cut
2942 3052
29431 30531
2944 3054

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines