1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - the DBI of event loop programming |
3 | AnyEvent - the DBI of event loop programming |
4 | |
4 | |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt, |
6 | and POE are various supported event loops/environments. |
6 | FLTK 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 | |
… | |
… | |
415 | not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's |
415 | not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's |
416 | pure perl implementation). |
416 | pure perl implementation). |
417 | |
417 | |
418 | =head3 Safe/Unsafe Signals |
418 | =head3 Safe/Unsafe Signals |
419 | |
419 | |
420 | Perl signals can be either "safe" (synchronous to opcode handling) or |
420 | Perl signals can be either "safe" (synchronous to opcode handling) |
421 | "unsafe" (asynchronous) - the former might get delayed indefinitely, the |
421 | or "unsafe" (asynchronous) - the former might delay signal delivery |
422 | latter might corrupt your memory. |
422 | indefinitely, the latter might corrupt your memory. |
423 | |
423 | |
424 | AnyEvent signal handlers are, in addition, synchronous to the event loop, |
424 | AnyEvent signal handlers are, in addition, synchronous to the event loop, |
425 | i.e. they will not interrupt your running perl program but will only be |
425 | i.e. they will not interrupt your running perl program but will only be |
426 | called as part of the normal event handling (just like timer, I/O etc. |
426 | called as part of the normal event handling (just like timer, I/O etc. |
427 | callbacks, too). |
427 | callbacks, too). |
428 | |
428 | |
429 | =head3 Signal Races, Delays and Workarounds |
429 | =head3 Signal Races, Delays and Workarounds |
430 | |
430 | |
431 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
431 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support |
432 | callbacks to signals in a generic way, which is a pity, as you cannot |
432 | attaching callbacks to signals in a generic way, which is a pity, |
433 | do race-free signal handling in perl, requiring C libraries for |
433 | as you cannot do race-free signal handling in perl, requiring |
434 | this. AnyEvent will try to do its best, which means in some cases, |
434 | C libraries for this. AnyEvent will try to do its best, which |
435 | signals will be delayed. The maximum time a signal might be delayed is |
435 | means in some cases, signals will be delayed. The maximum time |
436 | specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This |
436 | a signal might be delayed is 10 seconds by default, but can |
437 | variable can be changed only before the first signal watcher is created, |
437 | be overriden via C<$ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY}> or |
438 | and should be left alone otherwise. This variable determines how often |
438 | C<$AnyEvent::MAX_SIGNAL_LATENCY> - see the Ö<ENVIRONMENT VARIABLES> |
439 | AnyEvent polls for signals (in case a wake-up was missed). Higher values |
439 | section for details. |
440 | will cause fewer spurious wake-ups, which is better for power and CPU |
|
|
441 | saving. |
|
|
442 | |
440 | |
443 | All these problems can be avoided by installing the optional |
441 | All these problems can be avoided by installing the optional |
444 | L<Async::Interrupt> module, which works with most event loops. It will not |
442 | L<Async::Interrupt> module, which works with most event loops. It will not |
445 | work with inherently broken event loops such as L<Event> or L<Event::Lib> |
443 | work with inherently broken event loops such as L<Event> or L<Event::Lib> |
446 | (and not with L<POE> currently, as POE does its own workaround with |
444 | (and not with L<POE> currently). For those, you just have to suffer the |
447 | one-second latency). For those, you just have to suffer the delays. |
445 | delays. |
448 | |
446 | |
449 | =head2 CHILD PROCESS WATCHERS |
447 | =head2 CHILD PROCESS WATCHERS |
450 | |
448 | |
451 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
449 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
452 | |
450 | |
… | |
… | |
878 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
876 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
879 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
877 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
880 | AnyEvent::Impl::Irssi used when running within irssi. |
878 | AnyEvent::Impl::Irssi used when running within irssi. |
881 | AnyEvent::Impl::IOAsync based on IO::Async. |
879 | AnyEvent::Impl::IOAsync based on IO::Async. |
882 | AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. |
880 | AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. |
883 | AnyEvent::Impl::FLTK based on FLTK. |
881 | AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding). |
884 | |
882 | |
885 | =item Backends with special needs. |
883 | =item Backends with special needs. |
886 | |
884 | |
887 | Qt requires the Qt::Application to be instantiated first, but will |
885 | Qt requires the Qt::Application to be instantiated first, but will |
888 | otherwise be picked up automatically. As long as the main program |
886 | otherwise be picked up automatically. As long as the main program |
… | |
… | |
933 | |
931 | |
934 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
932 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
935 | if necessary. You should only call this function right before you would |
933 | if necessary. You should only call this function right before you would |
936 | have created an AnyEvent watcher anyway, that is, as late as possible at |
934 | have created an AnyEvent watcher anyway, that is, as late as possible at |
937 | runtime, and not e.g. during initialisation of your module. |
935 | runtime, and not e.g. during initialisation of your module. |
|
|
936 | |
|
|
937 | The effect of calling this function is as if a watcher had been created |
|
|
938 | (specifically, actions that happen "when the first watcher is created" |
|
|
939 | happen when calling detetc as well). |
938 | |
940 | |
939 | If you need to do some initialisation before AnyEvent watchers are |
941 | If you need to do some initialisation before AnyEvent watchers are |
940 | created, use C<post_detect>. |
942 | created, use C<post_detect>. |
941 | |
943 | |
942 | =item $guard = AnyEvent::post_detect { BLOCK } |
944 | =item $guard = AnyEvent::post_detect { BLOCK } |
… | |
… | |
1045 | It should use C<postpone>: |
1047 | It should use C<postpone>: |
1046 | |
1048 | |
1047 | AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later |
1049 | AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later |
1048 | if $some_error_condition; |
1050 | if $some_error_condition; |
1049 | |
1051 | |
|
|
1052 | =item AnyEvent::log $level, $msg[, @args] |
|
|
1053 | |
|
|
1054 | Log the given C<$msg> at the given C<$level>. |
|
|
1055 | |
|
|
1056 | If L<AnyEvent::Log> is not loaded then this function makes a simple test |
|
|
1057 | to see whether the message will be logged. If the test succeeds it will |
|
|
1058 | load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at |
|
|
1059 | the L<AnyEvent::Log> documentation for details. |
|
|
1060 | |
|
|
1061 | If the test fails it will simply return. Right now this happens when a |
|
|
1062 | numerical loglevel is used and it is larger than the level specified via |
|
|
1063 | C<$ENV{PERL_ANYEVENT_VERBOSE}>. |
|
|
1064 | |
|
|
1065 | If you want to sprinkle loads of logging calls around your code, consider |
|
|
1066 | creating a logger callback with the C<AnyEvent::Log::logger> function, |
|
|
1067 | which can reduce typing, codesize and can reduce the logging overhead |
|
|
1068 | enourmously. |
|
|
1069 | |
1050 | =back |
1070 | =back |
1051 | |
1071 | |
1052 | =head1 WHAT TO DO IN A MODULE |
1072 | =head1 WHAT TO DO IN A MODULE |
1053 | |
1073 | |
1054 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
1074 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
… | |
… | |
1110 | |
1130 | |
1111 | |
1131 | |
1112 | =head1 OTHER MODULES |
1132 | =head1 OTHER MODULES |
1113 | |
1133 | |
1114 | The following is a non-exhaustive list of additional modules that use |
1134 | The following is a non-exhaustive list of additional modules that use |
1115 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
1135 | AnyEvent as a client and can therefore be mixed easily with other |
1116 | modules and other event loops in the same program. Some of the modules |
1136 | AnyEvent modules and other event loops in the same program. Some of the |
1117 | come as part of AnyEvent, the others are available via CPAN. |
1137 | modules come as part of AnyEvent, the others are available via CPAN (see |
|
|
1138 | L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for |
|
|
1139 | a longer non-exhaustive list), and the list is heavily biased towards |
|
|
1140 | modules of the AnyEvent author himself :) |
1118 | |
1141 | |
1119 | =over 4 |
1142 | =over 4 |
1120 | |
1143 | |
1121 | =item L<AnyEvent::Util> |
1144 | =item L<AnyEvent::Util> |
1122 | |
1145 | |
… | |
… | |
1142 | =item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> |
1165 | =item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> |
1143 | |
1166 | |
1144 | Implement event-based interfaces to the protocols of the same name (for |
1167 | Implement event-based interfaces to the protocols of the same name (for |
1145 | the curious, IGS is the International Go Server and FCP is the Freenet |
1168 | the curious, IGS is the International Go Server and FCP is the Freenet |
1146 | Client Protocol). |
1169 | Client Protocol). |
1147 | |
|
|
1148 | =item L<AnyEvent::Handle::UDP> |
|
|
1149 | |
|
|
1150 | Here be danger! |
|
|
1151 | |
|
|
1152 | As Pauli would put it, "Not only is it not right, it's not even wrong!" - |
|
|
1153 | there are so many things wrong with AnyEvent::Handle::UDP, most notably |
|
|
1154 | its use of a stream-based API with a protocol that isn't streamable, that |
|
|
1155 | the only way to improve it is to delete it. |
|
|
1156 | |
|
|
1157 | It features data corruption (but typically only under load) and general |
|
|
1158 | confusion. On top, the author is not only clueless about UDP but also |
|
|
1159 | fact-resistant - some gems of his understanding: "connect doesn't work |
|
|
1160 | with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not |
|
|
1161 | packets", "I don't need to implement proper error checking as UDP doesn't |
|
|
1162 | support error checking" and so on - he doesn't even understand what's |
|
|
1163 | wrong with his module when it is explained to him. |
|
|
1164 | |
|
|
1165 | =item L<AnyEvent::DBI> |
|
|
1166 | |
|
|
1167 | Executes L<DBI> requests asynchronously in a proxy process for you, |
|
|
1168 | notifying you in an event-based way when the operation is finished. |
|
|
1169 | |
1170 | |
1170 | =item L<AnyEvent::AIO> |
1171 | =item L<AnyEvent::AIO> |
1171 | |
1172 | |
1172 | Truly asynchronous (as opposed to non-blocking) I/O, should be in the |
1173 | Truly asynchronous (as opposed to non-blocking) I/O, should be in the |
1173 | toolbox of every event programmer. AnyEvent::AIO transparently fuses |
1174 | toolbox of every event programmer. AnyEvent::AIO transparently fuses |
1174 | L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based |
1175 | L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based |
1175 | file I/O, and much more. |
1176 | file I/O, and much more. |
1176 | |
1177 | |
|
|
1178 | =item L<AnyEvent::Filesys::Notify> |
|
|
1179 | |
|
|
1180 | AnyEvent is good for non-blocking stuff, but it can't detect file or |
|
|
1181 | path changes (e.g. "watch this directory for new files", "watch this |
|
|
1182 | file for changes"). The L<AnyEvent::Filesys::Notify> module promises to |
|
|
1183 | do just that in a portbale fashion, supporting inotify on GNU/Linux and |
|
|
1184 | some weird, without doubt broken, stuff on OS X to monitor files. It can |
|
|
1185 | fall back to blocking scans at regular intervals transparently on other |
|
|
1186 | platforms, so it's about as portable as it gets. |
|
|
1187 | |
|
|
1188 | (I haven't used it myself, but I haven't heard anybody complaining about |
|
|
1189 | it yet). |
|
|
1190 | |
|
|
1191 | =item L<AnyEvent::DBI> |
|
|
1192 | |
|
|
1193 | Executes L<DBI> requests asynchronously in a proxy process for you, |
|
|
1194 | notifying you in an event-based way when the operation is finished. |
|
|
1195 | |
1177 | =item L<AnyEvent::HTTPD> |
1196 | =item L<AnyEvent::HTTPD> |
1178 | |
1197 | |
1179 | A simple embedded webserver. |
1198 | A simple embedded webserver. |
1180 | |
1199 | |
1181 | =item L<AnyEvent::FastPing> |
1200 | =item L<AnyEvent::FastPing> |
1182 | |
1201 | |
1183 | The fastest ping in the west. |
1202 | The fastest ping in the west. |
1184 | |
1203 | |
1185 | =item L<Coro> |
1204 | =item L<Coro> |
1186 | |
1205 | |
1187 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
1206 | Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you |
|
|
1207 | to simply invert the flow control - don't call us, we will call you: |
|
|
1208 | |
|
|
1209 | async { |
|
|
1210 | Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it |
|
|
1211 | print "5 seconds later!\n"; |
|
|
1212 | |
|
|
1213 | Coro::AnyEvent::readable *STDIN; # uses an I/O watcher |
|
|
1214 | my $line = <STDIN>; # works for ttys |
|
|
1215 | |
|
|
1216 | AnyEvent::HTTP::http_get "url", Coro::rouse_cb; |
|
|
1217 | my ($body, $hdr) = Coro::rouse_wait; |
|
|
1218 | }; |
1188 | |
1219 | |
1189 | =back |
1220 | =back |
1190 | |
1221 | |
1191 | =cut |
1222 | =cut |
1192 | |
1223 | |
… | |
… | |
1202 | |
1233 | |
1203 | BEGIN { AnyEvent::common_sense } |
1234 | BEGIN { AnyEvent::common_sense } |
1204 | |
1235 | |
1205 | use Carp (); |
1236 | use Carp (); |
1206 | |
1237 | |
1207 | our $VERSION = '5.34'; |
1238 | our $VERSION = '6.02'; |
1208 | our $MODEL; |
1239 | our $MODEL; |
1209 | |
|
|
1210 | our $AUTOLOAD; |
|
|
1211 | our @ISA; |
1240 | our @ISA; |
1212 | |
|
|
1213 | our @REGISTRY; |
1241 | our @REGISTRY; |
1214 | |
|
|
1215 | our $VERBOSE; |
1242 | our $VERBOSE; |
|
|
1243 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
|
|
1244 | our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} || 10; # executes after the BEGIN block below (tainting!) |
1216 | |
1245 | |
1217 | BEGIN { |
1246 | BEGIN { |
1218 | require "AnyEvent/constants.pl"; |
1247 | require "AnyEvent/constants.pl"; |
1219 | |
1248 | |
1220 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
1249 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
1221 | |
1250 | |
1222 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1251 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1223 | if ${^TAINT}; |
1252 | if ${^TAINT}; |
1224 | |
1253 | |
1225 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1254 | $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"} |
|
|
1255 | for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV; |
1226 | |
1256 | |
1227 | } |
1257 | @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = () |
|
|
1258 | if ${^TAINT}; |
1228 | |
1259 | |
1229 | our $MAX_SIGNAL_LATENCY = 10; |
1260 | # $ENV{PERL_ANYEVENT_xxx} now valid |
1230 | |
1261 | |
1231 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1262 | $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4; |
1232 | |
1263 | |
1233 | { |
|
|
1234 | my $idx; |
1264 | my $idx; |
1235 | $PROTOCOL{$_} = ++$idx |
1265 | $PROTOCOL{$_} = ++$idx |
1236 | for reverse split /\s*,\s*/, |
1266 | for reverse split /\s*,\s*/, |
1237 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1267 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1238 | } |
1268 | } |
1239 | |
1269 | |
|
|
1270 | our @post_detect; |
|
|
1271 | |
|
|
1272 | sub post_detect(&) { |
|
|
1273 | my ($cb) = @_; |
|
|
1274 | |
|
|
1275 | push @post_detect, $cb; |
|
|
1276 | |
|
|
1277 | defined wantarray |
|
|
1278 | ? bless \$cb, "AnyEvent::Util::postdetect" |
|
|
1279 | : () |
|
|
1280 | } |
|
|
1281 | |
|
|
1282 | sub AnyEvent::Util::postdetect::DESTROY { |
|
|
1283 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
|
|
1284 | } |
|
|
1285 | |
|
|
1286 | our $POSTPONE_W; |
|
|
1287 | our @POSTPONE; |
|
|
1288 | |
|
|
1289 | sub _postpone_exec { |
|
|
1290 | undef $POSTPONE_W; |
|
|
1291 | |
|
|
1292 | &{ shift @POSTPONE } |
|
|
1293 | while @POSTPONE; |
|
|
1294 | } |
|
|
1295 | |
|
|
1296 | sub postpone(&) { |
|
|
1297 | push @POSTPONE, shift; |
|
|
1298 | |
|
|
1299 | $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); |
|
|
1300 | |
|
|
1301 | () |
|
|
1302 | } |
|
|
1303 | |
|
|
1304 | sub log($$;@) { |
|
|
1305 | # only load the big bloated module when we actually are about to log something |
|
|
1306 | if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal |
|
|
1307 | local ($!, $@); |
|
|
1308 | require AnyEvent::Log; # among other things, sets $VERBOSE to 9 |
|
|
1309 | # AnyEvent::Log overwrites this function |
|
|
1310 | goto &log; |
|
|
1311 | } |
|
|
1312 | |
|
|
1313 | 0 # not logged |
|
|
1314 | } |
|
|
1315 | |
|
|
1316 | sub _logger($;$) { |
|
|
1317 | my ($level, $renabled) = @_; |
|
|
1318 | |
|
|
1319 | $$renabled = $level <= $VERBOSE; |
|
|
1320 | |
|
|
1321 | my $logger = [(caller)[0], $level, $renabled]; |
|
|
1322 | |
|
|
1323 | $AnyEvent::Log::LOGGER{$logger+0} = $logger; |
|
|
1324 | |
|
|
1325 | # return unless defined wantarray; |
|
|
1326 | # |
|
|
1327 | # require AnyEvent::Util; |
|
|
1328 | # my $guard = AnyEvent::Util::guard (sub { |
|
|
1329 | # # "clean up" |
|
|
1330 | # delete $LOGGER{$logger+0}; |
|
|
1331 | # }); |
|
|
1332 | # |
|
|
1333 | # sub { |
|
|
1334 | # return 0 unless $$renabled; |
|
|
1335 | # |
|
|
1336 | # $guard if 0; # keep guard alive, but don't cause runtime overhead |
|
|
1337 | # require AnyEvent::Log unless $AnyEvent::Log::VERSION; |
|
|
1338 | # package AnyEvent::Log; |
|
|
1339 | # _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time |
|
|
1340 | # } |
|
|
1341 | } |
|
|
1342 | |
|
|
1343 | if (length $ENV{PERL_ANYEVENT_LOG}) { |
|
|
1344 | require AnyEvent::Log; # AnyEvent::Log does the thing for us |
|
|
1345 | } |
|
|
1346 | |
1240 | my @models = ( |
1347 | our @models = ( |
1241 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1348 | [EV:: => AnyEvent::Impl::EV::], |
1242 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], |
1349 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl::], |
1243 | # everything below here will not (normally) be autoprobed |
1350 | # everything below here will not (normally) be autoprobed |
1244 | # as the pure perl backend should work everywhere |
1351 | # as the pure perl backend should work everywhere |
1245 | # and is usually faster |
1352 | # and is usually faster |
|
|
1353 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top |
1246 | [Event:: => AnyEvent::Impl::Event::, 1], |
1354 | [Event:: => AnyEvent::Impl::Event::], # slow, stable |
1247 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1355 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
|
|
1356 | # everything below here should not be autoloaded |
1248 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1357 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1249 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
|
|
1250 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1358 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1251 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1359 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1252 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1360 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1253 | [Wx:: => AnyEvent::Impl::POE::], |
1361 | [Wx:: => AnyEvent::Impl::POE::], |
1254 | [Prima:: => AnyEvent::Impl::POE::], |
1362 | [Prima:: => AnyEvent::Impl::POE::], |
1255 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], |
1363 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect |
1256 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
1364 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
1257 | [FLTK:: => AnyEvent::Impl::FLTK::], |
1365 | [FLTK:: => AnyEvent::Impl::FLTK::], |
1258 | ); |
1366 | ); |
1259 | |
1367 | |
1260 | our %method = map +($_ => 1), |
1368 | our @isa_hook; |
|
|
1369 | |
|
|
1370 | sub _isa_set { |
|
|
1371 | my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL); |
|
|
1372 | |
|
|
1373 | @{"$pkg[$_-1]::ISA"} = $pkg[$_] |
|
|
1374 | for 1 .. $#pkg; |
|
|
1375 | |
|
|
1376 | grep $_ && $_->[1], @isa_hook |
|
|
1377 | and AE::_reset (); |
|
|
1378 | } |
|
|
1379 | |
|
|
1380 | # used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy |
|
|
1381 | sub _isa_hook($$;$) { |
|
|
1382 | my ($i, $pkg, $reset_ae) = @_; |
|
|
1383 | |
|
|
1384 | $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef; |
|
|
1385 | |
|
|
1386 | _isa_set; |
|
|
1387 | } |
|
|
1388 | |
|
|
1389 | # all autoloaded methods reserve the complete glob, not just the method slot. |
|
|
1390 | # due to bugs in perls method cache implementation. |
1261 | qw(io timer time now now_update signal child idle condvar DESTROY); |
1391 | our @methods = qw(io timer time now now_update signal child idle condvar); |
1262 | |
|
|
1263 | our @post_detect; |
|
|
1264 | |
|
|
1265 | sub post_detect(&) { |
|
|
1266 | my ($cb) = @_; |
|
|
1267 | |
|
|
1268 | push @post_detect, $cb; |
|
|
1269 | |
|
|
1270 | defined wantarray |
|
|
1271 | ? bless \$cb, "AnyEvent::Util::postdetect" |
|
|
1272 | : () |
|
|
1273 | } |
|
|
1274 | |
|
|
1275 | sub AnyEvent::Util::postdetect::DESTROY { |
|
|
1276 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
|
|
1277 | } |
|
|
1278 | |
1392 | |
1279 | sub detect() { |
1393 | sub detect() { |
|
|
1394 | return $MODEL if $MODEL; # some programs keep references to detect |
|
|
1395 | |
|
|
1396 | # IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it |
|
|
1397 | # the author knows about the problems and what it does to AnyEvent as a whole |
|
|
1398 | # (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent |
|
|
1399 | # anyway. |
|
|
1400 | AnyEvent::log fatal => "AnyEvent: IO::Async::Loop::AnyEvent detected - this module is broken by design,\n" |
|
|
1401 | . "abuses internals and breaks AnyEvent, will not continue." |
|
|
1402 | if exists $INC{"IO/Async/Loop/AnyEvent.pm"}; |
|
|
1403 | |
|
|
1404 | local $!; # for good measure |
|
|
1405 | local $SIG{__DIE__}; # we use eval |
|
|
1406 | |
1280 | # free some memory |
1407 | # free some memory |
1281 | *detect = sub () { $MODEL }; |
1408 | *detect = sub () { $MODEL }; |
|
|
1409 | # undef &func doesn't correctly update the method cache. grmbl. |
|
|
1410 | # so we delete the whole glob. grmbl. |
|
|
1411 | # otoh, perl doesn't let me undef an active usb, but it lets me free |
|
|
1412 | # a glob with an active sub. hrm. i hope it works, but perl is |
|
|
1413 | # usually buggy in this department. sigh. |
|
|
1414 | delete @{"AnyEvent::"}{@methods}; |
|
|
1415 | undef @methods; |
1282 | |
1416 | |
1283 | local $!; # for good measure |
|
|
1284 | local $SIG{__DIE__}; |
|
|
1285 | |
|
|
1286 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1417 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { |
1287 | my $model = "AnyEvent::Impl::$1"; |
1418 | my $model = $1; |
|
|
1419 | $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; |
1288 | if (eval "require $model") { |
1420 | if (eval "require $model") { |
|
|
1421 | AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."; |
1289 | $MODEL = $model; |
1422 | $MODEL = $model; |
1290 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
|
|
1291 | } else { |
1423 | } else { |
1292 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
1424 | AnyEvent::log 4 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@"; |
1293 | } |
1425 | } |
1294 | } |
1426 | } |
1295 | |
1427 | |
1296 | # check for already loaded models |
1428 | # check for already loaded models |
1297 | unless ($MODEL) { |
1429 | unless ($MODEL) { |
1298 | for (@REGISTRY, @models) { |
1430 | for (@REGISTRY, @models) { |
1299 | my ($package, $model) = @$_; |
1431 | my ($package, $model) = @$_; |
1300 | if (${"$package\::VERSION"} > 0) { |
1432 | if (${"$package\::VERSION"} > 0) { |
1301 | if (eval "require $model") { |
1433 | if (eval "require $model") { |
|
|
1434 | AnyEvent::log 7 => "autodetected model '$model', using it."; |
1302 | $MODEL = $model; |
1435 | $MODEL = $model; |
1303 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
|
|
1304 | last; |
1436 | last; |
1305 | } |
1437 | } |
1306 | } |
1438 | } |
1307 | } |
1439 | } |
1308 | |
1440 | |
1309 | unless ($MODEL) { |
1441 | unless ($MODEL) { |
1310 | # try to autoload a model |
1442 | # try to autoload a model |
1311 | for (@REGISTRY, @models) { |
1443 | for (@REGISTRY, @models) { |
1312 | my ($package, $model, $autoload) = @$_; |
1444 | my ($package, $model) = @$_; |
1313 | if ( |
1445 | if ( |
1314 | $autoload |
|
|
1315 | and eval "require $package" |
1446 | eval "require $package" |
1316 | and ${"$package\::VERSION"} > 0 |
1447 | and ${"$package\::VERSION"} > 0 |
1317 | and eval "require $model" |
1448 | and eval "require $model" |
1318 | ) { |
1449 | ) { |
|
|
1450 | AnyEvent::log 7 => "autoloaded model '$model', using it."; |
1319 | $MODEL = $model; |
1451 | $MODEL = $model; |
1320 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
|
|
1321 | last; |
1452 | last; |
1322 | } |
1453 | } |
1323 | } |
1454 | } |
1324 | |
1455 | |
1325 | $MODEL |
1456 | $MODEL |
1326 | or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; |
1457 | or AnyEvent::log fatal => "AnyEvent: backend autodetection failed - did you properly install AnyEvent?"; |
1327 | } |
1458 | } |
1328 | } |
1459 | } |
1329 | |
1460 | |
1330 | @models = (); # free probe data |
1461 | # free memory only needed for probing |
|
|
1462 | undef @models; |
|
|
1463 | undef @REGISTRY; |
1331 | |
1464 | |
1332 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1465 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1333 | unshift @ISA, $MODEL; |
|
|
1334 | |
1466 | |
1335 | # now nuke some methods that are overridden by the backend. |
1467 | # now nuke some methods that are overridden by the backend. |
1336 | # SUPER is not allowed. |
1468 | # SUPER usage is not allowed in these. |
1337 | for (qw(time signal child idle)) { |
1469 | for (qw(time signal child idle)) { |
1338 | undef &{"AnyEvent::Base::$_"} |
1470 | undef &{"AnyEvent::Base::$_"} |
1339 | if defined &{"$MODEL\::$_"}; |
1471 | if defined &{"$MODEL\::$_"}; |
1340 | } |
1472 | } |
1341 | |
1473 | |
|
|
1474 | _isa_set; |
|
|
1475 | |
|
|
1476 | # we're officially open! |
|
|
1477 | |
1342 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
1478 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
1343 | eval { require AnyEvent::Strict }; |
1479 | require AnyEvent::Strict; |
1344 | warn "AnyEvent: cannot load AnyEvent::Strict: $@" |
|
|
1345 | if $@ && $VERBOSE; |
|
|
1346 | } |
1480 | } |
1347 | |
1481 | |
|
|
1482 | if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) { |
|
|
1483 | require AnyEvent::Debug; |
|
|
1484 | AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP}); |
|
|
1485 | } |
|
|
1486 | |
|
|
1487 | if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) { |
|
|
1488 | require AnyEvent::Socket; |
|
|
1489 | require AnyEvent::Debug; |
|
|
1490 | |
|
|
1491 | my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL}; |
|
|
1492 | $shell =~ s/\$\$/$$/g; |
|
|
1493 | |
|
|
1494 | my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell); |
|
|
1495 | $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service); |
|
|
1496 | } |
|
|
1497 | |
|
|
1498 | # now the anyevent environment is set up as the user told us to, so |
|
|
1499 | # call the actual user code - post detects |
|
|
1500 | |
1348 | (shift @post_detect)->() while @post_detect; |
1501 | (shift @post_detect)->() while @post_detect; |
|
|
1502 | undef @post_detect; |
1349 | |
1503 | |
1350 | *post_detect = sub(&) { |
1504 | *post_detect = sub(&) { |
1351 | shift->(); |
1505 | shift->(); |
1352 | |
1506 | |
1353 | undef |
1507 | undef |
1354 | }; |
1508 | }; |
1355 | |
1509 | |
1356 | $MODEL |
1510 | $MODEL |
1357 | } |
1511 | } |
1358 | |
1512 | |
1359 | sub AUTOLOAD { |
1513 | for my $name (@methods) { |
1360 | (my $func = $AUTOLOAD) =~ s/.*://; |
1514 | *$name = sub { |
1361 | |
|
|
1362 | $method{$func} |
|
|
1363 | or Carp::croak "$func: not a valid AnyEvent class method"; |
|
|
1364 | |
|
|
1365 | detect; |
1515 | detect; |
1366 | |
1516 | # we use goto because |
1367 | my $class = shift; |
1517 | # a) it makes the thunk more transparent |
1368 | $class->$func (@_); |
1518 | # b) it allows us to delete the thunk later |
1369 | } |
1519 | goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" } |
1370 | |
1520 | }; |
1371 | our $POSTPONE_W; |
|
|
1372 | our @POSTPONE; |
|
|
1373 | |
|
|
1374 | sub _postpone_exec { |
|
|
1375 | undef $POSTPONE_W; |
|
|
1376 | (pop @POSTPONE)->() |
|
|
1377 | while @POSTPONE; |
|
|
1378 | } |
|
|
1379 | |
|
|
1380 | sub postpone(&) { |
|
|
1381 | push @POSTPONE, shift; |
|
|
1382 | |
|
|
1383 | $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); |
|
|
1384 | |
|
|
1385 | () |
|
|
1386 | } |
1521 | } |
1387 | |
1522 | |
1388 | # utility function to dup a filehandle. this is used by many backends |
1523 | # utility function to dup a filehandle. this is used by many backends |
1389 | # to support binding more than one watcher per filehandle (they usually |
1524 | # to support binding more than one watcher per filehandle (they usually |
1390 | # allow only one watcher per fd, so we dup it to get a different one). |
1525 | # allow only one watcher per fd, so we dup it to get a different one). |
… | |
… | |
1414 | |
1549 | |
1415 | package AE; |
1550 | package AE; |
1416 | |
1551 | |
1417 | our $VERSION = $AnyEvent::VERSION; |
1552 | our $VERSION = $AnyEvent::VERSION; |
1418 | |
1553 | |
|
|
1554 | sub _reset() { |
|
|
1555 | eval q{ |
1419 | # fall back to the main API by default - backends and AnyEvent::Base |
1556 | # fall back to the main API by default - backends and AnyEvent::Base |
1420 | # implementations can overwrite these. |
1557 | # implementations can overwrite these. |
1421 | |
1558 | |
1422 | sub io($$$) { |
1559 | sub io($$$) { |
1423 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
1560 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
1424 | } |
1561 | } |
1425 | |
1562 | |
1426 | sub timer($$$) { |
1563 | sub timer($$$) { |
1427 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) |
1564 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) |
1428 | } |
1565 | } |
1429 | |
1566 | |
1430 | sub signal($$) { |
1567 | sub signal($$) { |
1431 | AnyEvent->signal (signal => $_[0], cb => $_[1]) |
1568 | AnyEvent->signal (signal => $_[0], cb => $_[1]) |
1432 | } |
1569 | } |
1433 | |
1570 | |
1434 | sub child($$) { |
1571 | sub child($$) { |
1435 | AnyEvent->child (pid => $_[0], cb => $_[1]) |
1572 | AnyEvent->child (pid => $_[0], cb => $_[1]) |
1436 | } |
1573 | } |
1437 | |
1574 | |
1438 | sub idle($) { |
1575 | sub idle($) { |
1439 | AnyEvent->idle (cb => $_[0]) |
1576 | AnyEvent->idle (cb => $_[0]); |
1440 | } |
1577 | } |
1441 | |
1578 | |
1442 | sub cv(;&) { |
1579 | sub cv(;&) { |
1443 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
1580 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
1444 | } |
1581 | } |
1445 | |
1582 | |
1446 | sub now() { |
1583 | sub now() { |
1447 | AnyEvent->now |
1584 | AnyEvent->now |
1448 | } |
1585 | } |
1449 | |
1586 | |
1450 | sub now_update() { |
1587 | sub now_update() { |
1451 | AnyEvent->now_update |
1588 | AnyEvent->now_update |
1452 | } |
1589 | } |
1453 | |
1590 | |
1454 | sub time() { |
1591 | sub time() { |
1455 | AnyEvent->time |
1592 | AnyEvent->time |
1456 | } |
1593 | } |
1457 | |
1594 | |
1458 | *postpone = \&AnyEvent::postpone; |
1595 | *postpone = \&AnyEvent::postpone; |
|
|
1596 | *log = \&AnyEvent::log; |
|
|
1597 | }; |
|
|
1598 | die if $@; |
|
|
1599 | } |
|
|
1600 | |
|
|
1601 | BEGIN { _reset } |
1459 | |
1602 | |
1460 | package AnyEvent::Base; |
1603 | package AnyEvent::Base; |
1461 | |
1604 | |
1462 | # default implementations for many methods |
1605 | # default implementations for many methods |
1463 | |
1606 | |
1464 | sub time { |
1607 | sub time { |
1465 | eval q{ # poor man's autoloading {} |
1608 | eval q{ # poor man's autoloading {} |
1466 | # probe for availability of Time::HiRes |
1609 | # probe for availability of Time::HiRes |
1467 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1610 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1468 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1611 | *time = sub { Time::HiRes::time () }; |
1469 | *AE::time = \&Time::HiRes::time; |
1612 | *AE::time = \& Time::HiRes::time ; |
|
|
1613 | *now = \&time; |
|
|
1614 | AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."; |
1470 | # if (eval "use POSIX (); (POSIX::times())... |
1615 | # if (eval "use POSIX (); (POSIX::times())... |
1471 | } else { |
1616 | } else { |
|
|
1617 | *time = sub { CORE::time }; |
|
|
1618 | *AE::time = sub (){ CORE::time }; |
|
|
1619 | *now = \&time; |
1472 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1620 | AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!"; |
1473 | *AE::time = sub (){ time }; # epic fail |
|
|
1474 | } |
1621 | } |
1475 | |
|
|
1476 | *time = sub { AE::time }; # different prototypes |
|
|
1477 | }; |
1622 | }; |
1478 | die if $@; |
1623 | die if $@; |
1479 | |
1624 | |
1480 | &time |
1625 | &time |
1481 | } |
1626 | } |
1482 | |
1627 | |
1483 | *now = \&time; |
1628 | *now = \&time; |
1484 | |
|
|
1485 | sub now_update { } |
1629 | sub now_update { } |
1486 | |
1630 | |
1487 | sub _poll { |
1631 | sub _poll { |
1488 | Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; |
1632 | Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; |
1489 | } |
1633 | } |
… | |
… | |
1575 | |
1719 | |
1576 | sub signal { |
1720 | sub signal { |
1577 | eval q{ # poor man's autoloading {} |
1721 | eval q{ # poor man's autoloading {} |
1578 | # probe for availability of Async::Interrupt |
1722 | # probe for availability of Async::Interrupt |
1579 | if (_have_async_interrupt) { |
1723 | if (_have_async_interrupt) { |
1580 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
1724 | AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."; |
1581 | |
1725 | |
1582 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1726 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1583 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1727 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1584 | |
1728 | |
1585 | } else { |
1729 | } else { |
1586 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
1730 | AnyEvent::log 8 => "using emulated perl signal handling with latency timer."; |
1587 | |
1731 | |
1588 | if (AnyEvent::WIN32) { |
1732 | if (AnyEvent::WIN32) { |
1589 | require AnyEvent::Util; |
1733 | require AnyEvent::Util; |
1590 | |
1734 | |
1591 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1735 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
… | |
… | |
1667 | : sysread $SIGPIPE_R, (my $dummy), 9; |
1811 | : sysread $SIGPIPE_R, (my $dummy), 9; |
1668 | |
1812 | |
1669 | while (%SIG_EV) { |
1813 | while (%SIG_EV) { |
1670 | for (keys %SIG_EV) { |
1814 | for (keys %SIG_EV) { |
1671 | delete $SIG_EV{$_}; |
1815 | delete $SIG_EV{$_}; |
1672 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1816 | &$_ for values %{ $SIG_CB{$_} || {} }; |
1673 | } |
1817 | } |
1674 | } |
1818 | } |
1675 | }; |
1819 | }; |
1676 | }; |
1820 | }; |
1677 | die if $@; |
1821 | die if $@; |
… | |
… | |
1744 | |
1888 | |
1745 | my ($cb, $w, $rcb) = $arg{cb}; |
1889 | my ($cb, $w, $rcb) = $arg{cb}; |
1746 | |
1890 | |
1747 | $rcb = sub { |
1891 | $rcb = sub { |
1748 | if ($cb) { |
1892 | if ($cb) { |
1749 | $w = _time; |
1893 | $w = AE::time; |
1750 | &$cb; |
1894 | &$cb; |
1751 | $w = _time - $w; |
1895 | $w = AE::time - $w; |
1752 | |
1896 | |
1753 | # never use more then 50% of the time for the idle watcher, |
1897 | # never use more then 50% of the time for the idle watcher, |
1754 | # within some limits |
1898 | # within some limits |
1755 | $w = 0.0001 if $w < 0.0001; |
1899 | $w = 0.0001 if $w < 0.0001; |
1756 | $w = 5 if $w > 5; |
1900 | $w = 5 if $w > 5; |
… | |
… | |
1885 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
2029 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
1886 | so on. |
2030 | so on. |
1887 | |
2031 | |
1888 | =head1 ENVIRONMENT VARIABLES |
2032 | =head1 ENVIRONMENT VARIABLES |
1889 | |
2033 | |
1890 | The following environment variables are used by this module or its |
2034 | AnyEvent supports a number of environment variables that tune the |
1891 | submodules. |
2035 | runtime behaviour. They are usually evaluated when AnyEvent is |
|
|
2036 | loaded, initialised, or a submodule that uses them is loaded. Many of |
|
|
2037 | them also cause AnyEvent to load additional modules - for example, |
|
|
2038 | C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be |
|
|
2039 | loaded. |
1892 | |
2040 | |
1893 | Note that AnyEvent will remove I<all> environment variables starting with |
2041 | All the environment variables documented here start with |
1894 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
2042 | C<PERL_ANYEVENT_>, which is what AnyEvent considers its own |
1895 | enabled. |
2043 | namespace. Other modules are encouraged (but by no means required) to use |
|
|
2044 | C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule |
|
|
2045 | namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could |
|
|
2046 | be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env |
|
|
2047 | variables starting with C<AE_>, see below). |
|
|
2048 | |
|
|
2049 | All variables can also be set via the C<AE_> prefix, that is, instead |
|
|
2050 | of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In |
|
|
2051 | case there is a clash btween anyevent and another program that uses |
|
|
2052 | C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something> |
|
|
2053 | variable to the empty string, as those variables take precedence. |
|
|
2054 | |
|
|
2055 | When AnyEvent is first loaded, it copies all C<AE_xxx> env variables |
|
|
2056 | to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already |
|
|
2057 | exists. If taint mode is on, then AnyEvent will remove I<all> environment |
|
|
2058 | variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them |
|
|
2059 | with C<undef> or the empty string, if the corresaponding C<AE_> variable |
|
|
2060 | is set). |
|
|
2061 | |
|
|
2062 | The exact algorithm is currently: |
|
|
2063 | |
|
|
2064 | 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV |
|
|
2065 | 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists |
|
|
2066 | 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef. |
|
|
2067 | |
|
|
2068 | This ensures that child processes will not see the C<AE_> variables. |
|
|
2069 | |
|
|
2070 | The following environment variables are currently known to AnyEvent: |
1896 | |
2071 | |
1897 | =over 4 |
2072 | =over 4 |
1898 | |
2073 | |
1899 | =item C<PERL_ANYEVENT_VERBOSE> |
2074 | =item C<PERL_ANYEVENT_VERBOSE> |
1900 | |
2075 | |
1901 | By default, AnyEvent will be completely silent except in fatal |
2076 | By default, AnyEvent will only log messages with loglevel C<3> |
1902 | conditions. You can set this environment variable to make AnyEvent more |
2077 | (C<critical>) or higher (see L<AnyEvent::Log>). You can set this |
|
|
2078 | environment variable to a numerical loglevel to make AnyEvent more (or |
1903 | talkative. |
2079 | less) talkative. |
1904 | |
2080 | |
|
|
2081 | If you want to do more than just set the global logging level |
|
|
2082 | you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more |
|
|
2083 | complex specifications. |
|
|
2084 | |
|
|
2085 | When set to C<0> (C<off>), then no messages whatsoever will be logged with |
|
|
2086 | the default logging settings. |
|
|
2087 | |
1905 | When set to C<1> or higher, causes AnyEvent to warn about unexpected |
2088 | When set to C<5> or higher (C<warn>), causes AnyEvent to warn about |
1906 | conditions, such as not being able to load the event model specified by |
2089 | unexpected conditions, such as not being able to load the event model |
1907 | C<PERL_ANYEVENT_MODEL>. |
2090 | specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an |
|
|
2091 | exception - this is the minimum recommended level. |
1908 | |
2092 | |
1909 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
2093 | When set to C<7> or higher (info), cause AnyEvent to report which event model it |
1910 | model it chooses. |
2094 | chooses. |
1911 | |
2095 | |
1912 | When set to C<8> or higher, then AnyEvent will report extra information on |
2096 | When set to C<8> or higher (debug), then AnyEvent will report extra information on |
1913 | which optional modules it loads and how it implements certain features. |
2097 | which optional modules it loads and how it implements certain features. |
|
|
2098 | |
|
|
2099 | =item C<PERL_ANYEVENT_LOG> |
|
|
2100 | |
|
|
2101 | Accepts rather complex logging specifications. For example, you could log |
|
|
2102 | all C<debug> messages of some module to stderr, warnings and above to |
|
|
2103 | stderr, and errors and above to syslog, with: |
|
|
2104 | |
|
|
2105 | PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog |
|
|
2106 | |
|
|
2107 | For the rather extensive details, see L<AnyEvent::Log>. |
|
|
2108 | |
|
|
2109 | This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded, |
|
|
2110 | so will take effect even before AnyEvent has initialised itself. |
|
|
2111 | |
|
|
2112 | Note that specifying this environment variable causes the L<AnyEvent::Log> |
|
|
2113 | module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only |
|
|
2114 | using the latter saves a few hundred kB of memory until the first message |
|
|
2115 | is being logged. |
1914 | |
2116 | |
1915 | =item C<PERL_ANYEVENT_STRICT> |
2117 | =item C<PERL_ANYEVENT_STRICT> |
1916 | |
2118 | |
1917 | AnyEvent does not do much argument checking by default, as thorough |
2119 | AnyEvent does not do much argument checking by default, as thorough |
1918 | argument checking is very costly. Setting this variable to a true value |
2120 | argument checking is very costly. Setting this variable to a true value |
… | |
… | |
1925 | Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> |
2127 | Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> |
1926 | >>, it is definitely recommended to keep it off in production. Keeping |
2128 | >>, it is definitely recommended to keep it off in production. Keeping |
1927 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
2129 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
1928 | can be very useful, however. |
2130 | can be very useful, however. |
1929 | |
2131 | |
|
|
2132 | =item C<PERL_ANYEVENT_DEBUG_SHELL> |
|
|
2133 | |
|
|
2134 | If this env variable is nonempty, then its contents will be interpreted by |
|
|
2135 | C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after |
|
|
2136 | replacing every occurance of C<$$> by the process pid). The shell object |
|
|
2137 | is saved in C<$AnyEvent::Debug::SHELL>. |
|
|
2138 | |
|
|
2139 | This happens when the first watcher is created. |
|
|
2140 | |
|
|
2141 | For example, to bind a debug shell on a unix domain socket in |
|
|
2142 | F<< /tmp/debug<pid>.sock >>, you could use this: |
|
|
2143 | |
|
|
2144 | PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog |
|
|
2145 | # connect with e.g.: socat readline /tmp/debug123.sock |
|
|
2146 | |
|
|
2147 | Or to bind to tcp port 4545 on localhost: |
|
|
2148 | |
|
|
2149 | PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog |
|
|
2150 | # connect with e.g.: telnet localhost 4545 |
|
|
2151 | |
|
|
2152 | Note that creating sockets in F</tmp> or on localhost is very unsafe on |
|
|
2153 | multiuser systems. |
|
|
2154 | |
|
|
2155 | =item C<PERL_ANYEVENT_DEBUG_WRAP> |
|
|
2156 | |
|
|
2157 | Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for |
|
|
2158 | debugging purposes. See C<AnyEvent::Debug::wrap> for details. |
|
|
2159 | |
1930 | =item C<PERL_ANYEVENT_MODEL> |
2160 | =item C<PERL_ANYEVENT_MODEL> |
1931 | |
2161 | |
1932 | This can be used to specify the event model to be used by AnyEvent, before |
2162 | This can be used to specify the event model to be used by AnyEvent, before |
1933 | auto detection and -probing kicks in. It must be a string consisting |
2163 | auto detection and -probing kicks in. |
1934 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
2164 | |
|
|
2165 | It normally is a string consisting entirely of ASCII letters (e.g. C<EV> |
|
|
2166 | or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the |
1935 | and the resulting module name is loaded and if the load was successful, |
2167 | resulting module name is loaded and - if the load was successful - used as |
1936 | used as event model. If it fails to load AnyEvent will proceed with |
2168 | event model backend. If it fails to load then AnyEvent will proceed with |
1937 | auto detection and -probing. |
2169 | auto detection and -probing. |
1938 | |
2170 | |
1939 | This functionality might change in future versions. |
2171 | If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then |
|
|
2172 | nothing gets prepended and the module name is used as-is (hint: C<::> at |
|
|
2173 | the end of a string designates a module name and quotes it appropriately). |
1940 | |
2174 | |
1941 | For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you |
2175 | For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you |
1942 | could start your program like this: |
2176 | could start your program like this: |
1943 | |
2177 | |
1944 | PERL_ANYEVENT_MODEL=Perl perl ... |
2178 | PERL_ANYEVENT_MODEL=Perl perl ... |
… | |
… | |
1962 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
2196 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
1963 | - only support IPv4, never try to resolve or contact IPv6 |
2197 | - only support IPv4, never try to resolve or contact IPv6 |
1964 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
2198 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
1965 | IPv6, but prefer IPv6 over IPv4. |
2199 | IPv6, but prefer IPv6 over IPv4. |
1966 | |
2200 | |
|
|
2201 | =item C<PERL_ANYEVENT_HOSTS> |
|
|
2202 | |
|
|
2203 | This variable, if specified, overrides the F</etc/hosts> file used by |
|
|
2204 | L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read |
|
|
2205 | from that file instead. |
|
|
2206 | |
1967 | =item C<PERL_ANYEVENT_EDNS0> |
2207 | =item C<PERL_ANYEVENT_EDNS0> |
1968 | |
2208 | |
1969 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension |
2209 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for |
1970 | for DNS. This extension is generally useful to reduce DNS traffic, but |
2210 | DNS. This extension is generally useful to reduce DNS traffic, especially |
1971 | some (broken) firewalls drop such DNS packets, which is why it is off by |
2211 | when DNSSEC is involved, but some (broken) firewalls drop such DNS |
1972 | default. |
2212 | packets, which is why it is off by default. |
1973 | |
2213 | |
1974 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
2214 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
1975 | EDNS0 in its DNS requests. |
2215 | EDNS0 in its DNS requests. |
1976 | |
2216 | |
1977 | =item C<PERL_ANYEVENT_MAX_FORKS> |
2217 | =item C<PERL_ANYEVENT_MAX_FORKS> |
… | |
… | |
1983 | |
2223 | |
1984 | The default value for the C<max_outstanding> parameter for the default DNS |
2224 | The default value for the C<max_outstanding> parameter for the default DNS |
1985 | resolver - this is the maximum number of parallel DNS requests that are |
2225 | resolver - this is the maximum number of parallel DNS requests that are |
1986 | sent to the DNS server. |
2226 | sent to the DNS server. |
1987 | |
2227 | |
|
|
2228 | =item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY> |
|
|
2229 | |
|
|
2230 | Perl has inherently racy signal handling (you can basically choose between |
|
|
2231 | losing signals and memory corruption) - pure perl event loops (including |
|
|
2232 | C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore |
|
|
2233 | have to poll regularly to avoid losing signals. |
|
|
2234 | |
|
|
2235 | Some event loops are racy, but don't poll regularly, and some event loops |
|
|
2236 | are written in C but are still racy. For those event loops, AnyEvent |
|
|
2237 | installs a timer that regularly wakes up the event loop. |
|
|
2238 | |
|
|
2239 | By default, the interval for this timer is C<10> seconds, but you can |
|
|
2240 | override this delay with this environment variable (or by setting |
|
|
2241 | the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal |
|
|
2242 | watchers). |
|
|
2243 | |
|
|
2244 | Lower values increase CPU (and energy) usage, higher values can introduce |
|
|
2245 | long delays when reaping children or waiting for signals. |
|
|
2246 | |
|
|
2247 | The L<AnyEvent::Async> module, if available, will be used to avoid this |
|
|
2248 | polling (with most event loops). |
|
|
2249 | |
1988 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
2250 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
1989 | |
2251 | |
1990 | The file to use instead of F</etc/resolv.conf> (or OS-specific |
2252 | The absolute path to a F<resolv.conf>-style file to use instead of |
1991 | configuration) in the default resolver. When set to the empty string, no |
2253 | F</etc/resolv.conf> (or the OS-specific configuration) in the default |
1992 | default config will be used. |
2254 | resolver, or the empty string to select the default configuration. |
1993 | |
2255 | |
1994 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
2256 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
1995 | |
2257 | |
1996 | When neither C<ca_file> nor C<ca_path> was specified during |
2258 | When neither C<ca_file> nor C<ca_path> was specified during |
1997 | L<AnyEvent::TLS> context creation, and either of these environment |
2259 | L<AnyEvent::TLS> context creation, and either of these environment |
1998 | variables exist, they will be used to specify CA certificate locations |
2260 | variables are nonempty, they will be used to specify CA certificate |
1999 | instead of a system-dependent default. |
2261 | locations instead of a system-dependent default. |
2000 | |
2262 | |
2001 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
2263 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
2002 | |
2264 | |
2003 | When these are set to C<1>, then the respective modules are not |
2265 | When these are set to C<1>, then the respective modules are not |
2004 | loaded. Mostly good for testing AnyEvent itself. |
2266 | loaded. Mostly good for testing AnyEvent itself. |
… | |
… | |
2336 | (even when used without AnyEvent), but most event loops have acceptable |
2598 | (even when used without AnyEvent), but most event loops have acceptable |
2337 | performance with or without AnyEvent. |
2599 | performance with or without AnyEvent. |
2338 | |
2600 | |
2339 | =item * The overhead AnyEvent adds is usually much smaller than the overhead of |
2601 | =item * The overhead AnyEvent adds is usually much smaller than the overhead of |
2340 | the actual event loop, only with extremely fast event loops such as EV |
2602 | the actual event loop, only with extremely fast event loops such as EV |
2341 | adds AnyEvent significant overhead. |
2603 | does AnyEvent add significant overhead. |
2342 | |
2604 | |
2343 | =item * You should avoid POE like the plague if you want performance or |
2605 | =item * You should avoid POE like the plague if you want performance or |
2344 | reasonable memory usage. |
2606 | reasonable memory usage. |
2345 | |
2607 | |
2346 | =back |
2608 | =back |
… | |
… | |
2721 | |
2983 | |
2722 | Tutorial/Introduction: L<AnyEvent::Intro>. |
2984 | Tutorial/Introduction: L<AnyEvent::Intro>. |
2723 | |
2985 | |
2724 | FAQ: L<AnyEvent::FAQ>. |
2986 | FAQ: L<AnyEvent::FAQ>. |
2725 | |
2987 | |
2726 | Utility functions: L<AnyEvent::Util>. |
2988 | Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log> |
|
|
2989 | (simply logging). |
2727 | |
2990 | |
|
|
2991 | Development/Debugging: L<AnyEvent::Strict> (stricter checking), |
|
|
2992 | L<AnyEvent::Debug> (interactive shell, watcher tracing). |
|
|
2993 | |
2728 | Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>, |
2994 | Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, |
2729 | L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2995 | L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, |
|
|
2996 | L<Qt>, L<POE>, L<FLTK>. |
2730 | |
2997 | |
2731 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2998 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2732 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2999 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2733 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
3000 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2734 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
3001 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>, |
|
|
3002 | L<AnyEvent::Impl::FLTK>. |
2735 | |
3003 | |
2736 | Non-blocking file handles, sockets, TCP clients and |
3004 | Non-blocking handles, pipes, stream sockets, TCP clients and |
2737 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
3005 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2738 | |
3006 | |
2739 | Asynchronous DNS: L<AnyEvent::DNS>. |
3007 | Asynchronous DNS: L<AnyEvent::DNS>. |
2740 | |
3008 | |
2741 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
3009 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |