ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.205 by root, Sun Apr 19 12:09:46 2009 UTC vs.
Revision 1.229 by root, Wed Jul 8 02:01:12 2009 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - provide framework for multiple event loops
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops 5EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported
6event 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:
168=head2 I/O WATCHERS 176=head2 I/O WATCHERS
169 177
170You can create an I/O watcher by calling the C<< AnyEvent->io >> method 178You can create an I/O watcher by calling the C<< AnyEvent->io >> method
171with the following mandatory key-value pairs as arguments: 179with the following mandatory key-value pairs as arguments:
172 180
173C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch 181C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
174for events (AnyEvent might or might not keep a reference to this file 182for events (AnyEvent might or might not keep a reference to this file
175handle). Note that only file handles pointing to things for which 183handle). Note that only file handles pointing to things for which
176non-blocking operation makes sense are allowed. This includes sockets, 184non-blocking operation makes sense are allowed. This includes sockets,
177most character devices, pipes, fifos and so on, but not for example files 185most character devices, pipes, fifos and so on, but not for example files
178or block devices. 186or block devices.
384 392
385There is a slight catch to child watchers, however: you usually start them 393There is a slight catch to child watchers, however: you usually start them
386I<after> the child process was created, and this means the process could 394I<after> the child process was created, and this means the process could
387have exited already (and no SIGCHLD will be sent anymore). 395have exited already (and no SIGCHLD will be sent anymore).
388 396
389Not all event models handle this correctly (POE doesn't), but even for 397Not all event models handle this correctly (neither POE nor IO::Async do,
398see their AnyEvent::Impl manpages for details), but even for event models
390event models that I<do> handle this correctly, they usually need to be 399that I<do> handle this correctly, they usually need to be loaded before
391loaded before the process exits (i.e. before you fork in the first place). 400the process exits (i.e. before you fork in the first place). AnyEvent's
401pure perl event loop handles all cases correctly regardless of when you
402start the watcher.
392 403
393This means you cannot create a child watcher as the very first thing in an 404This means you cannot create a child watcher as the very first
394AnyEvent program, you I<have> to create at least one watcher before you 405thing in an AnyEvent program, you I<have> to create at least one
395C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 406watcher before you C<fork> the child (alternatively, you can call
407C<AnyEvent::detect>).
396 408
397Example: fork a process and wait for it 409Example: fork a process and wait for it
398 410
399 my $done = AnyEvent->condvar; 411 my $done = AnyEvent->condvar;
400 412
410 ); 422 );
411 423
412 # do something else, then wait for process exit 424 # do something else, then wait for process exit
413 $done->recv; 425 $done->recv;
414 426
427=head2 IDLE WATCHERS
428
429Sometimes there is a need to do something, but it is not so important
430to 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
432attention by the event loop".
433
434Idle watchers ideally get invoked when the event loop has nothing
435better to do, just before it would block the process to wait for new
436events. Instead of blocking, the idle watcher is invoked.
437
438Most event loops unfortunately do not really support idle watchers (only
439EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
440will simply call the callback "from time to time".
441
442Example: read lines from STDIN, but only process them when the
443program 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
415=head2 CONDITION VARIABLES 462=head2 CONDITION VARIABLES
416 463
417If you are familiar with some event loops you will know that all of them 464If you are familiar with some event loops you will know that all of them
418require you to run some blocking "loop", "run" or similar function that 465require you to run some blocking "loop", "run" or similar function that
419will actively watch for new events and call your callbacks. 466will actively watch for new events and call your callbacks.
552 599
553=item $cv->begin ([group callback]) 600=item $cv->begin ([group callback])
554 601
555=item $cv->end 602=item $cv->end
556 603
557These two methods are EXPERIMENTAL and MIGHT CHANGE.
558
559These two methods can be used to combine many transactions/events into 604These two methods can be used to combine many transactions/events into
560one. For example, a function that pings many hosts in parallel might want 605one. For example, a function that pings many hosts in parallel might want
561to use a condition variable for the whole process. 606to use a condition variable for the whole process.
562 607
563Every call to C<< ->begin >> will increment a counter, and every call to 608Every call to C<< ->begin >> will increment a counter, and every call to
564C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 609C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
565>>, the (last) callback passed to C<begin> will be executed. That callback 610>>, the (last) callback passed to C<begin> will be executed. That callback
566is I<supposed> to call C<< ->send >>, but that is not required. If no 611is I<supposed> to call C<< ->send >>, but that is not required. If no
567callback was set, C<send> will be called without any arguments. 612callback was set, C<send> will be called without any arguments.
568 613
569Let's clarify this with the ping example: 614You can think of C<< $cv->send >> giving you an OR condition (one call
615sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
616condition (all C<begin> calls must be C<end>'ed before the condvar sends).
617
618Let's start with a simple example: you have two I/O watchers (for example,
619STDOUT and STDERR for a program), and you want to wait for both streams to
620close before activating a condvar:
621
622 my $cv = AnyEvent->condvar;
623
624 $cv->begin; # first watcher
625 my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
626 defined sysread $fh1, my $buf, 4096
627 or $cv->end;
628 });
629
630 $cv->begin; # second watcher
631 my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
632 defined sysread $fh2, my $buf, 4096
633 or $cv->end;
634 });
635
636 $cv->recv;
637
638This works because for every event source (EOF on file handle), there is
639one call to C<begin>, so the condvar waits for all calls to C<end> before
640sending.
641
642The ping example mentioned above is slightly more complicated, as the
643there are results to be passwd back, and the number of tasks that are
644begung can potentially be zero:
570 645
571 my $cv = AnyEvent->condvar; 646 my $cv = AnyEvent->condvar;
572 647
573 my %result; 648 my %result;
574 $cv->begin (sub { $cv->send (\%result) }); 649 $cv->begin (sub { $cv->send (\%result) });
594loop, which serves two important purposes: first, it sets the callback 669loop, which serves two important purposes: first, it sets the callback
595to be called once the counter reaches C<0>, and second, it ensures that 670to be called once the counter reaches C<0>, and second, it ensures that
596C<send> is called even when C<no> hosts are being pinged (the loop 671C<send> is called even when C<no> hosts are being pinged (the loop
597doesn't execute once). 672doesn't execute once).
598 673
599This is the general pattern when you "fan out" into multiple subrequests: 674This is the general pattern when you "fan out" into multiple (but
600use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 675potentially none) subrequests: use an outer C<begin>/C<end> pair to set
601is called at least once, and then, for each subrequest you start, call 676the callback and ensure C<end> is called at least once, and then, for each
602C<begin> and for each subrequest you finish, call C<end>. 677subrequest you start, call C<begin> and for each subrequest you finish,
678call C<end>.
603 679
604=back 680=back
605 681
606=head3 METHODS FOR CONSUMERS 682=head3 METHODS FOR CONSUMERS
607 683
687 AnyEvent::Impl::Tk based on Tk, very bad choice. 763 AnyEvent::Impl::Tk based on Tk, very bad choice.
688 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). 764 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
689 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 765 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
690 AnyEvent::Impl::POE based on POE, not generic enough for full support. 766 AnyEvent::Impl::POE based on POE, not generic enough for full support.
691 767
768 # warning, support for IO::Async is only partial, as it is too broken
769 # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
770 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
771
692There is no support for WxWidgets, as WxWidgets has no support for 772There is no support for WxWidgets, as WxWidgets has no support for
693watching file handles. However, you can use WxWidgets through the 773watching file handles. However, you can use WxWidgets through the
694POE Adaptor, as POE has a Wx backend that simply polls 20 times per 774POE Adaptor, as POE has a Wx backend that simply polls 20 times per
695second, which was considered to be too horrible to even consider for 775second, which was considered to be too horrible to even consider for
696AnyEvent. Likewise, other POE backends can be used by AnyEvent by using 776AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
888no warnings; 968no warnings;
889use strict qw(vars subs); 969use strict qw(vars subs);
890 970
891use Carp; 971use Carp;
892 972
893our $VERSION = 4.351; 973our $VERSION = 4.8;
894our $MODEL; 974our $MODEL;
895 975
896our $AUTOLOAD; 976our $AUTOLOAD;
897our @ISA; 977our @ISA;
898 978
899our @REGISTRY; 979our @REGISTRY;
900 980
901our $WIN32; 981our $WIN32;
902 982
903BEGIN { 983BEGIN {
904 my $win32 = ! ! ($^O =~ /mswin32/i); 984 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
905 eval "sub WIN32(){ $win32 }"; 985 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
986
987 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
988 if ${^TAINT};
906} 989}
907 990
908our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 991our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
909 992
910our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 993our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
928 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1011 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
929 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1012 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
930 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1013 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
931 [Wx:: => AnyEvent::Impl::POE::], 1014 [Wx:: => AnyEvent::Impl::POE::],
932 [Prima:: => AnyEvent::Impl::POE::], 1015 [Prima:: => AnyEvent::Impl::POE::],
1016 # IO::Async is just too broken - we would need workaorunds for its
1017 # byzantine signal and broken child handling, among others.
1018 # IO::Async is rather hard to detect, as it doesn't have any
1019 # obvious default class.
1020# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1021# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1022# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
933); 1023);
934 1024
935our %method = map +($_ => 1), 1025our %method = map +($_ => 1),
936 qw(io timer time now now_update signal child condvar one_event DESTROY); 1026 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
937 1027
938our @post_detect; 1028our @post_detect;
939 1029
940sub post_detect(&) { 1030sub post_detect(&) {
941 my ($cb) = @_; 1031 my ($cb) = @_;
946 1 1036 1
947 } else { 1037 } else {
948 push @post_detect, $cb; 1038 push @post_detect, $cb;
949 1039
950 defined wantarray 1040 defined wantarray
951 ? bless \$cb, "AnyEvent::Util::PostDetect" 1041 ? bless \$cb, "AnyEvent::Util::postdetect"
952 : () 1042 : ()
953 } 1043 }
954} 1044}
955 1045
956sub AnyEvent::Util::PostDetect::DESTROY { 1046sub AnyEvent::Util::postdetect::DESTROY {
957 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1047 @post_detect = grep $_ != ${$_[0]}, @post_detect;
958} 1048}
959 1049
960sub detect() { 1050sub detect() {
961 unless ($MODEL) { 1051 unless ($MODEL) {
1029} 1119}
1030 1120
1031# utility function to dup a filehandle. this is used by many backends 1121# utility function to dup a filehandle. this is used by many backends
1032# to support binding more than one watcher per filehandle (they usually 1122# to support binding more than one watcher per filehandle (they usually
1033# allow only one watcher per fd, so we dup it to get a different one). 1123# allow only one watcher per fd, so we dup it to get a different one).
1034sub _dupfh($$$$) { 1124sub _dupfh($$;$$) {
1035 my ($poll, $fh, $r, $w) = @_; 1125 my ($poll, $fh, $r, $w) = @_;
1036 1126
1037 # cygwin requires the fh mode to be matching, unix doesn't 1127 # cygwin requires the fh mode to be matching, unix doesn't
1038 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1128 my ($rw, $mode) = $poll eq "r" ? ($r, "<") : ($w, ">");
1039 : $poll eq "w" ? ($w, ">")
1040 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1041 1129
1042 open my $fh2, "$mode&" . fileno $fh 1130 open my $fh2, "$mode&", $fh
1043 or die "cannot dup() filehandle: $!,"; 1131 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1044 1132
1045 # we assume CLOEXEC is already set by perl in all important cases 1133 # we assume CLOEXEC is already set by perl in all important cases
1046 1134
1047 ($fh2, $rw) 1135 ($fh2, $rw)
1048} 1136}
1050package AnyEvent::Base; 1138package AnyEvent::Base;
1051 1139
1052# default implementations for many methods 1140# default implementations for many methods
1053 1141
1054BEGIN { 1142BEGIN {
1055 if (eval "use Time::HiRes (); time (); 1") { 1143 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1056 *_time = \&Time::HiRes::time; 1144 *_time = \&Time::HiRes::time;
1057 # if (eval "use POSIX (); (POSIX::times())... 1145 # if (eval "use POSIX (); (POSIX::times())...
1058 } else { 1146 } else {
1059 *_time = sub { time }; # epic fail 1147 *_time = sub { time }; # epic fail
1060 } 1148 }
1065sub now_update { } 1153sub now_update { }
1066 1154
1067# default implementation for ->condvar 1155# default implementation for ->condvar
1068 1156
1069sub condvar { 1157sub condvar {
1070 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1158 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1071} 1159}
1072 1160
1073# default implementation for ->signal 1161# default implementation for ->signal
1074 1162
1075our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1163our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1099 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case 1187 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1100 } else { 1188 } else {
1101 pipe $SIGPIPE_R, $SIGPIPE_W; 1189 pipe $SIGPIPE_R, $SIGPIPE_W;
1102 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; 1190 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1103 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case 1191 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1192
1193 # not strictly required, as $^F is normally 2, but let's make sure...
1194 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1195 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1104 } 1196 }
1105 1197
1106 $SIGPIPE_R 1198 $SIGPIPE_R
1107 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1199 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1108
1109 # not strictly required, as $^F is normally 2, but let's make sure...
1110 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1111 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1112 1200
1113 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1201 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1114 } 1202 }
1115 1203
1116 my $signal = uc $arg{signal} 1204 my $signal = uc $arg{signal}
1121 local $!; 1209 local $!;
1122 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1210 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1123 undef $SIG_EV{$signal}; 1211 undef $SIG_EV{$signal};
1124 }; 1212 };
1125 1213
1126 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1214 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1127} 1215}
1128 1216
1129sub AnyEvent::Base::Signal::DESTROY { 1217sub AnyEvent::Base::signal::DESTROY {
1130 my ($signal, $cb) = @{$_[0]}; 1218 my ($signal, $cb) = @{$_[0]};
1131 1219
1132 delete $SIG_CB{$signal}{$cb}; 1220 delete $SIG_CB{$signal}{$cb};
1133 1221
1222 # delete doesn't work with older perls - they then
1223 # print weird messages, or just unconditionally exit
1224 # instead of getting the default action.
1134 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; 1225 undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1135} 1226}
1136 1227
1137# default implementation for ->child 1228# default implementation for ->child
1138 1229
1139our %PID_CB; 1230our %PID_CB;
1140our $CHLD_W; 1231our $CHLD_W;
1141our $CHLD_DELAY_W; 1232our $CHLD_DELAY_W;
1142our $PID_IDLE;
1143our $WNOHANG; 1233our $WNOHANG;
1144 1234
1145sub _child_wait { 1235sub _sigchld {
1146 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1236 while (0 < (my $pid = waitpid -1, $WNOHANG)) {
1147 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1237 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),
1148 (values %{ $PID_CB{0} || {} }); 1238 (values %{ $PID_CB{0} || {} });
1149 } 1239 }
1150
1151 undef $PID_IDLE;
1152}
1153
1154sub _sigchld {
1155 # make sure we deliver these changes "synchronous" with the event loop.
1156 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1157 undef $CHLD_DELAY_W;
1158 &_child_wait;
1159 });
1160} 1240}
1161 1241
1162sub child { 1242sub child {
1163 my (undef, %arg) = @_; 1243 my (undef, %arg) = @_;
1164 1244
1165 defined (my $pid = $arg{pid} + 0) 1245 defined (my $pid = $arg{pid} + 0)
1166 or Carp::croak "required option 'pid' is missing"; 1246 or Carp::croak "required option 'pid' is missing";
1167 1247
1168 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1248 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1169 1249
1170 unless ($WNOHANG) {
1171 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1250 $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1172 }
1173 1251
1174 unless ($CHLD_W) { 1252 unless ($CHLD_W) {
1175 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1253 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1176 # child could be a zombie already, so make at least one round 1254 # child could be a zombie already, so make at least one round
1177 &_sigchld; 1255 &_sigchld;
1178 } 1256 }
1179 1257
1180 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1258 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1181} 1259}
1182 1260
1183sub AnyEvent::Base::Child::DESTROY { 1261sub AnyEvent::Base::child::DESTROY {
1184 my ($pid, $cb) = @{$_[0]}; 1262 my ($pid, $cb) = @{$_[0]};
1185 1263
1186 delete $PID_CB{$pid}{$cb}; 1264 delete $PID_CB{$pid}{$cb};
1187 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1265 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1188 1266
1189 undef $CHLD_W unless keys %PID_CB; 1267 undef $CHLD_W unless keys %PID_CB;
1268}
1269
1270# idle emulation is done by simply using a timer, regardless
1271# of whether the process is idle or not, and not letting
1272# the callback use more than 50% of the time.
1273sub idle {
1274 my (undef, %arg) = @_;
1275
1276 my ($cb, $w, $rcb) = $arg{cb};
1277
1278 $rcb = sub {
1279 if ($cb) {
1280 $w = _time;
1281 &$cb;
1282 $w = _time - $w;
1283
1284 # never use more then 50% of the time for the idle watcher,
1285 # within some limits
1286 $w = 0.0001 if $w < 0.0001;
1287 $w = 5 if $w > 5;
1288
1289 $w = AnyEvent->timer (after => $w, cb => $rcb);
1290 } else {
1291 # clean up...
1292 undef $w;
1293 undef $rcb;
1294 }
1295 };
1296
1297 $w = AnyEvent->timer (after => 0.05, cb => $rcb);
1298
1299 bless \\$cb, "AnyEvent::Base::idle"
1300}
1301
1302sub AnyEvent::Base::idle::DESTROY {
1303 undef $${$_[0]};
1190} 1304}
1191 1305
1192package AnyEvent::CondVar; 1306package AnyEvent::CondVar;
1193 1307
1194our @ISA = AnyEvent::CondVar::Base::; 1308our @ISA = AnyEvent::CondVar::Base::;
1268so on. 1382so on.
1269 1383
1270=head1 ENVIRONMENT VARIABLES 1384=head1 ENVIRONMENT VARIABLES
1271 1385
1272The following environment variables are used by this module or its 1386The following environment variables are used by this module or its
1273submodules: 1387submodules.
1388
1389Note that AnyEvent will remove I<all> environment variables starting with
1390C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
1391enabled.
1274 1392
1275=over 4 1393=over 4
1276 1394
1277=item C<PERL_ANYEVENT_VERBOSE> 1395=item C<PERL_ANYEVENT_VERBOSE>
1278 1396
1290=item C<PERL_ANYEVENT_STRICT> 1408=item C<PERL_ANYEVENT_STRICT>
1291 1409
1292AnyEvent does not do much argument checking by default, as thorough 1410AnyEvent does not do much argument checking by default, as thorough
1293argument checking is very costly. Setting this variable to a true value 1411argument checking is very costly. Setting this variable to a true value
1294will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly 1412will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1295check the arguments passed to most method calls. If it finds any problems 1413check the arguments passed to most method calls. If it finds any problems,
1296it will croak. 1414it will croak.
1297 1415
1298In other words, enables "strict" mode. 1416In other words, enables "strict" mode.
1299 1417
1300Unlike C<use strict>, it is definitely recommended ot keep it off in 1418Unlike C<use strict>, it is definitely recommended to keep it off in
1301production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while 1419production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
1302developing programs can be very useful, however. 1420developing programs can be very useful, however.
1303 1421
1304=item C<PERL_ANYEVENT_MODEL> 1422=item C<PERL_ANYEVENT_MODEL>
1305 1423
1350 1468
1351=item C<PERL_ANYEVENT_MAX_FORKS> 1469=item C<PERL_ANYEVENT_MAX_FORKS>
1352 1470
1353The maximum number of child processes that C<AnyEvent::Util::fork_call> 1471The maximum number of child processes that C<AnyEvent::Util::fork_call>
1354will create in parallel. 1472will create in parallel.
1473
1474=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1475
1476The default value for the C<max_outstanding> parameter for the default DNS
1477resolver - this is the maximum number of parallel DNS requests that are
1478sent to the DNS server.
1479
1480=item C<PERL_ANYEVENT_RESOLV_CONF>
1481
1482The file to use instead of F</etc/resolv.conf> (or OS-specific
1483configuration) in the default resolver. When set to the empty string, no
1484default config will be used.
1485
1486=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1487
1488When neither C<ca_file> nor C<ca_path> was specified during
1489L<AnyEvent::TLS> context creation, and either of these environment
1490variables exist, they will be used to specify CA certificate locations
1491instead of a system-dependent default.
1355 1492
1356=back 1493=back
1357 1494
1358=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1495=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1359 1496
1604 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 1741 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1605 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 1742 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1606 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 1743 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1607 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 1744 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1608 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 1745 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1746 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
1747 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1609 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 1748 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1610 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 1749 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1611 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 1750 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1612 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 1751 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1613 1752
1642performance becomes really bad with lots of file descriptors (and few of 1781performance becomes really bad with lots of file descriptors (and few of
1643them active), of course, but this was not subject of this benchmark. 1782them active), of course, but this was not subject of this benchmark.
1644 1783
1645The C<Event> module has a relatively high setup and callback invocation 1784The C<Event> module has a relatively high setup and callback invocation
1646cost, but overall scores in on the third place. 1785cost, but overall scores in on the third place.
1786
1787C<IO::Async> performs admirably well, about on par with C<Event>, even
1788when using its pure perl backend.
1647 1789
1648C<Glib>'s memory usage is quite a bit higher, but it features a 1790C<Glib>'s memory usage is quite a bit higher, but it features a
1649faster callback invocation and overall ends up in the same class as 1791faster callback invocation and overall ends up in the same class as
1650C<Event>. However, Glib scales extremely badly, doubling the number of 1792C<Event>. However, Glib scales extremely badly, doubling the number of
1651watchers increases the processing time by more than a factor of four, 1793watchers increases the processing time by more than a factor of four,
1729it to another server. This includes deleting the old timeout and creating 1871it to another server. This includes deleting the old timeout and creating
1730a new one that moves the timeout into the future. 1872a new one that moves the timeout into the future.
1731 1873
1732=head3 Results 1874=head3 Results
1733 1875
1734 name sockets create request 1876 name sockets create request
1735 EV 20000 69.01 11.16 1877 EV 20000 69.01 11.16
1736 Perl 20000 73.32 35.87 1878 Perl 20000 73.32 35.87
1879 IOAsync 20000 157.00 98.14 epoll
1880 IOAsync 20000 159.31 616.06 poll
1737 Event 20000 212.62 257.32 1881 Event 20000 212.62 257.32
1738 Glib 20000 651.16 1896.30 1882 Glib 20000 651.16 1896.30
1739 POE 20000 349.67 12317.24 uses POE::Loop::Event 1883 POE 20000 349.67 12317.24 uses POE::Loop::Event
1740 1884
1741=head3 Discussion 1885=head3 Discussion
1742 1886
1743This benchmark I<does> measure scalability and overall performance of the 1887This benchmark I<does> measure scalability and overall performance of the
1744particular event loop. 1888particular event loop.
1746EV is again fastest. Since it is using epoll on my system, the setup time 1890EV is again fastest. Since it is using epoll on my system, the setup time
1747is relatively high, though. 1891is relatively high, though.
1748 1892
1749Perl surprisingly comes second. It is much faster than the C-based event 1893Perl surprisingly comes second. It is much faster than the C-based event
1750loops Event and Glib. 1894loops Event and Glib.
1895
1896IO::Async performs very well when using its epoll backend, and still quite
1897good compared to Glib when using its pure perl backend.
1751 1898
1752Event suffers from high setup time as well (look at its code and you will 1899Event suffers from high setup time as well (look at its code and you will
1753understand why). Callback invocation also has a high overhead compared to 1900understand why). Callback invocation also has a high overhead compared to
1754the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 1901the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1755uses select or poll in basically all documented configurations. 1902uses select or poll in basically all documented configurations.
1818=item * C-based event loops perform very well with small number of 1965=item * C-based event loops perform very well with small number of
1819watchers, as the management overhead dominates. 1966watchers, as the management overhead dominates.
1820 1967
1821=back 1968=back
1822 1969
1970=head2 THE IO::Lambda BENCHMARK
1971
1972Recently I was told about the benchmark in the IO::Lambda manpage, which
1973could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
1974simply compares IO::Lambda with POE, and IO::Lambda looks better (which
1975shouldn't come as a surprise to anybody). As such, the benchmark is
1976fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
1977very optimal. But how would AnyEvent compare when used without the extra
1978baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
1979
1980The benchmark itself creates an echo-server, and then, for 500 times,
1981connects to the echo server, sends a line, waits for the reply, and then
1982creates the next connection. This is a rather bad benchmark, as it doesn't
1983test the efficiency of the framework or much non-blocking I/O, but it is a
1984benchmark nevertheless.
1985
1986 name runtime
1987 Lambda/select 0.330 sec
1988 + optimized 0.122 sec
1989 Lambda/AnyEvent 0.327 sec
1990 + optimized 0.138 sec
1991 Raw sockets/select 0.077 sec
1992 POE/select, components 0.662 sec
1993 POE/select, raw sockets 0.226 sec
1994 POE/select, optimized 0.404 sec
1995
1996 AnyEvent/select/nb 0.085 sec
1997 AnyEvent/EV/nb 0.068 sec
1998 +state machine 0.134 sec
1999
2000The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
2001benchmarks actually make blocking connects and use 100% blocking I/O,
2002defeating the purpose of an event-based solution. All of the newly
2003written AnyEvent benchmarks use 100% non-blocking connects (using
2004AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
2005resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
2006generally require a lot more bookkeeping and event handling than blocking
2007connects (which involve a single syscall only).
2008
2009The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
2010offers similar expressive power as POE and IO::Lambda, using conventional
2011Perl syntax. This means that both the echo server and the client are 100%
2012non-blocking, further placing it at a disadvantage.
2013
2014As you can see, the AnyEvent + EV combination even beats the
2015hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2016backend easily beats IO::Lambda and POE.
2017
2018And even the 100% non-blocking version written using the high-level (and
2019slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
2020large margin, even though it does all of DNS, tcp-connect and socket I/O
2021in a non-blocking way.
2022
2023The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2024F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2025part of the IO::lambda distribution and were used without any changes.
2026
1823 2027
1824=head1 SIGNALS 2028=head1 SIGNALS
1825 2029
1826AnyEvent currently installs handlers for these signals: 2030AnyEvent currently installs handlers for these signals:
1827 2031
1830=item SIGCHLD 2034=item SIGCHLD
1831 2035
1832A handler for C<SIGCHLD> is installed by AnyEvent's child watcher 2036A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1833emulation for event loops that do not support them natively. Also, some 2037emulation for event loops that do not support them natively. Also, some
1834event loops install a similar handler. 2038event loops install a similar handler.
2039
2040If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will
2041reset it to default, to avoid losing child exit statuses.
1835 2042
1836=item SIGPIPE 2043=item SIGPIPE
1837 2044
1838A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> 2045A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1839when AnyEvent gets loaded. 2046when AnyEvent gets loaded.
1851 2058
1852=back 2059=back
1853 2060
1854=cut 2061=cut
1855 2062
2063undef $SIG{CHLD}
2064 if $SIG{CHLD} eq 'IGNORE';
2065
1856$SIG{PIPE} = sub { } 2066$SIG{PIPE} = sub { }
1857 unless defined $SIG{PIPE}; 2067 unless defined $SIG{PIPE};
1858
1859 2068
1860=head1 FORK 2069=head1 FORK
1861 2070
1862Most event libraries are not fork-safe. The ones who are usually are 2071Most event libraries are not fork-safe. The ones who are usually are
1863because they rely on inefficient but fork-safe C<select> or C<poll> 2072because they rely on inefficient but fork-safe C<select> or C<poll>
1884 use AnyEvent; 2093 use AnyEvent;
1885 2094
1886Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2095Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1887be used to probe what backend is used and gain other information (which is 2096be used to probe what backend is used and gain other information (which is
1888probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and 2097probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1889$ENV{PERL_ANYEGENT_STRICT}. 2098$ENV{PERL_ANYEVENT_STRICT}.
2099
2100Note that AnyEvent will remove I<all> environment variables starting with
2101C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2102enabled.
1890 2103
1891 2104
1892=head1 BUGS 2105=head1 BUGS
1893 2106
1894Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 2107Perl 5.8 has numerous memleaks that sometimes hit this module and are hard

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines