… | |
… | |
363 | might affect timers and time-outs. |
363 | might affect timers and time-outs. |
364 | |
364 | |
365 | When this is the case, you can call this method, which will update the |
365 | When this is the case, you can call this method, which will update the |
366 | event loop's idea of "current time". |
366 | event loop's idea of "current time". |
367 | |
367 | |
|
|
368 | A typical example would be a script in a web server (e.g. C<mod_perl>) - |
|
|
369 | when mod_perl executes the script, then the event loop will have the wrong |
|
|
370 | idea about the "current time" (being potentially far in the past, when the |
|
|
371 | script ran the last time). In that case you should arrange a call to C<< |
|
|
372 | AnyEvent->now_update >> each time the web server process wakes up again |
|
|
373 | (e.g. at the start of your script, or in a handler). |
|
|
374 | |
368 | Note that updating the time I<might> cause some events to be handled. |
375 | Note that updating the time I<might> cause some events to be handled. |
369 | |
376 | |
370 | =back |
377 | =back |
371 | |
378 | |
372 | =head2 SIGNAL WATCHERS |
379 | =head2 SIGNAL WATCHERS |
… | |
… | |
395 | correctly. |
402 | correctly. |
396 | |
403 | |
397 | Example: exit on SIGINT |
404 | Example: exit on SIGINT |
398 | |
405 | |
399 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
406 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
|
|
407 | |
|
|
408 | =head3 Restart Behaviour |
|
|
409 | |
|
|
410 | While restart behaviour is up to the event loop implementation, most will |
|
|
411 | not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's |
|
|
412 | pure perl implementation). |
|
|
413 | |
|
|
414 | =head3 Safe/Unsafe Signals |
|
|
415 | |
|
|
416 | Perl signals can be either "safe" (synchronous to opcode handling) or |
|
|
417 | "unsafe" (asynchronous) - the former might get delayed indefinitely, the |
|
|
418 | latter might corrupt your memory. |
|
|
419 | |
|
|
420 | AnyEvent signal handlers are, in addition, synchronous to the event loop, |
|
|
421 | i.e. they will not interrupt your running perl program but will only be |
|
|
422 | called as part of the normal event handling (just like timer, I/O etc. |
|
|
423 | callbacks, too). |
400 | |
424 | |
401 | =head3 Signal Races, Delays and Workarounds |
425 | =head3 Signal Races, Delays and Workarounds |
402 | |
426 | |
403 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
427 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
404 | callbacks to signals in a generic way, which is a pity, as you cannot |
428 | callbacks to signals in a generic way, which is a pity, as you cannot |
… | |
… | |
479 | |
503 | |
480 | =head2 IDLE WATCHERS |
504 | =head2 IDLE WATCHERS |
481 | |
505 | |
482 | $w = AnyEvent->idle (cb => <callback>); |
506 | $w = AnyEvent->idle (cb => <callback>); |
483 | |
507 | |
484 | Sometimes there is a need to do something, but it is not so important |
508 | Repeatedly invoke the callback after the process becomes idle, until |
485 | to do it instantly, but only when there is nothing better to do. This |
509 | either the watcher is destroyed or new events have been detected. |
486 | "nothing better to do" is usually defined to be "no other events need |
|
|
487 | attention by the event loop". |
|
|
488 | |
510 | |
489 | Idle watchers ideally get invoked when the event loop has nothing |
511 | Idle watchers are useful when there is a need to do something, but it |
490 | better to do, just before it would block the process to wait for new |
512 | is not so important (or wise) to do it instantly. The callback will be |
491 | events. Instead of blocking, the idle watcher is invoked. |
513 | invoked only when there is "nothing better to do", which is usually |
|
|
514 | defined as "all outstanding events have been handled and no new events |
|
|
515 | have been detected". That means that idle watchers ideally get invoked |
|
|
516 | when the event loop has just polled for new events but none have been |
|
|
517 | detected. Instead of blocking to wait for more events, the idle watchers |
|
|
518 | will be invoked. |
492 | |
519 | |
493 | Most event loops unfortunately do not really support idle watchers (only |
520 | Unfortunately, most event loops do not really support idle watchers (only |
494 | EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent |
521 | EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent |
495 | will simply call the callback "from time to time". |
522 | will simply call the callback "from time to time". |
496 | |
523 | |
497 | Example: read lines from STDIN, but only process them when the |
524 | Example: read lines from STDIN, but only process them when the |
498 | program is otherwise idle: |
525 | program is otherwise idle: |
… | |
… | |
592 | after => 1, |
619 | after => 1, |
593 | cb => sub { $result_ready->send }, |
620 | cb => sub { $result_ready->send }, |
594 | ); |
621 | ); |
595 | |
622 | |
596 | # this "blocks" (while handling events) till the callback |
623 | # this "blocks" (while handling events) till the callback |
597 | # calls -<send |
624 | # calls ->send |
598 | $result_ready->recv; |
625 | $result_ready->recv; |
599 | |
626 | |
600 | Example: wait for a timer, but take advantage of the fact that condition |
627 | Example: wait for a timer, but take advantage of the fact that condition |
601 | variables are also callable directly. |
628 | variables are also callable directly. |
602 | |
629 | |
… | |
… | |
666 | one. For example, a function that pings many hosts in parallel might want |
693 | one. For example, a function that pings many hosts in parallel might want |
667 | to use a condition variable for the whole process. |
694 | to use a condition variable for the whole process. |
668 | |
695 | |
669 | Every call to C<< ->begin >> will increment a counter, and every call to |
696 | Every call to C<< ->begin >> will increment a counter, and every call to |
670 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
697 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
671 | >>, the (last) callback passed to C<begin> will be executed. That callback |
698 | >>, the (last) callback passed to C<begin> will be executed, passing the |
672 | is I<supposed> to call C<< ->send >>, but that is not required. If no |
699 | condvar as first argument. That callback is I<supposed> to call C<< ->send |
673 | callback was set, C<send> will be called without any arguments. |
700 | >>, but that is not required. If no group callback was set, C<send> will |
|
|
701 | be called without any arguments. |
674 | |
702 | |
675 | You can think of C<< $cv->send >> giving you an OR condition (one call |
703 | You can think of C<< $cv->send >> giving you an OR condition (one call |
676 | sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND |
704 | sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND |
677 | condition (all C<begin> calls must be C<end>'ed before the condvar sends). |
705 | condition (all C<begin> calls must be C<end>'ed before the condvar sends). |
678 | |
706 | |
… | |
… | |
705 | begung can potentially be zero: |
733 | begung can potentially be zero: |
706 | |
734 | |
707 | my $cv = AnyEvent->condvar; |
735 | my $cv = AnyEvent->condvar; |
708 | |
736 | |
709 | my %result; |
737 | my %result; |
710 | $cv->begin (sub { $cv->send (\%result) }); |
738 | $cv->begin (sub { shift->send (\%result) }); |
711 | |
739 | |
712 | for my $host (@list_of_hosts) { |
740 | for my $host (@list_of_hosts) { |
713 | $cv->begin; |
741 | $cv->begin; |
714 | ping_host_then_call_callback $host, sub { |
742 | ping_host_then_call_callback $host, sub { |
715 | $result{$host} = ...; |
743 | $result{$host} = ...; |
… | |
… | |
941 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
969 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
942 | if it is defined then the event loop has already been detected, and the |
970 | if it is defined then the event loop has already been detected, and the |
943 | array will be ignored. |
971 | array will be ignored. |
944 | |
972 | |
945 | Best use C<AnyEvent::post_detect { BLOCK }> when your application allows |
973 | Best use C<AnyEvent::post_detect { BLOCK }> when your application allows |
946 | it,as it takes care of these details. |
974 | it, as it takes care of these details. |
947 | |
975 | |
948 | This variable is mainly useful for modules that can do something useful |
976 | This variable is mainly useful for modules that can do something useful |
949 | when AnyEvent is used and thus want to know when it is initialised, but do |
977 | when AnyEvent is used and thus want to know when it is initialised, but do |
950 | not need to even load it by default. This array provides the means to hook |
978 | not need to even load it by default. This array provides the means to hook |
951 | into AnyEvent passively, without loading it. |
979 | into AnyEvent passively, without loading it. |
|
|
980 | |
|
|
981 | Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used |
|
|
982 | together, you could put this into Coro (this is the actual code used by |
|
|
983 | Coro to accomplish this): |
|
|
984 | |
|
|
985 | if (defined $AnyEvent::MODEL) { |
|
|
986 | # AnyEvent already initialised, so load Coro::AnyEvent |
|
|
987 | require Coro::AnyEvent; |
|
|
988 | } else { |
|
|
989 | # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent |
|
|
990 | # as soon as it is |
|
|
991 | push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; |
|
|
992 | } |
952 | |
993 | |
953 | =back |
994 | =back |
954 | |
995 | |
955 | =head1 WHAT TO DO IN A MODULE |
996 | =head1 WHAT TO DO IN A MODULE |
956 | |
997 | |
… | |
… | |
1105 | |
1146 | |
1106 | package AnyEvent; |
1147 | package AnyEvent; |
1107 | |
1148 | |
1108 | # basically a tuned-down version of common::sense |
1149 | # basically a tuned-down version of common::sense |
1109 | sub common_sense { |
1150 | sub common_sense { |
1110 | # no warnings |
1151 | # from common:.sense 1.0 |
1111 | ${^WARNING_BITS} ^= ${^WARNING_BITS}; |
1152 | ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00"; |
1112 | # use strict vars subs |
1153 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
1113 | $^H |= 0x00000600; |
1154 | $^H |= 0x00000600; |
1114 | } |
1155 | } |
1115 | |
1156 | |
1116 | BEGIN { AnyEvent::common_sense } |
1157 | BEGIN { AnyEvent::common_sense } |
1117 | |
1158 | |
1118 | use Carp (); |
1159 | use Carp (); |
1119 | |
1160 | |
1120 | our $VERSION = '5.0'; |
1161 | our $VERSION = '5.24'; |
1121 | our $MODEL; |
1162 | our $MODEL; |
1122 | |
1163 | |
1123 | our $AUTOLOAD; |
1164 | our $AUTOLOAD; |
1124 | our @ISA; |
1165 | our @ISA; |
1125 | |
1166 | |
1126 | our @REGISTRY; |
1167 | our @REGISTRY; |
1127 | |
1168 | |
1128 | our $WIN32; |
|
|
1129 | |
|
|
1130 | our $VERBOSE; |
1169 | our $VERBOSE; |
1131 | |
1170 | |
1132 | BEGIN { |
1171 | BEGIN { |
1133 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
1172 | require "AnyEvent/constants.pl"; |
|
|
1173 | |
1134 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
1174 | eval "sub TAINT (){" . (${^TAINT} *1) . "}"; |
1135 | |
1175 | |
1136 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1176 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1137 | if ${^TAINT}; |
1177 | if ${^TAINT}; |
1138 | |
1178 | |
1139 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1179 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
… | |
… | |
1200 | sub AnyEvent::Util::postdetect::DESTROY { |
1240 | sub AnyEvent::Util::postdetect::DESTROY { |
1201 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1241 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1202 | } |
1242 | } |
1203 | |
1243 | |
1204 | sub detect() { |
1244 | sub detect() { |
|
|
1245 | # free some memory |
|
|
1246 | *detect = sub () { $MODEL }; |
|
|
1247 | |
|
|
1248 | local $!; # for good measure |
|
|
1249 | local $SIG{__DIE__}; |
|
|
1250 | |
|
|
1251 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
|
|
1252 | my $model = "AnyEvent::Impl::$1"; |
|
|
1253 | if (eval "require $model") { |
|
|
1254 | $MODEL = $model; |
|
|
1255 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
|
|
1256 | } else { |
|
|
1257 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
|
|
1258 | } |
|
|
1259 | } |
|
|
1260 | |
|
|
1261 | # check for already loaded models |
1205 | unless ($MODEL) { |
1262 | unless ($MODEL) { |
1206 | local $SIG{__DIE__}; |
1263 | for (@REGISTRY, @models) { |
1207 | |
1264 | my ($package, $model) = @$_; |
1208 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1265 | if (${"$package\::VERSION"} > 0) { |
1209 | my $model = "AnyEvent::Impl::$1"; |
|
|
1210 | if (eval "require $model") { |
1266 | if (eval "require $model") { |
1211 | $MODEL = $model; |
1267 | $MODEL = $model; |
1212 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
1268 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
1213 | } else { |
1269 | last; |
1214 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
1270 | } |
1215 | } |
1271 | } |
1216 | } |
1272 | } |
1217 | |
1273 | |
1218 | # check for already loaded models |
|
|
1219 | unless ($MODEL) { |
1274 | unless ($MODEL) { |
|
|
1275 | # try to autoload a model |
1220 | for (@REGISTRY, @models) { |
1276 | for (@REGISTRY, @models) { |
1221 | my ($package, $model) = @$_; |
1277 | my ($package, $model, $autoload) = @$_; |
|
|
1278 | if ( |
|
|
1279 | $autoload |
|
|
1280 | and eval "require $package" |
1222 | if (${"$package\::VERSION"} > 0) { |
1281 | and ${"$package\::VERSION"} > 0 |
1223 | if (eval "require $model") { |
1282 | and eval "require $model" |
|
|
1283 | ) { |
1224 | $MODEL = $model; |
1284 | $MODEL = $model; |
1225 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
1285 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
1226 | last; |
1286 | last; |
1227 | } |
|
|
1228 | } |
1287 | } |
1229 | } |
1288 | } |
1230 | |
1289 | |
1231 | unless ($MODEL) { |
|
|
1232 | # try to autoload a model |
|
|
1233 | for (@REGISTRY, @models) { |
|
|
1234 | my ($package, $model, $autoload) = @$_; |
|
|
1235 | if ( |
|
|
1236 | $autoload |
|
|
1237 | and eval "require $package" |
|
|
1238 | and ${"$package\::VERSION"} > 0 |
|
|
1239 | and eval "require $model" |
|
|
1240 | ) { |
|
|
1241 | $MODEL = $model; |
|
|
1242 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
|
|
1243 | last; |
|
|
1244 | } |
|
|
1245 | } |
|
|
1246 | |
|
|
1247 | $MODEL |
1290 | $MODEL |
1248 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
1291 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
1249 | } |
|
|
1250 | } |
1292 | } |
1251 | |
|
|
1252 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
|
|
1253 | |
|
|
1254 | unshift @ISA, $MODEL; |
|
|
1255 | |
|
|
1256 | require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; |
|
|
1257 | |
|
|
1258 | (shift @post_detect)->() while @post_detect; |
|
|
1259 | } |
1293 | } |
|
|
1294 | |
|
|
1295 | @models = (); # free probe data |
|
|
1296 | |
|
|
1297 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
|
|
1298 | unshift @ISA, $MODEL; |
|
|
1299 | |
|
|
1300 | require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; |
|
|
1301 | |
|
|
1302 | (shift @post_detect)->() while @post_detect; |
1260 | |
1303 | |
1261 | $MODEL |
1304 | $MODEL |
1262 | } |
1305 | } |
1263 | |
1306 | |
1264 | sub AUTOLOAD { |
1307 | sub AUTOLOAD { |
1265 | (my $func = $AUTOLOAD) =~ s/.*://; |
1308 | (my $func = $AUTOLOAD) =~ s/.*://; |
1266 | |
1309 | |
1267 | $method{$func} |
1310 | $method{$func} |
1268 | or Carp::croak "$func: not a valid method for AnyEvent objects"; |
1311 | or Carp::croak "$func: not a valid AnyEvent class method"; |
1269 | |
1312 | |
1270 | detect unless $MODEL; |
1313 | detect; |
1271 | |
1314 | |
1272 | my $class = shift; |
1315 | my $class = shift; |
1273 | $class->$func (@_); |
1316 | $class->$func (@_); |
1274 | } |
1317 | } |
1275 | |
1318 | |
… | |
… | |
1342 | |
1385 | |
1343 | package AnyEvent::Base; |
1386 | package AnyEvent::Base; |
1344 | |
1387 | |
1345 | # default implementations for many methods |
1388 | # default implementations for many methods |
1346 | |
1389 | |
1347 | sub _time { |
1390 | sub _time() { |
|
|
1391 | eval q{ # poor man's autoloading |
1348 | # probe for availability of Time::HiRes |
1392 | # probe for availability of Time::HiRes |
1349 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1393 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1350 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1394 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1351 | *_time = \&Time::HiRes::time; |
1395 | *_time = \&Time::HiRes::time; |
1352 | # if (eval "use POSIX (); (POSIX::times())... |
1396 | # if (eval "use POSIX (); (POSIX::times())... |
1353 | } else { |
1397 | } else { |
1354 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1398 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1355 | *_time = sub { time }; # epic fail |
1399 | *_time = sub (){ time }; # epic fail |
|
|
1400 | } |
1356 | } |
1401 | }; |
|
|
1402 | die if $@; |
1357 | |
1403 | |
1358 | &_time |
1404 | &_time |
1359 | } |
1405 | } |
1360 | |
1406 | |
1361 | sub time { _time } |
1407 | sub time { _time } |
… | |
… | |
1372 | |
1418 | |
1373 | our $HAVE_ASYNC_INTERRUPT; |
1419 | our $HAVE_ASYNC_INTERRUPT; |
1374 | |
1420 | |
1375 | sub _have_async_interrupt() { |
1421 | sub _have_async_interrupt() { |
1376 | $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} |
1422 | $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} |
1377 | && eval "use Async::Interrupt 1.0 (); 1") |
1423 | && eval "use Async::Interrupt 1.02 (); 1") |
1378 | unless defined $HAVE_ASYNC_INTERRUPT; |
1424 | unless defined $HAVE_ASYNC_INTERRUPT; |
1379 | |
1425 | |
1380 | $HAVE_ASYNC_INTERRUPT |
1426 | $HAVE_ASYNC_INTERRUPT |
1381 | } |
1427 | } |
1382 | |
1428 | |
1383 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1429 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1384 | our (%SIG_ASY, %SIG_ASY_W); |
1430 | our (%SIG_ASY, %SIG_ASY_W); |
1385 | our ($SIG_COUNT, $SIG_TW); |
1431 | our ($SIG_COUNT, $SIG_TW); |
1386 | |
1432 | |
1387 | sub _signal_exec { |
|
|
1388 | $HAVE_ASYNC_INTERRUPT |
|
|
1389 | ? $SIGPIPE_R->drain |
|
|
1390 | : sysread $SIGPIPE_R, my $dummy, 9; |
|
|
1391 | |
|
|
1392 | while (%SIG_EV) { |
|
|
1393 | for (keys %SIG_EV) { |
|
|
1394 | delete $SIG_EV{$_}; |
|
|
1395 | $_->() for values %{ $SIG_CB{$_} || {} }; |
|
|
1396 | } |
|
|
1397 | } |
|
|
1398 | } |
|
|
1399 | |
|
|
1400 | # install a dummy wakeup watcher to reduce signal catching latency |
1433 | # install a dummy wakeup watcher to reduce signal catching latency |
|
|
1434 | # used by Impls |
1401 | sub _sig_add() { |
1435 | sub _sig_add() { |
1402 | unless ($SIG_COUNT++) { |
1436 | unless ($SIG_COUNT++) { |
1403 | # try to align timer on a full-second boundary, if possible |
1437 | # try to align timer on a full-second boundary, if possible |
1404 | my $NOW = AE::now; |
1438 | my $NOW = AE::now; |
1405 | |
1439 | |
… | |
… | |
1457 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1491 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1458 | |
1492 | |
1459 | } else { |
1493 | } else { |
1460 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
1494 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
1461 | |
1495 | |
1462 | require Fcntl; |
|
|
1463 | |
|
|
1464 | if (AnyEvent::WIN32) { |
1496 | if (AnyEvent::WIN32) { |
1465 | require AnyEvent::Util; |
1497 | require AnyEvent::Util; |
1466 | |
1498 | |
1467 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1499 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1468 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R; |
1500 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R; |
1469 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case |
1501 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case |
1470 | } else { |
1502 | } else { |
1471 | pipe $SIGPIPE_R, $SIGPIPE_W; |
1503 | pipe $SIGPIPE_R, $SIGPIPE_W; |
1472 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
1504 | fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R; |
1473 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
1505 | fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case |
1474 | |
1506 | |
1475 | # not strictly required, as $^F is normally 2, but let's make sure... |
1507 | # not strictly required, as $^F is normally 2, but let's make sure... |
1476 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
1508 | fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC; |
1477 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
1509 | fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC; |
1478 | } |
1510 | } |
1479 | |
1511 | |
1480 | $SIGPIPE_R |
1512 | $SIGPIPE_R |
1481 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
1513 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
1482 | |
1514 | |
… | |
… | |
1536 | # print weird messages, or just unconditionally exit |
1568 | # print weird messages, or just unconditionally exit |
1537 | # instead of getting the default action. |
1569 | # instead of getting the default action. |
1538 | undef $SIG{$signal} |
1570 | undef $SIG{$signal} |
1539 | unless keys %{ $SIG_CB{$signal} }; |
1571 | unless keys %{ $SIG_CB{$signal} }; |
1540 | }; |
1572 | }; |
|
|
1573 | |
|
|
1574 | *_signal_exec = sub { |
|
|
1575 | $HAVE_ASYNC_INTERRUPT |
|
|
1576 | ? $SIGPIPE_R->drain |
|
|
1577 | : sysread $SIGPIPE_R, (my $dummy), 9; |
|
|
1578 | |
|
|
1579 | while (%SIG_EV) { |
|
|
1580 | for (keys %SIG_EV) { |
|
|
1581 | delete $SIG_EV{$_}; |
|
|
1582 | $_->() for values %{ $SIG_CB{$_} || {} }; |
|
|
1583 | } |
|
|
1584 | } |
|
|
1585 | }; |
1541 | }; |
1586 | }; |
1542 | die if $@; |
1587 | die if $@; |
|
|
1588 | |
1543 | &signal |
1589 | &signal |
1544 | } |
1590 | } |
1545 | |
1591 | |
1546 | # default implementation for ->child |
1592 | # default implementation for ->child |
1547 | |
1593 | |
1548 | our %PID_CB; |
1594 | our %PID_CB; |
1549 | our $CHLD_W; |
1595 | our $CHLD_W; |
1550 | our $CHLD_DELAY_W; |
1596 | our $CHLD_DELAY_W; |
1551 | our $WNOHANG; |
1597 | our $WNOHANG; |
1552 | |
1598 | |
|
|
1599 | # used by many Impl's |
1553 | sub _emit_childstatus($$) { |
1600 | sub _emit_childstatus($$) { |
1554 | my (undef, $rpid, $rstatus) = @_; |
1601 | my (undef, $rpid, $rstatus) = @_; |
1555 | |
1602 | |
1556 | $_->($rpid, $rstatus) |
1603 | $_->($rpid, $rstatus) |
1557 | for values %{ $PID_CB{$rpid} || {} }, |
1604 | for values %{ $PID_CB{$rpid} || {} }, |
1558 | values %{ $PID_CB{0} || {} }; |
1605 | values %{ $PID_CB{0} || {} }; |
1559 | } |
1606 | } |
1560 | |
1607 | |
1561 | sub _sigchld { |
|
|
1562 | my $pid; |
|
|
1563 | |
|
|
1564 | AnyEvent->_emit_childstatus ($pid, $?) |
|
|
1565 | while ($pid = waitpid -1, $WNOHANG) > 0; |
|
|
1566 | } |
|
|
1567 | |
|
|
1568 | sub child { |
1608 | sub child { |
|
|
1609 | eval q{ # poor man's autoloading {} |
|
|
1610 | *_sigchld = sub { |
|
|
1611 | my $pid; |
|
|
1612 | |
|
|
1613 | AnyEvent->_emit_childstatus ($pid, $?) |
|
|
1614 | while ($pid = waitpid -1, $WNOHANG) > 0; |
|
|
1615 | }; |
|
|
1616 | |
|
|
1617 | *child = sub { |
1569 | my (undef, %arg) = @_; |
1618 | my (undef, %arg) = @_; |
1570 | |
1619 | |
1571 | defined (my $pid = $arg{pid} + 0) |
1620 | defined (my $pid = $arg{pid} + 0) |
1572 | or Carp::croak "required option 'pid' is missing"; |
1621 | or Carp::croak "required option 'pid' is missing"; |
1573 | |
1622 | |
1574 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1623 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1575 | |
1624 | |
1576 | # WNOHANG is almost cetrainly 1 everywhere |
1625 | # WNOHANG is almost cetrainly 1 everywhere |
1577 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
1626 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
1578 | ? 1 |
1627 | ? 1 |
1579 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1628 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1580 | |
1629 | |
1581 | unless ($CHLD_W) { |
1630 | unless ($CHLD_W) { |
1582 | $CHLD_W = AE::signal CHLD => \&_sigchld; |
1631 | $CHLD_W = AE::signal CHLD => \&_sigchld; |
1583 | # child could be a zombie already, so make at least one round |
1632 | # child could be a zombie already, so make at least one round |
1584 | &_sigchld; |
1633 | &_sigchld; |
1585 | } |
1634 | } |
1586 | |
1635 | |
1587 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
1636 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
1588 | } |
1637 | }; |
1589 | |
1638 | |
1590 | sub AnyEvent::Base::child::DESTROY { |
1639 | *AnyEvent::Base::child::DESTROY = sub { |
1591 | my ($pid, $cb) = @{$_[0]}; |
1640 | my ($pid, $cb) = @{$_[0]}; |
1592 | |
1641 | |
1593 | delete $PID_CB{$pid}{$cb}; |
1642 | delete $PID_CB{$pid}{$cb}; |
1594 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1643 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1595 | |
1644 | |
1596 | undef $CHLD_W unless keys %PID_CB; |
1645 | undef $CHLD_W unless keys %PID_CB; |
|
|
1646 | }; |
|
|
1647 | }; |
|
|
1648 | die if $@; |
|
|
1649 | |
|
|
1650 | &child |
1597 | } |
1651 | } |
1598 | |
1652 | |
1599 | # idle emulation is done by simply using a timer, regardless |
1653 | # idle emulation is done by simply using a timer, regardless |
1600 | # of whether the process is idle or not, and not letting |
1654 | # of whether the process is idle or not, and not letting |
1601 | # the callback use more than 50% of the time. |
1655 | # the callback use more than 50% of the time. |
1602 | sub idle { |
1656 | sub idle { |
|
|
1657 | eval q{ # poor man's autoloading {} |
|
|
1658 | *idle = sub { |
1603 | my (undef, %arg) = @_; |
1659 | my (undef, %arg) = @_; |
1604 | |
1660 | |
1605 | my ($cb, $w, $rcb) = $arg{cb}; |
1661 | my ($cb, $w, $rcb) = $arg{cb}; |
1606 | |
1662 | |
1607 | $rcb = sub { |
1663 | $rcb = sub { |
1608 | if ($cb) { |
1664 | if ($cb) { |
1609 | $w = _time; |
1665 | $w = _time; |
1610 | &$cb; |
1666 | &$cb; |
1611 | $w = _time - $w; |
1667 | $w = _time - $w; |
1612 | |
1668 | |
1613 | # never use more then 50% of the time for the idle watcher, |
1669 | # never use more then 50% of the time for the idle watcher, |
1614 | # within some limits |
1670 | # within some limits |
1615 | $w = 0.0001 if $w < 0.0001; |
1671 | $w = 0.0001 if $w < 0.0001; |
1616 | $w = 5 if $w > 5; |
1672 | $w = 5 if $w > 5; |
1617 | |
1673 | |
1618 | $w = AE::timer $w, 0, $rcb; |
1674 | $w = AE::timer $w, 0, $rcb; |
1619 | } else { |
1675 | } else { |
1620 | # clean up... |
1676 | # clean up... |
1621 | undef $w; |
1677 | undef $w; |
1622 | undef $rcb; |
1678 | undef $rcb; |
|
|
1679 | } |
|
|
1680 | }; |
|
|
1681 | |
|
|
1682 | $w = AE::timer 0.05, 0, $rcb; |
|
|
1683 | |
|
|
1684 | bless \\$cb, "AnyEvent::Base::idle" |
1623 | } |
1685 | }; |
|
|
1686 | |
|
|
1687 | *AnyEvent::Base::idle::DESTROY = sub { |
|
|
1688 | undef $${$_[0]}; |
|
|
1689 | }; |
1624 | }; |
1690 | }; |
|
|
1691 | die if $@; |
1625 | |
1692 | |
1626 | $w = AE::timer 0.05, 0, $rcb; |
1693 | &idle |
1627 | |
|
|
1628 | bless \\$cb, "AnyEvent::Base::idle" |
|
|
1629 | } |
|
|
1630 | |
|
|
1631 | sub AnyEvent::Base::idle::DESTROY { |
|
|
1632 | undef $${$_[0]}; |
|
|
1633 | } |
1694 | } |
1634 | |
1695 | |
1635 | package AnyEvent::CondVar; |
1696 | package AnyEvent::CondVar; |
1636 | |
1697 | |
1637 | our @ISA = AnyEvent::CondVar::Base::; |
1698 | our @ISA = AnyEvent::CondVar::Base::; |
… | |
… | |
1911 | warn "read: $input\n"; # output what has been read |
1972 | warn "read: $input\n"; # output what has been read |
1912 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
1973 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
1913 | }, |
1974 | }, |
1914 | ); |
1975 | ); |
1915 | |
1976 | |
1916 | my $time_watcher; # can only be used once |
|
|
1917 | |
|
|
1918 | sub new_timer { |
|
|
1919 | $timer = AnyEvent->timer (after => 1, cb => sub { |
1977 | my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub { |
1920 | warn "timeout\n"; # print 'timeout' about every second |
1978 | warn "timeout\n"; # print 'timeout' at most every second |
1921 | &new_timer; # and restart the time |
|
|
1922 | }); |
1979 | }); |
1923 | } |
|
|
1924 | |
|
|
1925 | new_timer; # create first timer |
|
|
1926 | |
1980 | |
1927 | $cv->recv; # wait until user enters /^q/i |
1981 | $cv->recv; # wait until user enters /^q/i |
1928 | |
1982 | |
1929 | =head1 REAL-WORLD EXAMPLE |
1983 | =head1 REAL-WORLD EXAMPLE |
1930 | |
1984 | |
… | |
… | |
2374 | As you can see, the AnyEvent + EV combination even beats the |
2428 | As you can see, the AnyEvent + EV combination even beats the |
2375 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
2429 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
2376 | backend easily beats IO::Lambda and POE. |
2430 | backend easily beats IO::Lambda and POE. |
2377 | |
2431 | |
2378 | And even the 100% non-blocking version written using the high-level (and |
2432 | And even the 100% non-blocking version written using the high-level (and |
2379 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a |
2433 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda |
2380 | large margin, even though it does all of DNS, tcp-connect and socket I/O |
2434 | higher level ("unoptimised") abstractions by a large margin, even though |
2381 | in a non-blocking way. |
2435 | it does all of DNS, tcp-connect and socket I/O in a non-blocking way. |
2382 | |
2436 | |
2383 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
2437 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
2384 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
2438 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
2385 | part of the IO::lambda distribution and were used without any changes. |
2439 | part of the IO::Lambda distribution and were used without any changes. |
2386 | |
2440 | |
2387 | |
2441 | |
2388 | =head1 SIGNALS |
2442 | =head1 SIGNALS |
2389 | |
2443 | |
2390 | AnyEvent currently installs handlers for these signals: |
2444 | AnyEvent currently installs handlers for these signals: |
… | |
… | |
2432 | it's built-in modules) are required to use it. |
2486 | it's built-in modules) are required to use it. |
2433 | |
2487 | |
2434 | That does not mean that AnyEvent won't take advantage of some additional |
2488 | That does not mean that AnyEvent won't take advantage of some additional |
2435 | modules if they are installed. |
2489 | modules if they are installed. |
2436 | |
2490 | |
2437 | This section epxlains which additional modules will be used, and how they |
2491 | This section explains which additional modules will be used, and how they |
2438 | affect AnyEvent's operetion. |
2492 | affect AnyEvent's operation. |
2439 | |
2493 | |
2440 | =over 4 |
2494 | =over 4 |
2441 | |
2495 | |
2442 | =item L<Async::Interrupt> |
2496 | =item L<Async::Interrupt> |
2443 | |
2497 | |
… | |
… | |
2448 | catch the signals) with some delay (default is 10 seconds, look for |
2502 | catch the signals) with some delay (default is 10 seconds, look for |
2449 | C<$AnyEvent::MAX_SIGNAL_LATENCY>). |
2503 | C<$AnyEvent::MAX_SIGNAL_LATENCY>). |
2450 | |
2504 | |
2451 | If this module is available, then it will be used to implement signal |
2505 | If this module is available, then it will be used to implement signal |
2452 | catching, which means that signals will not be delayed, and the event loop |
2506 | catching, which means that signals will not be delayed, and the event loop |
2453 | will not be interrupted regularly, which is more efficient (And good for |
2507 | will not be interrupted regularly, which is more efficient (and good for |
2454 | battery life on laptops). |
2508 | battery life on laptops). |
2455 | |
2509 | |
2456 | This affects not just the pure-perl event loop, but also other event loops |
2510 | This affects not just the pure-perl event loop, but also other event loops |
2457 | that have no signal handling on their own (e.g. Glib, Tk, Qt). |
2511 | that have no signal handling on their own (e.g. Glib, Tk, Qt). |
2458 | |
2512 | |
… | |
… | |
2479 | lot less memory), but otherwise doesn't affect guard operation much. It is |
2533 | lot less memory), but otherwise doesn't affect guard operation much. It is |
2480 | purely used for performance. |
2534 | purely used for performance. |
2481 | |
2535 | |
2482 | =item L<JSON> and L<JSON::XS> |
2536 | =item L<JSON> and L<JSON::XS> |
2483 | |
2537 | |
2484 | This module is required when you want to read or write JSON data via |
2538 | One of these modules is required when you want to read or write JSON data |
2485 | L<AnyEvent::Handle>. It is also written in pure-perl, but can take |
2539 | via L<AnyEvent::Handle>. It is also written in pure-perl, but can take |
2486 | advantage of the ultra-high-speed L<JSON::XS> module when it is installed. |
2540 | advantage of the ultra-high-speed L<JSON::XS> module when it is installed. |
2487 | |
2541 | |
2488 | In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is |
2542 | In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is |
2489 | installed. |
2543 | installed. |
2490 | |
2544 | |
… | |
… | |
2505 | |
2559 | |
2506 | |
2560 | |
2507 | =head1 FORK |
2561 | =head1 FORK |
2508 | |
2562 | |
2509 | Most event libraries are not fork-safe. The ones who are usually are |
2563 | Most event libraries are not fork-safe. The ones who are usually are |
2510 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2564 | because they rely on inefficient but fork-safe C<select> or C<poll> calls |
2511 | calls. Only L<EV> is fully fork-aware. |
2565 | - higher performance APIs such as BSD's kqueue or the dreaded Linux epoll |
|
|
2566 | are usually badly thought-out hacks that are incompatible with fork in |
|
|
2567 | one way or another. Only L<EV> is fully fork-aware and ensures that you |
|
|
2568 | continue event-processing in both parent and child (or both, if you know |
|
|
2569 | what you are doing). |
|
|
2570 | |
|
|
2571 | This means that, in general, you cannot fork and do event processing in |
|
|
2572 | the child if the event library was initialised before the fork (which |
|
|
2573 | usually happens when the first AnyEvent watcher is created, or the library |
|
|
2574 | is loaded). |
2512 | |
2575 | |
2513 | If you have to fork, you must either do so I<before> creating your first |
2576 | If you have to fork, you must either do so I<before> creating your first |
2514 | watcher OR you must not use AnyEvent at all in the child OR you must do |
2577 | watcher OR you must not use AnyEvent at all in the child OR you must do |
2515 | something completely out of the scope of AnyEvent. |
2578 | something completely out of the scope of AnyEvent. |
|
|
2579 | |
|
|
2580 | The problem of doing event processing in the parent I<and> the child |
|
|
2581 | is much more complicated: even for backends that I<are> fork-aware or |
|
|
2582 | fork-safe, their behaviour is not usually what you want: fork clones all |
|
|
2583 | watchers, that means all timers, I/O watchers etc. are active in both |
|
|
2584 | parent and child, which is almost never what you want. USing C<exec> |
|
|
2585 | to start worker children from some kind of manage rprocess is usually |
|
|
2586 | preferred, because it is much easier and cleaner, at the expense of having |
|
|
2587 | to have another binary. |
2516 | |
2588 | |
2517 | |
2589 | |
2518 | =head1 SECURITY CONSIDERATIONS |
2590 | =head1 SECURITY CONSIDERATIONS |
2519 | |
2591 | |
2520 | AnyEvent can be forced to load any event model via |
2592 | AnyEvent can be forced to load any event model via |