1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - provide framework for multiple event loops |
3 | AnyEvent - events independent of event loop implementation |
4 | |
4 | |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported |
6 | event loops. |
6 | event loops. |
7 | |
7 | |
8 | =head1 SYNOPSIS |
8 | =head1 SYNOPSIS |
… | |
… | |
40 | =head1 INTRODUCTION/TUTORIAL |
40 | =head1 INTRODUCTION/TUTORIAL |
41 | |
41 | |
42 | This manpage is mainly a reference manual. If you are interested |
42 | This manpage is mainly a reference manual. If you are interested |
43 | in a tutorial or some gentle introduction, have a look at the |
43 | in a tutorial or some gentle introduction, have a look at the |
44 | L<AnyEvent::Intro> manpage. |
44 | L<AnyEvent::Intro> manpage. |
|
|
45 | |
|
|
46 | =head1 SUPPORT |
|
|
47 | |
|
|
48 | There is a mailinglist for discussing all things AnyEvent, and an IRC |
|
|
49 | channel, too. |
|
|
50 | |
|
|
51 | See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software |
|
|
52 | Respository>, at L<http://anyevent.schmorp.de>, for more info. |
45 | |
53 | |
46 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
54 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
47 | |
55 | |
48 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
56 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
49 | nowadays. So what is different about AnyEvent? |
57 | nowadays. So what is different about AnyEvent? |
… | |
… | |
361 | invocation, and callback invocation will be synchronous. Synchronous means |
369 | invocation, and callback invocation will be synchronous. Synchronous means |
362 | that it might take a while until the signal gets handled by the process, |
370 | that it might take a while until the signal gets handled by the process, |
363 | but it is guaranteed not to interrupt any other callbacks. |
371 | but it is guaranteed not to interrupt any other callbacks. |
364 | |
372 | |
365 | The main advantage of using these watchers is that you can share a signal |
373 | The main advantage of using these watchers is that you can share a signal |
366 | between multiple watchers. |
374 | between multiple watchers, and AnyEvent will ensure that signals will not |
|
|
375 | interrupt your program at bad times. |
367 | |
376 | |
368 | This watcher might use C<%SIG>, so programs overwriting those signals |
377 | This watcher might use C<%SIG> (depending on the event loop used), |
369 | directly will likely not work correctly. |
378 | so programs overwriting those signals directly will likely not work |
|
|
379 | correctly. |
370 | |
380 | |
371 | Example: exit on SIGINT |
381 | Example: exit on SIGINT |
372 | |
382 | |
373 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
383 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
|
|
384 | |
|
|
385 | =head3 Signal Races, Delays and Workarounds |
|
|
386 | |
|
|
387 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
|
|
388 | callbacks to signals in a generic way, which is a pity, as you cannot do |
|
|
389 | race-free signal handling in perl. AnyEvent will try to do it's best, but |
|
|
390 | in some cases, signals will be delayed. The maximum time a signal might |
|
|
391 | be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 |
|
|
392 | seconds). This variable can be changed only before the first signal |
|
|
393 | watcher is created, and should be left alone otherwise. Higher values |
|
|
394 | will cause fewer spurious wake-ups, which is better for power and CPU |
|
|
395 | saving. All these problems can be avoided by installing the optional |
|
|
396 | L<Async::Interrupt> module. This will not work with inherently broken |
|
|
397 | event loops such as L<Event> or L<Event::Lib> (and not with L<POE> |
|
|
398 | currently, as POE does it's own workaround with one-second latency). With |
|
|
399 | those, you just have to suffer the delays. |
374 | |
400 | |
375 | =head2 CHILD PROCESS WATCHERS |
401 | =head2 CHILD PROCESS WATCHERS |
376 | |
402 | |
377 | You can also watch on a child process exit and catch its exit status. |
403 | You can also watch on a child process exit and catch its exit status. |
378 | |
404 | |
… | |
… | |
403 | |
429 | |
404 | This means you cannot create a child watcher as the very first |
430 | This means you cannot create a child watcher as the very first |
405 | thing in an AnyEvent program, you I<have> to create at least one |
431 | thing in an AnyEvent program, you I<have> to create at least one |
406 | watcher before you C<fork> the child (alternatively, you can call |
432 | watcher before you C<fork> the child (alternatively, you can call |
407 | C<AnyEvent::detect>). |
433 | C<AnyEvent::detect>). |
|
|
434 | |
|
|
435 | As most event loops do not support waiting for child events, they will be |
|
|
436 | emulated by AnyEvent in most cases, in which the latency and race problems |
|
|
437 | mentioned in the description of signal watchers apply. |
408 | |
438 | |
409 | Example: fork a process and wait for it |
439 | Example: fork a process and wait for it |
410 | |
440 | |
411 | my $done = AnyEvent->condvar; |
441 | my $done = AnyEvent->condvar; |
412 | |
442 | |
… | |
… | |
463 | |
493 | |
464 | If you are familiar with some event loops you will know that all of them |
494 | If you are familiar with some event loops you will know that all of them |
465 | require you to run some blocking "loop", "run" or similar function that |
495 | require you to run some blocking "loop", "run" or similar function that |
466 | will actively watch for new events and call your callbacks. |
496 | will actively watch for new events and call your callbacks. |
467 | |
497 | |
468 | AnyEvent is different, it expects somebody else to run the event loop and |
498 | AnyEvent is slightly different: it expects somebody else to run the event |
469 | will only block when necessary (usually when told by the user). |
499 | loop and will only block when necessary (usually when told by the user). |
470 | |
500 | |
471 | The instrument to do that is called a "condition variable", so called |
501 | The instrument to do that is called a "condition variable", so called |
472 | because they represent a condition that must become true. |
502 | because they represent a condition that must become true. |
473 | |
503 | |
|
|
504 | Now is probably a good time to look at the examples further below. |
|
|
505 | |
474 | Condition variables can be created by calling the C<< AnyEvent->condvar |
506 | Condition variables can be created by calling the C<< AnyEvent->condvar |
475 | >> method, usually without arguments. The only argument pair allowed is |
507 | >> method, usually without arguments. The only argument pair allowed is |
476 | |
|
|
477 | C<cb>, which specifies a callback to be called when the condition variable |
508 | C<cb>, which specifies a callback to be called when the condition variable |
478 | becomes true, with the condition variable as the first argument (but not |
509 | becomes true, with the condition variable as the first argument (but not |
479 | the results). |
510 | the results). |
480 | |
511 | |
481 | After creation, the condition variable is "false" until it becomes "true" |
512 | After creation, the condition variable is "false" until it becomes "true" |
… | |
… | |
486 | Condition variables are similar to callbacks, except that you can |
517 | Condition variables are similar to callbacks, except that you can |
487 | optionally wait for them. They can also be called merge points - points |
518 | optionally wait for them. They can also be called merge points - points |
488 | in time where multiple outstanding events have been processed. And yet |
519 | in time where multiple outstanding events have been processed. And yet |
489 | another way to call them is transactions - each condition variable can be |
520 | another way to call them is transactions - each condition variable can be |
490 | used to represent a transaction, which finishes at some point and delivers |
521 | used to represent a transaction, which finishes at some point and delivers |
491 | a result. |
522 | a result. And yet some people know them as "futures" - a promise to |
|
|
523 | compute/deliver something that you can wait for. |
492 | |
524 | |
493 | Condition variables are very useful to signal that something has finished, |
525 | Condition variables are very useful to signal that something has finished, |
494 | for example, if you write a module that does asynchronous http requests, |
526 | for example, if you write a module that does asynchronous http requests, |
495 | then a condition variable would be the ideal candidate to signal the |
527 | then a condition variable would be the ideal candidate to signal the |
496 | availability of results. The user can either act when the callback is |
528 | availability of results. The user can either act when the callback is |
… | |
… | |
530 | after => 1, |
562 | after => 1, |
531 | cb => sub { $result_ready->send }, |
563 | cb => sub { $result_ready->send }, |
532 | ); |
564 | ); |
533 | |
565 | |
534 | # this "blocks" (while handling events) till the callback |
566 | # this "blocks" (while handling events) till the callback |
535 | # calls send |
567 | # calls -<send |
536 | $result_ready->recv; |
568 | $result_ready->recv; |
537 | |
569 | |
538 | Example: wait for a timer, but take advantage of the fact that |
570 | Example: wait for a timer, but take advantage of the fact that condition |
539 | condition variables are also code references. |
571 | variables are also callable directly. |
540 | |
572 | |
541 | my $done = AnyEvent->condvar; |
573 | my $done = AnyEvent->condvar; |
542 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
574 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
543 | $done->recv; |
575 | $done->recv; |
544 | |
576 | |
… | |
… | |
550 | |
582 | |
551 | ... |
583 | ... |
552 | |
584 | |
553 | my @info = $couchdb->info->recv; |
585 | my @info = $couchdb->info->recv; |
554 | |
586 | |
555 | And this is how you would just ste a callback to be called whenever the |
587 | And this is how you would just set a callback to be called whenever the |
556 | results are available: |
588 | results are available: |
557 | |
589 | |
558 | $couchdb->info->cb (sub { |
590 | $couchdb->info->cb (sub { |
559 | my @info = $_[0]->recv; |
591 | my @info = $_[0]->recv; |
560 | }); |
592 | }); |
… | |
… | |
578 | immediately from within send. |
610 | immediately from within send. |
579 | |
611 | |
580 | Any arguments passed to the C<send> call will be returned by all |
612 | Any arguments passed to the C<send> call will be returned by all |
581 | future C<< ->recv >> calls. |
613 | future C<< ->recv >> calls. |
582 | |
614 | |
583 | Condition variables are overloaded so one can call them directly |
615 | Condition variables are overloaded so one can call them directly (as if |
584 | (as a code reference). Calling them directly is the same as calling |
616 | they were a code reference). Calling them directly is the same as calling |
585 | C<send>. Note, however, that many C-based event loops do not handle |
617 | C<send>. |
586 | overloading, so as tempting as it may be, passing a condition variable |
|
|
587 | instead of a callback does not work. Both the pure perl and EV loops |
|
|
588 | support overloading, however, as well as all functions that use perl to |
|
|
589 | invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for |
|
|
590 | example). |
|
|
591 | |
618 | |
592 | =item $cv->croak ($error) |
619 | =item $cv->croak ($error) |
593 | |
620 | |
594 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
621 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
595 | C<Carp::croak> with the given error message/object/scalar. |
622 | C<Carp::croak> with the given error message/object/scalar. |
596 | |
623 | |
597 | This can be used to signal any errors to the condition variable |
624 | This can be used to signal any errors to the condition variable |
598 | user/consumer. |
625 | user/consumer. Doing it this way instead of calling C<croak> directly |
|
|
626 | delays the error detetcion, but has the overwhelmign advantage that it |
|
|
627 | diagnoses the error at the place where the result is expected, and not |
|
|
628 | deep in some event clalback without connection to the actual code causing |
|
|
629 | the problem. |
599 | |
630 | |
600 | =item $cv->begin ([group callback]) |
631 | =item $cv->begin ([group callback]) |
601 | |
632 | |
602 | =item $cv->end |
633 | =item $cv->end |
603 | |
634 | |
… | |
… | |
699 | function will call C<croak>. |
730 | function will call C<croak>. |
700 | |
731 | |
701 | In list context, all parameters passed to C<send> will be returned, |
732 | In list context, all parameters passed to C<send> will be returned, |
702 | in scalar context only the first one will be returned. |
733 | in scalar context only the first one will be returned. |
703 | |
734 | |
|
|
735 | Note that doing a blocking wait in a callback is not supported by any |
|
|
736 | event loop, that is, recursive invocation of a blocking C<< ->recv |
|
|
737 | >> is not allowed, and the C<recv> call will C<croak> if such a |
|
|
738 | condition is detected. This condition can be slightly loosened by using |
|
|
739 | L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from |
|
|
740 | any thread that doesn't run the event loop itself. |
|
|
741 | |
704 | Not all event models support a blocking wait - some die in that case |
742 | Not all event models support a blocking wait - some die in that case |
705 | (programs might want to do that to stay interactive), so I<if you are |
743 | (programs might want to do that to stay interactive), so I<if you are |
706 | using this from a module, never require a blocking wait>, but let the |
744 | using this from a module, never require a blocking wait>. Instead, let the |
707 | caller decide whether the call will block or not (for example, by coupling |
745 | caller decide whether the call will block or not (for example, by coupling |
708 | condition variables with some kind of request results and supporting |
746 | condition variables with some kind of request results and supporting |
709 | callbacks so the caller knows that getting the result will not block, |
747 | callbacks so the caller knows that getting the result will not block, |
710 | while still supporting blocking waits if the caller so desires). |
748 | while still supporting blocking waits if the caller so desires). |
711 | |
|
|
712 | Another reason I<never> to C<< ->recv >> in a module is that you cannot |
|
|
713 | sensibly have two C<< ->recv >>'s in parallel, as that would require |
|
|
714 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
|
|
715 | can supply. |
|
|
716 | |
|
|
717 | The L<Coro> module, however, I<can> and I<does> supply coroutines and, in |
|
|
718 | fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe |
|
|
719 | versions and also integrates coroutines into AnyEvent, making blocking |
|
|
720 | C<< ->recv >> calls perfectly safe as long as they are done from another |
|
|
721 | coroutine (one that doesn't run the event loop). |
|
|
722 | |
749 | |
723 | You can ensure that C<< -recv >> never blocks by setting a callback and |
750 | You can ensure that C<< -recv >> never blocks by setting a callback and |
724 | only calling C<< ->recv >> from within that callback (or at a later |
751 | only calling C<< ->recv >> from within that callback (or at a later |
725 | time). This will work even when the event loop does not support blocking |
752 | time). This will work even when the event loop does not support blocking |
726 | waits otherwise. |
753 | waits otherwise. |
… | |
… | |
1028 | |
1055 | |
1029 | =cut |
1056 | =cut |
1030 | |
1057 | |
1031 | package AnyEvent; |
1058 | package AnyEvent; |
1032 | |
1059 | |
|
|
1060 | # basically a tuned-down version of common::sense |
|
|
1061 | sub common_sense { |
1033 | no warnings; |
1062 | # no warnings |
|
|
1063 | ${^WARNING_BITS} ^= ${^WARNING_BITS}; |
1034 | use strict qw(vars subs); |
1064 | # use strict vars subs |
|
|
1065 | $^H |= 0x00000600; |
|
|
1066 | } |
1035 | |
1067 | |
|
|
1068 | BEGIN { AnyEvent::common_sense } |
|
|
1069 | |
1036 | use Carp; |
1070 | use Carp (); |
1037 | |
1071 | |
1038 | our $VERSION = 4.82; |
1072 | our $VERSION = 4.86; |
1039 | our $MODEL; |
1073 | our $MODEL; |
1040 | |
1074 | |
1041 | our $AUTOLOAD; |
1075 | our $AUTOLOAD; |
1042 | our @ISA; |
1076 | our @ISA; |
1043 | |
1077 | |
1044 | our @REGISTRY; |
1078 | our @REGISTRY; |
1045 | |
1079 | |
1046 | our $WIN32; |
1080 | our $WIN32; |
|
|
1081 | |
|
|
1082 | our $VERBOSE; |
1047 | |
1083 | |
1048 | BEGIN { |
1084 | BEGIN { |
1049 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
1085 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
1050 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
1086 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
1051 | |
1087 | |
1052 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1088 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1053 | if ${^TAINT}; |
1089 | if ${^TAINT}; |
1054 | } |
|
|
1055 | |
1090 | |
1056 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1091 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
|
|
1092 | |
|
|
1093 | } |
|
|
1094 | |
|
|
1095 | our $MAX_SIGNAL_LATENCY = 10; |
1057 | |
1096 | |
1058 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1097 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1059 | |
1098 | |
1060 | { |
1099 | { |
1061 | my $idx; |
1100 | my $idx; |
… | |
… | |
1112 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1151 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1113 | } |
1152 | } |
1114 | |
1153 | |
1115 | sub detect() { |
1154 | sub detect() { |
1116 | unless ($MODEL) { |
1155 | unless ($MODEL) { |
1117 | no strict 'refs'; |
|
|
1118 | local $SIG{__DIE__}; |
1156 | local $SIG{__DIE__}; |
1119 | |
1157 | |
1120 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1158 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1121 | my $model = "AnyEvent::Impl::$1"; |
1159 | my $model = "AnyEvent::Impl::$1"; |
1122 | if (eval "require $model") { |
1160 | if (eval "require $model") { |
1123 | $MODEL = $model; |
1161 | $MODEL = $model; |
1124 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $verbose > 1; |
1162 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
1125 | } else { |
1163 | } else { |
1126 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $verbose; |
1164 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
1127 | } |
1165 | } |
1128 | } |
1166 | } |
1129 | |
1167 | |
1130 | # check for already loaded models |
1168 | # check for already loaded models |
1131 | unless ($MODEL) { |
1169 | unless ($MODEL) { |
1132 | for (@REGISTRY, @models) { |
1170 | for (@REGISTRY, @models) { |
1133 | my ($package, $model) = @$_; |
1171 | my ($package, $model) = @$_; |
1134 | if (${"$package\::VERSION"} > 0) { |
1172 | if (${"$package\::VERSION"} > 0) { |
1135 | if (eval "require $model") { |
1173 | if (eval "require $model") { |
1136 | $MODEL = $model; |
1174 | $MODEL = $model; |
1137 | warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; |
1175 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
1138 | last; |
1176 | last; |
1139 | } |
1177 | } |
1140 | } |
1178 | } |
1141 | } |
1179 | } |
1142 | |
1180 | |
… | |
… | |
1147 | my ($package, $model) = @$_; |
1185 | my ($package, $model) = @$_; |
1148 | if (eval "require $package" |
1186 | if (eval "require $package" |
1149 | and ${"$package\::VERSION"} > 0 |
1187 | and ${"$package\::VERSION"} > 0 |
1150 | and eval "require $model") { |
1188 | and eval "require $model") { |
1151 | $MODEL = $model; |
1189 | $MODEL = $model; |
1152 | warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; |
1190 | warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; |
1153 | last; |
1191 | last; |
1154 | } |
1192 | } |
1155 | } |
1193 | } |
1156 | |
1194 | |
1157 | $MODEL |
1195 | $MODEL |
… | |
… | |
1173 | |
1211 | |
1174 | sub AUTOLOAD { |
1212 | sub AUTOLOAD { |
1175 | (my $func = $AUTOLOAD) =~ s/.*://; |
1213 | (my $func = $AUTOLOAD) =~ s/.*://; |
1176 | |
1214 | |
1177 | $method{$func} |
1215 | $method{$func} |
1178 | or croak "$func: not a valid method for AnyEvent objects"; |
1216 | or Carp::croak "$func: not a valid method for AnyEvent objects"; |
1179 | |
1217 | |
1180 | detect unless $MODEL; |
1218 | detect unless $MODEL; |
1181 | |
1219 | |
1182 | my $class = shift; |
1220 | my $class = shift; |
1183 | $class->$func (@_); |
1221 | $class->$func (@_); |
… | |
… | |
1188 | # allow only one watcher per fd, so we dup it to get a different one). |
1226 | # allow only one watcher per fd, so we dup it to get a different one). |
1189 | sub _dupfh($$;$$) { |
1227 | sub _dupfh($$;$$) { |
1190 | my ($poll, $fh, $r, $w) = @_; |
1228 | my ($poll, $fh, $r, $w) = @_; |
1191 | |
1229 | |
1192 | # cygwin requires the fh mode to be matching, unix doesn't |
1230 | # cygwin requires the fh mode to be matching, unix doesn't |
1193 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") : ($w, ">"); |
1231 | my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&"); |
1194 | |
1232 | |
1195 | open my $fh2, "$mode&", $fh |
1233 | open my $fh2, $mode, $fh |
1196 | or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,"; |
1234 | or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,"; |
1197 | |
1235 | |
1198 | # we assume CLOEXEC is already set by perl in all important cases |
1236 | # we assume CLOEXEC is already set by perl in all important cases |
1199 | |
1237 | |
1200 | ($fh2, $rw) |
1238 | ($fh2, $rw) |
… | |
… | |
1202 | |
1240 | |
1203 | package AnyEvent::Base; |
1241 | package AnyEvent::Base; |
1204 | |
1242 | |
1205 | # default implementations for many methods |
1243 | # default implementations for many methods |
1206 | |
1244 | |
1207 | BEGIN { |
1245 | sub _time { |
|
|
1246 | # probe for availability of Time::HiRes |
1208 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1247 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
|
|
1248 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1209 | *_time = \&Time::HiRes::time; |
1249 | *_time = \&Time::HiRes::time; |
1210 | # if (eval "use POSIX (); (POSIX::times())... |
1250 | # if (eval "use POSIX (); (POSIX::times())... |
1211 | } else { |
1251 | } else { |
|
|
1252 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1212 | *_time = sub { time }; # epic fail |
1253 | *_time = sub { time }; # epic fail |
1213 | } |
1254 | } |
|
|
1255 | |
|
|
1256 | &_time |
1214 | } |
1257 | } |
1215 | |
1258 | |
1216 | sub time { _time } |
1259 | sub time { _time } |
1217 | sub now { _time } |
1260 | sub now { _time } |
1218 | sub now_update { } |
1261 | sub now_update { } |
… | |
… | |
1223 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1266 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1224 | } |
1267 | } |
1225 | |
1268 | |
1226 | # default implementation for ->signal |
1269 | # default implementation for ->signal |
1227 | |
1270 | |
|
|
1271 | our $HAVE_ASYNC_INTERRUPT; |
1228 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1272 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
|
|
1273 | our (%SIG_ASY, %SIG_ASY_W); |
|
|
1274 | our ($SIG_COUNT, $SIG_TW); |
1229 | |
1275 | |
1230 | sub _signal_exec { |
1276 | sub _signal_exec { |
|
|
1277 | $HAVE_ASYNC_INTERRUPT |
|
|
1278 | ? $SIGPIPE_R->drain |
1231 | sysread $SIGPIPE_R, my $dummy, 4; |
1279 | : sysread $SIGPIPE_R, my $dummy, 9; |
1232 | |
1280 | |
1233 | while (%SIG_EV) { |
1281 | while (%SIG_EV) { |
1234 | for (keys %SIG_EV) { |
1282 | for (keys %SIG_EV) { |
1235 | delete $SIG_EV{$_}; |
1283 | delete $SIG_EV{$_}; |
1236 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1284 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1237 | } |
1285 | } |
1238 | } |
1286 | } |
1239 | } |
1287 | } |
1240 | |
1288 | |
|
|
1289 | # install a dumym wakeupw atcher to reduce signal catching latency |
|
|
1290 | sub _sig_add() { |
|
|
1291 | unless ($SIG_COUNT++) { |
|
|
1292 | # try to align timer on a full-second boundary, if possible |
|
|
1293 | my $NOW = AnyEvent->now; |
|
|
1294 | |
|
|
1295 | $SIG_TW = AnyEvent->timer ( |
|
|
1296 | after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), |
|
|
1297 | interval => $MAX_SIGNAL_LATENCY, |
|
|
1298 | cb => sub { }, # just for the PERL_ASYNC_CHECK |
|
|
1299 | ); |
|
|
1300 | } |
|
|
1301 | } |
|
|
1302 | |
|
|
1303 | sub _sig_del { |
|
|
1304 | undef $SIG_TW |
|
|
1305 | unless --$SIG_COUNT; |
|
|
1306 | } |
|
|
1307 | |
|
|
1308 | sub _signal { |
|
|
1309 | my (undef, %arg) = @_; |
|
|
1310 | |
|
|
1311 | my $signal = uc $arg{signal} |
|
|
1312 | or Carp::croak "required option 'signal' is missing"; |
|
|
1313 | |
|
|
1314 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1315 | |
|
|
1316 | if ($HAVE_ASYNC_INTERRUPT) { |
|
|
1317 | # async::interrupt |
|
|
1318 | |
|
|
1319 | $SIG_ASY{$signal} ||= do { |
|
|
1320 | my $asy = new Async::Interrupt |
|
|
1321 | cb => sub { undef $SIG_EV{$signal} }, |
|
|
1322 | signal => $signal, |
|
|
1323 | pipe => [$SIGPIPE_R->filenos], |
|
|
1324 | ; |
|
|
1325 | $asy->pipe_autodrain (0); |
|
|
1326 | |
|
|
1327 | $asy |
|
|
1328 | }; |
|
|
1329 | |
|
|
1330 | } else { |
|
|
1331 | # pure perl |
|
|
1332 | |
|
|
1333 | $SIG{$signal} ||= sub { |
|
|
1334 | local $!; |
|
|
1335 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
|
|
1336 | undef $SIG_EV{$signal}; |
|
|
1337 | }; |
|
|
1338 | |
|
|
1339 | # can't do signal processing without introducing races in pure perl, |
|
|
1340 | # so limit the signal latency. |
|
|
1341 | _sig_add; |
|
|
1342 | } |
|
|
1343 | |
|
|
1344 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1345 | } |
|
|
1346 | |
1241 | sub signal { |
1347 | sub signal { |
1242 | my (undef, %arg) = @_; |
1348 | # probe for availability of Async::Interrupt |
|
|
1349 | if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") { |
|
|
1350 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
1243 | |
1351 | |
1244 | unless ($SIGPIPE_R) { |
1352 | $HAVE_ASYNC_INTERRUPT = 1; |
|
|
1353 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
|
|
1354 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); |
|
|
1355 | |
|
|
1356 | } else { |
|
|
1357 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
|
|
1358 | |
1245 | require Fcntl; |
1359 | require Fcntl; |
1246 | |
1360 | |
1247 | if (AnyEvent::WIN32) { |
1361 | if (AnyEvent::WIN32) { |
1248 | require AnyEvent::Util; |
1362 | require AnyEvent::Util; |
1249 | |
1363 | |
… | |
… | |
1264 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
1378 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
1265 | |
1379 | |
1266 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
1380 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
1267 | } |
1381 | } |
1268 | |
1382 | |
1269 | my $signal = uc $arg{signal} |
1383 | *signal = \&_signal; |
1270 | or Carp::croak "required option 'signal' is missing"; |
1384 | &signal |
1271 | |
|
|
1272 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1273 | $SIG{$signal} ||= sub { |
|
|
1274 | local $!; |
|
|
1275 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
|
|
1276 | undef $SIG_EV{$signal}; |
|
|
1277 | }; |
|
|
1278 | |
|
|
1279 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1280 | } |
1385 | } |
1281 | |
1386 | |
1282 | sub AnyEvent::Base::signal::DESTROY { |
1387 | sub AnyEvent::Base::signal::DESTROY { |
1283 | my ($signal, $cb) = @{$_[0]}; |
1388 | my ($signal, $cb) = @{$_[0]}; |
1284 | |
1389 | |
|
|
1390 | _sig_del; |
|
|
1391 | |
1285 | delete $SIG_CB{$signal}{$cb}; |
1392 | delete $SIG_CB{$signal}{$cb}; |
1286 | |
1393 | |
|
|
1394 | $HAVE_ASYNC_INTERRUPT |
|
|
1395 | ? delete $SIG_ASY{$signal} |
1287 | # delete doesn't work with older perls - they then |
1396 | : # delete doesn't work with older perls - they then |
1288 | # print weird messages, or just unconditionally exit |
1397 | # print weird messages, or just unconditionally exit |
1289 | # instead of getting the default action. |
1398 | # instead of getting the default action. |
|
|
1399 | undef $SIG{$signal} |
1290 | undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
1400 | unless keys %{ $SIG_CB{$signal} }; |
1291 | } |
1401 | } |
1292 | |
1402 | |
1293 | # default implementation for ->child |
1403 | # default implementation for ->child |
1294 | |
1404 | |
1295 | our %PID_CB; |
1405 | our %PID_CB; |
… | |
… | |
1297 | our $CHLD_DELAY_W; |
1407 | our $CHLD_DELAY_W; |
1298 | our $WNOHANG; |
1408 | our $WNOHANG; |
1299 | |
1409 | |
1300 | sub _sigchld { |
1410 | sub _sigchld { |
1301 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1411 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
|
|
1412 | $_->($pid, $?) |
1302 | $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), |
1413 | for values %{ $PID_CB{$pid} || {} }, |
1303 | (values %{ $PID_CB{0} || {} }); |
1414 | values %{ $PID_CB{0} || {} }; |
1304 | } |
1415 | } |
1305 | } |
1416 | } |
1306 | |
1417 | |
1307 | sub child { |
1418 | sub child { |
1308 | my (undef, %arg) = @_; |
1419 | my (undef, %arg) = @_; |
… | |
… | |
1310 | defined (my $pid = $arg{pid} + 0) |
1421 | defined (my $pid = $arg{pid} + 0) |
1311 | or Carp::croak "required option 'pid' is missing"; |
1422 | or Carp::croak "required option 'pid' is missing"; |
1312 | |
1423 | |
1313 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1424 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1314 | |
1425 | |
|
|
1426 | # WNOHANG is almost cetrainly 1 everywhere |
|
|
1427 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
|
|
1428 | ? 1 |
1315 | $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1429 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1316 | |
1430 | |
1317 | unless ($CHLD_W) { |
1431 | unless ($CHLD_W) { |
1318 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1432 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1319 | # child could be a zombie already, so make at least one round |
1433 | # child could be a zombie already, so make at least one round |
1320 | &_sigchld; |
1434 | &_sigchld; |
… | |
… | |
1372 | |
1486 | |
1373 | our @ISA = AnyEvent::CondVar::Base::; |
1487 | our @ISA = AnyEvent::CondVar::Base::; |
1374 | |
1488 | |
1375 | package AnyEvent::CondVar::Base; |
1489 | package AnyEvent::CondVar::Base; |
1376 | |
1490 | |
1377 | use overload |
1491 | #use overload |
1378 | '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
1492 | # '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
1379 | fallback => 1; |
1493 | # fallback => 1; |
|
|
1494 | |
|
|
1495 | # save 300+ kilobytes by dirtily hardcoding overloading |
|
|
1496 | ${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching. |
|
|
1497 | *{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod." |
|
|
1498 | *{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{} |
|
|
1499 | ${'AnyEvent::CondVar::Base::()'} = 1; # fallback |
|
|
1500 | |
|
|
1501 | our $WAITING; |
1380 | |
1502 | |
1381 | sub _send { |
1503 | sub _send { |
1382 | # nop |
1504 | # nop |
1383 | } |
1505 | } |
1384 | |
1506 | |
… | |
… | |
1397 | sub ready { |
1519 | sub ready { |
1398 | $_[0]{_ae_sent} |
1520 | $_[0]{_ae_sent} |
1399 | } |
1521 | } |
1400 | |
1522 | |
1401 | sub _wait { |
1523 | sub _wait { |
|
|
1524 | $WAITING |
|
|
1525 | and !$_[0]{_ae_sent} |
|
|
1526 | and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected"; |
|
|
1527 | |
|
|
1528 | local $WAITING = 1; |
1402 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
1529 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
1403 | } |
1530 | } |
1404 | |
1531 | |
1405 | sub recv { |
1532 | sub recv { |
1406 | $_[0]->_wait; |
1533 | $_[0]->_wait; |
… | |
… | |
1468 | C<PERL_ANYEVENT_MODEL>. |
1595 | C<PERL_ANYEVENT_MODEL>. |
1469 | |
1596 | |
1470 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
1597 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
1471 | model it chooses. |
1598 | model it chooses. |
1472 | |
1599 | |
|
|
1600 | When set to C<8> or higher, then AnyEvent will report extra information on |
|
|
1601 | which optional modules it loads and how it implements certain features. |
|
|
1602 | |
1473 | =item C<PERL_ANYEVENT_STRICT> |
1603 | =item C<PERL_ANYEVENT_STRICT> |
1474 | |
1604 | |
1475 | AnyEvent does not do much argument checking by default, as thorough |
1605 | AnyEvent does not do much argument checking by default, as thorough |
1476 | argument checking is very costly. Setting this variable to a true value |
1606 | argument checking is very costly. Setting this variable to a true value |
1477 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
1607 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
1478 | check the arguments passed to most method calls. If it finds any problems, |
1608 | check the arguments passed to most method calls. If it finds any problems, |
1479 | it will croak. |
1609 | it will croak. |
1480 | |
1610 | |
1481 | In other words, enables "strict" mode. |
1611 | In other words, enables "strict" mode. |
1482 | |
1612 | |
1483 | Unlike C<use strict>, it is definitely recommended to keep it off in |
1613 | Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense> |
1484 | production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while |
1614 | >>, it is definitely recommended to keep it off in production. Keeping |
1485 | developing programs can be very useful, however. |
1615 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
|
|
1616 | can be very useful, however. |
1486 | |
1617 | |
1487 | =item C<PERL_ANYEVENT_MODEL> |
1618 | =item C<PERL_ANYEVENT_MODEL> |
1488 | |
1619 | |
1489 | This can be used to specify the event model to be used by AnyEvent, before |
1620 | This can be used to specify the event model to be used by AnyEvent, before |
1490 | auto detection and -probing kicks in. It must be a string consisting |
1621 | auto detection and -probing kicks in. It must be a string consisting |
… | |
… | |
1552 | |
1683 | |
1553 | When neither C<ca_file> nor C<ca_path> was specified during |
1684 | When neither C<ca_file> nor C<ca_path> was specified during |
1554 | L<AnyEvent::TLS> context creation, and either of these environment |
1685 | L<AnyEvent::TLS> context creation, and either of these environment |
1555 | variables exist, they will be used to specify CA certificate locations |
1686 | variables exist, they will be used to specify CA certificate locations |
1556 | instead of a system-dependent default. |
1687 | instead of a system-dependent default. |
|
|
1688 | |
|
|
1689 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
|
|
1690 | |
|
|
1691 | When these are set to C<1>, then the respective modules are not |
|
|
1692 | loaded. Mostly good for testing AnyEvent itself. |
1557 | |
1693 | |
1558 | =back |
1694 | =back |
1559 | |
1695 | |
1560 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1696 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1561 | |
1697 | |
… | |
… | |
2129 | if $SIG{CHLD} eq 'IGNORE'; |
2265 | if $SIG{CHLD} eq 'IGNORE'; |
2130 | |
2266 | |
2131 | $SIG{PIPE} = sub { } |
2267 | $SIG{PIPE} = sub { } |
2132 | unless defined $SIG{PIPE}; |
2268 | unless defined $SIG{PIPE}; |
2133 | |
2269 | |
|
|
2270 | =head1 RECOMMENDED/OPTIONAL MODULES |
|
|
2271 | |
|
|
2272 | One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and |
|
|
2273 | it's built-in modules) are required to use it. |
|
|
2274 | |
|
|
2275 | That does not mean that AnyEvent won't take advantage of some additional |
|
|
2276 | modules if they are installed. |
|
|
2277 | |
|
|
2278 | This section epxlains which additional modules will be used, and how they |
|
|
2279 | affect AnyEvent's operetion. |
|
|
2280 | |
|
|
2281 | =over 4 |
|
|
2282 | |
|
|
2283 | =item L<Async::Interrupt> |
|
|
2284 | |
|
|
2285 | This slightly arcane module is used to implement fast signal handling: To |
|
|
2286 | my knowledge, there is no way to do completely race-free and quick |
|
|
2287 | signal handling in pure perl. To ensure that signals still get |
|
|
2288 | delivered, AnyEvent will start an interval timer to wake up perl (and |
|
|
2289 | catch the signals) with some delay (default is 10 seconds, look for |
|
|
2290 | C<$AnyEvent::MAX_SIGNAL_LATENCY>). |
|
|
2291 | |
|
|
2292 | If this module is available, then it will be used to implement signal |
|
|
2293 | catching, which means that signals will not be delayed, and the event loop |
|
|
2294 | will not be interrupted regularly, which is more efficient (And good for |
|
|
2295 | battery life on laptops). |
|
|
2296 | |
|
|
2297 | This affects not just the pure-perl event loop, but also other event loops |
|
|
2298 | that have no signal handling on their own (e.g. Glib, Tk, Qt). |
|
|
2299 | |
|
|
2300 | Some event loops (POE, Event, Event::Lib) offer signal watchers natively, |
|
|
2301 | and either employ their own workarounds (POE) or use AnyEvent's workaround |
|
|
2302 | (using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt> |
|
|
2303 | does nothing for those backends. |
|
|
2304 | |
|
|
2305 | =item L<EV> |
|
|
2306 | |
|
|
2307 | This module isn't really "optional", as it is simply one of the backend |
|
|
2308 | event loops that AnyEvent can use. However, it is simply the best event |
|
|
2309 | loop available in terms of features, speed and stability: It supports |
|
|
2310 | the AnyEvent API optimally, implements all the watcher types in XS, does |
|
|
2311 | automatic timer adjustments even when no monotonic clock is available, |
|
|
2312 | can take avdantage of advanced kernel interfaces such as C<epoll> and |
|
|
2313 | C<kqueue>, and is the fastest backend I<by far>. You can even embed |
|
|
2314 | L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). |
|
|
2315 | |
|
|
2316 | =item L<Guard> |
|
|
2317 | |
|
|
2318 | The guard module, when used, will be used to implement |
|
|
2319 | C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a |
|
|
2320 | lot less memory), but otherwise doesn't affect guard operation much. It is |
|
|
2321 | purely used for performance. |
|
|
2322 | |
|
|
2323 | =item L<JSON> and L<JSON::XS> |
|
|
2324 | |
|
|
2325 | This module is required when you want to read or write JSON data via |
|
|
2326 | L<AnyEvent::Handle>. It is also written in pure-perl, but can take |
|
|
2327 | advantage of the ultra-high-speed L<JSON::XS> module when it is installed. |
|
|
2328 | |
|
|
2329 | In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is |
|
|
2330 | installed. |
|
|
2331 | |
|
|
2332 | =item L<Net::SSLeay> |
|
|
2333 | |
|
|
2334 | Implementing TLS/SSL in Perl is certainly interesting, but not very |
|
|
2335 | worthwhile: If this module is installed, then L<AnyEvent::Handle> (with |
|
|
2336 | the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. |
|
|
2337 | |
|
|
2338 | =item L<Time::HiRes> |
|
|
2339 | |
|
|
2340 | This module is part of perl since release 5.008. It will be used when the |
|
|
2341 | chosen event library does not come with a timing source on it's own. The |
|
|
2342 | pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to |
|
|
2343 | try to use a monotonic clock for timing stability. |
|
|
2344 | |
|
|
2345 | =back |
|
|
2346 | |
|
|
2347 | |
2134 | =head1 FORK |
2348 | =head1 FORK |
2135 | |
2349 | |
2136 | Most event libraries are not fork-safe. The ones who are usually are |
2350 | Most event libraries are not fork-safe. The ones who are usually are |
2137 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2351 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2138 | calls. Only L<EV> is fully fork-aware. |
2352 | calls. Only L<EV> is fully fork-aware. |
2139 | |
2353 | |
2140 | If you have to fork, you must either do so I<before> creating your first |
2354 | If you have to fork, you must either do so I<before> creating your first |
2141 | watcher OR you must not use AnyEvent at all in the child. |
2355 | watcher OR you must not use AnyEvent at all in the child OR you must do |
|
|
2356 | something completely out of the scope of AnyEvent. |
2142 | |
2357 | |
2143 | |
2358 | |
2144 | =head1 SECURITY CONSIDERATIONS |
2359 | =head1 SECURITY CONSIDERATIONS |
2145 | |
2360 | |
2146 | AnyEvent can be forced to load any event model via |
2361 | AnyEvent can be forced to load any event model via |