… | |
… | |
878 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
878 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
879 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
879 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
880 | AnyEvent::Impl::Irssi used when running within irssi. |
880 | AnyEvent::Impl::Irssi used when running within irssi. |
881 | AnyEvent::Impl::IOAsync based on IO::Async. |
881 | AnyEvent::Impl::IOAsync based on IO::Async. |
882 | AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. |
882 | AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. |
883 | AnyEvent::Impl::FLTK based on FLTK. |
883 | AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding). |
884 | |
884 | |
885 | =item Backends with special needs. |
885 | =item Backends with special needs. |
886 | |
886 | |
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 | Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> - |
|
|
1059 | consequently, look at the L<AnyEvent::Log> documentation for details. |
|
|
1060 | |
|
|
1061 | If you want to sprinkle loads of logging calls around your code, consider |
|
|
1062 | creating a logger callback with the C<AnyEvent::Log::logger< function. |
|
|
1063 | |
1010 | =back |
1064 | =back |
1011 | |
1065 | |
1012 | =head1 WHAT TO DO IN A MODULE |
1066 | =head1 WHAT TO DO IN A MODULE |
1013 | |
1067 | |
1014 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
1068 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
… | |
… | |
1162 | |
1216 | |
1163 | BEGIN { AnyEvent::common_sense } |
1217 | BEGIN { AnyEvent::common_sense } |
1164 | |
1218 | |
1165 | use Carp (); |
1219 | use Carp (); |
1166 | |
1220 | |
1167 | our $VERSION = '5.34'; |
1221 | our $VERSION = '6.01'; |
1168 | our $MODEL; |
1222 | our $MODEL; |
1169 | |
1223 | |
1170 | our $AUTOLOAD; |
|
|
1171 | our @ISA; |
1224 | our @ISA; |
1172 | |
1225 | |
1173 | our @REGISTRY; |
1226 | our @REGISTRY; |
1174 | |
1227 | |
1175 | our $VERBOSE; |
1228 | our $VERBOSE; |
… | |
… | |
1181 | |
1234 | |
1182 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1235 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1183 | if ${^TAINT}; |
1236 | if ${^TAINT}; |
1184 | |
1237 | |
1185 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1238 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1186 | |
|
|
1187 | } |
1239 | } |
1188 | |
1240 | |
1189 | our $MAX_SIGNAL_LATENCY = 10; |
1241 | our $MAX_SIGNAL_LATENCY = 10; |
1190 | |
1242 | |
1191 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1243 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
… | |
… | |
1195 | $PROTOCOL{$_} = ++$idx |
1247 | $PROTOCOL{$_} = ++$idx |
1196 | for reverse split /\s*,\s*/, |
1248 | for reverse split /\s*,\s*/, |
1197 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1249 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1198 | } |
1250 | } |
1199 | |
1251 | |
|
|
1252 | our @post_detect; |
|
|
1253 | |
|
|
1254 | sub post_detect(&) { |
|
|
1255 | my ($cb) = @_; |
|
|
1256 | |
|
|
1257 | push @post_detect, $cb; |
|
|
1258 | |
|
|
1259 | defined wantarray |
|
|
1260 | ? bless \$cb, "AnyEvent::Util::postdetect" |
|
|
1261 | : () |
|
|
1262 | } |
|
|
1263 | |
|
|
1264 | sub AnyEvent::Util::postdetect::DESTROY { |
|
|
1265 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
|
|
1266 | } |
|
|
1267 | |
|
|
1268 | our $POSTPONE_W; |
|
|
1269 | our @POSTPONE; |
|
|
1270 | |
|
|
1271 | sub _postpone_exec { |
|
|
1272 | undef $POSTPONE_W; |
|
|
1273 | |
|
|
1274 | &{ shift @POSTPONE } |
|
|
1275 | while @POSTPONE; |
|
|
1276 | } |
|
|
1277 | |
|
|
1278 | sub postpone(&) { |
|
|
1279 | push @POSTPONE, shift; |
|
|
1280 | |
|
|
1281 | $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); |
|
|
1282 | |
|
|
1283 | () |
|
|
1284 | } |
|
|
1285 | |
|
|
1286 | sub log($$;@) { |
|
|
1287 | require AnyEvent::Log; |
|
|
1288 | # AnyEvent::Log overwrites this function |
|
|
1289 | goto &log; |
|
|
1290 | } |
|
|
1291 | |
1200 | my @models = ( |
1292 | our @models = ( |
1201 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1293 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1202 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], |
1294 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], |
1203 | # everything below here will not (normally) be autoprobed |
1295 | # everything below here will not (normally) be autoprobed |
1204 | # as the pure perl backend should work everywhere |
1296 | # as the pure perl backend should work everywhere |
1205 | # and is usually faster |
1297 | # and is usually faster |
… | |
… | |
1210 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1302 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1211 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1303 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1212 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1304 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1213 | [Wx:: => AnyEvent::Impl::POE::], |
1305 | [Wx:: => AnyEvent::Impl::POE::], |
1214 | [Prima:: => AnyEvent::Impl::POE::], |
1306 | [Prima:: => AnyEvent::Impl::POE::], |
1215 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], |
1307 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect |
1216 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
1308 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
1217 | [FLTK:: => AnyEvent::Impl::FLTK::], |
1309 | [FLTK:: => AnyEvent::Impl::FLTK2::], |
1218 | ); |
1310 | ); |
1219 | |
1311 | |
1220 | our %method = map +($_ => 1), |
1312 | our @isa_hook; |
|
|
1313 | |
|
|
1314 | sub _isa_set { |
|
|
1315 | my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL); |
|
|
1316 | |
|
|
1317 | @{"$pkg[$_-1]::ISA"} = $pkg[$_] |
|
|
1318 | for 1 .. $#pkg; |
|
|
1319 | |
|
|
1320 | grep $_ && $_->[1], @isa_hook |
|
|
1321 | and AE::_reset (); |
|
|
1322 | } |
|
|
1323 | |
|
|
1324 | # used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy |
|
|
1325 | sub _isa_hook($$;$) { |
|
|
1326 | my ($i, $pkg, $reset_ae) = @_; |
|
|
1327 | |
|
|
1328 | $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef; |
|
|
1329 | |
|
|
1330 | _isa_set; |
|
|
1331 | } |
|
|
1332 | |
|
|
1333 | # all autoloaded methods reserve the complete glob, not just the method slot. |
|
|
1334 | # due to bugs in perls method cache implementation. |
1221 | qw(io timer time now now_update signal child idle condvar DESTROY); |
1335 | 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 | |
1336 | |
1239 | sub detect() { |
1337 | sub detect() { |
|
|
1338 | return $MODEL if $MODEL; # some programs keep references to detect |
|
|
1339 | |
|
|
1340 | local $!; # for good measure |
|
|
1341 | local $SIG{__DIE__}; # we use eval |
|
|
1342 | |
1240 | # free some memory |
1343 | # free some memory |
1241 | *detect = sub () { $MODEL }; |
1344 | *detect = sub () { $MODEL }; |
|
|
1345 | # undef &func doesn't correctly update the method cache. grmbl. |
|
|
1346 | # so we delete the whole glob. grmbl. |
|
|
1347 | # otoh, perl doesn't let me undef an active usb, but it lets me free |
|
|
1348 | # a glob with an active sub. hrm. i hope it works, but perl is |
|
|
1349 | # usually buggy in this department. sigh. |
|
|
1350 | delete @{"AnyEvent::"}{@methods}; |
|
|
1351 | undef @methods; |
1242 | |
1352 | |
1243 | local $!; # for good measure |
|
|
1244 | local $SIG{__DIE__}; |
|
|
1245 | |
|
|
1246 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1353 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { |
1247 | my $model = "AnyEvent::Impl::$1"; |
1354 | my $model = $1; |
|
|
1355 | $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; |
1248 | if (eval "require $model") { |
1356 | if (eval "require $model") { |
1249 | $MODEL = $model; |
1357 | $MODEL = $model; |
1250 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
1358 | AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it." |
|
|
1359 | if $VERBOSE >= 7; |
1251 | } else { |
1360 | } else { |
1252 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
1361 | AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@"; |
1253 | } |
1362 | } |
1254 | } |
1363 | } |
1255 | |
1364 | |
1256 | # check for already loaded models |
1365 | # check for already loaded models |
1257 | unless ($MODEL) { |
1366 | unless ($MODEL) { |
1258 | for (@REGISTRY, @models) { |
1367 | for (@REGISTRY, @models) { |
1259 | my ($package, $model) = @$_; |
1368 | my ($package, $model) = @$_; |
1260 | if (${"$package\::VERSION"} > 0) { |
1369 | if (${"$package\::VERSION"} > 0) { |
1261 | if (eval "require $model") { |
1370 | if (eval "require $model") { |
1262 | $MODEL = $model; |
1371 | $MODEL = $model; |
1263 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
1372 | AnyEvent::log 7 => "autodetected model '$model', using it." |
|
|
1373 | if $VERBOSE >= 7; |
1264 | last; |
1374 | last; |
1265 | } |
1375 | } |
1266 | } |
1376 | } |
1267 | } |
1377 | } |
1268 | |
1378 | |
… | |
… | |
1275 | and eval "require $package" |
1385 | and eval "require $package" |
1276 | and ${"$package\::VERSION"} > 0 |
1386 | and ${"$package\::VERSION"} > 0 |
1277 | and eval "require $model" |
1387 | and eval "require $model" |
1278 | ) { |
1388 | ) { |
1279 | $MODEL = $model; |
1389 | $MODEL = $model; |
1280 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
1390 | AnyEvent::log 7 => "autoloaded model '$model', using it." |
|
|
1391 | if $VERBOSE >= 7; |
1281 | last; |
1392 | last; |
1282 | } |
1393 | } |
1283 | } |
1394 | } |
1284 | |
1395 | |
1285 | $MODEL |
1396 | $MODEL |
1286 | or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; |
1397 | or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?"; |
1287 | } |
1398 | } |
1288 | } |
1399 | } |
1289 | |
1400 | |
1290 | @models = (); # free probe data |
1401 | # free memory only needed for probing |
|
|
1402 | undef @models; |
|
|
1403 | undef @REGISTRY; |
1291 | |
1404 | |
1292 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1405 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1293 | unshift @ISA, $MODEL; |
|
|
1294 | |
1406 | |
1295 | # now nuke some methods that are overridden by the backend. |
1407 | # now nuke some methods that are overridden by the backend. |
1296 | # SUPER is not allowed. |
1408 | # SUPER usage is not allowed in these. |
1297 | for (qw(time signal child idle)) { |
1409 | for (qw(time signal child idle)) { |
1298 | undef &{"AnyEvent::Base::$_"} |
1410 | undef &{"AnyEvent::Base::$_"} |
1299 | if defined &{"$MODEL\::$_"}; |
1411 | if defined &{"$MODEL\::$_"}; |
1300 | } |
1412 | } |
1301 | |
1413 | |
|
|
1414 | _isa_set; |
|
|
1415 | |
|
|
1416 | # we're officially open! |
|
|
1417 | |
1302 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
1418 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
1303 | eval { require AnyEvent::Strict }; |
1419 | require AnyEvent::Strict; |
1304 | warn "AnyEvent: cannot load AnyEvent::Strict: $@" |
|
|
1305 | if $@ && $VERBOSE; |
|
|
1306 | } |
1420 | } |
1307 | |
1421 | |
|
|
1422 | if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) { |
|
|
1423 | require AnyEvent::Debug; |
|
|
1424 | AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP}); |
|
|
1425 | } |
|
|
1426 | |
|
|
1427 | if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) { |
|
|
1428 | require AnyEvent::Socket; |
|
|
1429 | require AnyEvent::Debug; |
|
|
1430 | |
|
|
1431 | my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL}; |
|
|
1432 | $shell =~ s/\$\$/$$/g; |
|
|
1433 | |
|
|
1434 | my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell); |
|
|
1435 | $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service); |
|
|
1436 | } |
|
|
1437 | |
|
|
1438 | # now the anyevent environment is set up as the user told us to, so |
|
|
1439 | # call the actual user code - post detects |
|
|
1440 | |
1308 | (shift @post_detect)->() while @post_detect; |
1441 | (shift @post_detect)->() while @post_detect; |
|
|
1442 | undef @post_detect; |
1309 | |
1443 | |
1310 | *post_detect = sub(&) { |
1444 | *post_detect = sub(&) { |
1311 | shift->(); |
1445 | shift->(); |
1312 | |
1446 | |
1313 | undef |
1447 | undef |
1314 | }; |
1448 | }; |
1315 | |
1449 | |
1316 | $MODEL |
1450 | $MODEL |
1317 | } |
1451 | } |
1318 | |
1452 | |
1319 | sub AUTOLOAD { |
1453 | for my $name (@methods) { |
1320 | (my $func = $AUTOLOAD) =~ s/.*://; |
1454 | *$name = sub { |
1321 | |
|
|
1322 | $method{$func} |
|
|
1323 | or Carp::croak "$func: not a valid AnyEvent class method"; |
|
|
1324 | |
|
|
1325 | detect; |
1455 | detect; |
1326 | |
1456 | # we use goto because |
1327 | my $class = shift; |
1457 | # a) it makes the thunk more transparent |
1328 | $class->$func (@_); |
1458 | # b) it allows us to delete the thunk later |
|
|
1459 | goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" } |
|
|
1460 | }; |
1329 | } |
1461 | } |
1330 | |
1462 | |
1331 | # utility function to dup a filehandle. this is used by many backends |
1463 | # utility function to dup a filehandle. this is used by many backends |
1332 | # to support binding more than one watcher per filehandle (they usually |
1464 | # 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). |
1465 | # allow only one watcher per fd, so we dup it to get a different one). |
… | |
… | |
1357 | |
1489 | |
1358 | package AE; |
1490 | package AE; |
1359 | |
1491 | |
1360 | our $VERSION = $AnyEvent::VERSION; |
1492 | our $VERSION = $AnyEvent::VERSION; |
1361 | |
1493 | |
|
|
1494 | sub _reset() { |
|
|
1495 | eval q{ |
1362 | # fall back to the main API by default - backends and AnyEvent::Base |
1496 | # fall back to the main API by default - backends and AnyEvent::Base |
1363 | # implementations can overwrite these. |
1497 | # implementations can overwrite these. |
1364 | |
1498 | |
1365 | sub io($$$) { |
1499 | sub io($$$) { |
1366 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
1500 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
1367 | } |
1501 | } |
1368 | |
1502 | |
1369 | sub timer($$$) { |
1503 | sub timer($$$) { |
1370 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) |
1504 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) |
1371 | } |
1505 | } |
1372 | |
1506 | |
1373 | sub signal($$) { |
1507 | sub signal($$) { |
1374 | AnyEvent->signal (signal => $_[0], cb => $_[1]) |
1508 | AnyEvent->signal (signal => $_[0], cb => $_[1]) |
1375 | } |
1509 | } |
1376 | |
1510 | |
1377 | sub child($$) { |
1511 | sub child($$) { |
1378 | AnyEvent->child (pid => $_[0], cb => $_[1]) |
1512 | AnyEvent->child (pid => $_[0], cb => $_[1]) |
1379 | } |
1513 | } |
1380 | |
1514 | |
1381 | sub idle($) { |
1515 | sub idle($) { |
1382 | AnyEvent->idle (cb => $_[0]) |
1516 | AnyEvent->idle (cb => $_[0]); |
1383 | } |
1517 | } |
1384 | |
1518 | |
1385 | sub cv(;&) { |
1519 | sub cv(;&) { |
1386 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
1520 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
1387 | } |
1521 | } |
1388 | |
1522 | |
1389 | sub now() { |
1523 | sub now() { |
1390 | AnyEvent->now |
1524 | AnyEvent->now |
1391 | } |
1525 | } |
1392 | |
1526 | |
1393 | sub now_update() { |
1527 | sub now_update() { |
1394 | AnyEvent->now_update |
1528 | AnyEvent->now_update |
1395 | } |
1529 | } |
1396 | |
1530 | |
1397 | sub time() { |
1531 | sub time() { |
1398 | AnyEvent->time |
1532 | AnyEvent->time |
|
|
1533 | } |
|
|
1534 | |
|
|
1535 | *postpone = \&AnyEvent::postpone; |
|
|
1536 | *log = \&AnyEvent::log; |
|
|
1537 | }; |
|
|
1538 | die if $@; |
1399 | } |
1539 | } |
|
|
1540 | |
|
|
1541 | BEGIN { _reset } |
1400 | |
1542 | |
1401 | package AnyEvent::Base; |
1543 | package AnyEvent::Base; |
1402 | |
1544 | |
1403 | # default implementations for many methods |
1545 | # default implementations for many methods |
1404 | |
1546 | |
1405 | sub time { |
1547 | sub time { |
1406 | eval q{ # poor man's autoloading {} |
1548 | eval q{ # poor man's autoloading {} |
1407 | # probe for availability of Time::HiRes |
1549 | # probe for availability of Time::HiRes |
1408 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1550 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1409 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1551 | AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy." |
|
|
1552 | if $AnyEvent::VERBOSE >= 8; |
|
|
1553 | *time = sub { Time::HiRes::time () }; |
1410 | *AE::time = \&Time::HiRes::time; |
1554 | *AE::time = \& Time::HiRes::time ; |
1411 | # if (eval "use POSIX (); (POSIX::times())... |
1555 | # if (eval "use POSIX (); (POSIX::times())... |
1412 | } else { |
1556 | } else { |
1413 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1557 | AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!"; |
|
|
1558 | *time = sub { CORE::time }; |
1414 | *AE::time = sub (){ time }; # epic fail |
1559 | *AE::time = sub (){ CORE::time }; |
1415 | } |
1560 | } |
1416 | |
1561 | |
1417 | *time = sub { AE::time }; # different prototypes |
1562 | *now = \&time; |
1418 | }; |
1563 | }; |
1419 | die if $@; |
1564 | die if $@; |
1420 | |
1565 | |
1421 | &time |
1566 | &time |
1422 | } |
1567 | } |
1423 | |
1568 | |
1424 | *now = \&time; |
1569 | *now = \&time; |
1425 | |
|
|
1426 | sub now_update { } |
1570 | sub now_update { } |
1427 | |
1571 | |
1428 | sub _poll { |
1572 | sub _poll { |
1429 | Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; |
1573 | Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; |
1430 | } |
1574 | } |
1431 | |
1575 | |
1432 | # default implementation for ->condvar |
1576 | # default implementation for ->condvar |
1433 | # in fact,t he default should not be overwritten |
1577 | # in fact, the default should not be overwritten |
1434 | |
1578 | |
1435 | sub condvar { |
1579 | sub condvar { |
1436 | eval q{ # poor man's autoloading {} |
1580 | eval q{ # poor man's autoloading {} |
1437 | *condvar = sub { |
1581 | *condvar = sub { |
1438 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1582 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
… | |
… | |
1516 | |
1660 | |
1517 | sub signal { |
1661 | sub signal { |
1518 | eval q{ # poor man's autoloading {} |
1662 | eval q{ # poor man's autoloading {} |
1519 | # probe for availability of Async::Interrupt |
1663 | # probe for availability of Async::Interrupt |
1520 | if (_have_async_interrupt) { |
1664 | if (_have_async_interrupt) { |
1521 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
1665 | AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling." |
|
|
1666 | if $AnyEvent::VERBOSE >= 8; |
1522 | |
1667 | |
1523 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1668 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1524 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1669 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1525 | |
1670 | |
1526 | } else { |
1671 | } else { |
1527 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
1672 | AnyEvent::log 8 => "using emulated perl signal handling with latency timer." |
|
|
1673 | if $AnyEvent::VERBOSE >= 8; |
1528 | |
1674 | |
1529 | if (AnyEvent::WIN32) { |
1675 | if (AnyEvent::WIN32) { |
1530 | require AnyEvent::Util; |
1676 | require AnyEvent::Util; |
1531 | |
1677 | |
1532 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1678 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
… | |
… | |
1608 | : sysread $SIGPIPE_R, (my $dummy), 9; |
1754 | : sysread $SIGPIPE_R, (my $dummy), 9; |
1609 | |
1755 | |
1610 | while (%SIG_EV) { |
1756 | while (%SIG_EV) { |
1611 | for (keys %SIG_EV) { |
1757 | for (keys %SIG_EV) { |
1612 | delete $SIG_EV{$_}; |
1758 | delete $SIG_EV{$_}; |
1613 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1759 | &$_ for values %{ $SIG_CB{$_} || {} }; |
1614 | } |
1760 | } |
1615 | } |
1761 | } |
1616 | }; |
1762 | }; |
1617 | }; |
1763 | }; |
1618 | die if $@; |
1764 | die if $@; |
… | |
… | |
1685 | |
1831 | |
1686 | my ($cb, $w, $rcb) = $arg{cb}; |
1832 | my ($cb, $w, $rcb) = $arg{cb}; |
1687 | |
1833 | |
1688 | $rcb = sub { |
1834 | $rcb = sub { |
1689 | if ($cb) { |
1835 | if ($cb) { |
1690 | $w = _time; |
1836 | $w = AE::time; |
1691 | &$cb; |
1837 | &$cb; |
1692 | $w = _time - $w; |
1838 | $w = AE::time - $w; |
1693 | |
1839 | |
1694 | # never use more then 50% of the time for the idle watcher, |
1840 | # never use more then 50% of the time for the idle watcher, |
1695 | # within some limits |
1841 | # within some limits |
1696 | $w = 0.0001 if $w < 0.0001; |
1842 | $w = 0.0001 if $w < 0.0001; |
1697 | $w = 5 if $w > 5; |
1843 | $w = 5 if $w > 5; |
… | |
… | |
1841 | |
1987 | |
1842 | By default, AnyEvent will be completely silent except in fatal |
1988 | By default, AnyEvent will be completely silent except in fatal |
1843 | conditions. You can set this environment variable to make AnyEvent more |
1989 | conditions. You can set this environment variable to make AnyEvent more |
1844 | talkative. |
1990 | talkative. |
1845 | |
1991 | |
1846 | When set to C<1> or higher, causes AnyEvent to warn about unexpected |
1992 | When set to C<5> or higher, causes AnyEvent to warn about unexpected |
1847 | conditions, such as not being able to load the event model specified by |
1993 | conditions, such as not being able to load the event model specified by |
1848 | C<PERL_ANYEVENT_MODEL>. |
1994 | C<PERL_ANYEVENT_MODEL>. |
1849 | |
1995 | |
1850 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
1996 | When set to C<7> or higher, cause AnyEvent to report to STDERR which event |
1851 | model it chooses. |
1997 | model it chooses. |
1852 | |
1998 | |
1853 | When set to C<8> or higher, then AnyEvent will report extra information on |
1999 | When set to C<8> or higher, then AnyEvent will report extra information on |
1854 | which optional modules it loads and how it implements certain features. |
2000 | which optional modules it loads and how it implements certain features. |
1855 | |
2001 | |
… | |
… | |
1866 | Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> |
2012 | 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 |
2013 | >>, it is definitely recommended to keep it off in production. Keeping |
1868 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
2014 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
1869 | can be very useful, however. |
2015 | can be very useful, however. |
1870 | |
2016 | |
|
|
2017 | =item C<PERL_ANYEVENT_DEBUG_SHELL> |
|
|
2018 | |
|
|
2019 | If this env variable is set, then its contents will be interpreted by |
|
|
2020 | C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of |
|
|
2021 | C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on |
|
|
2022 | that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>. |
|
|
2023 | |
|
|
2024 | This takes place when the first watcher is created. |
|
|
2025 | |
|
|
2026 | For example, to bind a debug shell on a unix domain socket in |
|
|
2027 | F<< /tmp/debug<pid>.sock >>, you could use this: |
|
|
2028 | |
|
|
2029 | PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog |
|
|
2030 | |
|
|
2031 | Note that creating sockets in F</tmp> is very unsafe on multiuser |
|
|
2032 | systems. |
|
|
2033 | |
|
|
2034 | =item C<PERL_ANYEVENT_DEBUG_WRAP> |
|
|
2035 | |
|
|
2036 | Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for |
|
|
2037 | debugging purposes. See C<AnyEvent::Debug::wrap> for details. |
|
|
2038 | |
1871 | =item C<PERL_ANYEVENT_MODEL> |
2039 | =item C<PERL_ANYEVENT_MODEL> |
1872 | |
2040 | |
1873 | This can be used to specify the event model to be used by AnyEvent, before |
2041 | 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 |
2042 | auto detection and -probing kicks in. |
1875 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
2043 | |
|
|
2044 | It normally is a string consisting entirely of ASCII letters (e.g. C<EV> |
|
|
2045 | 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, |
2046 | 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 |
2047 | event model backend. If it fails to load then AnyEvent will proceed with |
1878 | auto detection and -probing. |
2048 | auto detection and -probing. |
1879 | |
2049 | |
1880 | This functionality might change in future versions. |
2050 | If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then |
|
|
2051 | nothing gets prepended and the module name is used as-is (hint: C<::> at |
|
|
2052 | the end of a string designates a module name and quotes it appropriately). |
1881 | |
2053 | |
1882 | For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you |
2054 | For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you |
1883 | could start your program like this: |
2055 | could start your program like this: |
1884 | |
2056 | |
1885 | PERL_ANYEVENT_MODEL=Perl perl ... |
2057 | PERL_ANYEVENT_MODEL=Perl perl ... |
… | |
… | |
2277 | (even when used without AnyEvent), but most event loops have acceptable |
2449 | (even when used without AnyEvent), but most event loops have acceptable |
2278 | performance with or without AnyEvent. |
2450 | performance with or without AnyEvent. |
2279 | |
2451 | |
2280 | =item * The overhead AnyEvent adds is usually much smaller than the overhead of |
2452 | =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 |
2453 | the actual event loop, only with extremely fast event loops such as EV |
2282 | adds AnyEvent significant overhead. |
2454 | does AnyEvent add significant overhead. |
2283 | |
2455 | |
2284 | =item * You should avoid POE like the plague if you want performance or |
2456 | =item * You should avoid POE like the plague if you want performance or |
2285 | reasonable memory usage. |
2457 | reasonable memory usage. |
2286 | |
2458 | |
2287 | =back |
2459 | =back |
… | |
… | |
2662 | |
2834 | |
2663 | Tutorial/Introduction: L<AnyEvent::Intro>. |
2835 | Tutorial/Introduction: L<AnyEvent::Intro>. |
2664 | |
2836 | |
2665 | FAQ: L<AnyEvent::FAQ>. |
2837 | FAQ: L<AnyEvent::FAQ>. |
2666 | |
2838 | |
2667 | Utility functions: L<AnyEvent::Util>. |
2839 | Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log> |
|
|
2840 | (simply logging). |
2668 | |
2841 | |
|
|
2842 | Development/Debugging: L<AnyEvent::Strict> (stricter checking), |
|
|
2843 | L<AnyEvent::Debug> (interactive shell, watcher tracing). |
|
|
2844 | |
2669 | Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>, |
2845 | 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>. |
2846 | L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, |
|
|
2847 | L<Qt>, L<POE>, L<FLTK>. |
2671 | |
2848 | |
2672 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2849 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2673 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2850 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2674 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2851 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2675 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
2852 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>, |
|
|
2853 | L<AnyEvent::Impl::FLTK>. |
2676 | |
2854 | |
2677 | Non-blocking file handles, sockets, TCP clients and |
2855 | Non-blocking handles, pipes, stream sockets, TCP clients and |
2678 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2856 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2679 | |
2857 | |
2680 | Asynchronous DNS: L<AnyEvent::DNS>. |
2858 | Asynchronous DNS: L<AnyEvent::DNS>. |
2681 | |
2859 | |
2682 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
2860 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |