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.358 by root, Sat Aug 13 02:35:32 2011 UTC vs.
Revision 1.382 by root, Thu Sep 1 23:46:26 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
… …
878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
879 AnyEvent::Impl::POE based on POE, very slow, some limitations. 879 AnyEvent::Impl::POE based on POE, very slow, some limitations.
880 AnyEvent::Impl::Irssi used when running within irssi. 880 AnyEvent::Impl::Irssi used when running within irssi.
881 AnyEvent::Impl::IOAsync based on IO::Async. 881 AnyEvent::Impl::IOAsync based on IO::Async.
882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. 882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
883 AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding). 883 AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
884 884
885=item Backends with special needs. 885=item Backends with special needs.
886 886
887Qt requires the Qt::Application to be instantiated first, but will 887Qt requires the Qt::Application to be instantiated first, but will
888otherwise be picked up automatically. As long as the main program 888otherwise be picked up automatically. As long as the main program
… …
933 933
934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
935if necessary. You should only call this function right before you would 935if necessary. You should only call this function right before you would
936have created an AnyEvent watcher anyway, that is, as late as possible at 936have created an AnyEvent watcher anyway, that is, as late as possible at
937runtime, and not e.g. during initialisation of your module. 937runtime, and not e.g. during initialisation of your module.
938
939The effect of calling this function is as if a watcher had been created
940(specifically, actions that happen "when the first watcher is created"
941happen when calling detetc as well).
938 942
939If you need to do some initialisation before AnyEvent watchers are 943If you need to do some initialisation before AnyEvent watchers are
940created, use C<post_detect>. 944created, use C<post_detect>.
941 945
942=item $guard = AnyEvent::post_detect { BLOCK } 946=item $guard = AnyEvent::post_detect { BLOCK }
… …
1045It should use C<postpone>: 1049It should use C<postpone>:
1046 1050
1047 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later 1051 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1048 if $some_error_condition; 1052 if $some_error_condition;
1049 1053
1054=item AnyEvent::log $level, $msg[, @args]
1055
1056Log the given C<$msg> at the given C<$level>.
1057
1058If L<AnyEvent::Log> is not loaded then this function makes a simple test
1059to see whether the message will be logged. If the test succeeds it will
1060load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
1061the L<AnyEvent::Log> documentation for details.
1062
1063If the test fails it will simply return. Right now this happens when a
1064numerical loglevel is used and it is larger than the level specified via
1065C<$ENV{PERL_ANYEVENT_VERBOSE}>.
1066
1067If you want to sprinkle loads of logging calls around your code, consider
1068creating a logger callback with the C<AnyEvent::Log::logger> function,
1069which can reduce typing, codesize and can reduce the logging overhead
1070enourmously.
1071
1050=back 1072=back
1051 1073
1052=head1 WHAT TO DO IN A MODULE 1074=head1 WHAT TO DO IN A MODULE
1053 1075
1054As a module author, you should C<use AnyEvent> and call AnyEvent methods 1076As a module author, you should C<use AnyEvent> and call AnyEvent methods
… …
1110 1132
1111 1133
1112=head1 OTHER MODULES 1134=head1 OTHER MODULES
1113 1135
1114The following is a non-exhaustive list of additional modules that use 1136The following is a non-exhaustive list of additional modules that use
1115AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1137AnyEvent as a client and can therefore be mixed easily with other
1116modules and other event loops in the same program. Some of the modules 1138AnyEvent modules and other event loops in the same program. Some of the
1117come as part of AnyEvent, the others are available via CPAN. 1139modules come as part of AnyEvent, the others are available via CPAN (see
1140L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
1141a longer non-exhaustive list), and the list is heavily biased towards
1142modules of the AnyEvent author himself :)
1118 1143
1119=over 4 1144=over 4
1120 1145
1121=item L<AnyEvent::Util> 1146=item L<AnyEvent::Util>
1122 1147
… …
1142=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> 1167=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1143 1168
1144Implement event-based interfaces to the protocols of the same name (for 1169Implement event-based interfaces to the protocols of the same name (for
1145the curious, IGS is the International Go Server and FCP is the Freenet 1170the curious, IGS is the International Go Server and FCP is the Freenet
1146Client Protocol). 1171Client 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 1172
1170=item L<AnyEvent::AIO> 1173=item L<AnyEvent::AIO>
1171 1174
1172Truly asynchronous (as opposed to non-blocking) I/O, should be in the 1175Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1173toolbox of every event programmer. AnyEvent::AIO transparently fuses 1176toolbox of every event programmer. AnyEvent::AIO transparently fuses
1174L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based 1177L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1175file I/O, and much more. 1178file I/O, and much more.
1176 1179
1180=item L<AnyEvent::Filesys::Notify>
1181
1182AnyEvent is good for non-blocking stuff, but it can't detect file or
1183path changes (e.g. "watch this directory for new files", "watch this
1184file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
1185do just that in a portbale fashion, supporting inotify on GNU/Linux and
1186some weird, without doubt broken, stuff on OS X to monitor files. It can
1187fall back to blocking scans at regular intervals transparently on other
1188platforms, so it's about as portable as it gets.
1189
1190(I haven't used it myself, but I haven't heard anybody complaining about
1191it yet).
1192
1193=item L<AnyEvent::DBI>
1194
1195Executes L<DBI> requests asynchronously in a proxy process for you,
1196notifying you in an event-based way when the operation is finished.
1197
1177=item L<AnyEvent::HTTPD> 1198=item L<AnyEvent::HTTPD>
1178 1199
1179A simple embedded webserver. 1200A simple embedded webserver.
1180 1201
1181=item L<AnyEvent::FastPing> 1202=item L<AnyEvent::FastPing>
1182 1203
1183The fastest ping in the west. 1204The fastest ping in the west.
1184 1205
1185=item L<Coro> 1206=item L<Coro>
1186 1207
1187Has special support for AnyEvent via L<Coro::AnyEvent>. 1208Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
1209to simply invert the flow control - don't call us, we will call you:
1210
1211 async {
1212 Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
1213 print "5 seconds later!\n";
1214
1215 Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
1216 my $line = <STDIN>; # works for ttys
1217
1218 AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
1219 my ($body, $hdr) = Coro::rouse_wait;
1220 };
1188 1221
1189=back 1222=back
1190 1223
1191=cut 1224=cut
1192 1225
… …
1202 1235
1203BEGIN { AnyEvent::common_sense } 1236BEGIN { AnyEvent::common_sense }
1204 1237
1205use Carp (); 1238use Carp ();
1206 1239
1207our $VERSION = '5.34'; 1240our $VERSION = '6.02';
1208our $MODEL; 1241our $MODEL;
1209
1210our @ISA; 1242our @ISA;
1211
1212our @REGISTRY; 1243our @REGISTRY;
1213
1214our $VERBOSE; 1244our $VERBOSE;
1245our $MAX_SIGNAL_LATENCY = 10;
1246our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1215 1247
1216BEGIN { 1248BEGIN {
1217 require "AnyEvent/constants.pl"; 1249 require "AnyEvent/constants.pl";
1218 1250
1219 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1251 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1220 1252
1221 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1253 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1222 if ${^TAINT}; 1254 if ${^TAINT};
1223 1255
1224 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1256 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1257 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1225 1258
1226} 1259 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1260 if ${^TAINT};
1227 1261
1228our $MAX_SIGNAL_LATENCY = 10; 1262 # $ENV{PERL_ANYEVENT_xxx} now valid
1229 1263
1230our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1264 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 3;
1231 1265
1232{
1233 my $idx; 1266 my $idx;
1234 $PROTOCOL{$_} = ++$idx 1267 $PROTOCOL{$_} = ++$idx
1235 for reverse split /\s*,\s*/, 1268 for reverse split /\s*,\s*/,
1236 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1269 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1237} 1270}
… …
1266 push @POSTPONE, shift; 1299 push @POSTPONE, shift;
1267 1300
1268 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); 1301 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1269 1302
1270 () 1303 ()
1304}
1305
1306sub log($$;@) {
1307 # only load the big bloated module when we actually are about to log something
1308 if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!)
1309 require AnyEvent::Log;
1310 # AnyEvent::Log overwrites this function
1311 goto &log;
1312 }
1313
1314 0 # not logged
1315}
1316
1317if (length $ENV{PERL_ANYEVENT_LOG}) {
1318 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1271} 1319}
1272 1320
1273our @models = ( 1321our @models = (
1274 [EV:: => AnyEvent::Impl::EV:: , 1], 1322 [EV:: => AnyEvent::Impl::EV:: , 1],
1275 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], 1323 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
… …
1285 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1333 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1286 [Wx:: => AnyEvent::Impl::POE::], 1334 [Wx:: => AnyEvent::Impl::POE::],
1287 [Prima:: => AnyEvent::Impl::POE::], 1335 [Prima:: => AnyEvent::Impl::POE::],
1288 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect 1336 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1289 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1337 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1290 [FLTK:: => AnyEvent::Impl::FLTK2::], 1338 [FLTK:: => AnyEvent::Impl::FLTK::],
1291); 1339);
1340
1341our @isa_hook;
1342
1343sub _isa_set {
1344 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1345
1346 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1347 for 1 .. $#pkg;
1348
1349 grep $_ && $_->[1], @isa_hook
1350 and AE::_reset ();
1351}
1352
1353# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1354sub _isa_hook($$;$) {
1355 my ($i, $pkg, $reset_ae) = @_;
1356
1357 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1358
1359 _isa_set;
1360}
1292 1361
1293# all autoloaded methods reserve the complete glob, not just the method slot. 1362# all autoloaded methods reserve the complete glob, not just the method slot.
1294# due to bugs in perls method cache implementation. 1363# due to bugs in perls method cache implementation.
1295our @methods = qw(io timer time now now_update signal child idle condvar); 1364our @methods = qw(io timer time now now_update signal child idle condvar);
1296 1365
1297sub detect() { 1366sub detect() {
1367 return $MODEL if $MODEL; # some programs keep references to detect
1368
1298 local $!; # for good measure 1369 local $!; # for good measure
1299 local $SIG{__DIE__}; # we use eval 1370 local $SIG{__DIE__}; # we use eval
1300 1371
1301 # free some memory 1372 # free some memory
1302 *detect = sub () { $MODEL }; 1373 *detect = sub () { $MODEL };
… …
1310 1381
1311 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { 1382 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1312 my $model = $1; 1383 my $model = $1;
1313 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; 1384 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1314 if (eval "require $model") { 1385 if (eval "require $model") {
1386 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1315 $MODEL = $model; 1387 $MODEL = $model;
1316 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1317 } else { 1388 } else {
1318 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1389 AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1319 } 1390 }
1320 } 1391 }
1321 1392
1322 # check for already loaded models 1393 # check for already loaded models
1323 unless ($MODEL) { 1394 unless ($MODEL) {
1324 for (@REGISTRY, @models) { 1395 for (@REGISTRY, @models) {
1325 my ($package, $model) = @$_; 1396 my ($package, $model) = @$_;
1326 if (${"$package\::VERSION"} > 0) { 1397 if (${"$package\::VERSION"} > 0) {
1327 if (eval "require $model") { 1398 if (eval "require $model") {
1399 AnyEvent::log 7 => "autodetected model '$model', using it.";
1328 $MODEL = $model; 1400 $MODEL = $model;
1329 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1330 last; 1401 last;
1331 } 1402 }
1332 } 1403 }
1333 } 1404 }
1334 1405
… …
1340 $autoload 1411 $autoload
1341 and eval "require $package" 1412 and eval "require $package"
1342 and ${"$package\::VERSION"} > 0 1413 and ${"$package\::VERSION"} > 0
1343 and eval "require $model" 1414 and eval "require $model"
1344 ) { 1415 ) {
1416 AnyEvent::log 7 => "autoloaded model '$model', using it.";
1345 $MODEL = $model; 1417 $MODEL = $model;
1346 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1347 last; 1418 last;
1348 } 1419 }
1349 } 1420 }
1350 1421
1351 $MODEL 1422 $MODEL
1352 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; 1423 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1353 } 1424 }
1354 } 1425 }
1355 1426
1356 # free memory only needed for probing 1427 # free memory only needed for probing
1357 undef @models; 1428 undef @models;
1358 undef @REGISTRY; 1429 undef @REGISTRY;
1359 1430
1360 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1431 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1361 unshift @ISA, $MODEL;
1362 1432
1363 # now nuke some methods that are overridden by the backend. 1433 # now nuke some methods that are overridden by the backend.
1364 # SUPER usage is not allowed in these. 1434 # SUPER usage is not allowed in these.
1365 for (qw(time signal child idle)) { 1435 for (qw(time signal child idle)) {
1366 undef &{"AnyEvent::Base::$_"} 1436 undef &{"AnyEvent::Base::$_"}
1367 if defined &{"$MODEL\::$_"}; 1437 if defined &{"$MODEL\::$_"};
1368 } 1438 }
1369 1439
1440 _isa_set;
1441
1442 # we're officially open!
1443
1370 if ($ENV{PERL_ANYEVENT_STRICT}) { 1444 if ($ENV{PERL_ANYEVENT_STRICT}) {
1371 require AnyEvent::Strict; 1445 require AnyEvent::Strict;
1372 } 1446 }
1373 1447
1374 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) { 1448 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1375 require AnyEvent::Debug; 1449 require AnyEvent::Debug;
1376 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP}); 1450 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1377 } 1451 }
1378 1452
1379 if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) { 1453 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1380 require AnyEvent::Socket; 1454 require AnyEvent::Socket;
1381 require AnyEvent::Debug; 1455 require AnyEvent::Debug;
1382 1456
1457 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1458 $shell =~ s/\$\$/$$/g;
1459
1383 my ($host, $service) = AnyEvent::Socket::parse_hostport ($ENV{PERL_ANYEVENT_DEBUG_SHELL}); 1460 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1384 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service); 1461 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1385 } 1462 }
1463
1464 # now the anyevent environment is set up as the user told us to, so
1465 # call the actual user code - post detects
1386 1466
1387 (shift @post_detect)->() while @post_detect; 1467 (shift @post_detect)->() while @post_detect;
1388 undef @post_detect; 1468 undef @post_detect;
1389 1469
1390 *post_detect = sub(&) { 1470 *post_detect = sub(&) {
… …
1477 sub time() { 1557 sub time() {
1478 AnyEvent->time 1558 AnyEvent->time
1479 } 1559 }
1480 1560
1481 *postpone = \&AnyEvent::postpone; 1561 *postpone = \&AnyEvent::postpone;
1562 *log = \&AnyEvent::log;
1482 }; 1563 };
1483 die if $@; 1564 die if $@;
1484} 1565}
1485 1566
1486BEGIN { _reset } 1567BEGIN { _reset }
… …
1491 1572
1492sub time { 1573sub time {
1493 eval q{ # poor man's autoloading {} 1574 eval q{ # poor man's autoloading {}
1494 # probe for availability of Time::HiRes 1575 # probe for availability of Time::HiRes
1495 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1576 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1496 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1577 *time = sub { Time::HiRes::time () };
1497 *AE::time = \&Time::HiRes::time; 1578 *AE::time = \& Time::HiRes::time ;
1579 *now = \&time;
1580 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1498 # if (eval "use POSIX (); (POSIX::times())... 1581 # if (eval "use POSIX (); (POSIX::times())...
1499 } else { 1582 } else {
1583 *time = sub { CORE::time };
1584 *AE::time = sub (){ CORE::time };
1585 *now = \&time;
1500 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1586 AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1501 *AE::time = sub (){ time }; # epic fail
1502 } 1587 }
1503
1504 *time = sub { AE::time }; # different prototypes
1505 }; 1588 };
1506 die if $@; 1589 die if $@;
1507 1590
1508 &time 1591 &time
1509} 1592}
1510 1593
1511*now = \&time; 1594*now = \&time;
1512
1513sub now_update { } 1595sub now_update { }
1514 1596
1515sub _poll { 1597sub _poll {
1516 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; 1598 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1517} 1599}
… …
1603 1685
1604sub signal { 1686sub signal {
1605 eval q{ # poor man's autoloading {} 1687 eval q{ # poor man's autoloading {}
1606 # probe for availability of Async::Interrupt 1688 # probe for availability of Async::Interrupt
1607 if (_have_async_interrupt) { 1689 if (_have_async_interrupt) {
1608 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1690 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1609 1691
1610 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1692 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1611 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1693 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1612 1694
1613 } else { 1695 } else {
1614 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1696 AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1615 1697
1616 if (AnyEvent::WIN32) { 1698 if (AnyEvent::WIN32) {
1617 require AnyEvent::Util; 1699 require AnyEvent::Util;
1618 1700
1619 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1701 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
… …
1913$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 1995$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1914so on. 1996so on.
1915 1997
1916=head1 ENVIRONMENT VARIABLES 1998=head1 ENVIRONMENT VARIABLES
1917 1999
1918The following environment variables are used by this module or its 2000AnyEvent supports a number of environment variables that tune the
1919submodules. 2001runtime behaviour. They are usually evaluated when AnyEvent is
2002loaded, initialised, or a submodule that uses them is loaded. Many of
2003them also cause AnyEvent to load additional modules - for example,
2004C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
2005loaded.
1920 2006
1921Note that AnyEvent will remove I<all> environment variables starting with 2007All the environment variables documented here start with
1922C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 2008C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1923enabled. 2009namespace. Other modules are encouraged (but by no means required) to use
2010C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
2011namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
2012be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
2013variables starting with C<AE_>, see below).
2014
2015All variables can also be set via the C<AE_> prefix, that is, instead
2016of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
2017case there is a clash btween anyevent and another program that uses
2018C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
2019variable to the empty string, as those variables take precedence.
2020
2021When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
2022to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
2023exists. If taint mode is on, then AnyEvent will remove I<all> environment
2024variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
2025with C<undef> or the empty string, if the corresaponding C<AE_> variable
2026is set).
2027
2028The exact algorithm is currently:
2029
2030 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
2031 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
2032 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
2033
2034This ensures that child processes will not see the C<AE_> variables.
2035
2036The following environment variables are currently known to AnyEvent:
1924 2037
1925=over 4 2038=over 4
1926 2039
1927=item C<PERL_ANYEVENT_VERBOSE> 2040=item C<PERL_ANYEVENT_VERBOSE>
1928 2041
1929By default, AnyEvent will be completely silent except in fatal 2042By default, AnyEvent will only log messages with loglevel C<3>
1930conditions. You can set this environment variable to make AnyEvent more 2043(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
2044environment variable to a numerical loglevel to make AnyEvent more (or
1931talkative. 2045less) talkative.
1932 2046
2047If you want to do more than just set the global logging level
2048you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2049complex specifications.
2050
2051When set to C<0> (C<off>), then no messages whatsoever will be logged with
2052the default logging settings.
2053
1933When set to C<1> or higher, causes AnyEvent to warn about unexpected 2054When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1934conditions, such as not being able to load the event model specified by 2055unexpected conditions, such as not being able to load the event model
1935C<PERL_ANYEVENT_MODEL>. 2056specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
2057exception - this is the minimum recommended level.
1936 2058
1937When set to C<2> or higher, cause AnyEvent to report to STDERR which event 2059When set to C<7> or higher (info), cause AnyEvent to report which event model it
1938model it chooses. 2060chooses.
1939 2061
1940When set to C<8> or higher, then AnyEvent will report extra information on 2062When set to C<8> or higher (debug), then AnyEvent will report extra information on
1941which optional modules it loads and how it implements certain features. 2063which optional modules it loads and how it implements certain features.
2064
2065=item C<PERL_ANYEVENT_LOG>
2066
2067Accepts rather complex logging specifications. For example, you could log
2068all C<debug> messages of some module to stderr, warnings and above to
2069stderr, and errors and above to syslog, with:
2070
2071 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
2072
2073For the rather extensive details, see L<AnyEvent::Log>.
2074
2075This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2076so will take effect even before AnyEvent has initialised itself.
2077
2078Note that specifying this environment variable causes the L<AnyEvent::Log>
2079module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2080using the latter saves a few hundred kB of memory until the first message
2081is being logged.
1942 2082
1943=item C<PERL_ANYEVENT_STRICT> 2083=item C<PERL_ANYEVENT_STRICT>
1944 2084
1945AnyEvent does not do much argument checking by default, as thorough 2085AnyEvent does not do much argument checking by default, as thorough
1946argument checking is very costly. Setting this variable to a true value 2086argument checking is very costly. Setting this variable to a true value
… …
1955C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2095C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1956can be very useful, however. 2096can be very useful, however.
1957 2097
1958=item C<PERL_ANYEVENT_DEBUG_SHELL> 2098=item C<PERL_ANYEVENT_DEBUG_SHELL>
1959 2099
1960If this env variable is set, then its contents will be 2100If this env variable is set, then its contents will be interpreted by
1961interpreted by C<AnyEvent::Socket::parse_hostport> and an 2101C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
1962C<AnyEvent::Debug::shell> is bound on that port. The shell object is saved 2102C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
1963in C<$AnyEvent::Debug::SHELL>. 2103that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
2104
2105This happens when the first watcher is created.
1964 2106
1965For example, to bind a debug shell on a unix domain socket in 2107For example, to bind a debug shell on a unix domain socket in
1966F</tmp/debug.sock>, you could use this: 2108F<< /tmp/debug<pid>.sock >>, you could use this:
1967 2109
1968 PERL_ANYEVENT_DEBUG_SHELL=unix/:/tmp/debug.sock perlprog 2110 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2111
2112Note that creating sockets in F</tmp> is very unsafe on multiuser
2113systems.
1969 2114
1970=item C<PERL_ANYEVENT_DEBUG_WRAP> 2115=item C<PERL_ANYEVENT_DEBUG_WRAP>
1971 2116
1972Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for 2117Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
1973debugging purposes. See C<AnyEvent::Debug::wrap> for details. 2118debugging purposes. See C<AnyEvent::Debug::wrap> for details.
… …
2011but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 2156but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
2012- only support IPv4, never try to resolve or contact IPv6 2157- only support IPv4, never try to resolve or contact IPv6
2013addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2158addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
2014IPv6, but prefer IPv6 over IPv4. 2159IPv6, but prefer IPv6 over IPv4.
2015 2160
2161=item C<PERL_ANYEVENT_HOSTS>
2162
2163This variable, if specified, overrides the F</etc/hosts> file used by
2164L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2165from that file instead.
2166
2016=item C<PERL_ANYEVENT_EDNS0> 2167=item C<PERL_ANYEVENT_EDNS0>
2017 2168
2018Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension 2169Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
2019for DNS. This extension is generally useful to reduce DNS traffic, but 2170DNS. This extension is generally useful to reduce DNS traffic, especially
2020some (broken) firewalls drop such DNS packets, which is why it is off by 2171when DNSSEC is involved, but some (broken) firewalls drop such DNS
2021default. 2172packets, which is why it is off by default.
2022 2173
2023Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce 2174Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
2024EDNS0 in its DNS requests. 2175EDNS0 in its DNS requests.
2025 2176
2026=item C<PERL_ANYEVENT_MAX_FORKS> 2177=item C<PERL_ANYEVENT_MAX_FORKS>
… …
2034resolver - this is the maximum number of parallel DNS requests that are 2185resolver - this is the maximum number of parallel DNS requests that are
2035sent to the DNS server. 2186sent to the DNS server.
2036 2187
2037=item C<PERL_ANYEVENT_RESOLV_CONF> 2188=item C<PERL_ANYEVENT_RESOLV_CONF>
2038 2189
2039The file to use instead of F</etc/resolv.conf> (or OS-specific 2190The absolute path to a F<resolv.conf>-style file to use instead of
2040configuration) in the default resolver. When set to the empty string, no 2191F</etc/resolv.conf> (or the OS-specific configuration) in the default
2041default config will be used. 2192resolver, or the empty string to select the default configuration.
2042 2193
2043=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. 2194=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
2044 2195
2045When neither C<ca_file> nor C<ca_path> was specified during 2196When neither C<ca_file> nor C<ca_path> was specified during
2046L<AnyEvent::TLS> context creation, and either of these environment 2197L<AnyEvent::TLS> context creation, and either of these environment
2047variables exist, they will be used to specify CA certificate locations 2198variables are nonempty, they will be used to specify CA certificate
2048instead of a system-dependent default. 2199locations instead of a system-dependent default.
2049 2200
2050=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> 2201=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
2051 2202
2052When these are set to C<1>, then the respective modules are not 2203When these are set to C<1>, then the respective modules are not
2053loaded. Mostly good for testing AnyEvent itself. 2204loaded. Mostly good for testing AnyEvent itself.
… …
2385(even when used without AnyEvent), but most event loops have acceptable 2536(even when used without AnyEvent), but most event loops have acceptable
2386performance with or without AnyEvent. 2537performance with or without AnyEvent.
2387 2538
2388=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2539=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2389the actual event loop, only with extremely fast event loops such as EV 2540the actual event loop, only with extremely fast event loops such as EV
2390adds AnyEvent significant overhead. 2541does AnyEvent add significant overhead.
2391 2542
2392=item * You should avoid POE like the plague if you want performance or 2543=item * You should avoid POE like the plague if you want performance or
2393reasonable memory usage. 2544reasonable memory usage.
2394 2545
2395=back 2546=back
… …
2770 2921
2771Tutorial/Introduction: L<AnyEvent::Intro>. 2922Tutorial/Introduction: L<AnyEvent::Intro>.
2772 2923
2773FAQ: L<AnyEvent::FAQ>. 2924FAQ: L<AnyEvent::FAQ>.
2774 2925
2775Utility functions: L<AnyEvent::Util>. 2926Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2927(simply logging).
2776 2928
2929Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2930L<AnyEvent::Debug> (interactive shell, watcher tracing).
2931
2777Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>, 2932Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2778L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2933L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
2934L<Qt>, L<POE>, L<FLTK>.
2779 2935
2780Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2936Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2781L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2937L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2782L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2938L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2783L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2939L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
2940L<AnyEvent::Impl::FLTK>.
2784 2941
2785Non-blocking file handles, sockets, TCP clients and 2942Non-blocking handles, pipes, stream sockets, TCP clients and
2786servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2943servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2787 2944
2788Asynchronous DNS: L<AnyEvent::DNS>. 2945Asynchronous DNS: L<AnyEvent::DNS>.
2789 2946
2790Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 2947Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.

Diff Legend

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