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 L<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 | |
… | |
… | |
765 | }; |
763 | }; |
766 | } |
764 | } |
767 | |
765 | |
768 | $cv->end; |
766 | $cv->end; |
769 | |
767 | |
|
|
768 | ... |
|
|
769 | |
|
|
770 | my $results = $cv->recv; |
|
|
771 | |
770 | This code fragment supposedly pings a number of hosts and calls |
772 | This code fragment supposedly pings a number of hosts and calls |
771 | C<send> after results for all then have have been gathered - in any |
773 | C<send> after results for all then have have been gathered - in any |
772 | order. To achieve this, the code issues a call to C<begin> when it starts |
774 | order. To achieve this, the code issues a call to C<begin> when it starts |
773 | each ping request and calls C<end> when it has received some result for |
775 | each ping request and calls C<end> when it has received some result for |
774 | it. Since C<begin> and C<end> only maintain a counter, the order in which |
776 | it. Since C<begin> and C<end> only maintain a counter, the order in which |
… | |
… | |
878 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
880 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
879 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
881 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
880 | AnyEvent::Impl::Irssi used when running within irssi. |
882 | AnyEvent::Impl::Irssi used when running within irssi. |
881 | AnyEvent::Impl::IOAsync based on IO::Async. |
883 | AnyEvent::Impl::IOAsync based on IO::Async. |
882 | AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. |
884 | AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. |
883 | AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding). |
885 | AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding). |
884 | |
886 | |
885 | =item Backends with special needs. |
887 | =item Backends with special needs. |
886 | |
888 | |
887 | Qt requires the Qt::Application to be instantiated first, but will |
889 | Qt requires the Qt::Application to be instantiated first, but will |
888 | otherwise be picked up automatically. As long as the main program |
890 | otherwise be picked up automatically. As long as the main program |
… | |
… | |
933 | |
935 | |
934 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
936 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
935 | if necessary. You should only call this function right before you would |
937 | 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 |
938 | have created an AnyEvent watcher anyway, that is, as late as possible at |
937 | runtime, and not e.g. during initialisation of your module. |
939 | runtime, and not e.g. during initialisation of your module. |
|
|
940 | |
|
|
941 | The effect of calling this function is as if a watcher had been created |
|
|
942 | (specifically, actions that happen "when the first watcher is created" |
|
|
943 | happen when calling detetc as well). |
938 | |
944 | |
939 | If you need to do some initialisation before AnyEvent watchers are |
945 | If you need to do some initialisation before AnyEvent watchers are |
940 | created, use C<post_detect>. |
946 | created, use C<post_detect>. |
941 | |
947 | |
942 | =item $guard = AnyEvent::post_detect { BLOCK } |
948 | =item $guard = AnyEvent::post_detect { BLOCK } |
… | |
… | |
1045 | It should use C<postpone>: |
1051 | It should use C<postpone>: |
1046 | |
1052 | |
1047 | AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later |
1053 | AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later |
1048 | if $some_error_condition; |
1054 | if $some_error_condition; |
1049 | |
1055 | |
|
|
1056 | =item AnyEvent::log $level, $msg[, @args] |
|
|
1057 | |
|
|
1058 | Log the given C<$msg> at the given C<$level>. |
|
|
1059 | |
|
|
1060 | If L<AnyEvent::Log> is not loaded then this function makes a simple test |
|
|
1061 | to see whether the message will be logged. If the test succeeds it will |
|
|
1062 | load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at |
|
|
1063 | the L<AnyEvent::Log> documentation for details. |
|
|
1064 | |
|
|
1065 | If the test fails it will simply return. Right now this happens when a |
|
|
1066 | numerical loglevel is used and it is larger than the level specified via |
|
|
1067 | C<$ENV{PERL_ANYEVENT_VERBOSE}>. |
|
|
1068 | |
|
|
1069 | If you want to sprinkle loads of logging calls around your code, consider |
|
|
1070 | creating a logger callback with the C<AnyEvent::Log::logger> function, |
|
|
1071 | which can reduce typing, codesize and can reduce the logging overhead |
|
|
1072 | enourmously. |
|
|
1073 | |
1050 | =back |
1074 | =back |
1051 | |
1075 | |
1052 | =head1 WHAT TO DO IN A MODULE |
1076 | =head1 WHAT TO DO IN A MODULE |
1053 | |
1077 | |
1054 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
1078 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
… | |
… | |
1110 | |
1134 | |
1111 | |
1135 | |
1112 | =head1 OTHER MODULES |
1136 | =head1 OTHER MODULES |
1113 | |
1137 | |
1114 | The following is a non-exhaustive list of additional modules that use |
1138 | 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 |
1139 | 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 |
1140 | 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. |
1141 | modules come as part of AnyEvent, the others are available via CPAN (see |
|
|
1142 | L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for |
|
|
1143 | a longer non-exhaustive list), and the list is heavily biased towards |
|
|
1144 | modules of the AnyEvent author himself :) |
1118 | |
1145 | |
1119 | =over 4 |
1146 | =over 4 |
1120 | |
1147 | |
1121 | =item L<AnyEvent::Util> |
1148 | =item L<AnyEvent::Util> |
1122 | |
1149 | |
… | |
… | |
1142 | =item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> |
1169 | =item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> |
1143 | |
1170 | |
1144 | Implement event-based interfaces to the protocols of the same name (for |
1171 | 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 |
1172 | the curious, IGS is the International Go Server and FCP is the Freenet |
1146 | Client Protocol). |
1173 | 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 | |
1174 | |
1170 | =item L<AnyEvent::AIO> |
1175 | =item L<AnyEvent::AIO> |
1171 | |
1176 | |
1172 | Truly asynchronous (as opposed to non-blocking) I/O, should be in the |
1177 | Truly asynchronous (as opposed to non-blocking) I/O, should be in the |
1173 | toolbox of every event programmer. AnyEvent::AIO transparently fuses |
1178 | toolbox of every event programmer. AnyEvent::AIO transparently fuses |
1174 | L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based |
1179 | L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based |
1175 | file I/O, and much more. |
1180 | file I/O, and much more. |
1176 | |
1181 | |
|
|
1182 | =item L<AnyEvent::Filesys::Notify> |
|
|
1183 | |
|
|
1184 | AnyEvent is good for non-blocking stuff, but it can't detect file or |
|
|
1185 | path changes (e.g. "watch this directory for new files", "watch this |
|
|
1186 | file for changes"). The L<AnyEvent::Filesys::Notify> module promises to |
|
|
1187 | do just that in a portbale fashion, supporting inotify on GNU/Linux and |
|
|
1188 | some weird, without doubt broken, stuff on OS X to monitor files. It can |
|
|
1189 | fall back to blocking scans at regular intervals transparently on other |
|
|
1190 | platforms, so it's about as portable as it gets. |
|
|
1191 | |
|
|
1192 | (I haven't used it myself, but I haven't heard anybody complaining about |
|
|
1193 | it yet). |
|
|
1194 | |
|
|
1195 | =item L<AnyEvent::DBI> |
|
|
1196 | |
|
|
1197 | Executes L<DBI> requests asynchronously in a proxy process for you, |
|
|
1198 | notifying you in an event-based way when the operation is finished. |
|
|
1199 | |
1177 | =item L<AnyEvent::HTTPD> |
1200 | =item L<AnyEvent::HTTPD> |
1178 | |
1201 | |
1179 | A simple embedded webserver. |
1202 | A simple embedded webserver. |
1180 | |
1203 | |
1181 | =item L<AnyEvent::FastPing> |
1204 | =item L<AnyEvent::FastPing> |
1182 | |
1205 | |
1183 | The fastest ping in the west. |
1206 | The fastest ping in the west. |
1184 | |
1207 | |
1185 | =item L<Coro> |
1208 | =item L<Coro> |
1186 | |
1209 | |
1187 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
1210 | Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you |
|
|
1211 | to simply invert the flow control - don't call us, we will call you: |
|
|
1212 | |
|
|
1213 | async { |
|
|
1214 | Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it |
|
|
1215 | print "5 seconds later!\n"; |
|
|
1216 | |
|
|
1217 | Coro::AnyEvent::readable *STDIN; # uses an I/O watcher |
|
|
1218 | my $line = <STDIN>; # works for ttys |
|
|
1219 | |
|
|
1220 | AnyEvent::HTTP::http_get "url", Coro::rouse_cb; |
|
|
1221 | my ($body, $hdr) = Coro::rouse_wait; |
|
|
1222 | }; |
1188 | |
1223 | |
1189 | =back |
1224 | =back |
1190 | |
1225 | |
1191 | =cut |
1226 | =cut |
1192 | |
1227 | |
1193 | package AnyEvent; |
1228 | package AnyEvent; |
1194 | |
1229 | |
1195 | # basically a tuned-down version of common::sense |
1230 | # basically a tuned-down version of common::sense |
1196 | sub common_sense { |
1231 | sub common_sense { |
1197 | # from common:.sense 3.4 |
1232 | # from common:.sense 3.5 |
|
|
1233 | local $^W; |
1198 | ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00"; |
1234 | ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00"; |
1199 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
1235 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
1200 | $^H |= 0x00000600; |
1236 | $^H |= 0x00000600; |
1201 | } |
1237 | } |
1202 | |
1238 | |
1203 | BEGIN { AnyEvent::common_sense } |
1239 | BEGIN { AnyEvent::common_sense } |
1204 | |
1240 | |
1205 | use Carp (); |
1241 | use Carp (); |
1206 | |
1242 | |
1207 | our $VERSION = '5.34'; |
1243 | our $VERSION = '7.04'; |
1208 | our $MODEL; |
1244 | our $MODEL; |
1209 | |
|
|
1210 | our $AUTOLOAD; |
|
|
1211 | our @ISA; |
1245 | our @ISA; |
1212 | |
|
|
1213 | our @REGISTRY; |
1246 | our @REGISTRY; |
1214 | |
|
|
1215 | our $VERBOSE; |
1247 | our $VERBOSE; |
|
|
1248 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
|
|
1249 | our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} || 10; # executes after the BEGIN block below (tainting!) |
1216 | |
1250 | |
1217 | BEGIN { |
1251 | BEGIN { |
1218 | require "AnyEvent/constants.pl"; |
1252 | require "AnyEvent/constants.pl"; |
1219 | |
1253 | |
1220 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
1254 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
1221 | |
1255 | |
1222 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1256 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1223 | if ${^TAINT}; |
1257 | if ${^TAINT}; |
1224 | |
1258 | |
1225 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1259 | $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"} |
|
|
1260 | for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV; |
1226 | |
1261 | |
1227 | } |
1262 | @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = () |
|
|
1263 | if ${^TAINT}; |
1228 | |
1264 | |
1229 | our $MAX_SIGNAL_LATENCY = 10; |
1265 | # $ENV{PERL_ANYEVENT_xxx} now valid |
1230 | |
1266 | |
1231 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1267 | $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4; |
1232 | |
1268 | |
1233 | { |
|
|
1234 | my $idx; |
1269 | my $idx; |
1235 | $PROTOCOL{$_} = ++$idx |
1270 | $PROTOCOL{$_} = ++$idx |
1236 | for reverse split /\s*,\s*/, |
1271 | for reverse split /\s*,\s*/, |
1237 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1272 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1238 | } |
1273 | } |
… | |
… | |
1269 | $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); |
1304 | $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); |
1270 | |
1305 | |
1271 | () |
1306 | () |
1272 | } |
1307 | } |
1273 | |
1308 | |
|
|
1309 | sub log($$;@) { |
|
|
1310 | # only load the big bloated module when we actually are about to log something |
|
|
1311 | if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal |
|
|
1312 | local ($!, $@); |
|
|
1313 | require AnyEvent::Log; # among other things, sets $VERBOSE to 9 |
|
|
1314 | # AnyEvent::Log overwrites this function |
|
|
1315 | goto &log; |
|
|
1316 | } |
|
|
1317 | |
|
|
1318 | 0 # not logged |
|
|
1319 | } |
|
|
1320 | |
|
|
1321 | sub _logger($;$) { |
|
|
1322 | my ($level, $renabled) = @_; |
|
|
1323 | |
|
|
1324 | $$renabled = $level <= $VERBOSE; |
|
|
1325 | |
|
|
1326 | my $logger = [(caller)[0], $level, $renabled]; |
|
|
1327 | |
|
|
1328 | $AnyEvent::Log::LOGGER{$logger+0} = $logger; |
|
|
1329 | |
|
|
1330 | # return unless defined wantarray; |
|
|
1331 | # |
|
|
1332 | # require AnyEvent::Util; |
|
|
1333 | # my $guard = AnyEvent::Util::guard (sub { |
|
|
1334 | # # "clean up" |
|
|
1335 | # delete $LOGGER{$logger+0}; |
|
|
1336 | # }); |
|
|
1337 | # |
|
|
1338 | # sub { |
|
|
1339 | # return 0 unless $$renabled; |
|
|
1340 | # |
|
|
1341 | # $guard if 0; # keep guard alive, but don't cause runtime overhead |
|
|
1342 | # require AnyEvent::Log unless $AnyEvent::Log::VERSION; |
|
|
1343 | # package AnyEvent::Log; |
|
|
1344 | # _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time |
|
|
1345 | # } |
|
|
1346 | } |
|
|
1347 | |
|
|
1348 | if (length $ENV{PERL_ANYEVENT_LOG}) { |
|
|
1349 | require AnyEvent::Log; # AnyEvent::Log does the thing for us |
|
|
1350 | } |
|
|
1351 | |
1274 | our @models = ( |
1352 | our @models = ( |
1275 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1353 | [EV:: => AnyEvent::Impl::EV::], |
1276 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], |
1354 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl::], |
1277 | # everything below here will not (normally) be autoprobed |
1355 | # everything below here will not (normally) be autoprobed |
1278 | # as the pure perl backend should work everywhere |
1356 | # as the pure perl backend should work everywhere |
1279 | # and is usually faster |
1357 | # and is usually faster |
|
|
1358 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top |
1280 | [Event:: => AnyEvent::Impl::Event::, 1], |
1359 | [Event:: => AnyEvent::Impl::Event::], # slow, stable |
1281 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1360 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
|
|
1361 | # everything below here should not be autoloaded |
1282 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1362 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1283 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
|
|
1284 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1363 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1285 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1364 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1286 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1365 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1287 | [Wx:: => AnyEvent::Impl::POE::], |
1366 | [Wx:: => AnyEvent::Impl::POE::], |
1288 | [Prima:: => AnyEvent::Impl::POE::], |
1367 | [Prima:: => AnyEvent::Impl::POE::], |
1289 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect |
1368 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect |
1290 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
1369 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
1291 | [FLTK:: => AnyEvent::Impl::FLTK2::], |
1370 | [FLTK:: => AnyEvent::Impl::FLTK::], |
1292 | ); |
1371 | ); |
1293 | |
1372 | |
|
|
1373 | our @isa_hook; |
|
|
1374 | |
|
|
1375 | sub _isa_set { |
|
|
1376 | my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL); |
|
|
1377 | |
|
|
1378 | @{"$pkg[$_-1]::ISA"} = $pkg[$_] |
|
|
1379 | for 1 .. $#pkg; |
|
|
1380 | |
|
|
1381 | grep $_ && $_->[1], @isa_hook |
|
|
1382 | and AE::_reset (); |
|
|
1383 | } |
|
|
1384 | |
|
|
1385 | # used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy |
|
|
1386 | sub _isa_hook($$;$) { |
|
|
1387 | my ($i, $pkg, $reset_ae) = @_; |
|
|
1388 | |
|
|
1389 | $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef; |
|
|
1390 | |
|
|
1391 | _isa_set; |
|
|
1392 | } |
|
|
1393 | |
|
|
1394 | # all autoloaded methods reserve the complete glob, not just the method slot. |
|
|
1395 | # due to bugs in perls method cache implementation. |
|
|
1396 | our @methods = qw(io timer time now now_update signal child idle condvar); |
|
|
1397 | |
1294 | sub detect() { |
1398 | sub detect() { |
|
|
1399 | return $MODEL if $MODEL; # some programs keep references to detect |
|
|
1400 | |
|
|
1401 | # IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it |
|
|
1402 | # the author knows about the problems and what it does to AnyEvent as a whole |
|
|
1403 | # (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent |
|
|
1404 | # anyway. |
|
|
1405 | AnyEvent::log fatal => "IO::Async::Loop::AnyEvent detected - that module is broken by\n" |
|
|
1406 | . "design, abuses internals and breaks AnyEvent - will not continue." |
|
|
1407 | if exists $INC{"IO/Async/Loop/AnyEvent.pm"}; |
|
|
1408 | |
|
|
1409 | local $!; # for good measure |
|
|
1410 | local $SIG{__DIE__}; # we use eval |
|
|
1411 | |
1295 | # free some memory |
1412 | # free some memory |
1296 | *detect = sub () { $MODEL }; |
1413 | *detect = sub () { $MODEL }; |
1297 | |
1414 | # undef &func doesn't correctly update the method cache. grmbl. |
1298 | local $!; # for good measure |
1415 | # so we delete the whole glob. grmbl. |
1299 | local $SIG{__DIE__}; |
1416 | # otoh, perl doesn't let me undef an active usb, but it lets me free |
|
|
1417 | # a glob with an active sub. hrm. i hope it works, but perl is |
|
|
1418 | # usually buggy in this department. sigh. |
|
|
1419 | delete @{"AnyEvent::"}{@methods}; |
|
|
1420 | undef @methods; |
1300 | |
1421 | |
1301 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { |
1422 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { |
1302 | my $model = $1; |
1423 | my $model = $1; |
1303 | $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; |
1424 | $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; |
1304 | if (eval "require $model") { |
1425 | if (eval "require $model") { |
|
|
1426 | AnyEvent::log 7 => "Loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."; |
1305 | $MODEL = $model; |
1427 | $MODEL = $model; |
1306 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
|
|
1307 | } else { |
1428 | } else { |
1308 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
1429 | AnyEvent::log 4 => "Unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@"; |
1309 | } |
1430 | } |
1310 | } |
1431 | } |
1311 | |
1432 | |
1312 | # check for already loaded models |
1433 | # check for already loaded models |
1313 | unless ($MODEL) { |
1434 | unless ($MODEL) { |
1314 | for (@REGISTRY, @models) { |
1435 | for (@REGISTRY, @models) { |
1315 | my ($package, $model) = @$_; |
1436 | my ($package, $model) = @$_; |
1316 | if (${"$package\::VERSION"} > 0) { |
1437 | if (${"$package\::VERSION"} > 0) { |
1317 | if (eval "require $model") { |
1438 | if (eval "require $model") { |
|
|
1439 | AnyEvent::log 7 => "Autodetected model '$model', using it."; |
1318 | $MODEL = $model; |
1440 | $MODEL = $model; |
1319 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
1441 | last; |
|
|
1442 | } else { |
|
|
1443 | AnyEvent::log 8 => "Detected event loop $package, but cannot load '$model', skipping: $@"; |
|
|
1444 | } |
|
|
1445 | } |
|
|
1446 | } |
|
|
1447 | |
|
|
1448 | unless ($MODEL) { |
|
|
1449 | # try to autoload a model |
|
|
1450 | for (@REGISTRY, @models) { |
|
|
1451 | my ($package, $model) = @$_; |
|
|
1452 | if ( |
|
|
1453 | eval "require $package" |
|
|
1454 | and ${"$package\::VERSION"} > 0 |
|
|
1455 | and eval "require $model" |
|
|
1456 | ) { |
|
|
1457 | AnyEvent::log 7 => "Autoloaded model '$model', using it."; |
|
|
1458 | $MODEL = $model; |
1320 | last; |
1459 | last; |
1321 | } |
1460 | } |
1322 | } |
1461 | } |
1323 | } |
|
|
1324 | |
|
|
1325 | unless ($MODEL) { |
|
|
1326 | # try to autoload a model |
|
|
1327 | for (@REGISTRY, @models) { |
|
|
1328 | my ($package, $model, $autoload) = @$_; |
|
|
1329 | if ( |
|
|
1330 | $autoload |
|
|
1331 | and eval "require $package" |
|
|
1332 | and ${"$package\::VERSION"} > 0 |
|
|
1333 | and eval "require $model" |
|
|
1334 | ) { |
|
|
1335 | $MODEL = $model; |
|
|
1336 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
|
|
1337 | last; |
|
|
1338 | } |
|
|
1339 | } |
|
|
1340 | |
1462 | |
1341 | $MODEL |
1463 | $MODEL |
1342 | or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; |
1464 | or AnyEvent::log fatal => "Backend autodetection failed - did you properly install AnyEvent?"; |
1343 | } |
1465 | } |
1344 | } |
1466 | } |
1345 | |
1467 | |
1346 | # free memory only needed for probing |
1468 | # free memory only needed for probing |
1347 | undef @models; |
1469 | undef @models; |
1348 | undef @REGISTRY; |
1470 | undef @REGISTRY; |
1349 | |
1471 | |
1350 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1472 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1351 | unshift @ISA, $MODEL; |
|
|
1352 | |
1473 | |
1353 | # now nuke some methods that are overridden by the backend. |
1474 | # now nuke some methods that are overridden by the backend. |
1354 | # SUPER usage is not allowed in these. |
1475 | # SUPER usage is not allowed in these. |
1355 | for (qw(time signal child idle)) { |
1476 | for (qw(time signal child idle)) { |
1356 | undef &{"AnyEvent::Base::$_"} |
1477 | undef &{"AnyEvent::Base::$_"} |
1357 | if defined &{"$MODEL\::$_"}; |
1478 | if defined &{"$MODEL\::$_"}; |
1358 | } |
1479 | } |
1359 | |
1480 | |
|
|
1481 | _isa_set; |
|
|
1482 | |
|
|
1483 | # we're officially open! |
|
|
1484 | |
1360 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
1485 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
1361 | eval { require AnyEvent::Strict }; |
1486 | require AnyEvent::Strict; |
1362 | warn "AnyEvent: cannot load AnyEvent::Strict: $@" |
|
|
1363 | if $@ && $VERBOSE; |
|
|
1364 | } |
1487 | } |
|
|
1488 | |
|
|
1489 | if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) { |
|
|
1490 | require AnyEvent::Debug; |
|
|
1491 | AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP}); |
|
|
1492 | } |
|
|
1493 | |
|
|
1494 | if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) { |
|
|
1495 | require AnyEvent::Socket; |
|
|
1496 | require AnyEvent::Debug; |
|
|
1497 | |
|
|
1498 | my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL}; |
|
|
1499 | $shell =~ s/\$\$/$$/g; |
|
|
1500 | |
|
|
1501 | my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell); |
|
|
1502 | $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service); |
|
|
1503 | } |
|
|
1504 | |
|
|
1505 | # now the anyevent environment is set up as the user told us to, so |
|
|
1506 | # call the actual user code - post detects |
1365 | |
1507 | |
1366 | (shift @post_detect)->() while @post_detect; |
1508 | (shift @post_detect)->() while @post_detect; |
1367 | undef @post_detect; |
1509 | undef @post_detect; |
1368 | |
1510 | |
1369 | *post_detect = sub(&) { |
1511 | *post_detect = sub(&) { |
1370 | shift->(); |
1512 | shift->(); |
1371 | |
1513 | |
1372 | undef |
1514 | undef |
1373 | }; |
1515 | }; |
1374 | |
1516 | |
1375 | # recover a few more bytes |
1517 | $MODEL |
1376 | postpone { |
1518 | } |
1377 | undef &AUTOLOAD; |
1519 | |
|
|
1520 | for my $name (@methods) { |
|
|
1521 | *$name = sub { |
|
|
1522 | detect; |
|
|
1523 | # we use goto because |
|
|
1524 | # a) it makes the thunk more transparent |
|
|
1525 | # b) it allows us to delete the thunk later |
|
|
1526 | goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" } |
1378 | }; |
1527 | }; |
1379 | |
|
|
1380 | $MODEL |
|
|
1381 | } |
|
|
1382 | |
|
|
1383 | our %method = map +($_ => 1), |
|
|
1384 | qw(io timer time now now_update signal child idle condvar DESTROY); |
|
|
1385 | |
|
|
1386 | sub AUTOLOAD { |
|
|
1387 | (my $func = $AUTOLOAD) =~ s/.*://; |
|
|
1388 | |
|
|
1389 | $method{$func} |
|
|
1390 | or Carp::croak "$func: not a valid AnyEvent class method"; |
|
|
1391 | |
|
|
1392 | # free some memory |
|
|
1393 | undef %method; |
|
|
1394 | |
|
|
1395 | detect; |
|
|
1396 | |
|
|
1397 | my $class = shift; |
|
|
1398 | $class->$func (@_); |
|
|
1399 | } |
1528 | } |
1400 | |
1529 | |
1401 | # utility function to dup a filehandle. this is used by many backends |
1530 | # utility function to dup a filehandle. this is used by many backends |
1402 | # to support binding more than one watcher per filehandle (they usually |
1531 | # to support binding more than one watcher per filehandle (they usually |
1403 | # allow only one watcher per fd, so we dup it to get a different one). |
1532 | # allow only one watcher per fd, so we dup it to get a different one). |
… | |
… | |
1427 | |
1556 | |
1428 | package AE; |
1557 | package AE; |
1429 | |
1558 | |
1430 | our $VERSION = $AnyEvent::VERSION; |
1559 | our $VERSION = $AnyEvent::VERSION; |
1431 | |
1560 | |
1432 | |
|
|
1433 | sub _reset() { |
1561 | sub _reset() { |
1434 | eval q{ |
1562 | eval q{ |
1435 | # fall back to the main API by default - backends and AnyEvent::Base |
1563 | # fall back to the main API by default - backends and AnyEvent::Base |
1436 | # implementations can overwrite these. |
1564 | # implementations can overwrite these. |
1437 | |
1565 | |
… | |
… | |
1450 | sub child($$) { |
1578 | sub child($$) { |
1451 | AnyEvent->child (pid => $_[0], cb => $_[1]) |
1579 | AnyEvent->child (pid => $_[0], cb => $_[1]) |
1452 | } |
1580 | } |
1453 | |
1581 | |
1454 | sub idle($) { |
1582 | sub idle($) { |
1455 | AnyEvent->idle (cb => $_[0]) |
1583 | AnyEvent->idle (cb => $_[0]); |
1456 | } |
1584 | } |
1457 | |
1585 | |
1458 | sub cv(;&) { |
1586 | sub cv(;&) { |
1459 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
1587 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
1460 | } |
1588 | } |
… | |
… | |
1470 | sub time() { |
1598 | sub time() { |
1471 | AnyEvent->time |
1599 | AnyEvent->time |
1472 | } |
1600 | } |
1473 | |
1601 | |
1474 | *postpone = \&AnyEvent::postpone; |
1602 | *postpone = \&AnyEvent::postpone; |
|
|
1603 | *log = \&AnyEvent::log; |
1475 | }; |
1604 | }; |
1476 | die if $@; |
1605 | die if $@; |
1477 | } |
1606 | } |
1478 | |
1607 | |
1479 | BEGIN { _reset } |
1608 | BEGIN { _reset } |
… | |
… | |
1484 | |
1613 | |
1485 | sub time { |
1614 | sub time { |
1486 | eval q{ # poor man's autoloading {} |
1615 | eval q{ # poor man's autoloading {} |
1487 | # probe for availability of Time::HiRes |
1616 | # probe for availability of Time::HiRes |
1488 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1617 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1489 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1618 | *time = sub { Time::HiRes::time () }; |
1490 | *AE::time = \&Time::HiRes::time; |
1619 | *AE::time = \& Time::HiRes::time ; |
|
|
1620 | *now = \&time; |
|
|
1621 | AnyEvent::log 8 => "using Time::HiRes for sub-second timing accuracy."; |
1491 | # if (eval "use POSIX (); (POSIX::times())... |
1622 | # if (eval "use POSIX (); (POSIX::times())... |
1492 | } else { |
1623 | } else { |
1493 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1624 | *time = sub { CORE::time }; |
1494 | *AE::time = sub (){ time }; # epic fail |
1625 | *AE::time = sub (){ CORE::time }; |
|
|
1626 | *now = \&time; |
|
|
1627 | AnyEvent::log 3 => "Using built-in time(), no sub-second resolution!"; |
1495 | } |
1628 | } |
1496 | |
|
|
1497 | *time = sub { AE::time }; # different prototypes |
|
|
1498 | }; |
1629 | }; |
1499 | die if $@; |
1630 | die if $@; |
1500 | |
1631 | |
1501 | &time |
1632 | &time |
1502 | } |
1633 | } |
1503 | |
1634 | |
1504 | *now = \&time; |
1635 | *now = \&time; |
1505 | |
|
|
1506 | sub now_update { } |
1636 | sub now_update { } |
1507 | |
1637 | |
1508 | sub _poll { |
1638 | sub _poll { |
1509 | Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; |
1639 | Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; |
1510 | } |
1640 | } |
… | |
… | |
1596 | |
1726 | |
1597 | sub signal { |
1727 | sub signal { |
1598 | eval q{ # poor man's autoloading {} |
1728 | eval q{ # poor man's autoloading {} |
1599 | # probe for availability of Async::Interrupt |
1729 | # probe for availability of Async::Interrupt |
1600 | if (_have_async_interrupt) { |
1730 | if (_have_async_interrupt) { |
1601 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
1731 | AnyEvent::log 8 => "Using Async::Interrupt for race-free signal handling."; |
1602 | |
1732 | |
1603 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1733 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1604 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1734 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1605 | |
1735 | |
1606 | } else { |
1736 | } else { |
1607 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
1737 | AnyEvent::log 8 => "Using emulated perl signal handling with latency timer."; |
1608 | |
1738 | |
1609 | if (AnyEvent::WIN32) { |
1739 | if (AnyEvent::WIN32) { |
1610 | require AnyEvent::Util; |
1740 | require AnyEvent::Util; |
1611 | |
1741 | |
1612 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1742 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
… | |
… | |
1906 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
2036 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
1907 | so on. |
2037 | so on. |
1908 | |
2038 | |
1909 | =head1 ENVIRONMENT VARIABLES |
2039 | =head1 ENVIRONMENT VARIABLES |
1910 | |
2040 | |
1911 | The following environment variables are used by this module or its |
2041 | AnyEvent supports a number of environment variables that tune the |
1912 | submodules. |
2042 | runtime behaviour. They are usually evaluated when AnyEvent is |
|
|
2043 | loaded, initialised, or a submodule that uses them is loaded. Many of |
|
|
2044 | them also cause AnyEvent to load additional modules - for example, |
|
|
2045 | C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be |
|
|
2046 | loaded. |
1913 | |
2047 | |
1914 | Note that AnyEvent will remove I<all> environment variables starting with |
2048 | All the environment variables documented here start with |
1915 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
2049 | C<PERL_ANYEVENT_>, which is what AnyEvent considers its own |
1916 | enabled. |
2050 | namespace. Other modules are encouraged (but by no means required) to use |
|
|
2051 | C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule |
|
|
2052 | namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could |
|
|
2053 | be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env |
|
|
2054 | variables starting with C<AE_>, see below). |
|
|
2055 | |
|
|
2056 | All variables can also be set via the C<AE_> prefix, that is, instead |
|
|
2057 | of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In |
|
|
2058 | case there is a clash btween anyevent and another program that uses |
|
|
2059 | C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something> |
|
|
2060 | variable to the empty string, as those variables take precedence. |
|
|
2061 | |
|
|
2062 | When AnyEvent is first loaded, it copies all C<AE_xxx> env variables |
|
|
2063 | to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already |
|
|
2064 | exists. If taint mode is on, then AnyEvent will remove I<all> environment |
|
|
2065 | variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them |
|
|
2066 | with C<undef> or the empty string, if the corresaponding C<AE_> variable |
|
|
2067 | is set). |
|
|
2068 | |
|
|
2069 | The exact algorithm is currently: |
|
|
2070 | |
|
|
2071 | 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV |
|
|
2072 | 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists |
|
|
2073 | 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef. |
|
|
2074 | |
|
|
2075 | This ensures that child processes will not see the C<AE_> variables. |
|
|
2076 | |
|
|
2077 | The following environment variables are currently known to AnyEvent: |
1917 | |
2078 | |
1918 | =over 4 |
2079 | =over 4 |
1919 | |
2080 | |
1920 | =item C<PERL_ANYEVENT_VERBOSE> |
2081 | =item C<PERL_ANYEVENT_VERBOSE> |
1921 | |
2082 | |
1922 | By default, AnyEvent will be completely silent except in fatal |
2083 | By default, AnyEvent will log messages with loglevel C<4> (C<error>) or |
1923 | conditions. You can set this environment variable to make AnyEvent more |
2084 | higher (see L<AnyEvent::Log>). You can set this environment variable to a |
1924 | talkative. |
2085 | numerical loglevel to make AnyEvent more (or less) talkative. |
1925 | |
2086 | |
|
|
2087 | If you want to do more than just set the global logging level |
|
|
2088 | you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more |
|
|
2089 | complex specifications. |
|
|
2090 | |
|
|
2091 | When set to C<0> (C<off>), then no messages whatsoever will be logged with |
|
|
2092 | everything else at defaults. |
|
|
2093 | |
1926 | When set to C<1> or higher, causes AnyEvent to warn about unexpected |
2094 | When set to C<5> or higher (C<warn>), AnyEvent warns about unexpected |
1927 | conditions, such as not being able to load the event model specified by |
2095 | conditions, such as not being able to load the event model specified by |
1928 | C<PERL_ANYEVENT_MODEL>. |
2096 | C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this |
|
|
2097 | is the minimum recommended level for use during development. |
1929 | |
2098 | |
1930 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
2099 | When set to C<7> or higher (info), AnyEvent reports which event model it |
1931 | model it chooses. |
2100 | chooses. |
1932 | |
2101 | |
1933 | When set to C<8> or higher, then AnyEvent will report extra information on |
2102 | When set to C<8> or higher (debug), then AnyEvent will report extra |
1934 | which optional modules it loads and how it implements certain features. |
2103 | information on which optional modules it loads and how it implements |
|
|
2104 | certain features. |
|
|
2105 | |
|
|
2106 | =item C<PERL_ANYEVENT_LOG> |
|
|
2107 | |
|
|
2108 | Accepts rather complex logging specifications. For example, you could log |
|
|
2109 | all C<debug> messages of some module to stderr, warnings and above to |
|
|
2110 | stderr, and errors and above to syslog, with: |
|
|
2111 | |
|
|
2112 | PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog |
|
|
2113 | |
|
|
2114 | For the rather extensive details, see L<AnyEvent::Log>. |
|
|
2115 | |
|
|
2116 | This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded, |
|
|
2117 | so will take effect even before AnyEvent has initialised itself. |
|
|
2118 | |
|
|
2119 | Note that specifying this environment variable causes the L<AnyEvent::Log> |
|
|
2120 | module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only |
|
|
2121 | using the latter saves a few hundred kB of memory unless a module |
|
|
2122 | explicitly needs the extra features of AnyEvent::Log. |
1935 | |
2123 | |
1936 | =item C<PERL_ANYEVENT_STRICT> |
2124 | =item C<PERL_ANYEVENT_STRICT> |
1937 | |
2125 | |
1938 | AnyEvent does not do much argument checking by default, as thorough |
2126 | AnyEvent does not do much argument checking by default, as thorough |
1939 | argument checking is very costly. Setting this variable to a true value |
2127 | argument checking is very costly. Setting this variable to a true value |
… | |
… | |
1946 | Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> |
2134 | Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> |
1947 | >>, it is definitely recommended to keep it off in production. Keeping |
2135 | >>, it is definitely recommended to keep it off in production. Keeping |
1948 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
2136 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
1949 | can be very useful, however. |
2137 | can be very useful, however. |
1950 | |
2138 | |
|
|
2139 | =item C<PERL_ANYEVENT_DEBUG_SHELL> |
|
|
2140 | |
|
|
2141 | If this env variable is nonempty, then its contents will be interpreted by |
|
|
2142 | C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after |
|
|
2143 | replacing every occurance of C<$$> by the process pid). The shell object |
|
|
2144 | is saved in C<$AnyEvent::Debug::SHELL>. |
|
|
2145 | |
|
|
2146 | This happens when the first watcher is created. |
|
|
2147 | |
|
|
2148 | For example, to bind a debug shell on a unix domain socket in |
|
|
2149 | F<< /tmp/debug<pid>.sock >>, you could use this: |
|
|
2150 | |
|
|
2151 | PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog |
|
|
2152 | # connect with e.g.: socat readline /tmp/debug123.sock |
|
|
2153 | |
|
|
2154 | Or to bind to tcp port 4545 on localhost: |
|
|
2155 | |
|
|
2156 | PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog |
|
|
2157 | # connect with e.g.: telnet localhost 4545 |
|
|
2158 | |
|
|
2159 | Note that creating sockets in F</tmp> or on localhost is very unsafe on |
|
|
2160 | multiuser systems. |
|
|
2161 | |
|
|
2162 | =item C<PERL_ANYEVENT_DEBUG_WRAP> |
|
|
2163 | |
|
|
2164 | Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for |
|
|
2165 | debugging purposes. See C<AnyEvent::Debug::wrap> for details. |
|
|
2166 | |
1951 | =item C<PERL_ANYEVENT_MODEL> |
2167 | =item C<PERL_ANYEVENT_MODEL> |
1952 | |
2168 | |
1953 | This can be used to specify the event model to be used by AnyEvent, before |
2169 | This can be used to specify the event model to be used by AnyEvent, before |
1954 | auto detection and -probing kicks in. |
2170 | auto detection and -probing kicks in. |
1955 | |
2171 | |
… | |
… | |
1966 | For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you |
2182 | For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you |
1967 | could start your program like this: |
2183 | could start your program like this: |
1968 | |
2184 | |
1969 | PERL_ANYEVENT_MODEL=Perl perl ... |
2185 | PERL_ANYEVENT_MODEL=Perl perl ... |
1970 | |
2186 | |
|
|
2187 | =item C<PERL_ANYEVENT_IO_MODEL> |
|
|
2188 | |
|
|
2189 | The current file I/O model - see L<AnyEvent::IO> for more info. |
|
|
2190 | |
|
|
2191 | At the moment, only C<Perl> (small, pure-perl, synchronous) and |
|
|
2192 | C<IOAIO> (truly asynchronous) are supported. The default is C<IOAIO> if |
|
|
2193 | L<AnyEvent::AIO> can be loaded, otherwise it is C<Perl>. |
|
|
2194 | |
1971 | =item C<PERL_ANYEVENT_PROTOCOLS> |
2195 | =item C<PERL_ANYEVENT_PROTOCOLS> |
1972 | |
2196 | |
1973 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
2197 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
1974 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
2198 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
1975 | of auto probing). |
2199 | of auto probing). |
… | |
… | |
1987 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
2211 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
1988 | - only support IPv4, never try to resolve or contact IPv6 |
2212 | - only support IPv4, never try to resolve or contact IPv6 |
1989 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
2213 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
1990 | IPv6, but prefer IPv6 over IPv4. |
2214 | IPv6, but prefer IPv6 over IPv4. |
1991 | |
2215 | |
|
|
2216 | =item C<PERL_ANYEVENT_HOSTS> |
|
|
2217 | |
|
|
2218 | This variable, if specified, overrides the F</etc/hosts> file used by |
|
|
2219 | L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read |
|
|
2220 | from that file instead. |
|
|
2221 | |
1992 | =item C<PERL_ANYEVENT_EDNS0> |
2222 | =item C<PERL_ANYEVENT_EDNS0> |
1993 | |
2223 | |
1994 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension |
2224 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for |
1995 | for DNS. This extension is generally useful to reduce DNS traffic, but |
2225 | DNS. This extension is generally useful to reduce DNS traffic, especially |
1996 | some (broken) firewalls drop such DNS packets, which is why it is off by |
2226 | when DNSSEC is involved, but some (broken) firewalls drop such DNS |
1997 | default. |
2227 | packets, which is why it is off by default. |
1998 | |
2228 | |
1999 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
2229 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
2000 | EDNS0 in its DNS requests. |
2230 | EDNS0 in its DNS requests. |
2001 | |
2231 | |
2002 | =item C<PERL_ANYEVENT_MAX_FORKS> |
2232 | =item C<PERL_ANYEVENT_MAX_FORKS> |
… | |
… | |
2008 | |
2238 | |
2009 | The default value for the C<max_outstanding> parameter for the default DNS |
2239 | The default value for the C<max_outstanding> parameter for the default DNS |
2010 | resolver - this is the maximum number of parallel DNS requests that are |
2240 | resolver - this is the maximum number of parallel DNS requests that are |
2011 | sent to the DNS server. |
2241 | sent to the DNS server. |
2012 | |
2242 | |
|
|
2243 | =item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY> |
|
|
2244 | |
|
|
2245 | Perl has inherently racy signal handling (you can basically choose between |
|
|
2246 | losing signals and memory corruption) - pure perl event loops (including |
|
|
2247 | C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore |
|
|
2248 | have to poll regularly to avoid losing signals. |
|
|
2249 | |
|
|
2250 | Some event loops are racy, but don't poll regularly, and some event loops |
|
|
2251 | are written in C but are still racy. For those event loops, AnyEvent |
|
|
2252 | installs a timer that regularly wakes up the event loop. |
|
|
2253 | |
|
|
2254 | By default, the interval for this timer is C<10> seconds, but you can |
|
|
2255 | override this delay with this environment variable (or by setting |
|
|
2256 | the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal |
|
|
2257 | watchers). |
|
|
2258 | |
|
|
2259 | Lower values increase CPU (and energy) usage, higher values can introduce |
|
|
2260 | long delays when reaping children or waiting for signals. |
|
|
2261 | |
|
|
2262 | The L<AnyEvent::Async> module, if available, will be used to avoid this |
|
|
2263 | polling (with most event loops). |
|
|
2264 | |
2013 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
2265 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
2014 | |
2266 | |
2015 | The file to use instead of F</etc/resolv.conf> (or OS-specific |
2267 | The absolute path to a F<resolv.conf>-style file to use instead of |
2016 | configuration) in the default resolver. When set to the empty string, no |
2268 | F</etc/resolv.conf> (or the OS-specific configuration) in the default |
2017 | default config will be used. |
2269 | resolver, or the empty string to select the default configuration. |
2018 | |
2270 | |
2019 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
2271 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
2020 | |
2272 | |
2021 | When neither C<ca_file> nor C<ca_path> was specified during |
2273 | When neither C<ca_file> nor C<ca_path> was specified during |
2022 | L<AnyEvent::TLS> context creation, and either of these environment |
2274 | L<AnyEvent::TLS> context creation, and either of these environment |
2023 | variables exist, they will be used to specify CA certificate locations |
2275 | variables are nonempty, they will be used to specify CA certificate |
2024 | instead of a system-dependent default. |
2276 | locations instead of a system-dependent default. |
2025 | |
2277 | |
2026 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
2278 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
2027 | |
2279 | |
2028 | When these are set to C<1>, then the respective modules are not |
2280 | When these are set to C<1>, then the respective modules are not |
2029 | loaded. Mostly good for testing AnyEvent itself. |
2281 | loaded. Mostly good for testing AnyEvent itself. |
… | |
… | |
2361 | (even when used without AnyEvent), but most event loops have acceptable |
2613 | (even when used without AnyEvent), but most event loops have acceptable |
2362 | performance with or without AnyEvent. |
2614 | performance with or without AnyEvent. |
2363 | |
2615 | |
2364 | =item * The overhead AnyEvent adds is usually much smaller than the overhead of |
2616 | =item * The overhead AnyEvent adds is usually much smaller than the overhead of |
2365 | the actual event loop, only with extremely fast event loops such as EV |
2617 | the actual event loop, only with extremely fast event loops such as EV |
2366 | adds AnyEvent significant overhead. |
2618 | does AnyEvent add significant overhead. |
2367 | |
2619 | |
2368 | =item * You should avoid POE like the plague if you want performance or |
2620 | =item * You should avoid POE like the plague if you want performance or |
2369 | reasonable memory usage. |
2621 | reasonable memory usage. |
2370 | |
2622 | |
2371 | =back |
2623 | =back |
… | |
… | |
2746 | |
2998 | |
2747 | Tutorial/Introduction: L<AnyEvent::Intro>. |
2999 | Tutorial/Introduction: L<AnyEvent::Intro>. |
2748 | |
3000 | |
2749 | FAQ: L<AnyEvent::FAQ>. |
3001 | FAQ: L<AnyEvent::FAQ>. |
2750 | |
3002 | |
2751 | Utility functions: L<AnyEvent::Util>. |
3003 | Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log> |
|
|
3004 | (simply logging). |
2752 | |
3005 | |
|
|
3006 | Development/Debugging: L<AnyEvent::Strict> (stricter checking), |
|
|
3007 | L<AnyEvent::Debug> (interactive shell, watcher tracing). |
|
|
3008 | |
2753 | Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>, |
3009 | Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, |
2754 | L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
3010 | L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, |
|
|
3011 | L<Qt>, L<POE>, L<FLTK>. |
2755 | |
3012 | |
2756 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
3013 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2757 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
3014 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2758 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
3015 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2759 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
3016 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>, |
|
|
3017 | L<AnyEvent::Impl::FLTK>. |
2760 | |
3018 | |
2761 | Non-blocking file handles, sockets, TCP clients and |
3019 | Non-blocking handles, pipes, stream sockets, TCP clients and |
2762 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
3020 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
|
|
3021 | |
|
|
3022 | Asynchronous File I/O: L<AnyEvent::IO>. |
2763 | |
3023 | |
2764 | Asynchronous DNS: L<AnyEvent::DNS>. |
3024 | Asynchronous DNS: L<AnyEvent::DNS>. |
2765 | |
3025 | |
2766 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
3026 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
2767 | |
3027 | |
… | |
… | |
2770 | |
3030 | |
2771 | |
3031 | |
2772 | =head1 AUTHOR |
3032 | =head1 AUTHOR |
2773 | |
3033 | |
2774 | Marc Lehmann <schmorp@schmorp.de> |
3034 | Marc Lehmann <schmorp@schmorp.de> |
2775 | http://home.schmorp.de/ |
3035 | http://anyevent.schmorp.de |
2776 | |
3036 | |
2777 | =cut |
3037 | =cut |
2778 | |
3038 | |
2779 | 1 |
3039 | 1 |
2780 | |
3040 | |