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.343 by root, Wed Dec 29 04:27:53 2010 UTC vs.
Revision 1.373 by root, Thu Aug 25 03:08:48 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
121The interface itself is vaguely similar, but not identical to the L<Event> 121The interface itself is vaguely similar, but not identical to the L<Event>
122module. 122module.
123 123
124During the first call of any watcher-creation method, the module tries 124During the first call of any watcher-creation method, the module tries
125to detect the currently loaded event loop by probing whether one of the 125to detect the currently loaded event loop by probing whether one of the
126following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>, 126following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
127L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one 127L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
128found is used. If none are detected, the module tries to load the first 128found is used. If none are detected, the module tries to load the first
129four modules in the order given; but note that if L<EV> is not 129four modules in the order given; but note that if L<EV> is not
130available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so 130available, the pure-perl L<AnyEvent::Loop> should always work, so
131the other two are not normally tried. 131the other two are not normally tried.
132 132
133Because AnyEvent first checks for modules that are already loaded, loading 133Because AnyEvent first checks for modules that are already loaded, loading
134an event model explicitly before first using AnyEvent will likely make 134an event model explicitly before first using AnyEvent will likely make
135that model the default. For example: 135that model the default. For example:
142The I<likely> means that, if any module loads another event model and 142The I<likely> means that, if any module loads another event model and
143starts using it, all bets are off - this case should be very rare though, 143starts using it, all bets are off - this case should be very rare though,
144as very few modules hardcode event loops without announcing this very 144as very few modules hardcode event loops without announcing this very
145loudly. 145loudly.
146 146
147The pure-perl implementation of AnyEvent is called 147The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
148C<AnyEvent::Impl::Perl>. Like other event modules you can load it 148other event modules you can load it explicitly and enjoy the high
149explicitly and enjoy the high availability of that event loop :) 149availability of that event loop :)
150 150
151=head1 WATCHERS 151=head1 WATCHERS
152 152
153AnyEvent has the central concept of a I<watcher>, which is an object that 153AnyEvent has the central concept of a I<watcher>, which is an object that
154stores relevant data for each kind of event you are waiting for, such as 154stores relevant data for each kind of event you are waiting for, such as
356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
357account. 357account.
358 358
359=item AnyEvent->now_update 359=item AnyEvent->now_update
360 360
361Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache 361Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current
362the current time for each loop iteration (see the discussion of L<< 362time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
363AnyEvent->now >>, above). 363above).
364 364
365When a callback runs for a long time (or when the process sleeps), then 365When a callback runs for a long time (or when the process sleeps), then
366this "current" time will differ substantially from the real time, which 366this "current" time will differ substantially from the real time, which
367might affect timers and time-outs. 367might affect timers and time-outs.
368 368
482thing in an AnyEvent program, you I<have> to create at least one 482thing in an AnyEvent program, you I<have> to create at least one
483watcher before you C<fork> the child (alternatively, you can call 483watcher before you C<fork> the child (alternatively, you can call
484C<AnyEvent::detect>). 484C<AnyEvent::detect>).
485 485
486As most event loops do not support waiting for child events, they will be 486As most event loops do not support waiting for child events, they will be
487emulated by AnyEvent in most cases, in which the latency and race problems 487emulated by AnyEvent in most cases, in which case the latency and race
488mentioned in the description of signal watchers apply. 488problems mentioned in the description of signal watchers apply.
489 489
490Example: fork a process and wait for it 490Example: fork a process and wait for it
491 491
492 my $done = AnyEvent->condvar; 492 my $done = AnyEvent->condvar;
493 493
860use. If EV is not installed, then AnyEvent will fall back to its own 860use. If EV is not installed, then AnyEvent will fall back to its own
861pure-perl implementation, which is available everywhere as it comes with 861pure-perl implementation, which is available everywhere as it comes with
862AnyEvent itself. 862AnyEvent itself.
863 863
864 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 864 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
865 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 865 AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
866 866
867=item Backends that are transparently being picked up when they are used. 867=item Backends that are transparently being picked up when they are used.
868 868
869These will be used if they are already loaded when the first watcher 869These will be used if they are already loaded when the first watcher
870is created, in which case it is assumed that the application is using 870is created, in which case it is assumed that the application is using
877 AnyEvent::Impl::Tk based on Tk, very broken. 877 AnyEvent::Impl::Tk based on Tk, very broken.
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.
883 AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding).
882 884
883=item Backends with special needs. 885=item Backends with special needs.
884 886
885Qt requires the Qt::Application to be instantiated first, but will 887Qt requires the Qt::Application to be instantiated first, but will
886otherwise be picked up automatically. As long as the main program 888otherwise be picked up automatically. As long as the main program
931 933
932Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
933if necessary. You should only call this function right before you would 935if necessary. You should only call this function right before you would
934have 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
935runtime, 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).
936 942
937If you need to do some initialisation before AnyEvent watchers are 943If you need to do some initialisation before AnyEvent watchers are
938created, use C<post_detect>. 944created, use C<post_detect>.
939 945
940=item $guard = AnyEvent::post_detect { BLOCK } 946=item $guard = AnyEvent::post_detect { BLOCK }
1003 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent 1009 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1004 # as soon as it is 1010 # as soon as it is
1005 push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; 1011 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1006 } 1012 }
1007 1013
1014=item AnyEvent::postpone { BLOCK }
1015
1016Arranges for the block to be executed as soon as possible, but not before
1017the call itself returns. In practise, the block will be executed just
1018before the event loop polls for new events, or shortly afterwards.
1019
1020This function never returns anything (to make the C<return postpone { ...
1021}> idiom more useful.
1022
1023To understand the usefulness of this function, consider a function that
1024asynchronously does something for you and returns some transaction
1025object or guard to let you cancel the operation. For example,
1026C<AnyEvent::Socket::tcp_connect>:
1027
1028 # start a conenction attempt unless one is active
1029 $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
1030 delete $self->{connect_guard};
1031 ...
1032 };
1033
1034Imagine that this function could instantly call the callback, for
1035example, because it detects an obvious error such as a negative port
1036number. Invoking the callback before the function returns causes problems
1037however: the callback will be called and will try to delete the guard
1038object. But since the function hasn't returned yet, there is nothing to
1039delete. When the function eventually returns it will assign the guard
1040object to C<< $self->{connect_guard} >>, where it will likely never be
1041deleted, so the program thinks it is still trying to connect.
1042
1043This is where C<AnyEvent::postpone> should be used. Instead of calling the
1044callback directly on error:
1045
1046 $cb->(undef), return # signal error to callback, BAD!
1047 if $some_error_condition;
1048
1049It should use C<postpone>:
1050
1051 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1052 if $some_error_condition;
1053
1054=item AnyEvent::log $level, $msg[, @args]
1055
1056Log the given C<$msg> at the given C<$level>.
1057
1058Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> -
1059consequently, look at the L<AnyEvent::Log> documentation for details.
1060
1061If you want to sprinkle loads of logging calls around your code, consider
1062creating a logger callback with the C<AnyEvent::Log::logger> function.
1063
1008=back 1064=back
1009 1065
1010=head1 WHAT TO DO IN A MODULE 1066=head1 WHAT TO DO IN A MODULE
1011 1067
1012As a module author, you should C<use AnyEvent> and call AnyEvent methods 1068As a module author, you should C<use AnyEvent> and call AnyEvent methods
1045modules might create watchers when they are loaded, and AnyEvent will 1101modules might create watchers when they are loaded, and AnyEvent will
1046decide on the event model to use as soon as it creates watchers, and it 1102decide on the event model to use as soon as it creates watchers, and it
1047might choose the wrong one unless you load the correct one yourself. 1103might choose the wrong one unless you load the correct one yourself.
1048 1104
1049You can chose to use a pure-perl implementation by loading the 1105You can chose to use a pure-perl implementation by loading the
1050C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1106C<AnyEvent::Loop> module, which gives you similar behaviour
1051everywhere, but letting AnyEvent chose the model is generally better. 1107everywhere, but letting AnyEvent chose the model is generally better.
1052 1108
1053=head2 MAINLOOP EMULATION 1109=head2 MAINLOOP EMULATION
1054 1110
1055Sometimes (often for short test scripts, or even standalone programs who 1111Sometimes (often for short test scripts, or even standalone programs who
1068 1124
1069 1125
1070=head1 OTHER MODULES 1126=head1 OTHER MODULES
1071 1127
1072The following is a non-exhaustive list of additional modules that use 1128The following is a non-exhaustive list of additional modules that use
1073AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1129AnyEvent as a client and can therefore be mixed easily with other
1074modules and other event loops in the same program. Some of the modules 1130AnyEvent modules and other event loops in the same program. Some of the
1075come as part of AnyEvent, the others are available via CPAN. 1131modules come as part of AnyEvent, the others are available via CPAN (see
1132L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
1133a longer non-exhaustive list), and the list is heavily biased towards
1134modules of the AnyEvent author himself :)
1076 1135
1077=over 4 1136=over 4
1078 1137
1079=item L<AnyEvent::Util> 1138=item L<AnyEvent::Util>
1080 1139
1150 1209
1151package AnyEvent; 1210package AnyEvent;
1152 1211
1153# basically a tuned-down version of common::sense 1212# basically a tuned-down version of common::sense
1154sub common_sense { 1213sub common_sense {
1155 # from common:.sense 3.3 1214 # from common:.sense 3.4
1156 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00"; 1215 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1157 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) 1216 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1158 $^H |= 0x00000600; 1217 $^H |= 0x00000600;
1159} 1218}
1160 1219
1161BEGIN { AnyEvent::common_sense } 1220BEGIN { AnyEvent::common_sense }
1162 1221
1163use Carp (); 1222use Carp ();
1164 1223
1165our $VERSION = '5.29'; 1224our $VERSION = '6.01';
1166our $MODEL; 1225our $MODEL;
1167 1226
1168our $AUTOLOAD;
1169our @ISA; 1227our @ISA;
1170 1228
1171our @REGISTRY; 1229our @REGISTRY;
1172 1230
1173our $VERBOSE; 1231our $VERBOSE;
1178 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1236 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1179 1237
1180 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1238 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1181 if ${^TAINT}; 1239 if ${^TAINT};
1182 1240
1241 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1242 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1243
1244 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1245 if ${^TAINT};
1246
1183 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1247 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1184
1185} 1248}
1186 1249
1187our $MAX_SIGNAL_LATENCY = 10; 1250our $MAX_SIGNAL_LATENCY = 10;
1188 1251
1189our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1252our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1193 $PROTOCOL{$_} = ++$idx 1256 $PROTOCOL{$_} = ++$idx
1194 for reverse split /\s*,\s*/, 1257 for reverse split /\s*,\s*/,
1195 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1258 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1196} 1259}
1197 1260
1261our @post_detect;
1262
1263sub post_detect(&) {
1264 my ($cb) = @_;
1265
1266 push @post_detect, $cb;
1267
1268 defined wantarray
1269 ? bless \$cb, "AnyEvent::Util::postdetect"
1270 : ()
1271}
1272
1273sub AnyEvent::Util::postdetect::DESTROY {
1274 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1275}
1276
1277our $POSTPONE_W;
1278our @POSTPONE;
1279
1280sub _postpone_exec {
1281 undef $POSTPONE_W;
1282
1283 &{ shift @POSTPONE }
1284 while @POSTPONE;
1285}
1286
1287sub postpone(&) {
1288 push @POSTPONE, shift;
1289
1290 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1291
1292 ()
1293}
1294
1295sub log($$;@) {
1296 # only load the bug bloated module when we actually are about to log something
1297 if ($_[0] <= $VERBOSE) {
1298 require AnyEvent::Log;
1299 # AnyEvent::Log overwrites this function
1300 goto &log;
1301 }
1302}
1303
1304if (length $ENV{PERL_ANYEVENT_LOG}) {
1305 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1306}
1307
1198my @models = ( 1308our @models = (
1199 [EV:: => AnyEvent::Impl::EV:: , 1], 1309 [EV:: => AnyEvent::Impl::EV:: , 1],
1200 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1310 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1201 # everything below here will not (normally) be autoprobed 1311 # everything below here will not (normally) be autoprobed
1202 # as the pureperl backend should work everywhere 1312 # as the pure perl backend should work everywhere
1203 # and is usually faster 1313 # and is usually faster
1204 [Event:: => AnyEvent::Impl::Event::, 1], 1314 [Event:: => AnyEvent::Impl::Event::, 1],
1205 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1315 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1206 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1316 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1207 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1317 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1208 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1318 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1209 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1319 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1210 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1320 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1211 [Wx:: => AnyEvent::Impl::POE::], 1321 [Wx:: => AnyEvent::Impl::POE::],
1212 [Prima:: => AnyEvent::Impl::POE::], 1322 [Prima:: => AnyEvent::Impl::POE::],
1213 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], 1323 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1324 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1325 [FLTK:: => AnyEvent::Impl::FLTK2::],
1214); 1326);
1215 1327
1216our %method = map +($_ => 1), 1328our @isa_hook;
1329
1330sub _isa_set {
1331 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1332
1333 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1334 for 1 .. $#pkg;
1335
1336 grep $_ && $_->[1], @isa_hook
1337 and AE::_reset ();
1338}
1339
1340# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1341sub _isa_hook($$;$) {
1342 my ($i, $pkg, $reset_ae) = @_;
1343
1344 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1345
1346 _isa_set;
1347}
1348
1349# all autoloaded methods reserve the complete glob, not just the method slot.
1350# due to bugs in perls method cache implementation.
1217 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1351our @methods = qw(io timer time now now_update signal child idle condvar);
1218
1219our @post_detect;
1220
1221sub post_detect(&) {
1222 my ($cb) = @_;
1223
1224 push @post_detect, $cb;
1225
1226 defined wantarray
1227 ? bless \$cb, "AnyEvent::Util::postdetect"
1228 : ()
1229}
1230
1231sub AnyEvent::Util::postdetect::DESTROY {
1232 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1233}
1234 1352
1235sub detect() { 1353sub detect() {
1354 return $MODEL if $MODEL; # some programs keep references to detect
1355
1356 local $!; # for good measure
1357 local $SIG{__DIE__}; # we use eval
1358
1236 # free some memory 1359 # free some memory
1237 *detect = sub () { $MODEL }; 1360 *detect = sub () { $MODEL };
1361 # undef &func doesn't correctly update the method cache. grmbl.
1362 # so we delete the whole glob. grmbl.
1363 # otoh, perl doesn't let me undef an active usb, but it lets me free
1364 # a glob with an active sub. hrm. i hope it works, but perl is
1365 # usually buggy in this department. sigh.
1366 delete @{"AnyEvent::"}{@methods};
1367 undef @methods;
1238 1368
1239 local $!; # for good measure
1240 local $SIG{__DIE__};
1241
1242 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1369 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1243 my $model = "AnyEvent::Impl::$1"; 1370 my $model = $1;
1371 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1244 if (eval "require $model") { 1372 if (eval "require $model") {
1373 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1245 $MODEL = $model; 1374 $MODEL = $model;
1246 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1247 } else { 1375 } else {
1248 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1376 AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1249 } 1377 }
1250 } 1378 }
1251 1379
1252 # check for already loaded models 1380 # check for already loaded models
1253 unless ($MODEL) { 1381 unless ($MODEL) {
1254 for (@REGISTRY, @models) { 1382 for (@REGISTRY, @models) {
1255 my ($package, $model) = @$_; 1383 my ($package, $model) = @$_;
1256 if (${"$package\::VERSION"} > 0) { 1384 if (${"$package\::VERSION"} > 0) {
1257 if (eval "require $model") { 1385 if (eval "require $model") {
1386 AnyEvent::log 7 => "autodetected model '$model', using it.";
1258 $MODEL = $model; 1387 $MODEL = $model;
1259 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1260 last; 1388 last;
1261 } 1389 }
1262 } 1390 }
1263 } 1391 }
1264 1392
1270 $autoload 1398 $autoload
1271 and eval "require $package" 1399 and eval "require $package"
1272 and ${"$package\::VERSION"} > 0 1400 and ${"$package\::VERSION"} > 0
1273 and eval "require $model" 1401 and eval "require $model"
1274 ) { 1402 ) {
1403 AnyEvent::log 7 => "autoloaded model '$model', using it.";
1275 $MODEL = $model; 1404 $MODEL = $model;
1276 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1277 last; 1405 last;
1278 } 1406 }
1279 } 1407 }
1280 1408
1281 $MODEL 1409 $MODEL
1282 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; 1410 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1283 } 1411 }
1284 } 1412 }
1285 1413
1286 @models = (); # free probe data 1414 # free memory only needed for probing
1415 undef @models;
1416 undef @REGISTRY;
1287 1417
1288 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1418 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1289 unshift @ISA, $MODEL;
1290 1419
1291 # now nuke some methods that are overridden by the backend. 1420 # now nuke some methods that are overridden by the backend.
1292 # SUPER is not allowed. 1421 # SUPER usage is not allowed in these.
1293 for (qw(time signal child idle)) { 1422 for (qw(time signal child idle)) {
1294 undef &{"AnyEvent::Base::$_"} 1423 undef &{"AnyEvent::Base::$_"}
1295 if defined &{"$MODEL\::$_"}; 1424 if defined &{"$MODEL\::$_"};
1296 } 1425 }
1297 1426
1427 _isa_set;
1428
1429 # we're officially open!
1430
1298 if ($ENV{PERL_ANYEVENT_STRICT}) { 1431 if ($ENV{PERL_ANYEVENT_STRICT}) {
1299 eval { require AnyEvent::Strict }; 1432 require AnyEvent::Strict;
1300 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1301 if $@ && $VERBOSE;
1302 } 1433 }
1303 1434
1435 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1436 require AnyEvent::Debug;
1437 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1438 }
1439
1440 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1441 require AnyEvent::Socket;
1442 require AnyEvent::Debug;
1443
1444 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1445 $shell =~ s/\$\$/$$/g;
1446
1447 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1448 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1449 }
1450
1451 # now the anyevent environment is set up as the user told us to, so
1452 # call the actual user code - post detects
1453
1304 (shift @post_detect)->() while @post_detect; 1454 (shift @post_detect)->() while @post_detect;
1455 undef @post_detect;
1305 1456
1306 *post_detect = sub(&) { 1457 *post_detect = sub(&) {
1307 shift->(); 1458 shift->();
1308 1459
1309 undef 1460 undef
1310 }; 1461 };
1311 1462
1312 $MODEL 1463 $MODEL
1313} 1464}
1314 1465
1315sub AUTOLOAD { 1466for my $name (@methods) {
1316 (my $func = $AUTOLOAD) =~ s/.*://; 1467 *$name = sub {
1317
1318 $method{$func}
1319 or Carp::croak "$func: not a valid AnyEvent class method";
1320
1321 detect; 1468 detect;
1322 1469 # we use goto because
1323 my $class = shift; 1470 # a) it makes the thunk more transparent
1324 $class->$func (@_); 1471 # b) it allows us to delete the thunk later
1472 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1473 };
1325} 1474}
1326 1475
1327# utility function to dup a filehandle. this is used by many backends 1476# utility function to dup a filehandle. this is used by many backends
1328# to support binding more than one watcher per filehandle (they usually 1477# to support binding more than one watcher per filehandle (they usually
1329# allow only one watcher per fd, so we dup it to get a different one). 1478# allow only one watcher per fd, so we dup it to get a different one).
1353 1502
1354package AE; 1503package AE;
1355 1504
1356our $VERSION = $AnyEvent::VERSION; 1505our $VERSION = $AnyEvent::VERSION;
1357 1506
1507sub _reset() {
1508 eval q{
1358# fall back to the main API by default - backends and AnyEvent::Base 1509 # fall back to the main API by default - backends and AnyEvent::Base
1359# implementations can overwrite these. 1510 # implementations can overwrite these.
1360 1511
1361sub io($$$) { 1512 sub io($$$) {
1362 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1513 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1363} 1514 }
1364 1515
1365sub timer($$$) { 1516 sub timer($$$) {
1366 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1517 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1367} 1518 }
1368 1519
1369sub signal($$) { 1520 sub signal($$) {
1370 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1521 AnyEvent->signal (signal => $_[0], cb => $_[1])
1371} 1522 }
1372 1523
1373sub child($$) { 1524 sub child($$) {
1374 AnyEvent->child (pid => $_[0], cb => $_[1]) 1525 AnyEvent->child (pid => $_[0], cb => $_[1])
1375} 1526 }
1376 1527
1377sub idle($) { 1528 sub idle($) {
1378 AnyEvent->idle (cb => $_[0]) 1529 AnyEvent->idle (cb => $_[0]);
1379} 1530 }
1380 1531
1381sub cv(;&) { 1532 sub cv(;&) {
1382 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1533 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1383} 1534 }
1384 1535
1385sub now() { 1536 sub now() {
1386 AnyEvent->now 1537 AnyEvent->now
1387} 1538 }
1388 1539
1389sub now_update() { 1540 sub now_update() {
1390 AnyEvent->now_update 1541 AnyEvent->now_update
1391} 1542 }
1392 1543
1393sub time() { 1544 sub time() {
1394 AnyEvent->time 1545 AnyEvent->time
1546 }
1547
1548 *postpone = \&AnyEvent::postpone;
1549 *log = \&AnyEvent::log;
1550 };
1551 die if $@;
1395} 1552}
1553
1554BEGIN { _reset }
1396 1555
1397package AnyEvent::Base; 1556package AnyEvent::Base;
1398 1557
1399# default implementations for many methods 1558# default implementations for many methods
1400 1559
1401sub time { 1560sub time {
1402 eval q{ # poor man's autoloading {} 1561 eval q{ # poor man's autoloading {}
1403 # probe for availability of Time::HiRes 1562 # probe for availability of Time::HiRes
1404 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1563 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1405 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1564 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."
1565 if $AnyEvent::VERBOSE >= 8;
1566 *time = sub { Time::HiRes::time () };
1406 *AE::time = \&Time::HiRes::time; 1567 *AE::time = \& Time::HiRes::time ;
1407 # if (eval "use POSIX (); (POSIX::times())... 1568 # if (eval "use POSIX (); (POSIX::times())...
1408 } else { 1569 } else {
1409 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1570 AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
1571 *time = sub { CORE::time };
1410 *AE::time = sub (){ time }; # epic fail 1572 *AE::time = sub (){ CORE::time };
1411 } 1573 }
1412 1574
1413 *time = sub { AE::time }; # different prototypes 1575 *now = \&time;
1414 }; 1576 };
1415 die if $@; 1577 die if $@;
1416 1578
1417 &time 1579 &time
1418} 1580}
1419 1581
1420*now = \&time; 1582*now = \&time;
1421
1422sub now_update { } 1583sub now_update { }
1423 1584
1585sub _poll {
1586 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1587}
1588
1424# default implementation for ->condvar 1589# default implementation for ->condvar
1590# in fact, the default should not be overwritten
1425 1591
1426sub condvar { 1592sub condvar {
1427 eval q{ # poor man's autoloading {} 1593 eval q{ # poor man's autoloading {}
1428 *condvar = sub { 1594 *condvar = sub {
1429 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1595 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1507 1673
1508sub signal { 1674sub signal {
1509 eval q{ # poor man's autoloading {} 1675 eval q{ # poor man's autoloading {}
1510 # probe for availability of Async::Interrupt 1676 # probe for availability of Async::Interrupt
1511 if (_have_async_interrupt) { 1677 if (_have_async_interrupt) {
1512 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1678 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."
1679 if $AnyEvent::VERBOSE >= 8;
1513 1680
1514 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1681 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1515 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1682 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1516 1683
1517 } else { 1684 } else {
1518 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1685 AnyEvent::log 8 => "using emulated perl signal handling with latency timer."
1686 if $AnyEvent::VERBOSE >= 8;
1519 1687
1520 if (AnyEvent::WIN32) { 1688 if (AnyEvent::WIN32) {
1521 require AnyEvent::Util; 1689 require AnyEvent::Util;
1522 1690
1523 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1691 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1599 : sysread $SIGPIPE_R, (my $dummy), 9; 1767 : sysread $SIGPIPE_R, (my $dummy), 9;
1600 1768
1601 while (%SIG_EV) { 1769 while (%SIG_EV) {
1602 for (keys %SIG_EV) { 1770 for (keys %SIG_EV) {
1603 delete $SIG_EV{$_}; 1771 delete $SIG_EV{$_};
1604 $_->() for values %{ $SIG_CB{$_} || {} }; 1772 &$_ for values %{ $SIG_CB{$_} || {} };
1605 } 1773 }
1606 } 1774 }
1607 }; 1775 };
1608 }; 1776 };
1609 die if $@; 1777 die if $@;
1636 }; 1804 };
1637 1805
1638 *child = sub { 1806 *child = sub {
1639 my (undef, %arg) = @_; 1807 my (undef, %arg) = @_;
1640 1808
1641 defined (my $pid = $arg{pid} + 0) 1809 my $pid = $arg{pid};
1642 or Carp::croak "required option 'pid' is missing"; 1810 my $cb = $arg{cb};
1643 1811
1644 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1812 $PID_CB{$pid}{$cb+0} = $cb;
1645 1813
1646 unless ($CHLD_W) { 1814 unless ($CHLD_W) {
1647 $CHLD_W = AE::signal CHLD => \&_sigchld; 1815 $CHLD_W = AE::signal CHLD => \&_sigchld;
1648 # child could be a zombie already, so make at least one round 1816 # child could be a zombie already, so make at least one round
1649 &_sigchld; 1817 &_sigchld;
1650 } 1818 }
1651 1819
1652 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1820 bless [$pid, $cb+0], "AnyEvent::Base::child"
1653 }; 1821 };
1654 1822
1655 *AnyEvent::Base::child::DESTROY = sub { 1823 *AnyEvent::Base::child::DESTROY = sub {
1656 my ($pid, $cb) = @{$_[0]}; 1824 my ($pid, $icb) = @{$_[0]};
1657 1825
1658 delete $PID_CB{$pid}{$cb}; 1826 delete $PID_CB{$pid}{$icb};
1659 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1827 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1660 1828
1661 undef $CHLD_W unless keys %PID_CB; 1829 undef $CHLD_W unless keys %PID_CB;
1662 }; 1830 };
1663 }; 1831 };
1676 1844
1677 my ($cb, $w, $rcb) = $arg{cb}; 1845 my ($cb, $w, $rcb) = $arg{cb};
1678 1846
1679 $rcb = sub { 1847 $rcb = sub {
1680 if ($cb) { 1848 if ($cb) {
1681 $w = _time; 1849 $w = AE::time;
1682 &$cb; 1850 &$cb;
1683 $w = _time - $w; 1851 $w = AE::time - $w;
1684 1852
1685 # never use more then 50% of the time for the idle watcher, 1853 # never use more then 50% of the time for the idle watcher,
1686 # within some limits 1854 # within some limits
1687 $w = 0.0001 if $w < 0.0001; 1855 $w = 0.0001 if $w < 0.0001;
1688 $w = 5 if $w > 5; 1856 $w = 5 if $w > 5;
1735 1903
1736sub _send { 1904sub _send {
1737 # nop 1905 # nop
1738} 1906}
1739 1907
1908sub _wait {
1909 AnyEvent->_poll until $_[0]{_ae_sent};
1910}
1911
1740sub send { 1912sub send {
1741 my $cv = shift; 1913 my $cv = shift;
1742 $cv->{_ae_sent} = [@_]; 1914 $cv->{_ae_sent} = [@_];
1743 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1915 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1744 $cv->_send; 1916 $cv->_send;
1751 1923
1752sub ready { 1924sub ready {
1753 $_[0]{_ae_sent} 1925 $_[0]{_ae_sent}
1754} 1926}
1755 1927
1756sub _wait {
1757 $WAITING
1758 and !$_[0]{_ae_sent}
1759 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1760
1761 local $WAITING = 1;
1762 AnyEvent->one_event while !$_[0]{_ae_sent};
1763}
1764
1765sub recv { 1928sub recv {
1929 unless ($_[0]{_ae_sent}) {
1930 $WAITING
1931 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1932
1933 local $WAITING = 1;
1766 $_[0]->_wait; 1934 $_[0]->_wait;
1935 }
1767 1936
1768 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1937 $_[0]{_ae_croak}
1769 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1938 and Carp::croak $_[0]{_ae_croak};
1939
1940 wantarray
1941 ? @{ $_[0]{_ae_sent} }
1942 : $_[0]{_ae_sent}[0]
1770} 1943}
1771 1944
1772sub cb { 1945sub cb {
1773 my $cv = shift; 1946 my $cv = shift;
1774 1947
1790 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 1963 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1791} 1964}
1792 1965
1793# undocumented/compatibility with pre-3.4 1966# undocumented/compatibility with pre-3.4
1794*broadcast = \&send; 1967*broadcast = \&send;
1795*wait = \&_wait; 1968*wait = \&recv;
1796 1969
1797=head1 ERROR AND EXCEPTION HANDLING 1970=head1 ERROR AND EXCEPTION HANDLING
1798 1971
1799In general, AnyEvent does not do any error handling - it relies on the 1972In general, AnyEvent does not do any error handling - it relies on the
1800caller to do that if required. The L<AnyEvent::Strict> module (see also 1973caller to do that if required. The L<AnyEvent::Strict> module (see also
1812$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 1985$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1813so on. 1986so on.
1814 1987
1815=head1 ENVIRONMENT VARIABLES 1988=head1 ENVIRONMENT VARIABLES
1816 1989
1817The following environment variables are used by this module or its 1990AnyEvent supports a number of environment variables that tune the
1818submodules. 1991runtime behaviour. They are usually evaluated when AnyEvent is
1992loaded, initialised, or a submodule that uses them is loaded. Many of
1993them also cause AnyEvent to load additional modules - for example,
1994C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
1995loaded.
1819 1996
1820Note that AnyEvent will remove I<all> environment variables starting with 1997All the environment variables documented here start with
1821C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 1998C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1822enabled. 1999namespace. Other modules are encouraged (but by no means required) to use
2000C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
2001namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
2002be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
2003variables starting with C<AE_>, see below).
2004
2005All variables can also be set via the C<AE_> prefix, that is, instead
2006of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
2007case there is a clash btween anyevent and another program that uses
2008C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
2009variable to the empty string, as those variables take precedence.
2010
2011When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
2012to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
2013exists. If taint mode is on, then AnyEvent will remove I<all> environment
2014variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
2015with C<undef> or the empty string, if the corresaponding C<AE_> variable
2016is set).
2017
2018The exact algorithm is currently:
2019
2020 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
2021 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
2022 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
2023
2024This ensures that child processes will not see the C<AE_> variables.
2025
2026The following environment variables are currently known to AnyEvent:
1823 2027
1824=over 4 2028=over 4
1825 2029
1826=item C<PERL_ANYEVENT_VERBOSE> 2030=item C<PERL_ANYEVENT_VERBOSE>
1827 2031
1828By default, AnyEvent will be completely silent except in fatal 2032By default, AnyEvent will be completely silent except in fatal
1829conditions. You can set this environment variable to make AnyEvent more 2033conditions. You can set this environment variable to make AnyEvent more
1830talkative. 2034talkative. If you want to do more than just set the global logging level
2035you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2036complex specifications.
1831 2037
1832When set to C<1> or higher, causes AnyEvent to warn about unexpected 2038When set to C<5> or higher, causes AnyEvent to warn about unexpected
1833conditions, such as not being able to load the event model specified by 2039conditions, such as not being able to load the event model specified by
1834C<PERL_ANYEVENT_MODEL>. 2040C<PERL_ANYEVENT_MODEL>.
1835 2041
1836When set to C<2> or higher, cause AnyEvent to report to STDERR which event 2042When set to C<7> or higher, cause AnyEvent to report to STDERR which event
1837model it chooses. 2043model it chooses.
1838 2044
1839When set to C<8> or higher, then AnyEvent will report extra information on 2045When set to C<8> or higher, then AnyEvent will report extra information on
1840which optional modules it loads and how it implements certain features. 2046which optional modules it loads and how it implements certain features.
2047
2048=item C<PERL_ANYEVENT_LOG>
2049
2050Accepts rather complex logging specifications. For example, you could log
2051all C<debug> messages of some module to stderr, warnings and above to
2052stderr, and errors and above to syslog, with:
2053
2054 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
2055
2056For the rather extensive details, see L<AnyEvent::Log>.
2057
2058Note that specifying this environment variable causes the L<AnyEvent::Log>
2059module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2060using the latter saves a few hundred kB of memory until the first message
2061is being logged.
1841 2062
1842=item C<PERL_ANYEVENT_STRICT> 2063=item C<PERL_ANYEVENT_STRICT>
1843 2064
1844AnyEvent does not do much argument checking by default, as thorough 2065AnyEvent does not do much argument checking by default, as thorough
1845argument checking is very costly. Setting this variable to a true value 2066argument checking is very costly. Setting this variable to a true value
1852Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> 2073Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1853>>, it is definitely recommended to keep it off in production. Keeping 2074>>, it is definitely recommended to keep it off in production. Keeping
1854C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2075C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1855can be very useful, however. 2076can be very useful, however.
1856 2077
2078=item C<PERL_ANYEVENT_DEBUG_SHELL>
2079
2080If this env variable is set, then its contents will be interpreted by
2081C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
2082C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
2083that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
2084
2085This takes place when the first watcher is created.
2086
2087For example, to bind a debug shell on a unix domain socket in
2088F<< /tmp/debug<pid>.sock >>, you could use this:
2089
2090 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2091
2092Note that creating sockets in F</tmp> is very unsafe on multiuser
2093systems.
2094
2095=item C<PERL_ANYEVENT_DEBUG_WRAP>
2096
2097Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2098debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2099
1857=item C<PERL_ANYEVENT_MODEL> 2100=item C<PERL_ANYEVENT_MODEL>
1858 2101
1859This can be used to specify the event model to be used by AnyEvent, before 2102This can be used to specify the event model to be used by AnyEvent, before
1860auto detection and -probing kicks in. It must be a string consisting 2103auto detection and -probing kicks in.
1861entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2104
2105It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2106or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1862and the resulting module name is loaded and if the load was successful, 2107resulting module name is loaded and - if the load was successful - used as
1863used as event model. If it fails to load AnyEvent will proceed with 2108event model backend. If it fails to load then AnyEvent will proceed with
1864auto detection and -probing. 2109auto detection and -probing.
1865 2110
1866This functionality might change in future versions. 2111If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2112nothing gets prepended and the module name is used as-is (hint: C<::> at
2113the end of a string designates a module name and quotes it appropriately).
1867 2114
1868For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 2115For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1869could start your program like this: 2116could start your program like this:
1870 2117
1871 PERL_ANYEVENT_MODEL=Perl perl ... 2118 PERL_ANYEVENT_MODEL=Perl perl ...
1872 2119
1873=item C<PERL_ANYEVENT_PROTOCOLS> 2120=item C<PERL_ANYEVENT_PROTOCOLS>
1889but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 2136but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1890- only support IPv4, never try to resolve or contact IPv6 2137- only support IPv4, never try to resolve or contact IPv6
1891addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2138addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1892IPv6, but prefer IPv6 over IPv4. 2139IPv6, but prefer IPv6 over IPv4.
1893 2140
2141=item C<PERL_ANYEVENT_HOSTS>
2142
2143This variable, if specified, overrides the F</etc/hosts> file used by
2144L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2145from that file instead.
2146
1894=item C<PERL_ANYEVENT_EDNS0> 2147=item C<PERL_ANYEVENT_EDNS0>
1895 2148
1896Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension 2149Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1897for DNS. This extension is generally useful to reduce DNS traffic, but 2150DNS. This extension is generally useful to reduce DNS traffic, especially
1898some (broken) firewalls drop such DNS packets, which is why it is off by 2151when DNSSEC is involved, but some (broken) firewalls drop such DNS
1899default. 2152packets, which is why it is off by default.
1900 2153
1901Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce 2154Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1902EDNS0 in its DNS requests. 2155EDNS0 in its DNS requests.
1903 2156
1904=item C<PERL_ANYEVENT_MAX_FORKS> 2157=item C<PERL_ANYEVENT_MAX_FORKS>
1912resolver - this is the maximum number of parallel DNS requests that are 2165resolver - this is the maximum number of parallel DNS requests that are
1913sent to the DNS server. 2166sent to the DNS server.
1914 2167
1915=item C<PERL_ANYEVENT_RESOLV_CONF> 2168=item C<PERL_ANYEVENT_RESOLV_CONF>
1916 2169
1917The file to use instead of F</etc/resolv.conf> (or OS-specific 2170The absolute path to a F<resolv.conf>-style file to use instead of
1918configuration) in the default resolver. When set to the empty string, no 2171F</etc/resolv.conf> (or the OS-specific configuration) in the default
1919default config will be used. 2172resolver, or the empty string to select the default configuration.
1920 2173
1921=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. 2174=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1922 2175
1923When neither C<ca_file> nor C<ca_path> was specified during 2176When neither C<ca_file> nor C<ca_path> was specified during
1924L<AnyEvent::TLS> context creation, and either of these environment 2177L<AnyEvent::TLS> context creation, and either of these environment
1925variables exist, they will be used to specify CA certificate locations 2178variables are nonempty, they will be used to specify CA certificate
1926instead of a system-dependent default. 2179locations instead of a system-dependent default.
1927 2180
1928=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> 2181=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1929 2182
1930When these are set to C<1>, then the respective modules are not 2183When these are set to C<1>, then the respective modules are not
1931loaded. Mostly good for testing AnyEvent itself. 2184loaded. Mostly good for testing AnyEvent itself.
2263(even when used without AnyEvent), but most event loops have acceptable 2516(even when used without AnyEvent), but most event loops have acceptable
2264performance with or without AnyEvent. 2517performance with or without AnyEvent.
2265 2518
2266=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2519=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2267the actual event loop, only with extremely fast event loops such as EV 2520the actual event loop, only with extremely fast event loops such as EV
2268adds AnyEvent significant overhead. 2521does AnyEvent add significant overhead.
2269 2522
2270=item * You should avoid POE like the plague if you want performance or 2523=item * You should avoid POE like the plague if you want performance or
2271reasonable memory usage. 2524reasonable memory usage.
2272 2525
2273=back 2526=back
2572 2825
2573=item L<Time::HiRes> 2826=item L<Time::HiRes>
2574 2827
2575This module is part of perl since release 5.008. It will be used when the 2828This module is part of perl since release 5.008. It will be used when the
2576chosen event library does not come with a timing source of its own. The 2829chosen event library does not come with a timing source of its own. The
2577pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2830pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2578try to use a monotonic clock for timing stability. 2831try to use a monotonic clock for timing stability.
2579 2832
2580=back 2833=back
2581 2834
2582 2835
2648 2901
2649Tutorial/Introduction: L<AnyEvent::Intro>. 2902Tutorial/Introduction: L<AnyEvent::Intro>.
2650 2903
2651FAQ: L<AnyEvent::FAQ>. 2904FAQ: L<AnyEvent::FAQ>.
2652 2905
2653Utility functions: L<AnyEvent::Util>. 2906Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2907(simply logging).
2654 2908
2655Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2909Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2656L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2910L<AnyEvent::Debug> (interactive shell, watcher tracing).
2911
2912Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2913L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
2914L<Qt>, L<POE>, L<FLTK>.
2657 2915
2658Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2916Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2659L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2917L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2660L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2918L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2661L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2919L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
2920L<AnyEvent::Impl::FLTK>.
2662 2921
2663Non-blocking file handles, sockets, TCP clients and 2922Non-blocking handles, pipes, stream sockets, TCP clients and
2664servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2923servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2665 2924
2666Asynchronous DNS: L<AnyEvent::DNS>. 2925Asynchronous DNS: L<AnyEvent::DNS>.
2667 2926
2668Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 2927Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines