ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.354 by root, Thu Aug 11 21:26:39 2011 UTC vs.
Revision 1.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::FLTK based on FLTK. 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 $AUTOLOAD;
1211our @ISA; 1242our @ISA;
1212
1213our @REGISTRY; 1243our @REGISTRY;
1214
1215our $VERBOSE; 1244our $VERBOSE;
1245our $MAX_SIGNAL_LATENCY = 10;
1246our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1216 1247
1217BEGIN { 1248BEGIN {
1218 require "AnyEvent/constants.pl"; 1249 require "AnyEvent/constants.pl";
1219 1250
1220 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1251 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1221 1252
1222 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1253 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1223 if ${^TAINT}; 1254 if ${^TAINT};
1224 1255
1225 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1256 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1257 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1226 1258
1227} 1259 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1260 if ${^TAINT};
1228 1261
1229our $MAX_SIGNAL_LATENCY = 10; 1262 # $ENV{PERL_ANYEVENT_xxx} now valid
1230 1263
1231our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1264 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 3;
1232 1265
1233{
1234 my $idx; 1266 my $idx;
1235 $PROTOCOL{$_} = ++$idx 1267 $PROTOCOL{$_} = ++$idx
1236 for reverse split /\s*,\s*/, 1268 for reverse split /\s*,\s*/,
1237 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1269 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1238} 1270}
1239 1271
1272our @post_detect;
1273
1274sub post_detect(&) {
1275 my ($cb) = @_;
1276
1277 push @post_detect, $cb;
1278
1279 defined wantarray
1280 ? bless \$cb, "AnyEvent::Util::postdetect"
1281 : ()
1282}
1283
1284sub AnyEvent::Util::postdetect::DESTROY {
1285 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1286}
1287
1288our $POSTPONE_W;
1289our @POSTPONE;
1290
1291sub _postpone_exec {
1292 undef $POSTPONE_W;
1293
1294 &{ shift @POSTPONE }
1295 while @POSTPONE;
1296}
1297
1298sub postpone(&) {
1299 push @POSTPONE, shift;
1300
1301 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1302
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
1319}
1320
1240my @models = ( 1321our @models = (
1241 [EV:: => AnyEvent::Impl::EV:: , 1], 1322 [EV:: => AnyEvent::Impl::EV:: , 1],
1242 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], 1323 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1243 # everything below here will not (normally) be autoprobed 1324 # everything below here will not (normally) be autoprobed
1244 # as the pure perl backend should work everywhere 1325 # as the pure perl backend should work everywhere
1245 # and is usually faster 1326 # and is usually faster
1250 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1331 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1251 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1332 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1252 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1333 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1253 [Wx:: => AnyEvent::Impl::POE::], 1334 [Wx:: => AnyEvent::Impl::POE::],
1254 [Prima:: => AnyEvent::Impl::POE::], 1335 [Prima:: => AnyEvent::Impl::POE::],
1255 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], 1336 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1256 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1337 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1257 [FLTK:: => AnyEvent::Impl::FLTK::], 1338 [FLTK:: => AnyEvent::Impl::FLTK::],
1258); 1339);
1259 1340
1260our %method = map +($_ => 1), 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}
1361
1362# all autoloaded methods reserve the complete glob, not just the method slot.
1363# due to bugs in perls method cache implementation.
1261 qw(io timer time now now_update signal child idle condvar DESTROY); 1364our @methods = qw(io timer time now now_update signal child idle condvar);
1262
1263our @post_detect;
1264
1265sub post_detect(&) {
1266 my ($cb) = @_;
1267
1268 push @post_detect, $cb;
1269
1270 defined wantarray
1271 ? bless \$cb, "AnyEvent::Util::postdetect"
1272 : ()
1273}
1274
1275sub AnyEvent::Util::postdetect::DESTROY {
1276 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1277}
1278 1365
1279sub detect() { 1366sub detect() {
1367 return $MODEL if $MODEL; # some programs keep references to detect
1368
1369 local $!; # for good measure
1370 local $SIG{__DIE__}; # we use eval
1371
1280 # free some memory 1372 # free some memory
1281 *detect = sub () { $MODEL }; 1373 *detect = sub () { $MODEL };
1374 # undef &func doesn't correctly update the method cache. grmbl.
1375 # so we delete the whole glob. grmbl.
1376 # otoh, perl doesn't let me undef an active usb, but it lets me free
1377 # a glob with an active sub. hrm. i hope it works, but perl is
1378 # usually buggy in this department. sigh.
1379 delete @{"AnyEvent::"}{@methods};
1380 undef @methods;
1282 1381
1283 local $!; # for good measure
1284 local $SIG{__DIE__};
1285
1286 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1382 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1287 my $model = "AnyEvent::Impl::$1"; 1383 my $model = $1;
1384 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1288 if (eval "require $model") { 1385 if (eval "require $model") {
1386 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1289 $MODEL = $model; 1387 $MODEL = $model;
1290 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1291 } else { 1388 } else {
1292 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$@";
1293 } 1390 }
1294 } 1391 }
1295 1392
1296 # check for already loaded models 1393 # check for already loaded models
1297 unless ($MODEL) { 1394 unless ($MODEL) {
1298 for (@REGISTRY, @models) { 1395 for (@REGISTRY, @models) {
1299 my ($package, $model) = @$_; 1396 my ($package, $model) = @$_;
1300 if (${"$package\::VERSION"} > 0) { 1397 if (${"$package\::VERSION"} > 0) {
1301 if (eval "require $model") { 1398 if (eval "require $model") {
1399 AnyEvent::log 7 => "autodetected model '$model', using it.";
1302 $MODEL = $model; 1400 $MODEL = $model;
1303 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1304 last; 1401 last;
1305 } 1402 }
1306 } 1403 }
1307 } 1404 }
1308 1405
1314 $autoload 1411 $autoload
1315 and eval "require $package" 1412 and eval "require $package"
1316 and ${"$package\::VERSION"} > 0 1413 and ${"$package\::VERSION"} > 0
1317 and eval "require $model" 1414 and eval "require $model"
1318 ) { 1415 ) {
1416 AnyEvent::log 7 => "autoloaded model '$model', using it.";
1319 $MODEL = $model; 1417 $MODEL = $model;
1320 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1321 last; 1418 last;
1322 } 1419 }
1323 } 1420 }
1324 1421
1325 $MODEL 1422 $MODEL
1326 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; 1423 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1327 } 1424 }
1328 } 1425 }
1329 1426
1330 @models = (); # free probe data 1427 # free memory only needed for probing
1428 undef @models;
1429 undef @REGISTRY;
1331 1430
1332 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1431 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1333 unshift @ISA, $MODEL;
1334 1432
1335 # now nuke some methods that are overridden by the backend. 1433 # now nuke some methods that are overridden by the backend.
1336 # SUPER is not allowed. 1434 # SUPER usage is not allowed in these.
1337 for (qw(time signal child idle)) { 1435 for (qw(time signal child idle)) {
1338 undef &{"AnyEvent::Base::$_"} 1436 undef &{"AnyEvent::Base::$_"}
1339 if defined &{"$MODEL\::$_"}; 1437 if defined &{"$MODEL\::$_"};
1340 } 1438 }
1341 1439
1440 _isa_set;
1441
1442 # we're officially open!
1443
1342 if ($ENV{PERL_ANYEVENT_STRICT}) { 1444 if ($ENV{PERL_ANYEVENT_STRICT}) {
1343 eval { require AnyEvent::Strict }; 1445 require AnyEvent::Strict;
1344 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1345 if $@ && $VERBOSE;
1346 } 1446 }
1347 1447
1448 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1449 require AnyEvent::Debug;
1450 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1451 }
1452
1453 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1454 require AnyEvent::Socket;
1455 require AnyEvent::Debug;
1456
1457 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1458 $shell =~ s/\$\$/$$/g;
1459
1460 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1461 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
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
1466
1348 (shift @post_detect)->() while @post_detect; 1467 (shift @post_detect)->() while @post_detect;
1468 undef @post_detect;
1349 1469
1350 *post_detect = sub(&) { 1470 *post_detect = sub(&) {
1351 shift->(); 1471 shift->();
1352 1472
1353 undef 1473 undef
1354 }; 1474 };
1355 1475
1356 $MODEL 1476 $MODEL
1357} 1477}
1358 1478
1359sub AUTOLOAD { 1479for my $name (@methods) {
1360 (my $func = $AUTOLOAD) =~ s/.*://; 1480 *$name = sub {
1361
1362 $method{$func}
1363 or Carp::croak "$func: not a valid AnyEvent class method";
1364
1365 detect; 1481 detect;
1366 1482 # we use goto because
1367 my $class = shift; 1483 # a) it makes the thunk more transparent
1368 $class->$func (@_); 1484 # b) it allows us to delete the thunk later
1369} 1485 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1370 1486 };
1371our $POSTPONE_W;
1372our @POSTPONE;
1373
1374sub _postpone_exec {
1375 undef $POSTPONE_W;
1376 (pop @POSTPONE)->()
1377 while @POSTPONE;
1378}
1379
1380sub postpone(&) {
1381 push @POSTPONE, shift;
1382
1383 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1384
1385 ()
1386} 1487}
1387 1488
1388# utility function to dup a filehandle. this is used by many backends 1489# utility function to dup a filehandle. this is used by many backends
1389# to support binding more than one watcher per filehandle (they usually 1490# to support binding more than one watcher per filehandle (they usually
1390# allow only one watcher per fd, so we dup it to get a different one). 1491# allow only one watcher per fd, so we dup it to get a different one).
1414 1515
1415package AE; 1516package AE;
1416 1517
1417our $VERSION = $AnyEvent::VERSION; 1518our $VERSION = $AnyEvent::VERSION;
1418 1519
1520sub _reset() {
1521 eval q{
1419# fall back to the main API by default - backends and AnyEvent::Base 1522 # fall back to the main API by default - backends and AnyEvent::Base
1420# implementations can overwrite these. 1523 # implementations can overwrite these.
1421 1524
1422sub io($$$) { 1525 sub io($$$) {
1423 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1526 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1424} 1527 }
1425 1528
1426sub timer($$$) { 1529 sub timer($$$) {
1427 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1530 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1428} 1531 }
1429 1532
1430sub signal($$) { 1533 sub signal($$) {
1431 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1534 AnyEvent->signal (signal => $_[0], cb => $_[1])
1432} 1535 }
1433 1536
1434sub child($$) { 1537 sub child($$) {
1435 AnyEvent->child (pid => $_[0], cb => $_[1]) 1538 AnyEvent->child (pid => $_[0], cb => $_[1])
1436} 1539 }
1437 1540
1438sub idle($) { 1541 sub idle($) {
1439 AnyEvent->idle (cb => $_[0]) 1542 AnyEvent->idle (cb => $_[0]);
1440} 1543 }
1441 1544
1442sub cv(;&) { 1545 sub cv(;&) {
1443 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1546 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1444} 1547 }
1445 1548
1446sub now() { 1549 sub now() {
1447 AnyEvent->now 1550 AnyEvent->now
1448} 1551 }
1449 1552
1450sub now_update() { 1553 sub now_update() {
1451 AnyEvent->now_update 1554 AnyEvent->now_update
1452} 1555 }
1453 1556
1454sub time() { 1557 sub time() {
1455 AnyEvent->time 1558 AnyEvent->time
1456} 1559 }
1457 1560
1458*postpone = \&AnyEvent::postpone; 1561 *postpone = \&AnyEvent::postpone;
1562 *log = \&AnyEvent::log;
1563 };
1564 die if $@;
1565}
1566
1567BEGIN { _reset }
1459 1568
1460package AnyEvent::Base; 1569package AnyEvent::Base;
1461 1570
1462# default implementations for many methods 1571# default implementations for many methods
1463 1572
1464sub time { 1573sub time {
1465 eval q{ # poor man's autoloading {} 1574 eval q{ # poor man's autoloading {}
1466 # probe for availability of Time::HiRes 1575 # probe for availability of Time::HiRes
1467 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1576 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1468 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1577 *time = sub { Time::HiRes::time () };
1469 *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.";
1470 # if (eval "use POSIX (); (POSIX::times())... 1581 # if (eval "use POSIX (); (POSIX::times())...
1471 } else { 1582 } else {
1583 *time = sub { CORE::time };
1584 *AE::time = sub (){ CORE::time };
1585 *now = \&time;
1472 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!";
1473 *AE::time = sub (){ time }; # epic fail
1474 } 1587 }
1475
1476 *time = sub { AE::time }; # different prototypes
1477 }; 1588 };
1478 die if $@; 1589 die if $@;
1479 1590
1480 &time 1591 &time
1481} 1592}
1482 1593
1483*now = \&time; 1594*now = \&time;
1484
1485sub now_update { } 1595sub now_update { }
1486 1596
1487sub _poll { 1597sub _poll {
1488 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; 1598 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1489} 1599}
1575 1685
1576sub signal { 1686sub signal {
1577 eval q{ # poor man's autoloading {} 1687 eval q{ # poor man's autoloading {}
1578 # probe for availability of Async::Interrupt 1688 # probe for availability of Async::Interrupt
1579 if (_have_async_interrupt) { 1689 if (_have_async_interrupt) {
1580 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.";
1581 1691
1582 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1692 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1583 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1693 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1584 1694
1585 } else { 1695 } else {
1586 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.";
1587 1697
1588 if (AnyEvent::WIN32) { 1698 if (AnyEvent::WIN32) {
1589 require AnyEvent::Util; 1699 require AnyEvent::Util;
1590 1700
1591 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1701 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1667 : sysread $SIGPIPE_R, (my $dummy), 9; 1777 : sysread $SIGPIPE_R, (my $dummy), 9;
1668 1778
1669 while (%SIG_EV) { 1779 while (%SIG_EV) {
1670 for (keys %SIG_EV) { 1780 for (keys %SIG_EV) {
1671 delete $SIG_EV{$_}; 1781 delete $SIG_EV{$_};
1672 $_->() for values %{ $SIG_CB{$_} || {} }; 1782 &$_ for values %{ $SIG_CB{$_} || {} };
1673 } 1783 }
1674 } 1784 }
1675 }; 1785 };
1676 }; 1786 };
1677 die if $@; 1787 die if $@;
1744 1854
1745 my ($cb, $w, $rcb) = $arg{cb}; 1855 my ($cb, $w, $rcb) = $arg{cb};
1746 1856
1747 $rcb = sub { 1857 $rcb = sub {
1748 if ($cb) { 1858 if ($cb) {
1749 $w = _time; 1859 $w = AE::time;
1750 &$cb; 1860 &$cb;
1751 $w = _time - $w; 1861 $w = AE::time - $w;
1752 1862
1753 # never use more then 50% of the time for the idle watcher, 1863 # never use more then 50% of the time for the idle watcher,
1754 # within some limits 1864 # within some limits
1755 $w = 0.0001 if $w < 0.0001; 1865 $w = 0.0001 if $w < 0.0001;
1756 $w = 5 if $w > 5; 1866 $w = 5 if $w > 5;
1885$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 1995$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1886so on. 1996so on.
1887 1997
1888=head1 ENVIRONMENT VARIABLES 1998=head1 ENVIRONMENT VARIABLES
1889 1999
1890The following environment variables are used by this module or its 2000AnyEvent supports a number of environment variables that tune the
1891submodules. 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.
1892 2006
1893Note that AnyEvent will remove I<all> environment variables starting with 2007All the environment variables documented here start with
1894C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 2008C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1895enabled. 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:
1896 2037
1897=over 4 2038=over 4
1898 2039
1899=item C<PERL_ANYEVENT_VERBOSE> 2040=item C<PERL_ANYEVENT_VERBOSE>
1900 2041
1901By default, AnyEvent will be completely silent except in fatal 2042By default, AnyEvent will only log messages with loglevel C<3>
1902conditions. 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
1903talkative. 2045less) talkative.
1904 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
1905When 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
1906conditions, such as not being able to load the event model specified by 2055unexpected conditions, such as not being able to load the event model
1907C<PERL_ANYEVENT_MODEL>. 2056specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
2057exception - this is the minimum recommended level.
1908 2058
1909When 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
1910model it chooses. 2060chooses.
1911 2061
1912When 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
1913which 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.
1914 2082
1915=item C<PERL_ANYEVENT_STRICT> 2083=item C<PERL_ANYEVENT_STRICT>
1916 2084
1917AnyEvent does not do much argument checking by default, as thorough 2085AnyEvent does not do much argument checking by default, as thorough
1918argument checking is very costly. Setting this variable to a true value 2086argument checking is very costly. Setting this variable to a true value
1925Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> 2093Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1926>>, it is definitely recommended to keep it off in production. Keeping 2094>>, it is definitely recommended to keep it off in production. Keeping
1927C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2095C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1928can be very useful, however. 2096can be very useful, however.
1929 2097
2098=item C<PERL_ANYEVENT_DEBUG_SHELL>
2099
2100If this env variable is set, then its contents will be interpreted by
2101C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
2102C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
2103that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
2104
2105This happens when the first watcher is created.
2106
2107For example, to bind a debug shell on a unix domain socket in
2108F<< /tmp/debug<pid>.sock >>, you could use this:
2109
2110 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2111
2112Note that creating sockets in F</tmp> is very unsafe on multiuser
2113systems.
2114
2115=item C<PERL_ANYEVENT_DEBUG_WRAP>
2116
2117Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2118debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2119
1930=item C<PERL_ANYEVENT_MODEL> 2120=item C<PERL_ANYEVENT_MODEL>
1931 2121
1932This can be used to specify the event model to be used by AnyEvent, before 2122This can be used to specify the event model to be used by AnyEvent, before
1933auto detection and -probing kicks in. It must be a string consisting 2123auto detection and -probing kicks in.
1934entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2124
2125It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2126or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1935and the resulting module name is loaded and if the load was successful, 2127resulting module name is loaded and - if the load was successful - used as
1936used as event model. If it fails to load AnyEvent will proceed with 2128event model backend. If it fails to load then AnyEvent will proceed with
1937auto detection and -probing. 2129auto detection and -probing.
1938 2130
1939This functionality might change in future versions. 2131If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2132nothing gets prepended and the module name is used as-is (hint: C<::> at
2133the end of a string designates a module name and quotes it appropriately).
1940 2134
1941For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you 2135For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1942could start your program like this: 2136could start your program like this:
1943 2137
1944 PERL_ANYEVENT_MODEL=Perl perl ... 2138 PERL_ANYEVENT_MODEL=Perl perl ...
1962but 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>
1963- only support IPv4, never try to resolve or contact IPv6 2157- only support IPv4, never try to resolve or contact IPv6
1964addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2158addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1965IPv6, but prefer IPv6 over IPv4. 2159IPv6, but prefer IPv6 over IPv4.
1966 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
1967=item C<PERL_ANYEVENT_EDNS0> 2167=item C<PERL_ANYEVENT_EDNS0>
1968 2168
1969Used 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
1970for DNS. This extension is generally useful to reduce DNS traffic, but 2170DNS. This extension is generally useful to reduce DNS traffic, especially
1971some (broken) firewalls drop such DNS packets, which is why it is off by 2171when DNSSEC is involved, but some (broken) firewalls drop such DNS
1972default. 2172packets, which is why it is off by default.
1973 2173
1974Setting 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
1975EDNS0 in its DNS requests. 2175EDNS0 in its DNS requests.
1976 2176
1977=item C<PERL_ANYEVENT_MAX_FORKS> 2177=item C<PERL_ANYEVENT_MAX_FORKS>
1985resolver - this is the maximum number of parallel DNS requests that are 2185resolver - this is the maximum number of parallel DNS requests that are
1986sent to the DNS server. 2186sent to the DNS server.
1987 2187
1988=item C<PERL_ANYEVENT_RESOLV_CONF> 2188=item C<PERL_ANYEVENT_RESOLV_CONF>
1989 2189
1990The 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
1991configuration) in the default resolver. When set to the empty string, no 2191F</etc/resolv.conf> (or the OS-specific configuration) in the default
1992default config will be used. 2192resolver, or the empty string to select the default configuration.
1993 2193
1994=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. 2194=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1995 2195
1996When neither C<ca_file> nor C<ca_path> was specified during 2196When neither C<ca_file> nor C<ca_path> was specified during
1997L<AnyEvent::TLS> context creation, and either of these environment 2197L<AnyEvent::TLS> context creation, and either of these environment
1998variables exist, they will be used to specify CA certificate locations 2198variables are nonempty, they will be used to specify CA certificate
1999instead of a system-dependent default. 2199locations instead of a system-dependent default.
2000 2200
2001=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>
2002 2202
2003When 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
2004loaded. Mostly good for testing AnyEvent itself. 2204loaded. Mostly good for testing AnyEvent itself.
2336(even when used without AnyEvent), but most event loops have acceptable 2536(even when used without AnyEvent), but most event loops have acceptable
2337performance with or without AnyEvent. 2537performance with or without AnyEvent.
2338 2538
2339=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
2340the 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
2341adds AnyEvent significant overhead. 2541does AnyEvent add significant overhead.
2342 2542
2343=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
2344reasonable memory usage. 2544reasonable memory usage.
2345 2545
2346=back 2546=back
2721 2921
2722Tutorial/Introduction: L<AnyEvent::Intro>. 2922Tutorial/Introduction: L<AnyEvent::Intro>.
2723 2923
2724FAQ: L<AnyEvent::FAQ>. 2924FAQ: L<AnyEvent::FAQ>.
2725 2925
2726Utility functions: L<AnyEvent::Util>. 2926Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2927(simply logging).
2727 2928
2929Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2930L<AnyEvent::Debug> (interactive shell, watcher tracing).
2931
2728Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>, 2932Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2729L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2933L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
2934L<Qt>, L<POE>, L<FLTK>.
2730 2935
2731Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2936Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2732L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2937L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2733L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2938L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2734L<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>.
2735 2941
2736Non-blocking file handles, sockets, TCP clients and 2942Non-blocking handles, pipes, stream sockets, TCP clients and
2737servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2943servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2738 2944
2739Asynchronous DNS: L<AnyEvent::DNS>. 2945Asynchronous DNS: L<AnyEvent::DNS>.
2740 2946
2741Thread 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