1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - provide framework for multiple event loops |
3 | AnyEvent - provide framework for multiple event loops |
4 | |
4 | |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported |
|
|
6 | event loops. |
6 | |
7 | |
7 | =head1 SYNOPSIS |
8 | =head1 SYNOPSIS |
8 | |
9 | |
9 | use AnyEvent; |
10 | use AnyEvent; |
10 | |
11 | |
|
|
12 | # file descriptor readable |
11 | my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { ... }); |
13 | my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); |
12 | |
14 | |
|
|
15 | # one-shot or repeating timers |
13 | my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); |
16 | my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); |
14 | my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... |
17 | my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... |
15 | |
18 | |
16 | print AnyEvent->now; # prints current event loop time |
19 | print AnyEvent->now; # prints current event loop time |
17 | print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. |
20 | print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. |
18 | |
21 | |
|
|
22 | # POSIX signal |
19 | my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... }); |
23 | my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... }); |
20 | |
24 | |
|
|
25 | # child process exit |
21 | my $w = AnyEvent->child (pid => $pid, cb => sub { |
26 | my $w = AnyEvent->child (pid => $pid, cb => sub { |
22 | my ($pid, $status) = @_; |
27 | my ($pid, $status) = @_; |
23 | ... |
28 | ... |
24 | }); |
29 | }); |
|
|
30 | |
|
|
31 | # called when event loop idle (if applicable) |
|
|
32 | my $w = AnyEvent->idle (cb => sub { ... }); |
25 | |
33 | |
26 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
34 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
27 | $w->send; # wake up current and all future recv's |
35 | $w->send; # wake up current and all future recv's |
28 | $w->recv; # enters "main loop" till $condvar gets ->send |
36 | $w->recv; # enters "main loop" till $condvar gets ->send |
29 | # use a condvar in callback mode: |
37 | # use a condvar in callback mode: |
… | |
… | |
320 | In either case, if you care (and in most cases, you don't), then you |
328 | In either case, if you care (and in most cases, you don't), then you |
321 | can get whatever behaviour you want with any event loop, by taking the |
329 | can get whatever behaviour you want with any event loop, by taking the |
322 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
330 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
323 | account. |
331 | account. |
324 | |
332 | |
|
|
333 | =item AnyEvent->now_update |
|
|
334 | |
|
|
335 | Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache |
|
|
336 | the current time for each loop iteration (see the discussion of L<< |
|
|
337 | AnyEvent->now >>, above). |
|
|
338 | |
|
|
339 | When a callback runs for a long time (or when the process sleeps), then |
|
|
340 | this "current" time will differ substantially from the real time, which |
|
|
341 | might affect timers and time-outs. |
|
|
342 | |
|
|
343 | When this is the case, you can call this method, which will update the |
|
|
344 | event loop's idea of "current time". |
|
|
345 | |
|
|
346 | Note that updating the time I<might> cause some events to be handled. |
|
|
347 | |
325 | =back |
348 | =back |
326 | |
349 | |
327 | =head2 SIGNAL WATCHERS |
350 | =head2 SIGNAL WATCHERS |
328 | |
351 | |
329 | You can watch for signals using a signal watcher, C<signal> is the signal |
352 | You can watch for signals using a signal watcher, C<signal> is the signal |
… | |
… | |
369 | |
392 | |
370 | There is a slight catch to child watchers, however: you usually start them |
393 | There is a slight catch to child watchers, however: you usually start them |
371 | I<after> the child process was created, and this means the process could |
394 | I<after> the child process was created, and this means the process could |
372 | have exited already (and no SIGCHLD will be sent anymore). |
395 | have exited already (and no SIGCHLD will be sent anymore). |
373 | |
396 | |
374 | Not all event models handle this correctly (POE doesn't), but even for |
397 | Not all event models handle this correctly (neither POE nor IO::Async do, |
|
|
398 | see their AnyEvent::Impl manpages for details), but even for event models |
375 | event models that I<do> handle this correctly, they usually need to be |
399 | that I<do> handle this correctly, they usually need to be loaded before |
376 | loaded before the process exits (i.e. before you fork in the first place). |
400 | the process exits (i.e. before you fork in the first place). AnyEvent's |
|
|
401 | pure perl event loop handles all cases correctly regardless of when you |
|
|
402 | start the watcher. |
377 | |
403 | |
378 | This means you cannot create a child watcher as the very first thing in an |
404 | This means you cannot create a child watcher as the very first |
379 | AnyEvent program, you I<have> to create at least one watcher before you |
405 | thing in an AnyEvent program, you I<have> to create at least one |
380 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
406 | watcher before you C<fork> the child (alternatively, you can call |
|
|
407 | C<AnyEvent::detect>). |
381 | |
408 | |
382 | Example: fork a process and wait for it |
409 | Example: fork a process and wait for it |
383 | |
410 | |
384 | my $done = AnyEvent->condvar; |
411 | my $done = AnyEvent->condvar; |
385 | |
412 | |
… | |
… | |
395 | ); |
422 | ); |
396 | |
423 | |
397 | # do something else, then wait for process exit |
424 | # do something else, then wait for process exit |
398 | $done->recv; |
425 | $done->recv; |
399 | |
426 | |
|
|
427 | =head2 IDLE WATCHERS |
|
|
428 | |
|
|
429 | Sometimes there is a need to do something, but it is not so important |
|
|
430 | to do it instantly, but only when there is nothing better to do. This |
|
|
431 | "nothing better to do" is usually defined to be "no other events need |
|
|
432 | attention by the event loop". |
|
|
433 | |
|
|
434 | Idle watchers ideally get invoked when the event loop has nothing |
|
|
435 | better to do, just before it would block the process to wait for new |
|
|
436 | events. Instead of blocking, the idle watcher is invoked. |
|
|
437 | |
|
|
438 | Most event loops unfortunately do not really support idle watchers (only |
|
|
439 | EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent |
|
|
440 | will simply call the callback "from time to time". |
|
|
441 | |
|
|
442 | Example: read lines from STDIN, but only process them when the |
|
|
443 | program is otherwise idle: |
|
|
444 | |
|
|
445 | my @lines; # read data |
|
|
446 | my $idle_w; |
|
|
447 | my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
|
|
448 | push @lines, scalar <STDIN>; |
|
|
449 | |
|
|
450 | # start an idle watcher, if not already done |
|
|
451 | $idle_w ||= AnyEvent->idle (cb => sub { |
|
|
452 | # handle only one line, when there are lines left |
|
|
453 | if (my $line = shift @lines) { |
|
|
454 | print "handled when idle: $line"; |
|
|
455 | } else { |
|
|
456 | # otherwise disable the idle watcher again |
|
|
457 | undef $idle_w; |
|
|
458 | } |
|
|
459 | }); |
|
|
460 | }); |
|
|
461 | |
400 | =head2 CONDITION VARIABLES |
462 | =head2 CONDITION VARIABLES |
401 | |
463 | |
402 | If you are familiar with some event loops you will know that all of them |
464 | If you are familiar with some event loops you will know that all of them |
403 | require you to run some blocking "loop", "run" or similar function that |
465 | require you to run some blocking "loop", "run" or similar function that |
404 | will actively watch for new events and call your callbacks. |
466 | will actively watch for new events and call your callbacks. |
… | |
… | |
672 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
734 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
673 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
735 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
674 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
736 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
675 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
737 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
676 | |
738 | |
|
|
739 | # warning, support for IO::Async is only partial, as it is too broken |
|
|
740 | # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async. |
|
|
741 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs). |
|
|
742 | |
677 | There is no support for WxWidgets, as WxWidgets has no support for |
743 | There is no support for WxWidgets, as WxWidgets has no support for |
678 | watching file handles. However, you can use WxWidgets through the |
744 | watching file handles. However, you can use WxWidgets through the |
679 | POE Adaptor, as POE has a Wx backend that simply polls 20 times per |
745 | POE Adaptor, as POE has a Wx backend that simply polls 20 times per |
680 | second, which was considered to be too horrible to even consider for |
746 | second, which was considered to be too horrible to even consider for |
681 | AnyEvent. Likewise, other POE backends can be used by AnyEvent by using |
747 | AnyEvent. Likewise, other POE backends can be used by AnyEvent by using |
… | |
… | |
873 | no warnings; |
939 | no warnings; |
874 | use strict qw(vars subs); |
940 | use strict qw(vars subs); |
875 | |
941 | |
876 | use Carp; |
942 | use Carp; |
877 | |
943 | |
878 | our $VERSION = 4.35; |
944 | our $VERSION = 4.412; |
879 | our $MODEL; |
945 | our $MODEL; |
880 | |
946 | |
881 | our $AUTOLOAD; |
947 | our $AUTOLOAD; |
882 | our @ISA; |
948 | our @ISA; |
883 | |
949 | |
884 | our @REGISTRY; |
950 | our @REGISTRY; |
885 | |
951 | |
886 | our $WIN32; |
952 | our $WIN32; |
887 | |
953 | |
888 | BEGIN { |
954 | BEGIN { |
889 | my $win32 = ! ! ($^O =~ /mswin32/i); |
955 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
890 | eval "sub WIN32(){ $win32 }"; |
956 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
|
|
957 | |
|
|
958 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
|
|
959 | if ${^TAINT}; |
891 | } |
960 | } |
892 | |
961 | |
893 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
962 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
894 | |
963 | |
895 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
964 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
… | |
… | |
913 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
982 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
914 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
983 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
915 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
984 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
916 | [Wx:: => AnyEvent::Impl::POE::], |
985 | [Wx:: => AnyEvent::Impl::POE::], |
917 | [Prima:: => AnyEvent::Impl::POE::], |
986 | [Prima:: => AnyEvent::Impl::POE::], |
|
|
987 | # IO::Async is just too broken - we would need workaorunds for its |
|
|
988 | # byzantine signal and broken child handling, among others. |
|
|
989 | # IO::Async is rather hard to detect, as it doesn't have any |
|
|
990 | # obvious default class. |
|
|
991 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
992 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
993 | # [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
918 | ); |
994 | ); |
919 | |
995 | |
920 | our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); |
996 | our %method = map +($_ => 1), |
|
|
997 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
921 | |
998 | |
922 | our @post_detect; |
999 | our @post_detect; |
923 | |
1000 | |
924 | sub post_detect(&) { |
1001 | sub post_detect(&) { |
925 | my ($cb) = @_; |
1002 | my ($cb) = @_; |
… | |
… | |
930 | 1 |
1007 | 1 |
931 | } else { |
1008 | } else { |
932 | push @post_detect, $cb; |
1009 | push @post_detect, $cb; |
933 | |
1010 | |
934 | defined wantarray |
1011 | defined wantarray |
935 | ? bless \$cb, "AnyEvent::Util::PostDetect" |
1012 | ? bless \$cb, "AnyEvent::Util::postdetect" |
936 | : () |
1013 | : () |
937 | } |
1014 | } |
938 | } |
1015 | } |
939 | |
1016 | |
940 | sub AnyEvent::Util::PostDetect::DESTROY { |
1017 | sub AnyEvent::Util::postdetect::DESTROY { |
941 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1018 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
942 | } |
1019 | } |
943 | |
1020 | |
944 | sub detect() { |
1021 | sub detect() { |
945 | unless ($MODEL) { |
1022 | unless ($MODEL) { |
… | |
… | |
982 | last; |
1059 | last; |
983 | } |
1060 | } |
984 | } |
1061 | } |
985 | |
1062 | |
986 | $MODEL |
1063 | $MODEL |
987 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; |
1064 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
988 | } |
1065 | } |
989 | } |
1066 | } |
990 | |
1067 | |
991 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1068 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
992 | |
1069 | |
… | |
… | |
1013 | } |
1090 | } |
1014 | |
1091 | |
1015 | # utility function to dup a filehandle. this is used by many backends |
1092 | # utility function to dup a filehandle. this is used by many backends |
1016 | # to support binding more than one watcher per filehandle (they usually |
1093 | # to support binding more than one watcher per filehandle (they usually |
1017 | # allow only one watcher per fd, so we dup it to get a different one). |
1094 | # allow only one watcher per fd, so we dup it to get a different one). |
1018 | sub _dupfh($$$$) { |
1095 | sub _dupfh($$;$$) { |
1019 | my ($poll, $fh, $r, $w) = @_; |
1096 | my ($poll, $fh, $r, $w) = @_; |
1020 | |
1097 | |
1021 | # cygwin requires the fh mode to be matching, unix doesn't |
1098 | # cygwin requires the fh mode to be matching, unix doesn't |
1022 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
1099 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
1023 | : $poll eq "w" ? ($w, ">") |
1100 | : $poll eq "w" ? ($w, ">") |
1024 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
1101 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
1025 | |
1102 | |
1026 | open my $fh2, "$mode&" . fileno $fh |
1103 | open my $fh2, "$mode&" . fileno $fh |
1027 | or die "cannot dup() filehandle: $!"; |
1104 | or die "cannot dup() filehandle: $!,"; |
1028 | |
1105 | |
1029 | # we assume CLOEXEC is already set by perl in all important cases |
1106 | # we assume CLOEXEC is already set by perl in all important cases |
1030 | |
1107 | |
1031 | ($fh2, $rw) |
1108 | ($fh2, $rw) |
1032 | } |
1109 | } |
1033 | |
1110 | |
1034 | package AnyEvent::Base; |
1111 | package AnyEvent::Base; |
1035 | |
1112 | |
1036 | # default implementation for now and time |
1113 | # default implementations for many methods |
1037 | |
1114 | |
1038 | BEGIN { |
1115 | BEGIN { |
1039 | if (eval "use Time::HiRes (); time (); 1") { |
1116 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1040 | *_time = \&Time::HiRes::time; |
1117 | *_time = \&Time::HiRes::time; |
1041 | # if (eval "use POSIX (); (POSIX::times())... |
1118 | # if (eval "use POSIX (); (POSIX::times())... |
1042 | } else { |
1119 | } else { |
1043 | *_time = sub { time }; # epic fail |
1120 | *_time = sub { time }; # epic fail |
1044 | } |
1121 | } |
1045 | } |
1122 | } |
1046 | |
1123 | |
1047 | sub time { _time } |
1124 | sub time { _time } |
1048 | sub now { _time } |
1125 | sub now { _time } |
|
|
1126 | sub now_update { } |
1049 | |
1127 | |
1050 | # default implementation for ->condvar |
1128 | # default implementation for ->condvar |
1051 | |
1129 | |
1052 | sub condvar { |
1130 | sub condvar { |
1053 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
1131 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1054 | } |
1132 | } |
1055 | |
1133 | |
1056 | # default implementation for ->signal |
1134 | # default implementation for ->signal |
1057 | |
1135 | |
1058 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1136 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
… | |
… | |
1082 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
1160 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
1083 | } else { |
1161 | } else { |
1084 | pipe $SIGPIPE_R, $SIGPIPE_W; |
1162 | pipe $SIGPIPE_R, $SIGPIPE_W; |
1085 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
1163 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
1086 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
1164 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1165 | |
|
|
1166 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1167 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1168 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
1087 | } |
1169 | } |
1088 | |
1170 | |
1089 | $SIGPIPE_R |
1171 | $SIGPIPE_R |
1090 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
1172 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
1091 | |
|
|
1092 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1093 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1094 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1095 | |
1173 | |
1096 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
1174 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
1097 | } |
1175 | } |
1098 | |
1176 | |
1099 | my $signal = uc $arg{signal} |
1177 | my $signal = uc $arg{signal} |
… | |
… | |
1104 | local $!; |
1182 | local $!; |
1105 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1183 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1106 | undef $SIG_EV{$signal}; |
1184 | undef $SIG_EV{$signal}; |
1107 | }; |
1185 | }; |
1108 | |
1186 | |
1109 | bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" |
1187 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
1110 | } |
1188 | } |
1111 | |
1189 | |
1112 | sub AnyEvent::Base::Signal::DESTROY { |
1190 | sub AnyEvent::Base::signal::DESTROY { |
1113 | my ($signal, $cb) = @{$_[0]}; |
1191 | my ($signal, $cb) = @{$_[0]}; |
1114 | |
1192 | |
1115 | delete $SIG_CB{$signal}{$cb}; |
1193 | delete $SIG_CB{$signal}{$cb}; |
1116 | |
1194 | |
|
|
1195 | # delete doesn't work with older perls - they then |
|
|
1196 | # print weird messages, or just unconditionally exit |
|
|
1197 | # instead of getting the default action. |
1117 | delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
1198 | undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
1118 | } |
1199 | } |
1119 | |
1200 | |
1120 | # default implementation for ->child |
1201 | # default implementation for ->child |
1121 | |
1202 | |
1122 | our %PID_CB; |
1203 | our %PID_CB; |
1123 | our $CHLD_W; |
1204 | our $CHLD_W; |
1124 | our $CHLD_DELAY_W; |
1205 | our $CHLD_DELAY_W; |
1125 | our $PID_IDLE; |
|
|
1126 | our $WNOHANG; |
1206 | our $WNOHANG; |
1127 | |
1207 | |
1128 | sub _child_wait { |
1208 | sub _sigchld { |
1129 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1209 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1130 | $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), |
1210 | $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), |
1131 | (values %{ $PID_CB{0} || {} }); |
1211 | (values %{ $PID_CB{0} || {} }); |
1132 | } |
1212 | } |
1133 | |
|
|
1134 | undef $PID_IDLE; |
|
|
1135 | } |
|
|
1136 | |
|
|
1137 | sub _sigchld { |
|
|
1138 | # make sure we deliver these changes "synchronous" with the event loop. |
|
|
1139 | $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub { |
|
|
1140 | undef $CHLD_DELAY_W; |
|
|
1141 | &_child_wait; |
|
|
1142 | }); |
|
|
1143 | } |
1213 | } |
1144 | |
1214 | |
1145 | sub child { |
1215 | sub child { |
1146 | my (undef, %arg) = @_; |
1216 | my (undef, %arg) = @_; |
1147 | |
1217 | |
1148 | defined (my $pid = $arg{pid} + 0) |
1218 | defined (my $pid = $arg{pid} + 0) |
1149 | or Carp::croak "required option 'pid' is missing"; |
1219 | or Carp::croak "required option 'pid' is missing"; |
1150 | |
1220 | |
1151 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1221 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1152 | |
1222 | |
1153 | unless ($WNOHANG) { |
|
|
1154 | $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1223 | $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1155 | } |
|
|
1156 | |
1224 | |
1157 | unless ($CHLD_W) { |
1225 | unless ($CHLD_W) { |
1158 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1226 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1159 | # child could be a zombie already, so make at least one round |
1227 | # child could be a zombie already, so make at least one round |
1160 | &_sigchld; |
1228 | &_sigchld; |
1161 | } |
1229 | } |
1162 | |
1230 | |
1163 | bless [$pid, $arg{cb}], "AnyEvent::Base::Child" |
1231 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
1164 | } |
1232 | } |
1165 | |
1233 | |
1166 | sub AnyEvent::Base::Child::DESTROY { |
1234 | sub AnyEvent::Base::child::DESTROY { |
1167 | my ($pid, $cb) = @{$_[0]}; |
1235 | my ($pid, $cb) = @{$_[0]}; |
1168 | |
1236 | |
1169 | delete $PID_CB{$pid}{$cb}; |
1237 | delete $PID_CB{$pid}{$cb}; |
1170 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1238 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1171 | |
1239 | |
1172 | undef $CHLD_W unless keys %PID_CB; |
1240 | undef $CHLD_W unless keys %PID_CB; |
|
|
1241 | } |
|
|
1242 | |
|
|
1243 | # idle emulation is done by simply using a timer, regardless |
|
|
1244 | # of whether the process is idle or not, and not letting |
|
|
1245 | # the callback use more than 50% of the time. |
|
|
1246 | sub idle { |
|
|
1247 | my (undef, %arg) = @_; |
|
|
1248 | |
|
|
1249 | my ($cb, $w, $rcb) = $arg{cb}; |
|
|
1250 | |
|
|
1251 | $rcb = sub { |
|
|
1252 | if ($cb) { |
|
|
1253 | $w = _time; |
|
|
1254 | &$cb; |
|
|
1255 | $w = _time - $w; |
|
|
1256 | |
|
|
1257 | # never use more then 50% of the time for the idle watcher, |
|
|
1258 | # within some limits |
|
|
1259 | $w = 0.0001 if $w < 0.0001; |
|
|
1260 | $w = 5 if $w > 5; |
|
|
1261 | |
|
|
1262 | $w = AnyEvent->timer (after => $w, cb => $rcb); |
|
|
1263 | } else { |
|
|
1264 | # clean up... |
|
|
1265 | undef $w; |
|
|
1266 | undef $rcb; |
|
|
1267 | } |
|
|
1268 | }; |
|
|
1269 | |
|
|
1270 | $w = AnyEvent->timer (after => 0.05, cb => $rcb); |
|
|
1271 | |
|
|
1272 | bless \\$cb, "AnyEvent::Base::idle" |
|
|
1273 | } |
|
|
1274 | |
|
|
1275 | sub AnyEvent::Base::idle::DESTROY { |
|
|
1276 | undef $${$_[0]}; |
1173 | } |
1277 | } |
1174 | |
1278 | |
1175 | package AnyEvent::CondVar; |
1279 | package AnyEvent::CondVar; |
1176 | |
1280 | |
1177 | our @ISA = AnyEvent::CondVar::Base::; |
1281 | our @ISA = AnyEvent::CondVar::Base::; |
… | |
… | |
1251 | so on. |
1355 | so on. |
1252 | |
1356 | |
1253 | =head1 ENVIRONMENT VARIABLES |
1357 | =head1 ENVIRONMENT VARIABLES |
1254 | |
1358 | |
1255 | The following environment variables are used by this module or its |
1359 | The following environment variables are used by this module or its |
1256 | submodules: |
1360 | submodules. |
|
|
1361 | |
|
|
1362 | Note that AnyEvent will remove I<all> environment variables starting with |
|
|
1363 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
|
|
1364 | enabled. |
1257 | |
1365 | |
1258 | =over 4 |
1366 | =over 4 |
1259 | |
1367 | |
1260 | =item C<PERL_ANYEVENT_VERBOSE> |
1368 | =item C<PERL_ANYEVENT_VERBOSE> |
1261 | |
1369 | |
… | |
… | |
1273 | =item C<PERL_ANYEVENT_STRICT> |
1381 | =item C<PERL_ANYEVENT_STRICT> |
1274 | |
1382 | |
1275 | AnyEvent does not do much argument checking by default, as thorough |
1383 | AnyEvent does not do much argument checking by default, as thorough |
1276 | argument checking is very costly. Setting this variable to a true value |
1384 | argument checking is very costly. Setting this variable to a true value |
1277 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
1385 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
1278 | check the arguments passed to most method calls. If it finds any problems |
1386 | check the arguments passed to most method calls. If it finds any problems, |
1279 | it will croak. |
1387 | it will croak. |
1280 | |
1388 | |
1281 | In other words, enables "strict" mode. |
1389 | In other words, enables "strict" mode. |
1282 | |
1390 | |
1283 | Unlike C<use strict>, it is definitely recommended ot keep it off in |
1391 | Unlike C<use strict>, it is definitely recommended to keep it off in |
1284 | production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while |
1392 | production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while |
1285 | developing programs can be very useful, however. |
1393 | developing programs can be very useful, however. |
1286 | |
1394 | |
1287 | =item C<PERL_ANYEVENT_MODEL> |
1395 | =item C<PERL_ANYEVENT_MODEL> |
1288 | |
1396 | |
… | |
… | |
1801 | =item * C-based event loops perform very well with small number of |
1909 | =item * C-based event loops perform very well with small number of |
1802 | watchers, as the management overhead dominates. |
1910 | watchers, as the management overhead dominates. |
1803 | |
1911 | |
1804 | =back |
1912 | =back |
1805 | |
1913 | |
|
|
1914 | =head2 THE IO::Lambda BENCHMARK |
|
|
1915 | |
|
|
1916 | Recently I was told about the benchmark in the IO::Lambda manpage, which |
|
|
1917 | could be misinterpreted to make AnyEvent look bad. In fact, the benchmark |
|
|
1918 | simply compares IO::Lambda with POE, and IO::Lambda looks better (which |
|
|
1919 | shouldn't come as a surprise to anybody). As such, the benchmark is |
|
|
1920 | fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't |
|
|
1921 | very optimal. But how would AnyEvent compare when used without the extra |
|
|
1922 | baggage? To explore this, I wrote the equivalent benchmark for AnyEvent. |
|
|
1923 | |
|
|
1924 | The benchmark itself creates an echo-server, and then, for 500 times, |
|
|
1925 | connects to the echo server, sends a line, waits for the reply, and then |
|
|
1926 | creates the next connection. This is a rather bad benchmark, as it doesn't |
|
|
1927 | test the efficiency of the framework or much non-blocking I/O, but it is a |
|
|
1928 | benchmark nevertheless. |
|
|
1929 | |
|
|
1930 | name runtime |
|
|
1931 | Lambda/select 0.330 sec |
|
|
1932 | + optimized 0.122 sec |
|
|
1933 | Lambda/AnyEvent 0.327 sec |
|
|
1934 | + optimized 0.138 sec |
|
|
1935 | Raw sockets/select 0.077 sec |
|
|
1936 | POE/select, components 0.662 sec |
|
|
1937 | POE/select, raw sockets 0.226 sec |
|
|
1938 | POE/select, optimized 0.404 sec |
|
|
1939 | |
|
|
1940 | AnyEvent/select/nb 0.085 sec |
|
|
1941 | AnyEvent/EV/nb 0.068 sec |
|
|
1942 | +state machine 0.134 sec |
|
|
1943 | |
|
|
1944 | The benchmark is also a bit unfair (my fault): the IO::Lambda/POE |
|
|
1945 | benchmarks actually make blocking connects and use 100% blocking I/O, |
|
|
1946 | defeating the purpose of an event-based solution. All of the newly |
|
|
1947 | written AnyEvent benchmarks use 100% non-blocking connects (using |
|
|
1948 | AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS |
|
|
1949 | resolver), so AnyEvent is at a disadvantage here, as non-blocking connects |
|
|
1950 | generally require a lot more bookkeeping and event handling than blocking |
|
|
1951 | connects (which involve a single syscall only). |
|
|
1952 | |
|
|
1953 | The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which |
|
|
1954 | offers similar expressive power as POE and IO::Lambda, using conventional |
|
|
1955 | Perl syntax. This means that both the echo server and the client are 100% |
|
|
1956 | non-blocking, further placing it at a disadvantage. |
|
|
1957 | |
|
|
1958 | As you can see, the AnyEvent + EV combination even beats the |
|
|
1959 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
|
|
1960 | backend easily beats IO::Lambda and POE. |
|
|
1961 | |
|
|
1962 | And even the 100% non-blocking version written using the high-level (and |
|
|
1963 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a |
|
|
1964 | large margin, even though it does all of DNS, tcp-connect and socket I/O |
|
|
1965 | in a non-blocking way. |
|
|
1966 | |
|
|
1967 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
|
|
1968 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
|
|
1969 | part of the IO::lambda distribution and were used without any changes. |
|
|
1970 | |
1806 | |
1971 | |
1807 | =head1 SIGNALS |
1972 | =head1 SIGNALS |
1808 | |
1973 | |
1809 | AnyEvent currently installs handlers for these signals: |
1974 | AnyEvent currently installs handlers for these signals: |
1810 | |
1975 | |
… | |
… | |
1813 | =item SIGCHLD |
1978 | =item SIGCHLD |
1814 | |
1979 | |
1815 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
1980 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
1816 | emulation for event loops that do not support them natively. Also, some |
1981 | emulation for event loops that do not support them natively. Also, some |
1817 | event loops install a similar handler. |
1982 | event loops install a similar handler. |
|
|
1983 | |
|
|
1984 | If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will |
|
|
1985 | reset it to default, to avoid losing child exit statuses. |
1818 | |
1986 | |
1819 | =item SIGPIPE |
1987 | =item SIGPIPE |
1820 | |
1988 | |
1821 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
1989 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
1822 | when AnyEvent gets loaded. |
1990 | when AnyEvent gets loaded. |
… | |
… | |
1834 | |
2002 | |
1835 | =back |
2003 | =back |
1836 | |
2004 | |
1837 | =cut |
2005 | =cut |
1838 | |
2006 | |
|
|
2007 | undef $SIG{CHLD} |
|
|
2008 | if $SIG{CHLD} eq 'IGNORE'; |
|
|
2009 | |
1839 | $SIG{PIPE} = sub { } |
2010 | $SIG{PIPE} = sub { } |
1840 | unless defined $SIG{PIPE}; |
2011 | unless defined $SIG{PIPE}; |
1841 | |
|
|
1842 | |
2012 | |
1843 | =head1 FORK |
2013 | =head1 FORK |
1844 | |
2014 | |
1845 | Most event libraries are not fork-safe. The ones who are usually are |
2015 | Most event libraries are not fork-safe. The ones who are usually are |
1846 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2016 | because they rely on inefficient but fork-safe C<select> or C<poll> |
… | |
… | |
1867 | use AnyEvent; |
2037 | use AnyEvent; |
1868 | |
2038 | |
1869 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
2039 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1870 | be used to probe what backend is used and gain other information (which is |
2040 | be used to probe what backend is used and gain other information (which is |
1871 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and |
2041 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and |
1872 | $ENV{PERL_ANYEGENT_STRICT}. |
2042 | $ENV{PERL_ANYEVENT_STRICT}. |
|
|
2043 | |
|
|
2044 | Note that AnyEvent will remove I<all> environment variables starting with |
|
|
2045 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
|
|
2046 | enabled. |
1873 | |
2047 | |
1874 | |
2048 | |
1875 | =head1 BUGS |
2049 | =head1 BUGS |
1876 | |
2050 | |
1877 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
2051 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |