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.349 by root, Mon Jul 4 21:14:42 2011 UTC vs.
Revision 1.375 by root, Thu Aug 25 05:39:47 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
… …
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::FLTK2 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 }
… …
1005 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent 1009 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1006 # as soon as it is 1010 # as soon as it is
1007 push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; 1011 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1008 } 1012 }
1009 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
1010=back 1064=back
1011 1065
1012=head1 WHAT TO DO IN A MODULE 1066=head1 WHAT TO DO IN A MODULE
1013 1067
1014As 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
… …
1047modules might create watchers when they are loaded, and AnyEvent will 1101modules might create watchers when they are loaded, and AnyEvent will
1048decide 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
1049might choose the wrong one unless you load the correct one yourself. 1103might choose the wrong one unless you load the correct one yourself.
1050 1104
1051You can chose to use a pure-perl implementation by loading the 1105You can chose to use a pure-perl implementation by loading the
1052C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1106C<AnyEvent::Loop> module, which gives you similar behaviour
1053everywhere, but letting AnyEvent chose the model is generally better. 1107everywhere, but letting AnyEvent chose the model is generally better.
1054 1108
1055=head2 MAINLOOP EMULATION 1109=head2 MAINLOOP EMULATION
1056 1110
1057Sometimes (often for short test scripts, or even standalone programs who 1111Sometimes (often for short test scripts, or even standalone programs who
… …
1070 1124
1071 1125
1072=head1 OTHER MODULES 1126=head1 OTHER MODULES
1073 1127
1074The following is a non-exhaustive list of additional modules that use 1128The following is a non-exhaustive list of additional modules that use
1075AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1129AnyEvent as a client and can therefore be mixed easily with other
1076modules 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
1077come 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 :)
1078 1135
1079=over 4 1136=over 4
1080 1137
1081=item L<AnyEvent::Util> 1138=item L<AnyEvent::Util>
1082 1139
… …
1162 1219
1163BEGIN { AnyEvent::common_sense } 1220BEGIN { AnyEvent::common_sense }
1164 1221
1165use Carp (); 1222use Carp ();
1166 1223
1167our $VERSION = '5.34'; 1224our $VERSION = '6.01';
1168our $MODEL; 1225our $MODEL;
1169 1226
1170our $AUTOLOAD;
1171our @ISA; 1227our @ISA;
1172 1228
1173our @REGISTRY; 1229our @REGISTRY;
1174 1230
1175our $VERBOSE; 1231our $VERBOSE;
… …
1180 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1236 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1181 1237
1182 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1238 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1183 if ${^TAINT}; 1239 if ${^TAINT};
1184 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
1185 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1247 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1186
1187} 1248}
1188 1249
1189our $MAX_SIGNAL_LATENCY = 10; 1250our $MAX_SIGNAL_LATENCY = 10;
1190 1251
1191our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1252our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
… …
1195 $PROTOCOL{$_} = ++$idx 1256 $PROTOCOL{$_} = ++$idx
1196 for reverse split /\s*,\s*/, 1257 for reverse split /\s*,\s*/,
1197 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1258 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1198} 1259}
1199 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
1200my @models = ( 1308our @models = (
1201 [EV:: => AnyEvent::Impl::EV:: , 1], 1309 [EV:: => AnyEvent::Impl::EV:: , 1],
1202 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1310 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1203 # everything below here will not (normally) be autoprobed 1311 # everything below here will not (normally) be autoprobed
1204 # as the pureperl backend should work everywhere 1312 # as the pure perl backend should work everywhere
1205 # and is usually faster 1313 # and is usually faster
1206 [Event:: => AnyEvent::Impl::Event::, 1], 1314 [Event:: => AnyEvent::Impl::Event::, 1],
1207 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1315 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1208 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1316 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1209 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1317 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1210 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1318 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1211 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1319 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1212 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1320 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1213 [Wx:: => AnyEvent::Impl::POE::], 1321 [Wx:: => AnyEvent::Impl::POE::],
1214 [Prima:: => AnyEvent::Impl::POE::], 1322 [Prima:: => AnyEvent::Impl::POE::],
1215 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], 1323 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1216 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1324 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1217 [FLTK:: => AnyEvent::Impl::FLTK::], 1325 [FLTK:: => AnyEvent::Impl::FLTK2::],
1218); 1326);
1219 1327
1220our %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.
1221 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);
1222
1223our @post_detect;
1224
1225sub post_detect(&) {
1226 my ($cb) = @_;
1227
1228 push @post_detect, $cb;
1229
1230 defined wantarray
1231 ? bless \$cb, "AnyEvent::Util::postdetect"
1232 : ()
1233}
1234
1235sub AnyEvent::Util::postdetect::DESTROY {
1236 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1237}
1238 1352
1239sub 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
1240 # free some memory 1359 # free some memory
1241 *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;
1242 1368
1243 local $!; # for good measure
1244 local $SIG{__DIE__};
1245
1246 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1369 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1247 my $model = "AnyEvent::Impl::$1"; 1370 my $model = $1;
1371 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1248 if (eval "require $model") { 1372 if (eval "require $model") {
1373 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1249 $MODEL = $model; 1374 $MODEL = $model;
1250 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1251 } else { 1375 } else {
1252 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$@";
1253 } 1377 }
1254 } 1378 }
1255 1379
1256 # check for already loaded models 1380 # check for already loaded models
1257 unless ($MODEL) { 1381 unless ($MODEL) {
1258 for (@REGISTRY, @models) { 1382 for (@REGISTRY, @models) {
1259 my ($package, $model) = @$_; 1383 my ($package, $model) = @$_;
1260 if (${"$package\::VERSION"} > 0) { 1384 if (${"$package\::VERSION"} > 0) {
1261 if (eval "require $model") { 1385 if (eval "require $model") {
1386 AnyEvent::log 7 => "autodetected model '$model', using it.";
1262 $MODEL = $model; 1387 $MODEL = $model;
1263 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1264 last; 1388 last;
1265 } 1389 }
1266 } 1390 }
1267 } 1391 }
1268 1392
… …
1274 $autoload 1398 $autoload
1275 and eval "require $package" 1399 and eval "require $package"
1276 and ${"$package\::VERSION"} > 0 1400 and ${"$package\::VERSION"} > 0
1277 and eval "require $model" 1401 and eval "require $model"
1278 ) { 1402 ) {
1403 AnyEvent::log 7 => "autoloaded model '$model', using it.";
1279 $MODEL = $model; 1404 $MODEL = $model;
1280 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1281 last; 1405 last;
1282 } 1406 }
1283 } 1407 }
1284 1408
1285 $MODEL 1409 $MODEL
1286 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; 1410 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1287 } 1411 }
1288 } 1412 }
1289 1413
1290 @models = (); # free probe data 1414 # free memory only needed for probing
1415 undef @models;
1416 undef @REGISTRY;
1291 1417
1292 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1418 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1293 unshift @ISA, $MODEL;
1294 1419
1295 # now nuke some methods that are overridden by the backend. 1420 # now nuke some methods that are overridden by the backend.
1296 # SUPER is not allowed. 1421 # SUPER usage is not allowed in these.
1297 for (qw(time signal child idle)) { 1422 for (qw(time signal child idle)) {
1298 undef &{"AnyEvent::Base::$_"} 1423 undef &{"AnyEvent::Base::$_"}
1299 if defined &{"$MODEL\::$_"}; 1424 if defined &{"$MODEL\::$_"};
1300 } 1425 }
1301 1426
1427 _isa_set;
1428
1429 # we're officially open!
1430
1302 if ($ENV{PERL_ANYEVENT_STRICT}) { 1431 if ($ENV{PERL_ANYEVENT_STRICT}) {
1303 eval { require AnyEvent::Strict }; 1432 require AnyEvent::Strict;
1304 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1305 if $@ && $VERBOSE;
1306 } 1433 }
1307 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
1308 (shift @post_detect)->() while @post_detect; 1454 (shift @post_detect)->() while @post_detect;
1455 undef @post_detect;
1309 1456
1310 *post_detect = sub(&) { 1457 *post_detect = sub(&) {
1311 shift->(); 1458 shift->();
1312 1459
1313 undef 1460 undef
1314 }; 1461 };
1315 1462
1316 $MODEL 1463 $MODEL
1317} 1464}
1318 1465
1319sub AUTOLOAD { 1466for my $name (@methods) {
1320 (my $func = $AUTOLOAD) =~ s/.*://; 1467 *$name = sub {
1321
1322 $method{$func}
1323 or Carp::croak "$func: not a valid AnyEvent class method";
1324
1325 detect; 1468 detect;
1326 1469 # we use goto because
1327 my $class = shift; 1470 # a) it makes the thunk more transparent
1328 $class->$func (@_); 1471 # b) it allows us to delete the thunk later
1472 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1473 };
1329} 1474}
1330 1475
1331# 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
1332# to support binding more than one watcher per filehandle (they usually 1477# to support binding more than one watcher per filehandle (they usually
1333# 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).
… …
1357 1502
1358package AE; 1503package AE;
1359 1504
1360our $VERSION = $AnyEvent::VERSION; 1505our $VERSION = $AnyEvent::VERSION;
1361 1506
1507sub _reset() {
1508 eval q{
1362# 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
1363# implementations can overwrite these. 1510 # implementations can overwrite these.
1364 1511
1365sub io($$$) { 1512 sub io($$$) {
1366 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1513 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1367} 1514 }
1368 1515
1369sub timer($$$) { 1516 sub timer($$$) {
1370 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1517 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1371} 1518 }
1372 1519
1373sub signal($$) { 1520 sub signal($$) {
1374 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1521 AnyEvent->signal (signal => $_[0], cb => $_[1])
1375} 1522 }
1376 1523
1377sub child($$) { 1524 sub child($$) {
1378 AnyEvent->child (pid => $_[0], cb => $_[1]) 1525 AnyEvent->child (pid => $_[0], cb => $_[1])
1379} 1526 }
1380 1527
1381sub idle($) { 1528 sub idle($) {
1382 AnyEvent->idle (cb => $_[0]) 1529 AnyEvent->idle (cb => $_[0]);
1383} 1530 }
1384 1531
1385sub cv(;&) { 1532 sub cv(;&) {
1386 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1533 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1387} 1534 }
1388 1535
1389sub now() { 1536 sub now() {
1390 AnyEvent->now 1537 AnyEvent->now
1391} 1538 }
1392 1539
1393sub now_update() { 1540 sub now_update() {
1394 AnyEvent->now_update 1541 AnyEvent->now_update
1395} 1542 }
1396 1543
1397sub time() { 1544 sub time() {
1398 AnyEvent->time 1545 AnyEvent->time
1546 }
1547
1548 *postpone = \&AnyEvent::postpone;
1549 *log = \&AnyEvent::log;
1550 };
1551 die if $@;
1399} 1552}
1553
1554BEGIN { _reset }
1400 1555
1401package AnyEvent::Base; 1556package AnyEvent::Base;
1402 1557
1403# default implementations for many methods 1558# default implementations for many methods
1404 1559
1405sub time { 1560sub time {
1406 eval q{ # poor man's autoloading {} 1561 eval q{ # poor man's autoloading {}
1407 # probe for availability of Time::HiRes 1562 # probe for availability of Time::HiRes
1408 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1563 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1409 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 () };
1410 *AE::time = \&Time::HiRes::time; 1567 *AE::time = \& Time::HiRes::time ;
1411 # if (eval "use POSIX (); (POSIX::times())... 1568 # if (eval "use POSIX (); (POSIX::times())...
1412 } else { 1569 } else {
1413 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 };
1414 *AE::time = sub (){ time }; # epic fail 1572 *AE::time = sub (){ CORE::time };
1415 } 1573 }
1416 1574
1417 *time = sub { AE::time }; # different prototypes 1575 *now = \&time;
1418 }; 1576 };
1419 die if $@; 1577 die if $@;
1420 1578
1421 &time 1579 &time
1422} 1580}
1423 1581
1424*now = \&time; 1582*now = \&time;
1425
1426sub now_update { } 1583sub now_update { }
1427 1584
1585sub _poll {
1586 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1587}
1588
1428# default implementation for ->condvar 1589# default implementation for ->condvar
1590# in fact, the default should not be overwritten
1429 1591
1430sub condvar { 1592sub condvar {
1431 eval q{ # poor man's autoloading {} 1593 eval q{ # poor man's autoloading {}
1432 *condvar = sub { 1594 *condvar = sub {
1433 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1595 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
… …
1511 1673
1512sub signal { 1674sub signal {
1513 eval q{ # poor man's autoloading {} 1675 eval q{ # poor man's autoloading {}
1514 # probe for availability of Async::Interrupt 1676 # probe for availability of Async::Interrupt
1515 if (_have_async_interrupt) { 1677 if (_have_async_interrupt) {
1516 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;
1517 1680
1518 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1681 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1519 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1682 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1520 1683
1521 } else { 1684 } else {
1522 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;
1523 1687
1524 if (AnyEvent::WIN32) { 1688 if (AnyEvent::WIN32) {
1525 require AnyEvent::Util; 1689 require AnyEvent::Util;
1526 1690
1527 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1691 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
… …
1603 : sysread $SIGPIPE_R, (my $dummy), 9; 1767 : sysread $SIGPIPE_R, (my $dummy), 9;
1604 1768
1605 while (%SIG_EV) { 1769 while (%SIG_EV) {
1606 for (keys %SIG_EV) { 1770 for (keys %SIG_EV) {
1607 delete $SIG_EV{$_}; 1771 delete $SIG_EV{$_};
1608 $_->() for values %{ $SIG_CB{$_} || {} }; 1772 &$_ for values %{ $SIG_CB{$_} || {} };
1609 } 1773 }
1610 } 1774 }
1611 }; 1775 };
1612 }; 1776 };
1613 die if $@; 1777 die if $@;
… …
1640 }; 1804 };
1641 1805
1642 *child = sub { 1806 *child = sub {
1643 my (undef, %arg) = @_; 1807 my (undef, %arg) = @_;
1644 1808
1645 defined (my $pid = $arg{pid} + 0) 1809 my $pid = $arg{pid};
1646 or Carp::croak "required option 'pid' is missing"; 1810 my $cb = $arg{cb};
1647 1811
1648 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1812 $PID_CB{$pid}{$cb+0} = $cb;
1649 1813
1650 unless ($CHLD_W) { 1814 unless ($CHLD_W) {
1651 $CHLD_W = AE::signal CHLD => \&_sigchld; 1815 $CHLD_W = AE::signal CHLD => \&_sigchld;
1652 # 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
1653 &_sigchld; 1817 &_sigchld;
1654 } 1818 }
1655 1819
1656 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1820 bless [$pid, $cb+0], "AnyEvent::Base::child"
1657 }; 1821 };
1658 1822
1659 *AnyEvent::Base::child::DESTROY = sub { 1823 *AnyEvent::Base::child::DESTROY = sub {
1660 my ($pid, $cb) = @{$_[0]}; 1824 my ($pid, $icb) = @{$_[0]};
1661 1825
1662 delete $PID_CB{$pid}{$cb}; 1826 delete $PID_CB{$pid}{$icb};
1663 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1827 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1664 1828
1665 undef $CHLD_W unless keys %PID_CB; 1829 undef $CHLD_W unless keys %PID_CB;
1666 }; 1830 };
1667 }; 1831 };
… …
1680 1844
1681 my ($cb, $w, $rcb) = $arg{cb}; 1845 my ($cb, $w, $rcb) = $arg{cb};
1682 1846
1683 $rcb = sub { 1847 $rcb = sub {
1684 if ($cb) { 1848 if ($cb) {
1685 $w = _time; 1849 $w = AE::time;
1686 &$cb; 1850 &$cb;
1687 $w = _time - $w; 1851 $w = AE::time - $w;
1688 1852
1689 # 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,
1690 # within some limits 1854 # within some limits
1691 $w = 0.0001 if $w < 0.0001; 1855 $w = 0.0001 if $w < 0.0001;
1692 $w = 5 if $w > 5; 1856 $w = 5 if $w > 5;
… …
1739 1903
1740sub _send { 1904sub _send {
1741 # nop 1905 # nop
1742} 1906}
1743 1907
1908sub _wait {
1909 AnyEvent->_poll until $_[0]{_ae_sent};
1910}
1911
1744sub send { 1912sub send {
1745 my $cv = shift; 1913 my $cv = shift;
1746 $cv->{_ae_sent} = [@_]; 1914 $cv->{_ae_sent} = [@_];
1747 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1915 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1748 $cv->_send; 1916 $cv->_send;
… …
1755 1923
1756sub ready { 1924sub ready {
1757 $_[0]{_ae_sent} 1925 $_[0]{_ae_sent}
1758} 1926}
1759 1927
1760sub _wait {
1761 $WAITING
1762 and !$_[0]{_ae_sent}
1763 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1764
1765 local $WAITING = 1;
1766 AnyEvent->one_event while !$_[0]{_ae_sent};
1767}
1768
1769sub 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;
1770 $_[0]->_wait; 1934 $_[0]->_wait;
1935 }
1771 1936
1772 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1937 $_[0]{_ae_croak}
1773 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]
1774} 1943}
1775 1944
1776sub cb { 1945sub cb {
1777 my $cv = shift; 1946 my $cv = shift;
1778 1947
… …
1794 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 1963 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1795} 1964}
1796 1965
1797# undocumented/compatibility with pre-3.4 1966# undocumented/compatibility with pre-3.4
1798*broadcast = \&send; 1967*broadcast = \&send;
1799*wait = \&_wait; 1968*wait = \&recv;
1800 1969
1801=head1 ERROR AND EXCEPTION HANDLING 1970=head1 ERROR AND EXCEPTION HANDLING
1802 1971
1803In 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
1804caller 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
… …
1816$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 1985$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1817so on. 1986so on.
1818 1987
1819=head1 ENVIRONMENT VARIABLES 1988=head1 ENVIRONMENT VARIABLES
1820 1989
1821The following environment variables are used by this module or its 1990AnyEvent supports a number of environment variables that tune the
1822submodules. 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.
1823 1996
1824Note that AnyEvent will remove I<all> environment variables starting with 1997All the environment variables documented here start with
1825C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 1998C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1826enabled. 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:
1827 2027
1828=over 4 2028=over 4
1829 2029
1830=item C<PERL_ANYEVENT_VERBOSE> 2030=item C<PERL_ANYEVENT_VERBOSE>
1831 2031
1832By default, AnyEvent will be completely silent except in fatal 2032By default, AnyEvent will be completely silent except in fatal
1833conditions. You can set this environment variable to make AnyEvent more 2033conditions. You can set this environment variable to make AnyEvent more
1834talkative. 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.
1835 2037
1836When 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
1837conditions, 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
1838C<PERL_ANYEVENT_MODEL>. 2040C<PERL_ANYEVENT_MODEL>.
1839 2041
1840When 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
1841model it chooses. 2043model it chooses.
1842 2044
1843When 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
1844which 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
2058This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2059so will take effect even before AnyEvent has initialised itself.
2060
2061Note that specifying this environment variable causes the L<AnyEvent::Log>
2062module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2063using the latter saves a few hundred kB of memory until the first message
2064is being logged.
1845 2065
1846=item C<PERL_ANYEVENT_STRICT> 2066=item C<PERL_ANYEVENT_STRICT>
1847 2067
1848AnyEvent does not do much argument checking by default, as thorough 2068AnyEvent does not do much argument checking by default, as thorough
1849argument checking is very costly. Setting this variable to a true value 2069argument checking is very costly. Setting this variable to a true value
… …
1856Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> 2076Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1857>>, it is definitely recommended to keep it off in production. Keeping 2077>>, it is definitely recommended to keep it off in production. Keeping
1858C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2078C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1859can be very useful, however. 2079can be very useful, however.
1860 2080
2081=item C<PERL_ANYEVENT_DEBUG_SHELL>
2082
2083If this env variable is set, then its contents will be interpreted by
2084C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
2085C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
2086that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
2087
2088This happens when the first watcher is created.
2089
2090For example, to bind a debug shell on a unix domain socket in
2091F<< /tmp/debug<pid>.sock >>, you could use this:
2092
2093 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2094
2095Note that creating sockets in F</tmp> is very unsafe on multiuser
2096systems.
2097
2098=item C<PERL_ANYEVENT_DEBUG_WRAP>
2099
2100Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2101debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2102
1861=item C<PERL_ANYEVENT_MODEL> 2103=item C<PERL_ANYEVENT_MODEL>
1862 2104
1863This can be used to specify the event model to be used by AnyEvent, before 2105This can be used to specify the event model to be used by AnyEvent, before
1864auto detection and -probing kicks in. It must be a string consisting 2106auto detection and -probing kicks in.
1865entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2107
2108It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2109or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1866and the resulting module name is loaded and if the load was successful, 2110resulting module name is loaded and - if the load was successful - used as
1867used as event model. If it fails to load AnyEvent will proceed with 2111event model backend. If it fails to load then AnyEvent will proceed with
1868auto detection and -probing. 2112auto detection and -probing.
1869 2113
1870This functionality might change in future versions. 2114If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2115nothing gets prepended and the module name is used as-is (hint: C<::> at
2116the end of a string designates a module name and quotes it appropriately).
1871 2117
1872For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 2118For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1873could start your program like this: 2119could start your program like this:
1874 2120
1875 PERL_ANYEVENT_MODEL=Perl perl ... 2121 PERL_ANYEVENT_MODEL=Perl perl ...
1876 2122
1877=item C<PERL_ANYEVENT_PROTOCOLS> 2123=item C<PERL_ANYEVENT_PROTOCOLS>
… …
1893but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 2139but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1894- only support IPv4, never try to resolve or contact IPv6 2140- only support IPv4, never try to resolve or contact IPv6
1895addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2141addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1896IPv6, but prefer IPv6 over IPv4. 2142IPv6, but prefer IPv6 over IPv4.
1897 2143
2144=item C<PERL_ANYEVENT_HOSTS>
2145
2146This variable, if specified, overrides the F</etc/hosts> file used by
2147L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2148from that file instead.
2149
1898=item C<PERL_ANYEVENT_EDNS0> 2150=item C<PERL_ANYEVENT_EDNS0>
1899 2151
1900Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension 2152Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1901for DNS. This extension is generally useful to reduce DNS traffic, but 2153DNS. This extension is generally useful to reduce DNS traffic, especially
1902some (broken) firewalls drop such DNS packets, which is why it is off by 2154when DNSSEC is involved, but some (broken) firewalls drop such DNS
1903default. 2155packets, which is why it is off by default.
1904 2156
1905Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce 2157Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1906EDNS0 in its DNS requests. 2158EDNS0 in its DNS requests.
1907 2159
1908=item C<PERL_ANYEVENT_MAX_FORKS> 2160=item C<PERL_ANYEVENT_MAX_FORKS>
… …
1916resolver - this is the maximum number of parallel DNS requests that are 2168resolver - this is the maximum number of parallel DNS requests that are
1917sent to the DNS server. 2169sent to the DNS server.
1918 2170
1919=item C<PERL_ANYEVENT_RESOLV_CONF> 2171=item C<PERL_ANYEVENT_RESOLV_CONF>
1920 2172
1921The file to use instead of F</etc/resolv.conf> (or OS-specific 2173The absolute path to a F<resolv.conf>-style file to use instead of
1922configuration) in the default resolver. When set to the empty string, no 2174F</etc/resolv.conf> (or the OS-specific configuration) in the default
1923default config will be used. 2175resolver, or the empty string to select the default configuration.
1924 2176
1925=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. 2177=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1926 2178
1927When neither C<ca_file> nor C<ca_path> was specified during 2179When neither C<ca_file> nor C<ca_path> was specified during
1928L<AnyEvent::TLS> context creation, and either of these environment 2180L<AnyEvent::TLS> context creation, and either of these environment
1929variables exist, they will be used to specify CA certificate locations 2181variables are nonempty, they will be used to specify CA certificate
1930instead of a system-dependent default. 2182locations instead of a system-dependent default.
1931 2183
1932=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> 2184=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1933 2185
1934When these are set to C<1>, then the respective modules are not 2186When these are set to C<1>, then the respective modules are not
1935loaded. Mostly good for testing AnyEvent itself. 2187loaded. Mostly good for testing AnyEvent itself.
… …
2267(even when used without AnyEvent), but most event loops have acceptable 2519(even when used without AnyEvent), but most event loops have acceptable
2268performance with or without AnyEvent. 2520performance with or without AnyEvent.
2269 2521
2270=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2522=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2271the actual event loop, only with extremely fast event loops such as EV 2523the actual event loop, only with extremely fast event loops such as EV
2272adds AnyEvent significant overhead. 2524does AnyEvent add significant overhead.
2273 2525
2274=item * You should avoid POE like the plague if you want performance or 2526=item * You should avoid POE like the plague if you want performance or
2275reasonable memory usage. 2527reasonable memory usage.
2276 2528
2277=back 2529=back
… …
2576 2828
2577=item L<Time::HiRes> 2829=item L<Time::HiRes>
2578 2830
2579This module is part of perl since release 5.008. It will be used when the 2831This module is part of perl since release 5.008. It will be used when the
2580chosen event library does not come with a timing source of its own. The 2832chosen event library does not come with a timing source of its own. The
2581pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2833pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2582try to use a monotonic clock for timing stability. 2834try to use a monotonic clock for timing stability.
2583 2835
2584=back 2836=back
2585 2837
2586 2838
… …
2652 2904
2653Tutorial/Introduction: L<AnyEvent::Intro>. 2905Tutorial/Introduction: L<AnyEvent::Intro>.
2654 2906
2655FAQ: L<AnyEvent::FAQ>. 2907FAQ: L<AnyEvent::FAQ>.
2656 2908
2657Utility functions: L<AnyEvent::Util>. 2909Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2910(simply logging).
2658 2911
2659Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2912Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2660L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2913L<AnyEvent::Debug> (interactive shell, watcher tracing).
2914
2915Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2916L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
2917L<Qt>, L<POE>, L<FLTK>.
2661 2918
2662Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2919Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2663L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2920L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2664L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2921L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2665L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2922L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
2923L<AnyEvent::Impl::FLTK>.
2666 2924
2667Non-blocking file handles, sockets, TCP clients and 2925Non-blocking handles, pipes, stream sockets, TCP clients and
2668servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2926servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2669 2927
2670Asynchronous DNS: L<AnyEvent::DNS>. 2928Asynchronous DNS: L<AnyEvent::DNS>.
2671 2929
2672Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 2930Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.

Diff Legend

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