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.359 by root, Sat Aug 13 16:11:33 2011 UTC vs.
Revision 1.381 by root, Thu Sep 1 22:09:25 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
… …
1049It should use C<postpone>: 1049It should use C<postpone>:
1050 1050
1051 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later 1051 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1052 if $some_error_condition; 1052 if $some_error_condition;
1053 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
1054=back 1072=back
1055 1073
1056=head1 WHAT TO DO IN A MODULE 1074=head1 WHAT TO DO IN A MODULE
1057 1075
1058As 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
… …
1114 1132
1115 1133
1116=head1 OTHER MODULES 1134=head1 OTHER MODULES
1117 1135
1118The following is a non-exhaustive list of additional modules that use 1136The following is a non-exhaustive list of additional modules that use
1119AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1137AnyEvent as a client and can therefore be mixed easily with other
1120modules 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
1121come 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 :)
1122 1143
1123=over 4 1144=over 4
1124 1145
1125=item L<AnyEvent::Util> 1146=item L<AnyEvent::Util>
1126 1147
… …
1146=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>
1147 1168
1148Implement event-based interfaces to the protocols of the same name (for 1169Implement event-based interfaces to the protocols of the same name (for
1149the 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
1150Client Protocol). 1171Client Protocol).
1151
1152=item L<AnyEvent::Handle::UDP>
1153
1154Here be danger!
1155
1156As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1157there are so many things wrong with AnyEvent::Handle::UDP, most notably
1158its use of a stream-based API with a protocol that isn't streamable, that
1159the only way to improve it is to delete it.
1160
1161It features data corruption (but typically only under load) and general
1162confusion. On top, the author is not only clueless about UDP but also
1163fact-resistant - some gems of his understanding: "connect doesn't work
1164with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1165packets", "I don't need to implement proper error checking as UDP doesn't
1166support error checking" and so on - he doesn't even understand what's
1167wrong with his module when it is explained to him.
1168
1169=item L<AnyEvent::DBI>
1170
1171Executes L<DBI> requests asynchronously in a proxy process for you,
1172notifying you in an event-based way when the operation is finished.
1173 1172
1174=item L<AnyEvent::AIO> 1173=item L<AnyEvent::AIO>
1175 1174
1176Truly 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
1177toolbox of every event programmer. AnyEvent::AIO transparently fuses 1176toolbox of every event programmer. AnyEvent::AIO transparently fuses
1178L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based 1177L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1179file I/O, and much more. 1178file I/O, and much more.
1180 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
1181=item L<AnyEvent::HTTPD> 1198=item L<AnyEvent::HTTPD>
1182 1199
1183A simple embedded webserver. 1200A simple embedded webserver.
1184 1201
1185=item L<AnyEvent::FastPing> 1202=item L<AnyEvent::FastPing>
1186 1203
1187The fastest ping in the west. 1204The fastest ping in the west.
1188 1205
1189=item L<Coro> 1206=item L<Coro>
1190 1207
1191Has 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 };
1192 1221
1193=back 1222=back
1194 1223
1195=cut 1224=cut
1196 1225
… …
1206 1235
1207BEGIN { AnyEvent::common_sense } 1236BEGIN { AnyEvent::common_sense }
1208 1237
1209use Carp (); 1238use Carp ();
1210 1239
1211our $VERSION = '5.34'; 1240our $VERSION = '6.02';
1212our $MODEL; 1241our $MODEL;
1213 1242
1214our @ISA; 1243our @ISA;
1215 1244
1216our @REGISTRY; 1245our @REGISTRY;
… …
1223 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1252 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1224 1253
1225 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1254 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1226 if ${^TAINT}; 1255 if ${^TAINT};
1227 1256
1228 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1257 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1258 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1229 1259
1260 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1261 if ${^TAINT};
1262
1263 # $ENV{PERL_ANYEVENT_xxx} now valid
1264
1265 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 3;
1230} 1266}
1231 1267
1232our $MAX_SIGNAL_LATENCY = 10; 1268our $MAX_SIGNAL_LATENCY = 10;
1233 1269
1234our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1270our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
… …
1270 push @POSTPONE, shift; 1306 push @POSTPONE, shift;
1271 1307
1272 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); 1308 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1273 1309
1274 () 1310 ()
1311}
1312
1313sub log($$;@) {
1314 # only load the big bloated module when we actually are about to log something
1315 if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!)
1316 require AnyEvent::Log;
1317 # AnyEvent::Log overwrites this function
1318 goto &log;
1319 }
1320
1321 0 # not logged
1322}
1323
1324if (length $ENV{PERL_ANYEVENT_LOG}) {
1325 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1275} 1326}
1276 1327
1277our @models = ( 1328our @models = (
1278 [EV:: => AnyEvent::Impl::EV:: , 1], 1329 [EV:: => AnyEvent::Impl::EV:: , 1],
1279 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], 1330 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
… …
1289 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1340 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1290 [Wx:: => AnyEvent::Impl::POE::], 1341 [Wx:: => AnyEvent::Impl::POE::],
1291 [Prima:: => AnyEvent::Impl::POE::], 1342 [Prima:: => AnyEvent::Impl::POE::],
1292 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect 1343 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1293 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1344 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1294 [FLTK:: => AnyEvent::Impl::FLTK2::], 1345 [FLTK:: => AnyEvent::Impl::FLTK::],
1295); 1346);
1347
1348our @isa_hook;
1349
1350sub _isa_set {
1351 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1352
1353 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1354 for 1 .. $#pkg;
1355
1356 grep $_ && $_->[1], @isa_hook
1357 and AE::_reset ();
1358}
1359
1360# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1361sub _isa_hook($$;$) {
1362 my ($i, $pkg, $reset_ae) = @_;
1363
1364 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1365
1366 _isa_set;
1367}
1296 1368
1297# all autoloaded methods reserve the complete glob, not just the method slot. 1369# all autoloaded methods reserve the complete glob, not just the method slot.
1298# due to bugs in perls method cache implementation. 1370# due to bugs in perls method cache implementation.
1299our @methods = qw(io timer time now now_update signal child idle condvar); 1371our @methods = qw(io timer time now now_update signal child idle condvar);
1300 1372
1301sub detect() { 1373sub detect() {
1374 return $MODEL if $MODEL; # some programs keep references to detect
1375
1302 local $!; # for good measure 1376 local $!; # for good measure
1303 local $SIG{__DIE__}; # we use eval 1377 local $SIG{__DIE__}; # we use eval
1304 1378
1305 # free some memory 1379 # free some memory
1306 *detect = sub () { $MODEL }; 1380 *detect = sub () { $MODEL };
… …
1314 1388
1315 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { 1389 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1316 my $model = $1; 1390 my $model = $1;
1317 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; 1391 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1318 if (eval "require $model") { 1392 if (eval "require $model") {
1393 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1319 $MODEL = $model; 1394 $MODEL = $model;
1320 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1321 } else { 1395 } else {
1322 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1396 AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1323 } 1397 }
1324 } 1398 }
1325 1399
1326 # check for already loaded models 1400 # check for already loaded models
1327 unless ($MODEL) { 1401 unless ($MODEL) {
1328 for (@REGISTRY, @models) { 1402 for (@REGISTRY, @models) {
1329 my ($package, $model) = @$_; 1403 my ($package, $model) = @$_;
1330 if (${"$package\::VERSION"} > 0) { 1404 if (${"$package\::VERSION"} > 0) {
1331 if (eval "require $model") { 1405 if (eval "require $model") {
1406 AnyEvent::log 7 => "autodetected model '$model', using it.";
1332 $MODEL = $model; 1407 $MODEL = $model;
1333 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1334 last; 1408 last;
1335 } 1409 }
1336 } 1410 }
1337 } 1411 }
1338 1412
… …
1344 $autoload 1418 $autoload
1345 and eval "require $package" 1419 and eval "require $package"
1346 and ${"$package\::VERSION"} > 0 1420 and ${"$package\::VERSION"} > 0
1347 and eval "require $model" 1421 and eval "require $model"
1348 ) { 1422 ) {
1423 AnyEvent::log 7 => "autoloaded model '$model', using it.";
1349 $MODEL = $model; 1424 $MODEL = $model;
1350 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1351 last; 1425 last;
1352 } 1426 }
1353 } 1427 }
1354 1428
1355 $MODEL 1429 $MODEL
1356 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; 1430 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1357 } 1431 }
1358 } 1432 }
1359 1433
1360 # free memory only needed for probing 1434 # free memory only needed for probing
1361 undef @models; 1435 undef @models;
1362 undef @REGISTRY; 1436 undef @REGISTRY;
1363 1437
1364 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1438 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1365 unshift @ISA, $MODEL;
1366 1439
1367 # now nuke some methods that are overridden by the backend. 1440 # now nuke some methods that are overridden by the backend.
1368 # SUPER usage is not allowed in these. 1441 # SUPER usage is not allowed in these.
1369 for (qw(time signal child idle)) { 1442 for (qw(time signal child idle)) {
1370 undef &{"AnyEvent::Base::$_"} 1443 undef &{"AnyEvent::Base::$_"}
1371 if defined &{"$MODEL\::$_"}; 1444 if defined &{"$MODEL\::$_"};
1372 } 1445 }
1373 1446
1447 _isa_set;
1448
1449 # we're officially open!
1450
1374 if ($ENV{PERL_ANYEVENT_STRICT}) { 1451 if ($ENV{PERL_ANYEVENT_STRICT}) {
1375 require AnyEvent::Strict; 1452 require AnyEvent::Strict;
1376 } 1453 }
1377 1454
1378 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) { 1455 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1379 require AnyEvent::Debug; 1456 require AnyEvent::Debug;
1380 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP}); 1457 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1381 } 1458 }
1382 1459
1383 if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) { 1460 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1384 require AnyEvent::Socket; 1461 require AnyEvent::Socket;
1385 require AnyEvent::Debug; 1462 require AnyEvent::Debug;
1386 1463
1387 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL}; 1464 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1388 $shell =~ s/\$\$/$$/g; 1465 $shell =~ s/\$\$/$$/g;
1389 1466
1390 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell); 1467 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1391 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service); 1468 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1392 } 1469 }
1470
1471 # now the anyevent environment is set up as the user told us to, so
1472 # call the actual user code - post detects
1393 1473
1394 (shift @post_detect)->() while @post_detect; 1474 (shift @post_detect)->() while @post_detect;
1395 undef @post_detect; 1475 undef @post_detect;
1396 1476
1397 *post_detect = sub(&) { 1477 *post_detect = sub(&) {
… …
1484 sub time() { 1564 sub time() {
1485 AnyEvent->time 1565 AnyEvent->time
1486 } 1566 }
1487 1567
1488 *postpone = \&AnyEvent::postpone; 1568 *postpone = \&AnyEvent::postpone;
1569 *log = \&AnyEvent::log;
1489 }; 1570 };
1490 die if $@; 1571 die if $@;
1491} 1572}
1492 1573
1493BEGIN { _reset } 1574BEGIN { _reset }
… …
1498 1579
1499sub time { 1580sub time {
1500 eval q{ # poor man's autoloading {} 1581 eval q{ # poor man's autoloading {}
1501 # probe for availability of Time::HiRes 1582 # probe for availability of Time::HiRes
1502 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1583 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1503 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1584 *time = sub { Time::HiRes::time () };
1504 *AE::time = \&Time::HiRes::time; 1585 *AE::time = \& Time::HiRes::time ;
1586 *now = \&time;
1587 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1505 # if (eval "use POSIX (); (POSIX::times())... 1588 # if (eval "use POSIX (); (POSIX::times())...
1506 } else { 1589 } else {
1590 *time = sub { CORE::time };
1591 *AE::time = sub (){ CORE::time };
1592 *now = \&time;
1507 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1593 AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1508 *AE::time = sub (){ time }; # epic fail
1509 } 1594 }
1510
1511 *time = sub { AE::time }; # different prototypes
1512 }; 1595 };
1513 die if $@; 1596 die if $@;
1514 1597
1515 &time 1598 &time
1516} 1599}
1517 1600
1518*now = \&time; 1601*now = \&time;
1519
1520sub now_update { } 1602sub now_update { }
1521 1603
1522sub _poll { 1604sub _poll {
1523 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; 1605 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1524} 1606}
… …
1610 1692
1611sub signal { 1693sub signal {
1612 eval q{ # poor man's autoloading {} 1694 eval q{ # poor man's autoloading {}
1613 # probe for availability of Async::Interrupt 1695 # probe for availability of Async::Interrupt
1614 if (_have_async_interrupt) { 1696 if (_have_async_interrupt) {
1615 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1697 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1616 1698
1617 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1699 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1618 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1700 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1619 1701
1620 } else { 1702 } else {
1621 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1703 AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1622 1704
1623 if (AnyEvent::WIN32) { 1705 if (AnyEvent::WIN32) {
1624 require AnyEvent::Util; 1706 require AnyEvent::Util;
1625 1707
1626 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1708 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
… …
1920$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 2002$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1921so on. 2003so on.
1922 2004
1923=head1 ENVIRONMENT VARIABLES 2005=head1 ENVIRONMENT VARIABLES
1924 2006
1925The following environment variables are used by this module or its 2007AnyEvent supports a number of environment variables that tune the
1926submodules. 2008runtime behaviour. They are usually evaluated when AnyEvent is
2009loaded, initialised, or a submodule that uses them is loaded. Many of
2010them also cause AnyEvent to load additional modules - for example,
2011C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
2012loaded.
1927 2013
1928Note that AnyEvent will remove I<all> environment variables starting with 2014All the environment variables documented here start with
1929C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 2015C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1930enabled. 2016namespace. Other modules are encouraged (but by no means required) to use
2017C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
2018namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
2019be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
2020variables starting with C<AE_>, see below).
2021
2022All variables can also be set via the C<AE_> prefix, that is, instead
2023of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
2024case there is a clash btween anyevent and another program that uses
2025C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
2026variable to the empty string, as those variables take precedence.
2027
2028When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
2029to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
2030exists. If taint mode is on, then AnyEvent will remove I<all> environment
2031variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
2032with C<undef> or the empty string, if the corresaponding C<AE_> variable
2033is set).
2034
2035The exact algorithm is currently:
2036
2037 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
2038 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
2039 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
2040
2041This ensures that child processes will not see the C<AE_> variables.
2042
2043The following environment variables are currently known to AnyEvent:
1931 2044
1932=over 4 2045=over 4
1933 2046
1934=item C<PERL_ANYEVENT_VERBOSE> 2047=item C<PERL_ANYEVENT_VERBOSE>
1935 2048
1936By default, AnyEvent will be completely silent except in fatal 2049By default, AnyEvent will only log messages with loglevel C<3>
1937conditions. You can set this environment variable to make AnyEvent more 2050(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
2051environment variable to a numerical loglevel to make AnyEvent more (or
1938talkative. 2052less) talkative.
1939 2053
2054If you want to do more than just set the global logging level
2055you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2056complex specifications.
2057
2058When set to C<0> (C<off>), then no messages whatsoever will be logged with
2059the default logging settings.
2060
1940When set to C<1> or higher, causes AnyEvent to warn about unexpected 2061When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1941conditions, such as not being able to load the event model specified by 2062unexpected conditions, such as not being able to load the event model
1942C<PERL_ANYEVENT_MODEL>. 2063specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
2064exception - this is the minimum recommended level.
1943 2065
1944When set to C<2> or higher, cause AnyEvent to report to STDERR which event 2066When set to C<7> or higher (info), cause AnyEvent to report which event model it
1945model it chooses. 2067chooses.
1946 2068
1947When set to C<8> or higher, then AnyEvent will report extra information on 2069When set to C<8> or higher (debug), then AnyEvent will report extra information on
1948which optional modules it loads and how it implements certain features. 2070which optional modules it loads and how it implements certain features.
2071
2072=item C<PERL_ANYEVENT_LOG>
2073
2074Accepts rather complex logging specifications. For example, you could log
2075all C<debug> messages of some module to stderr, warnings and above to
2076stderr, and errors and above to syslog, with:
2077
2078 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
2079
2080For the rather extensive details, see L<AnyEvent::Log>.
2081
2082This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2083so will take effect even before AnyEvent has initialised itself.
2084
2085Note that specifying this environment variable causes the L<AnyEvent::Log>
2086module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2087using the latter saves a few hundred kB of memory until the first message
2088is being logged.
1949 2089
1950=item C<PERL_ANYEVENT_STRICT> 2090=item C<PERL_ANYEVENT_STRICT>
1951 2091
1952AnyEvent does not do much argument checking by default, as thorough 2092AnyEvent does not do much argument checking by default, as thorough
1953argument checking is very costly. Setting this variable to a true value 2093argument checking is very costly. Setting this variable to a true value
… …
1967If this env variable is set, then its contents will be interpreted by 2107If this env variable is set, then its contents will be interpreted by
1968C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of 2108C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
1969C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on 2109C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
1970that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>. 2110that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
1971 2111
1972This takes place when the first watcher is created. 2112This happens when the first watcher is created.
1973 2113
1974For example, to bind a debug shell on a unix domain socket in 2114For example, to bind a debug shell on a unix domain socket in
1975F<< /tmp/debug<pid>.sock >>, you could use this: 2115F<< /tmp/debug<pid>.sock >>, you could use this:
1976 2116
1977 PERL_ANYEVENT_DEBUG_SHELL=unix/:/tmp/debug\$\$.sock perlprog 2117 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
1978 2118
1979Note that creating sockets in F</tmp> is very unsafe on multiuser 2119Note that creating sockets in F</tmp> is very unsafe on multiuser
1980systems. 2120systems.
1981 2121
1982=item C<PERL_ANYEVENT_DEBUG_WRAP> 2122=item C<PERL_ANYEVENT_DEBUG_WRAP>
… …
2023but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 2163but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
2024- only support IPv4, never try to resolve or contact IPv6 2164- only support IPv4, never try to resolve or contact IPv6
2025addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2165addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
2026IPv6, but prefer IPv6 over IPv4. 2166IPv6, but prefer IPv6 over IPv4.
2027 2167
2168=item C<PERL_ANYEVENT_HOSTS>
2169
2170This variable, if specified, overrides the F</etc/hosts> file used by
2171L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2172from that file instead.
2173
2028=item C<PERL_ANYEVENT_EDNS0> 2174=item C<PERL_ANYEVENT_EDNS0>
2029 2175
2030Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension 2176Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
2031for DNS. This extension is generally useful to reduce DNS traffic, but 2177DNS. This extension is generally useful to reduce DNS traffic, especially
2032some (broken) firewalls drop such DNS packets, which is why it is off by 2178when DNSSEC is involved, but some (broken) firewalls drop such DNS
2033default. 2179packets, which is why it is off by default.
2034 2180
2035Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce 2181Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
2036EDNS0 in its DNS requests. 2182EDNS0 in its DNS requests.
2037 2183
2038=item C<PERL_ANYEVENT_MAX_FORKS> 2184=item C<PERL_ANYEVENT_MAX_FORKS>
… …
2046resolver - this is the maximum number of parallel DNS requests that are 2192resolver - this is the maximum number of parallel DNS requests that are
2047sent to the DNS server. 2193sent to the DNS server.
2048 2194
2049=item C<PERL_ANYEVENT_RESOLV_CONF> 2195=item C<PERL_ANYEVENT_RESOLV_CONF>
2050 2196
2051The file to use instead of F</etc/resolv.conf> (or OS-specific 2197The absolute path to a F<resolv.conf>-style file to use instead of
2052configuration) in the default resolver. When set to the empty string, no 2198F</etc/resolv.conf> (or the OS-specific configuration) in the default
2053default config will be used. 2199resolver, or the empty string to select the default configuration.
2054 2200
2055=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. 2201=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
2056 2202
2057When neither C<ca_file> nor C<ca_path> was specified during 2203When neither C<ca_file> nor C<ca_path> was specified during
2058L<AnyEvent::TLS> context creation, and either of these environment 2204L<AnyEvent::TLS> context creation, and either of these environment
2059variables exist, they will be used to specify CA certificate locations 2205variables are nonempty, they will be used to specify CA certificate
2060instead of a system-dependent default. 2206locations instead of a system-dependent default.
2061 2207
2062=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> 2208=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
2063 2209
2064When these are set to C<1>, then the respective modules are not 2210When these are set to C<1>, then the respective modules are not
2065loaded. Mostly good for testing AnyEvent itself. 2211loaded. Mostly good for testing AnyEvent itself.
… …
2397(even when used without AnyEvent), but most event loops have acceptable 2543(even when used without AnyEvent), but most event loops have acceptable
2398performance with or without AnyEvent. 2544performance with or without AnyEvent.
2399 2545
2400=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2546=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2401the actual event loop, only with extremely fast event loops such as EV 2547the actual event loop, only with extremely fast event loops such as EV
2402adds AnyEvent significant overhead. 2548does AnyEvent add significant overhead.
2403 2549
2404=item * You should avoid POE like the plague if you want performance or 2550=item * You should avoid POE like the plague if you want performance or
2405reasonable memory usage. 2551reasonable memory usage.
2406 2552
2407=back 2553=back
… …
2782 2928
2783Tutorial/Introduction: L<AnyEvent::Intro>. 2929Tutorial/Introduction: L<AnyEvent::Intro>.
2784 2930
2785FAQ: L<AnyEvent::FAQ>. 2931FAQ: L<AnyEvent::FAQ>.
2786 2932
2787Utility functions: L<AnyEvent::Util>. 2933Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2934(simply logging).
2788 2935
2936Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2937L<AnyEvent::Debug> (interactive shell, watcher tracing).
2938
2789Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>, 2939Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2790L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2940L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
2941L<Qt>, L<POE>, L<FLTK>.
2791 2942
2792Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2943Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2793L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2944L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2794L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2945L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2795L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2946L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
2947L<AnyEvent::Impl::FLTK>.
2796 2948
2797Non-blocking file handles, sockets, TCP clients and 2949Non-blocking handles, pipes, stream sockets, TCP clients and
2798servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2950servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2799 2951
2800Asynchronous DNS: L<AnyEvent::DNS>. 2952Asynchronous DNS: L<AnyEvent::DNS>.
2801 2953
2802Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 2954Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.

Diff Legend

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