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 | |
… | |
… | |
878 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
878 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
879 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
879 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
880 | AnyEvent::Impl::Irssi used when running within irssi. |
880 | AnyEvent::Impl::Irssi used when running within irssi. |
881 | AnyEvent::Impl::IOAsync based on IO::Async. |
881 | AnyEvent::Impl::IOAsync based on IO::Async. |
882 | AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. |
882 | AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. |
883 | AnyEvent::Impl::FLTK based on FLTK. |
883 | AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding). |
884 | |
884 | |
885 | =item Backends with special needs. |
885 | =item Backends with special needs. |
886 | |
886 | |
887 | Qt requires the Qt::Application to be instantiated first, but will |
887 | Qt requires the Qt::Application to be instantiated first, but will |
888 | otherwise be picked up automatically. As long as the main program |
888 | otherwise be picked up automatically. As long as the main program |
… | |
… | |
933 | |
933 | |
934 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
934 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
935 | if necessary. You should only call this function right before you would |
935 | 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 |
936 | have created an AnyEvent watcher anyway, that is, as late as possible at |
937 | runtime, and not e.g. during initialisation of your module. |
937 | runtime, and not e.g. during initialisation of your module. |
|
|
938 | |
|
|
939 | The effect of calling this function is as if a watcher had been created |
|
|
940 | (specifically, actions that happen "when the first watcher is created" |
|
|
941 | happen when calling detetc as well). |
938 | |
942 | |
939 | If you need to do some initialisation before AnyEvent watchers are |
943 | If you need to do some initialisation before AnyEvent watchers are |
940 | created, use C<post_detect>. |
944 | created, use C<post_detect>. |
941 | |
945 | |
942 | =item $guard = AnyEvent::post_detect { BLOCK } |
946 | =item $guard = AnyEvent::post_detect { BLOCK } |
… | |
… | |
1005 | # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent |
1009 | # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent |
1006 | # as soon as it is |
1010 | # as soon as it is |
1007 | push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; |
1011 | push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; |
1008 | } |
1012 | } |
1009 | |
1013 | |
|
|
1014 | =item AnyEvent::postpone { BLOCK } |
|
|
1015 | |
|
|
1016 | Arranges for the block to be executed as soon as possible, but not before |
|
|
1017 | the call itself returns. In practise, the block will be executed just |
|
|
1018 | before the event loop polls for new events, or shortly afterwards. |
|
|
1019 | |
|
|
1020 | This function never returns anything (to make the C<return postpone { ... |
|
|
1021 | }> idiom more useful. |
|
|
1022 | |
|
|
1023 | To understand the usefulness of this function, consider a function that |
|
|
1024 | asynchronously does something for you and returns some transaction |
|
|
1025 | object or guard to let you cancel the operation. For example, |
|
|
1026 | C<AnyEvent::Socket::tcp_connect>: |
|
|
1027 | |
|
|
1028 | # start a conenction attempt unless one is active |
|
|
1029 | $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub { |
|
|
1030 | delete $self->{connect_guard}; |
|
|
1031 | ... |
|
|
1032 | }; |
|
|
1033 | |
|
|
1034 | Imagine that this function could instantly call the callback, for |
|
|
1035 | example, because it detects an obvious error such as a negative port |
|
|
1036 | number. Invoking the callback before the function returns causes problems |
|
|
1037 | however: the callback will be called and will try to delete the guard |
|
|
1038 | object. But since the function hasn't returned yet, there is nothing to |
|
|
1039 | delete. When the function eventually returns it will assign the guard |
|
|
1040 | object to C<< $self->{connect_guard} >>, where it will likely never be |
|
|
1041 | deleted, so the program thinks it is still trying to connect. |
|
|
1042 | |
|
|
1043 | This is where C<AnyEvent::postpone> should be used. Instead of calling the |
|
|
1044 | callback directly on error: |
|
|
1045 | |
|
|
1046 | $cb->(undef), return # signal error to callback, BAD! |
|
|
1047 | if $some_error_condition; |
|
|
1048 | |
|
|
1049 | It should use C<postpone>: |
|
|
1050 | |
|
|
1051 | AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later |
|
|
1052 | if $some_error_condition; |
|
|
1053 | |
|
|
1054 | =item AnyEvent::log $level, $msg[, @args] |
|
|
1055 | |
|
|
1056 | Log the given C<$msg> at the given C<$level>. |
|
|
1057 | |
|
|
1058 | If L<AnyEvent::Log> is not loaded then this function makes a simple test |
|
|
1059 | to see whether the message will be logged. If the test succeeds it will |
|
|
1060 | load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at |
|
|
1061 | the L<AnyEvent::Log> documentation for details. |
|
|
1062 | |
|
|
1063 | If the test fails it will simply return. Right now this happens when a |
|
|
1064 | numerical loglevel is used and it is larger than the level specified via |
|
|
1065 | C<$ENV{PERL_ANYEVENT_VERBOSE}>. |
|
|
1066 | |
|
|
1067 | If you want to sprinkle loads of logging calls around your code, consider |
|
|
1068 | creating a logger callback with the C<AnyEvent::Log::logger> function, |
|
|
1069 | which can reduce typing, codesize and can reduce the logging overhead |
|
|
1070 | enourmously. |
|
|
1071 | |
1010 | =back |
1072 | =back |
1011 | |
1073 | |
1012 | =head1 WHAT TO DO IN A MODULE |
1074 | =head1 WHAT TO DO IN A MODULE |
1013 | |
1075 | |
1014 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
1076 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
… | |
… | |
1070 | |
1132 | |
1071 | |
1133 | |
1072 | =head1 OTHER MODULES |
1134 | =head1 OTHER MODULES |
1073 | |
1135 | |
1074 | The following is a non-exhaustive list of additional modules that use |
1136 | The following is a non-exhaustive list of additional modules that use |
1075 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
1137 | AnyEvent as a client and can therefore be mixed easily with other |
1076 | modules and other event loops in the same program. Some of the modules |
1138 | AnyEvent modules and other event loops in the same program. Some of the |
1077 | come as part of AnyEvent, the others are available via CPAN. |
1139 | modules come as part of AnyEvent, the others are available via CPAN (see |
|
|
1140 | L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for |
|
|
1141 | a longer non-exhaustive list), and the list is heavily biased towards |
|
|
1142 | modules of the AnyEvent author himself :) |
1078 | |
1143 | |
1079 | =over 4 |
1144 | =over 4 |
1080 | |
1145 | |
1081 | =item L<AnyEvent::Util> |
1146 | =item L<AnyEvent::Util> |
1082 | |
1147 | |
… | |
… | |
1102 | =item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> |
1167 | =item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> |
1103 | |
1168 | |
1104 | Implement event-based interfaces to the protocols of the same name (for |
1169 | Implement event-based interfaces to the protocols of the same name (for |
1105 | the curious, IGS is the International Go Server and FCP is the Freenet |
1170 | the curious, IGS is the International Go Server and FCP is the Freenet |
1106 | Client Protocol). |
1171 | Client Protocol). |
1107 | |
|
|
1108 | =item L<AnyEvent::Handle::UDP> |
|
|
1109 | |
|
|
1110 | Here be danger! |
|
|
1111 | |
|
|
1112 | As Pauli would put it, "Not only is it not right, it's not even wrong!" - |
|
|
1113 | there are so many things wrong with AnyEvent::Handle::UDP, most notably |
|
|
1114 | its use of a stream-based API with a protocol that isn't streamable, that |
|
|
1115 | the only way to improve it is to delete it. |
|
|
1116 | |
|
|
1117 | It features data corruption (but typically only under load) and general |
|
|
1118 | confusion. On top, the author is not only clueless about UDP but also |
|
|
1119 | fact-resistant - some gems of his understanding: "connect doesn't work |
|
|
1120 | with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not |
|
|
1121 | packets", "I don't need to implement proper error checking as UDP doesn't |
|
|
1122 | support error checking" and so on - he doesn't even understand what's |
|
|
1123 | wrong with his module when it is explained to him. |
|
|
1124 | |
|
|
1125 | =item L<AnyEvent::DBI> |
|
|
1126 | |
|
|
1127 | Executes L<DBI> requests asynchronously in a proxy process for you, |
|
|
1128 | notifying you in an event-based way when the operation is finished. |
|
|
1129 | |
1172 | |
1130 | =item L<AnyEvent::AIO> |
1173 | =item L<AnyEvent::AIO> |
1131 | |
1174 | |
1132 | Truly asynchronous (as opposed to non-blocking) I/O, should be in the |
1175 | Truly asynchronous (as opposed to non-blocking) I/O, should be in the |
1133 | toolbox of every event programmer. AnyEvent::AIO transparently fuses |
1176 | toolbox of every event programmer. AnyEvent::AIO transparently fuses |
1134 | L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based |
1177 | L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based |
1135 | file I/O, and much more. |
1178 | file I/O, and much more. |
1136 | |
1179 | |
|
|
1180 | =item L<AnyEvent::Filesys::Notify> |
|
|
1181 | |
|
|
1182 | AnyEvent is good for non-blocking stuff, but it can't detect file or |
|
|
1183 | path changes (e.g. "watch this directory for new files", "watch this |
|
|
1184 | file for changes"). The L<AnyEvent::Filesys::Notify> module promises to |
|
|
1185 | do just that in a portbale fashion, supporting inotify on GNU/Linux and |
|
|
1186 | some weird, without doubt broken, stuff on OS X to monitor files. It can |
|
|
1187 | fall back to blocking scans at regular intervals transparently on other |
|
|
1188 | platforms, so it's about as portable as it gets. |
|
|
1189 | |
|
|
1190 | (I haven't used it myself, but I haven't heard anybody complaining about |
|
|
1191 | it yet). |
|
|
1192 | |
|
|
1193 | =item L<AnyEvent::DBI> |
|
|
1194 | |
|
|
1195 | Executes L<DBI> requests asynchronously in a proxy process for you, |
|
|
1196 | notifying you in an event-based way when the operation is finished. |
|
|
1197 | |
1137 | =item L<AnyEvent::HTTPD> |
1198 | =item L<AnyEvent::HTTPD> |
1138 | |
1199 | |
1139 | A simple embedded webserver. |
1200 | A simple embedded webserver. |
1140 | |
1201 | |
1141 | =item L<AnyEvent::FastPing> |
1202 | =item L<AnyEvent::FastPing> |
1142 | |
1203 | |
1143 | The fastest ping in the west. |
1204 | The fastest ping in the west. |
1144 | |
1205 | |
1145 | =item L<Coro> |
1206 | =item L<Coro> |
1146 | |
1207 | |
1147 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
1208 | Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you |
|
|
1209 | to simply invert the flow control - don't call us, we will call you: |
|
|
1210 | |
|
|
1211 | async { |
|
|
1212 | Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it |
|
|
1213 | print "5 seconds later!\n"; |
|
|
1214 | |
|
|
1215 | Coro::AnyEvent::readable *STDIN; # uses an I/O watcher |
|
|
1216 | my $line = <STDIN>; # works for ttys |
|
|
1217 | |
|
|
1218 | AnyEvent::HTTP::http_get "url", Coro::rouse_cb; |
|
|
1219 | my ($body, $hdr) = Coro::rouse_wait; |
|
|
1220 | }; |
1148 | |
1221 | |
1149 | =back |
1222 | =back |
1150 | |
1223 | |
1151 | =cut |
1224 | =cut |
1152 | |
1225 | |
… | |
… | |
1162 | |
1235 | |
1163 | BEGIN { AnyEvent::common_sense } |
1236 | BEGIN { AnyEvent::common_sense } |
1164 | |
1237 | |
1165 | use Carp (); |
1238 | use Carp (); |
1166 | |
1239 | |
1167 | our $VERSION = '5.34'; |
1240 | our $VERSION = '6.02'; |
1168 | our $MODEL; |
1241 | our $MODEL; |
1169 | |
1242 | |
1170 | our $AUTOLOAD; |
|
|
1171 | our @ISA; |
1243 | our @ISA; |
1172 | |
1244 | |
1173 | our @REGISTRY; |
1245 | our @REGISTRY; |
1174 | |
1246 | |
1175 | our $VERBOSE; |
1247 | our $VERBOSE; |
… | |
… | |
1180 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
1252 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
1181 | |
1253 | |
1182 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1254 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1183 | if ${^TAINT}; |
1255 | if ${^TAINT}; |
1184 | |
1256 | |
1185 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1257 | $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"} |
|
|
1258 | for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV; |
1186 | |
1259 | |
|
|
1260 | @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = () |
|
|
1261 | if ${^TAINT}; |
|
|
1262 | |
|
|
1263 | # $ENV{PERL_ANYEVENT_xxx} now valid |
|
|
1264 | |
|
|
1265 | $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 3; |
1187 | } |
1266 | } |
1188 | |
1267 | |
1189 | our $MAX_SIGNAL_LATENCY = 10; |
1268 | our $MAX_SIGNAL_LATENCY = 10; |
1190 | |
1269 | |
1191 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1270 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
… | |
… | |
1195 | $PROTOCOL{$_} = ++$idx |
1274 | $PROTOCOL{$_} = ++$idx |
1196 | for reverse split /\s*,\s*/, |
1275 | for reverse split /\s*,\s*/, |
1197 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1276 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1198 | } |
1277 | } |
1199 | |
1278 | |
|
|
1279 | our @post_detect; |
|
|
1280 | |
|
|
1281 | sub post_detect(&) { |
|
|
1282 | my ($cb) = @_; |
|
|
1283 | |
|
|
1284 | push @post_detect, $cb; |
|
|
1285 | |
|
|
1286 | defined wantarray |
|
|
1287 | ? bless \$cb, "AnyEvent::Util::postdetect" |
|
|
1288 | : () |
|
|
1289 | } |
|
|
1290 | |
|
|
1291 | sub AnyEvent::Util::postdetect::DESTROY { |
|
|
1292 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
|
|
1293 | } |
|
|
1294 | |
|
|
1295 | our $POSTPONE_W; |
|
|
1296 | our @POSTPONE; |
|
|
1297 | |
|
|
1298 | sub _postpone_exec { |
|
|
1299 | undef $POSTPONE_W; |
|
|
1300 | |
|
|
1301 | &{ shift @POSTPONE } |
|
|
1302 | while @POSTPONE; |
|
|
1303 | } |
|
|
1304 | |
|
|
1305 | sub postpone(&) { |
|
|
1306 | push @POSTPONE, shift; |
|
|
1307 | |
|
|
1308 | $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); |
|
|
1309 | |
|
|
1310 | () |
|
|
1311 | } |
|
|
1312 | |
|
|
1313 | sub log($$;@) { |
|
|
1314 | # only load the big bloated module when we actually are about to log something |
|
|
1315 | if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!) |
|
|
1316 | require AnyEvent::Log; |
|
|
1317 | # AnyEvent::Log overwrites this function |
|
|
1318 | goto &log; |
|
|
1319 | } |
|
|
1320 | |
|
|
1321 | 0 # not logged |
|
|
1322 | } |
|
|
1323 | |
|
|
1324 | if (length $ENV{PERL_ANYEVENT_LOG}) { |
|
|
1325 | require AnyEvent::Log; # AnyEvent::Log does the thing for us |
|
|
1326 | } |
|
|
1327 | |
1200 | my @models = ( |
1328 | our @models = ( |
1201 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1329 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1202 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], |
1330 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], |
1203 | # everything below here will not (normally) be autoprobed |
1331 | # everything below here will not (normally) be autoprobed |
1204 | # as the pure perl backend should work everywhere |
1332 | # as the pure perl backend should work everywhere |
1205 | # and is usually faster |
1333 | # and is usually faster |
… | |
… | |
1210 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1338 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1211 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1339 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1212 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1340 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1213 | [Wx:: => AnyEvent::Impl::POE::], |
1341 | [Wx:: => AnyEvent::Impl::POE::], |
1214 | [Prima:: => AnyEvent::Impl::POE::], |
1342 | [Prima:: => AnyEvent::Impl::POE::], |
1215 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], |
1343 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect |
1216 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
1344 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
1217 | [FLTK:: => AnyEvent::Impl::FLTK::], |
1345 | [FLTK:: => AnyEvent::Impl::FLTK::], |
1218 | ); |
1346 | ); |
1219 | |
1347 | |
1220 | our %method = map +($_ => 1), |
1348 | our @isa_hook; |
|
|
1349 | |
|
|
1350 | sub _isa_set { |
|
|
1351 | my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL); |
|
|
1352 | |
|
|
1353 | @{"$pkg[$_-1]::ISA"} = $pkg[$_] |
|
|
1354 | for 1 .. $#pkg; |
|
|
1355 | |
|
|
1356 | grep $_ && $_->[1], @isa_hook |
|
|
1357 | and AE::_reset (); |
|
|
1358 | } |
|
|
1359 | |
|
|
1360 | # used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy |
|
|
1361 | sub _isa_hook($$;$) { |
|
|
1362 | my ($i, $pkg, $reset_ae) = @_; |
|
|
1363 | |
|
|
1364 | $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef; |
|
|
1365 | |
|
|
1366 | _isa_set; |
|
|
1367 | } |
|
|
1368 | |
|
|
1369 | # all autoloaded methods reserve the complete glob, not just the method slot. |
|
|
1370 | # due to bugs in perls method cache implementation. |
1221 | qw(io timer time now now_update signal child idle condvar DESTROY); |
1371 | our @methods = qw(io timer time now now_update signal child idle condvar); |
1222 | |
|
|
1223 | our @post_detect; |
|
|
1224 | |
|
|
1225 | sub post_detect(&) { |
|
|
1226 | my ($cb) = @_; |
|
|
1227 | |
|
|
1228 | push @post_detect, $cb; |
|
|
1229 | |
|
|
1230 | defined wantarray |
|
|
1231 | ? bless \$cb, "AnyEvent::Util::postdetect" |
|
|
1232 | : () |
|
|
1233 | } |
|
|
1234 | |
|
|
1235 | sub AnyEvent::Util::postdetect::DESTROY { |
|
|
1236 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
|
|
1237 | } |
|
|
1238 | |
1372 | |
1239 | sub detect() { |
1373 | sub detect() { |
|
|
1374 | return $MODEL if $MODEL; # some programs keep references to detect |
|
|
1375 | |
|
|
1376 | local $!; # for good measure |
|
|
1377 | local $SIG{__DIE__}; # we use eval |
|
|
1378 | |
1240 | # free some memory |
1379 | # free some memory |
1241 | *detect = sub () { $MODEL }; |
1380 | *detect = sub () { $MODEL }; |
|
|
1381 | # undef &func doesn't correctly update the method cache. grmbl. |
|
|
1382 | # so we delete the whole glob. grmbl. |
|
|
1383 | # otoh, perl doesn't let me undef an active usb, but it lets me free |
|
|
1384 | # a glob with an active sub. hrm. i hope it works, but perl is |
|
|
1385 | # usually buggy in this department. sigh. |
|
|
1386 | delete @{"AnyEvent::"}{@methods}; |
|
|
1387 | undef @methods; |
1242 | |
1388 | |
1243 | local $!; # for good measure |
|
|
1244 | local $SIG{__DIE__}; |
|
|
1245 | |
|
|
1246 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1389 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { |
1247 | my $model = "AnyEvent::Impl::$1"; |
1390 | my $model = $1; |
|
|
1391 | $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; |
1248 | if (eval "require $model") { |
1392 | if (eval "require $model") { |
|
|
1393 | AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."; |
1249 | $MODEL = $model; |
1394 | $MODEL = $model; |
1250 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
|
|
1251 | } else { |
1395 | } else { |
1252 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
1396 | AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@"; |
1253 | } |
1397 | } |
1254 | } |
1398 | } |
1255 | |
1399 | |
1256 | # check for already loaded models |
1400 | # check for already loaded models |
1257 | unless ($MODEL) { |
1401 | unless ($MODEL) { |
1258 | for (@REGISTRY, @models) { |
1402 | for (@REGISTRY, @models) { |
1259 | my ($package, $model) = @$_; |
1403 | my ($package, $model) = @$_; |
1260 | if (${"$package\::VERSION"} > 0) { |
1404 | if (${"$package\::VERSION"} > 0) { |
1261 | if (eval "require $model") { |
1405 | if (eval "require $model") { |
|
|
1406 | AnyEvent::log 7 => "autodetected model '$model', using it."; |
1262 | $MODEL = $model; |
1407 | $MODEL = $model; |
1263 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
|
|
1264 | last; |
1408 | last; |
1265 | } |
1409 | } |
1266 | } |
1410 | } |
1267 | } |
1411 | } |
1268 | |
1412 | |
… | |
… | |
1274 | $autoload |
1418 | $autoload |
1275 | and eval "require $package" |
1419 | and eval "require $package" |
1276 | and ${"$package\::VERSION"} > 0 |
1420 | and ${"$package\::VERSION"} > 0 |
1277 | and eval "require $model" |
1421 | and eval "require $model" |
1278 | ) { |
1422 | ) { |
|
|
1423 | AnyEvent::log 7 => "autoloaded model '$model', using it."; |
1279 | $MODEL = $model; |
1424 | $MODEL = $model; |
1280 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
|
|
1281 | last; |
1425 | last; |
1282 | } |
1426 | } |
1283 | } |
1427 | } |
1284 | |
1428 | |
1285 | $MODEL |
1429 | $MODEL |
1286 | or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; |
1430 | or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?"; |
1287 | } |
1431 | } |
1288 | } |
1432 | } |
1289 | |
1433 | |
1290 | @models = (); # free probe data |
1434 | # free memory only needed for probing |
|
|
1435 | undef @models; |
|
|
1436 | undef @REGISTRY; |
1291 | |
1437 | |
1292 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1438 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1293 | unshift @ISA, $MODEL; |
|
|
1294 | |
1439 | |
1295 | # now nuke some methods that are overridden by the backend. |
1440 | # now nuke some methods that are overridden by the backend. |
1296 | # SUPER is not allowed. |
1441 | # SUPER usage is not allowed in these. |
1297 | for (qw(time signal child idle)) { |
1442 | for (qw(time signal child idle)) { |
1298 | undef &{"AnyEvent::Base::$_"} |
1443 | undef &{"AnyEvent::Base::$_"} |
1299 | if defined &{"$MODEL\::$_"}; |
1444 | if defined &{"$MODEL\::$_"}; |
1300 | } |
1445 | } |
1301 | |
1446 | |
|
|
1447 | _isa_set; |
|
|
1448 | |
|
|
1449 | # we're officially open! |
|
|
1450 | |
1302 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
1451 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
1303 | eval { require AnyEvent::Strict }; |
1452 | require AnyEvent::Strict; |
1304 | warn "AnyEvent: cannot load AnyEvent::Strict: $@" |
|
|
1305 | if $@ && $VERBOSE; |
|
|
1306 | } |
1453 | } |
1307 | |
1454 | |
|
|
1455 | if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) { |
|
|
1456 | require AnyEvent::Debug; |
|
|
1457 | AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP}); |
|
|
1458 | } |
|
|
1459 | |
|
|
1460 | if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) { |
|
|
1461 | require AnyEvent::Socket; |
|
|
1462 | require AnyEvent::Debug; |
|
|
1463 | |
|
|
1464 | my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL}; |
|
|
1465 | $shell =~ s/\$\$/$$/g; |
|
|
1466 | |
|
|
1467 | my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell); |
|
|
1468 | $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service); |
|
|
1469 | } |
|
|
1470 | |
|
|
1471 | # now the anyevent environment is set up as the user told us to, so |
|
|
1472 | # call the actual user code - post detects |
|
|
1473 | |
1308 | (shift @post_detect)->() while @post_detect; |
1474 | (shift @post_detect)->() while @post_detect; |
|
|
1475 | undef @post_detect; |
1309 | |
1476 | |
1310 | *post_detect = sub(&) { |
1477 | *post_detect = sub(&) { |
1311 | shift->(); |
1478 | shift->(); |
1312 | |
1479 | |
1313 | undef |
1480 | undef |
1314 | }; |
1481 | }; |
1315 | |
1482 | |
1316 | $MODEL |
1483 | $MODEL |
1317 | } |
1484 | } |
1318 | |
1485 | |
1319 | sub AUTOLOAD { |
1486 | for my $name (@methods) { |
1320 | (my $func = $AUTOLOAD) =~ s/.*://; |
1487 | *$name = sub { |
1321 | |
|
|
1322 | $method{$func} |
|
|
1323 | or Carp::croak "$func: not a valid AnyEvent class method"; |
|
|
1324 | |
|
|
1325 | detect; |
1488 | detect; |
1326 | |
1489 | # we use goto because |
1327 | my $class = shift; |
1490 | # a) it makes the thunk more transparent |
1328 | $class->$func (@_); |
1491 | # b) it allows us to delete the thunk later |
|
|
1492 | goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" } |
|
|
1493 | }; |
1329 | } |
1494 | } |
1330 | |
1495 | |
1331 | # utility function to dup a filehandle. this is used by many backends |
1496 | # utility function to dup a filehandle. this is used by many backends |
1332 | # to support binding more than one watcher per filehandle (they usually |
1497 | # to support binding more than one watcher per filehandle (they usually |
1333 | # allow only one watcher per fd, so we dup it to get a different one). |
1498 | # allow only one watcher per fd, so we dup it to get a different one). |
… | |
… | |
1357 | |
1522 | |
1358 | package AE; |
1523 | package AE; |
1359 | |
1524 | |
1360 | our $VERSION = $AnyEvent::VERSION; |
1525 | our $VERSION = $AnyEvent::VERSION; |
1361 | |
1526 | |
|
|
1527 | sub _reset() { |
|
|
1528 | eval q{ |
1362 | # fall back to the main API by default - backends and AnyEvent::Base |
1529 | # fall back to the main API by default - backends and AnyEvent::Base |
1363 | # implementations can overwrite these. |
1530 | # implementations can overwrite these. |
1364 | |
1531 | |
1365 | sub io($$$) { |
1532 | sub io($$$) { |
1366 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
1533 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
1367 | } |
1534 | } |
1368 | |
1535 | |
1369 | sub timer($$$) { |
1536 | sub timer($$$) { |
1370 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) |
1537 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) |
1371 | } |
1538 | } |
1372 | |
1539 | |
1373 | sub signal($$) { |
1540 | sub signal($$) { |
1374 | AnyEvent->signal (signal => $_[0], cb => $_[1]) |
1541 | AnyEvent->signal (signal => $_[0], cb => $_[1]) |
1375 | } |
1542 | } |
1376 | |
1543 | |
1377 | sub child($$) { |
1544 | sub child($$) { |
1378 | AnyEvent->child (pid => $_[0], cb => $_[1]) |
1545 | AnyEvent->child (pid => $_[0], cb => $_[1]) |
1379 | } |
1546 | } |
1380 | |
1547 | |
1381 | sub idle($) { |
1548 | sub idle($) { |
1382 | AnyEvent->idle (cb => $_[0]) |
1549 | AnyEvent->idle (cb => $_[0]); |
1383 | } |
1550 | } |
1384 | |
1551 | |
1385 | sub cv(;&) { |
1552 | sub cv(;&) { |
1386 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
1553 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
1387 | } |
1554 | } |
1388 | |
1555 | |
1389 | sub now() { |
1556 | sub now() { |
1390 | AnyEvent->now |
1557 | AnyEvent->now |
1391 | } |
1558 | } |
1392 | |
1559 | |
1393 | sub now_update() { |
1560 | sub now_update() { |
1394 | AnyEvent->now_update |
1561 | AnyEvent->now_update |
1395 | } |
1562 | } |
1396 | |
1563 | |
1397 | sub time() { |
1564 | sub time() { |
1398 | AnyEvent->time |
1565 | AnyEvent->time |
|
|
1566 | } |
|
|
1567 | |
|
|
1568 | *postpone = \&AnyEvent::postpone; |
|
|
1569 | *log = \&AnyEvent::log; |
|
|
1570 | }; |
|
|
1571 | die if $@; |
1399 | } |
1572 | } |
|
|
1573 | |
|
|
1574 | BEGIN { _reset } |
1400 | |
1575 | |
1401 | package AnyEvent::Base; |
1576 | package AnyEvent::Base; |
1402 | |
1577 | |
1403 | # default implementations for many methods |
1578 | # default implementations for many methods |
1404 | |
1579 | |
1405 | sub time { |
1580 | sub time { |
1406 | eval q{ # poor man's autoloading {} |
1581 | eval q{ # poor man's autoloading {} |
1407 | # probe for availability of Time::HiRes |
1582 | # probe for availability of Time::HiRes |
1408 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1583 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1409 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1584 | *time = sub { Time::HiRes::time () }; |
1410 | *AE::time = \&Time::HiRes::time; |
1585 | *AE::time = \& Time::HiRes::time ; |
|
|
1586 | *now = \&time; |
|
|
1587 | AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."; |
1411 | # if (eval "use POSIX (); (POSIX::times())... |
1588 | # if (eval "use POSIX (); (POSIX::times())... |
1412 | } else { |
1589 | } else { |
|
|
1590 | *time = sub { CORE::time }; |
|
|
1591 | *AE::time = sub (){ CORE::time }; |
|
|
1592 | *now = \&time; |
1413 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1593 | AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!"; |
1414 | *AE::time = sub (){ time }; # epic fail |
|
|
1415 | } |
1594 | } |
1416 | |
|
|
1417 | *time = sub { AE::time }; # different prototypes |
|
|
1418 | }; |
1595 | }; |
1419 | die if $@; |
1596 | die if $@; |
1420 | |
1597 | |
1421 | &time |
1598 | &time |
1422 | } |
1599 | } |
1423 | |
1600 | |
1424 | *now = \&time; |
1601 | *now = \&time; |
1425 | |
|
|
1426 | sub now_update { } |
1602 | sub now_update { } |
1427 | |
1603 | |
1428 | sub _poll { |
1604 | sub _poll { |
1429 | Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; |
1605 | Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; |
1430 | } |
1606 | } |
1431 | |
1607 | |
1432 | # default implementation for ->condvar |
1608 | # default implementation for ->condvar |
1433 | # in fact,t he default should not be overwritten |
1609 | # in fact, the default should not be overwritten |
1434 | |
1610 | |
1435 | sub condvar { |
1611 | sub condvar { |
1436 | eval q{ # poor man's autoloading {} |
1612 | eval q{ # poor man's autoloading {} |
1437 | *condvar = sub { |
1613 | *condvar = sub { |
1438 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1614 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
… | |
… | |
1516 | |
1692 | |
1517 | sub signal { |
1693 | sub signal { |
1518 | eval q{ # poor man's autoloading {} |
1694 | eval q{ # poor man's autoloading {} |
1519 | # probe for availability of Async::Interrupt |
1695 | # probe for availability of Async::Interrupt |
1520 | if (_have_async_interrupt) { |
1696 | if (_have_async_interrupt) { |
1521 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
1697 | AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."; |
1522 | |
1698 | |
1523 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1699 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1524 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1700 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1525 | |
1701 | |
1526 | } else { |
1702 | } else { |
1527 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
1703 | AnyEvent::log 8 => "using emulated perl signal handling with latency timer."; |
1528 | |
1704 | |
1529 | if (AnyEvent::WIN32) { |
1705 | if (AnyEvent::WIN32) { |
1530 | require AnyEvent::Util; |
1706 | require AnyEvent::Util; |
1531 | |
1707 | |
1532 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1708 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
… | |
… | |
1608 | : sysread $SIGPIPE_R, (my $dummy), 9; |
1784 | : sysread $SIGPIPE_R, (my $dummy), 9; |
1609 | |
1785 | |
1610 | while (%SIG_EV) { |
1786 | while (%SIG_EV) { |
1611 | for (keys %SIG_EV) { |
1787 | for (keys %SIG_EV) { |
1612 | delete $SIG_EV{$_}; |
1788 | delete $SIG_EV{$_}; |
1613 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1789 | &$_ for values %{ $SIG_CB{$_} || {} }; |
1614 | } |
1790 | } |
1615 | } |
1791 | } |
1616 | }; |
1792 | }; |
1617 | }; |
1793 | }; |
1618 | die if $@; |
1794 | die if $@; |
… | |
… | |
1685 | |
1861 | |
1686 | my ($cb, $w, $rcb) = $arg{cb}; |
1862 | my ($cb, $w, $rcb) = $arg{cb}; |
1687 | |
1863 | |
1688 | $rcb = sub { |
1864 | $rcb = sub { |
1689 | if ($cb) { |
1865 | if ($cb) { |
1690 | $w = _time; |
1866 | $w = AE::time; |
1691 | &$cb; |
1867 | &$cb; |
1692 | $w = _time - $w; |
1868 | $w = AE::time - $w; |
1693 | |
1869 | |
1694 | # never use more then 50% of the time for the idle watcher, |
1870 | # never use more then 50% of the time for the idle watcher, |
1695 | # within some limits |
1871 | # within some limits |
1696 | $w = 0.0001 if $w < 0.0001; |
1872 | $w = 0.0001 if $w < 0.0001; |
1697 | $w = 5 if $w > 5; |
1873 | $w = 5 if $w > 5; |
… | |
… | |
1826 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
2002 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
1827 | so on. |
2003 | so on. |
1828 | |
2004 | |
1829 | =head1 ENVIRONMENT VARIABLES |
2005 | =head1 ENVIRONMENT VARIABLES |
1830 | |
2006 | |
1831 | The following environment variables are used by this module or its |
2007 | AnyEvent supports a number of environment variables that tune the |
1832 | submodules. |
2008 | runtime behaviour. They are usually evaluated when AnyEvent is |
|
|
2009 | loaded, initialised, or a submodule that uses them is loaded. Many of |
|
|
2010 | them also cause AnyEvent to load additional modules - for example, |
|
|
2011 | C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be |
|
|
2012 | loaded. |
1833 | |
2013 | |
1834 | Note that AnyEvent will remove I<all> environment variables starting with |
2014 | All the environment variables documented here start with |
1835 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
2015 | C<PERL_ANYEVENT_>, which is what AnyEvent considers its own |
1836 | enabled. |
2016 | namespace. Other modules are encouraged (but by no means required) to use |
|
|
2017 | C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule |
|
|
2018 | namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could |
|
|
2019 | be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env |
|
|
2020 | variables starting with C<AE_>, see below). |
|
|
2021 | |
|
|
2022 | All variables can also be set via the C<AE_> prefix, that is, instead |
|
|
2023 | of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In |
|
|
2024 | case there is a clash btween anyevent and another program that uses |
|
|
2025 | C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something> |
|
|
2026 | variable to the empty string, as those variables take precedence. |
|
|
2027 | |
|
|
2028 | When AnyEvent is first loaded, it copies all C<AE_xxx> env variables |
|
|
2029 | to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already |
|
|
2030 | exists. If taint mode is on, then AnyEvent will remove I<all> environment |
|
|
2031 | variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them |
|
|
2032 | with C<undef> or the empty string, if the corresaponding C<AE_> variable |
|
|
2033 | is set). |
|
|
2034 | |
|
|
2035 | The exact algorithm is currently: |
|
|
2036 | |
|
|
2037 | 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV |
|
|
2038 | 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists |
|
|
2039 | 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef. |
|
|
2040 | |
|
|
2041 | This ensures that child processes will not see the C<AE_> variables. |
|
|
2042 | |
|
|
2043 | The following environment variables are currently known to AnyEvent: |
1837 | |
2044 | |
1838 | =over 4 |
2045 | =over 4 |
1839 | |
2046 | |
1840 | =item C<PERL_ANYEVENT_VERBOSE> |
2047 | =item C<PERL_ANYEVENT_VERBOSE> |
1841 | |
2048 | |
1842 | By default, AnyEvent will be completely silent except in fatal |
2049 | By default, AnyEvent will only log messages with loglevel C<3> |
1843 | conditions. You can set this environment variable to make AnyEvent more |
2050 | (C<critical>) or higher (see L<AnyEvent::Log>). You can set this |
|
|
2051 | environment variable to a numerical loglevel to make AnyEvent more (or |
1844 | talkative. |
2052 | less) talkative. |
1845 | |
2053 | |
|
|
2054 | If you want to do more than just set the global logging level |
|
|
2055 | you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more |
|
|
2056 | complex specifications. |
|
|
2057 | |
|
|
2058 | When set to C<0> (C<off>), then no messages whatsoever will be logged with |
|
|
2059 | the default logging settings. |
|
|
2060 | |
1846 | When set to C<1> or higher, causes AnyEvent to warn about unexpected |
2061 | When set to C<5> or higher (C<warn>), causes AnyEvent to warn about |
1847 | conditions, such as not being able to load the event model specified by |
2062 | unexpected conditions, such as not being able to load the event model |
1848 | C<PERL_ANYEVENT_MODEL>. |
2063 | specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an |
|
|
2064 | exception - this is the minimum recommended level. |
1849 | |
2065 | |
1850 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
2066 | When set to C<7> or higher (info), cause AnyEvent to report which event model it |
1851 | model it chooses. |
2067 | chooses. |
1852 | |
2068 | |
1853 | When set to C<8> or higher, then AnyEvent will report extra information on |
2069 | When set to C<8> or higher (debug), then AnyEvent will report extra information on |
1854 | which optional modules it loads and how it implements certain features. |
2070 | which optional modules it loads and how it implements certain features. |
|
|
2071 | |
|
|
2072 | =item C<PERL_ANYEVENT_LOG> |
|
|
2073 | |
|
|
2074 | Accepts rather complex logging specifications. For example, you could log |
|
|
2075 | all C<debug> messages of some module to stderr, warnings and above to |
|
|
2076 | stderr, and errors and above to syslog, with: |
|
|
2077 | |
|
|
2078 | PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog |
|
|
2079 | |
|
|
2080 | For the rather extensive details, see L<AnyEvent::Log>. |
|
|
2081 | |
|
|
2082 | This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded, |
|
|
2083 | so will take effect even before AnyEvent has initialised itself. |
|
|
2084 | |
|
|
2085 | Note that specifying this environment variable causes the L<AnyEvent::Log> |
|
|
2086 | module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only |
|
|
2087 | using the latter saves a few hundred kB of memory until the first message |
|
|
2088 | is being logged. |
1855 | |
2089 | |
1856 | =item C<PERL_ANYEVENT_STRICT> |
2090 | =item C<PERL_ANYEVENT_STRICT> |
1857 | |
2091 | |
1858 | AnyEvent does not do much argument checking by default, as thorough |
2092 | AnyEvent does not do much argument checking by default, as thorough |
1859 | argument checking is very costly. Setting this variable to a true value |
2093 | argument checking is very costly. Setting this variable to a true value |
… | |
… | |
1866 | Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> |
2100 | Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> |
1867 | >>, it is definitely recommended to keep it off in production. Keeping |
2101 | >>, it is definitely recommended to keep it off in production. Keeping |
1868 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
2102 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
1869 | can be very useful, however. |
2103 | can be very useful, however. |
1870 | |
2104 | |
|
|
2105 | =item C<PERL_ANYEVENT_DEBUG_SHELL> |
|
|
2106 | |
|
|
2107 | If this env variable is set, then its contents will be interpreted by |
|
|
2108 | C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of |
|
|
2109 | C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on |
|
|
2110 | that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>. |
|
|
2111 | |
|
|
2112 | This happens when the first watcher is created. |
|
|
2113 | |
|
|
2114 | For example, to bind a debug shell on a unix domain socket in |
|
|
2115 | F<< /tmp/debug<pid>.sock >>, you could use this: |
|
|
2116 | |
|
|
2117 | PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog |
|
|
2118 | |
|
|
2119 | Note that creating sockets in F</tmp> is very unsafe on multiuser |
|
|
2120 | systems. |
|
|
2121 | |
|
|
2122 | =item C<PERL_ANYEVENT_DEBUG_WRAP> |
|
|
2123 | |
|
|
2124 | Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for |
|
|
2125 | debugging purposes. See C<AnyEvent::Debug::wrap> for details. |
|
|
2126 | |
1871 | =item C<PERL_ANYEVENT_MODEL> |
2127 | =item C<PERL_ANYEVENT_MODEL> |
1872 | |
2128 | |
1873 | This can be used to specify the event model to be used by AnyEvent, before |
2129 | This can be used to specify the event model to be used by AnyEvent, before |
1874 | auto detection and -probing kicks in. It must be a string consisting |
2130 | auto detection and -probing kicks in. |
1875 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
2131 | |
|
|
2132 | It normally is a string consisting entirely of ASCII letters (e.g. C<EV> |
|
|
2133 | or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the |
1876 | and the resulting module name is loaded and if the load was successful, |
2134 | resulting module name is loaded and - if the load was successful - used as |
1877 | used as event model. If it fails to load AnyEvent will proceed with |
2135 | event model backend. If it fails to load then AnyEvent will proceed with |
1878 | auto detection and -probing. |
2136 | auto detection and -probing. |
1879 | |
2137 | |
1880 | This functionality might change in future versions. |
2138 | If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then |
|
|
2139 | nothing gets prepended and the module name is used as-is (hint: C<::> at |
|
|
2140 | the end of a string designates a module name and quotes it appropriately). |
1881 | |
2141 | |
1882 | For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you |
2142 | For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you |
1883 | could start your program like this: |
2143 | could start your program like this: |
1884 | |
2144 | |
1885 | PERL_ANYEVENT_MODEL=Perl perl ... |
2145 | PERL_ANYEVENT_MODEL=Perl perl ... |
… | |
… | |
1903 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
2163 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
1904 | - only support IPv4, never try to resolve or contact IPv6 |
2164 | - only support IPv4, never try to resolve or contact IPv6 |
1905 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
2165 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
1906 | IPv6, but prefer IPv6 over IPv4. |
2166 | IPv6, but prefer IPv6 over IPv4. |
1907 | |
2167 | |
|
|
2168 | =item C<PERL_ANYEVENT_HOSTS> |
|
|
2169 | |
|
|
2170 | This variable, if specified, overrides the F</etc/hosts> file used by |
|
|
2171 | L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read |
|
|
2172 | from that file instead. |
|
|
2173 | |
1908 | =item C<PERL_ANYEVENT_EDNS0> |
2174 | =item C<PERL_ANYEVENT_EDNS0> |
1909 | |
2175 | |
1910 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension |
2176 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for |
1911 | for DNS. This extension is generally useful to reduce DNS traffic, but |
2177 | DNS. This extension is generally useful to reduce DNS traffic, especially |
1912 | some (broken) firewalls drop such DNS packets, which is why it is off by |
2178 | when DNSSEC is involved, but some (broken) firewalls drop such DNS |
1913 | default. |
2179 | packets, which is why it is off by default. |
1914 | |
2180 | |
1915 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
2181 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
1916 | EDNS0 in its DNS requests. |
2182 | EDNS0 in its DNS requests. |
1917 | |
2183 | |
1918 | =item C<PERL_ANYEVENT_MAX_FORKS> |
2184 | =item C<PERL_ANYEVENT_MAX_FORKS> |
… | |
… | |
1926 | resolver - this is the maximum number of parallel DNS requests that are |
2192 | resolver - this is the maximum number of parallel DNS requests that are |
1927 | sent to the DNS server. |
2193 | sent to the DNS server. |
1928 | |
2194 | |
1929 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
2195 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
1930 | |
2196 | |
1931 | The file to use instead of F</etc/resolv.conf> (or OS-specific |
2197 | The absolute path to a F<resolv.conf>-style file to use instead of |
1932 | configuration) in the default resolver. When set to the empty string, no |
2198 | F</etc/resolv.conf> (or the OS-specific configuration) in the default |
1933 | default config will be used. |
2199 | resolver, or the empty string to select the default configuration. |
1934 | |
2200 | |
1935 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
2201 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
1936 | |
2202 | |
1937 | When neither C<ca_file> nor C<ca_path> was specified during |
2203 | When neither C<ca_file> nor C<ca_path> was specified during |
1938 | L<AnyEvent::TLS> context creation, and either of these environment |
2204 | L<AnyEvent::TLS> context creation, and either of these environment |
1939 | variables exist, they will be used to specify CA certificate locations |
2205 | variables are nonempty, they will be used to specify CA certificate |
1940 | instead of a system-dependent default. |
2206 | locations instead of a system-dependent default. |
1941 | |
2207 | |
1942 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
2208 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
1943 | |
2209 | |
1944 | When these are set to C<1>, then the respective modules are not |
2210 | When these are set to C<1>, then the respective modules are not |
1945 | loaded. Mostly good for testing AnyEvent itself. |
2211 | loaded. Mostly good for testing AnyEvent itself. |
… | |
… | |
2277 | (even when used without AnyEvent), but most event loops have acceptable |
2543 | (even when used without AnyEvent), but most event loops have acceptable |
2278 | performance with or without AnyEvent. |
2544 | performance with or without AnyEvent. |
2279 | |
2545 | |
2280 | =item * The overhead AnyEvent adds is usually much smaller than the overhead of |
2546 | =item * The overhead AnyEvent adds is usually much smaller than the overhead of |
2281 | the actual event loop, only with extremely fast event loops such as EV |
2547 | the actual event loop, only with extremely fast event loops such as EV |
2282 | adds AnyEvent significant overhead. |
2548 | does AnyEvent add significant overhead. |
2283 | |
2549 | |
2284 | =item * You should avoid POE like the plague if you want performance or |
2550 | =item * You should avoid POE like the plague if you want performance or |
2285 | reasonable memory usage. |
2551 | reasonable memory usage. |
2286 | |
2552 | |
2287 | =back |
2553 | =back |
… | |
… | |
2662 | |
2928 | |
2663 | Tutorial/Introduction: L<AnyEvent::Intro>. |
2929 | Tutorial/Introduction: L<AnyEvent::Intro>. |
2664 | |
2930 | |
2665 | FAQ: L<AnyEvent::FAQ>. |
2931 | FAQ: L<AnyEvent::FAQ>. |
2666 | |
2932 | |
2667 | Utility functions: L<AnyEvent::Util>. |
2933 | Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log> |
|
|
2934 | (simply logging). |
2668 | |
2935 | |
|
|
2936 | Development/Debugging: L<AnyEvent::Strict> (stricter checking), |
|
|
2937 | L<AnyEvent::Debug> (interactive shell, watcher tracing). |
|
|
2938 | |
2669 | Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>, |
2939 | Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, |
2670 | L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2940 | L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, |
|
|
2941 | L<Qt>, L<POE>, L<FLTK>. |
2671 | |
2942 | |
2672 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2943 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2673 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2944 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2674 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2945 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2675 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
2946 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>, |
|
|
2947 | L<AnyEvent::Impl::FLTK>. |
2676 | |
2948 | |
2677 | Non-blocking file handles, sockets, TCP clients and |
2949 | Non-blocking handles, pipes, stream sockets, TCP clients and |
2678 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2950 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2679 | |
2951 | |
2680 | Asynchronous DNS: L<AnyEvent::DNS>. |
2952 | Asynchronous DNS: L<AnyEvent::DNS>. |
2681 | |
2953 | |
2682 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
2954 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |