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.198 by root, Thu Mar 26 20:17:44 2009 UTC vs.
Revision 1.226 by root, Mon Jul 6 23:32:49 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> the Perl I<file handle> (I<not> file descriptor) to watch for events 181C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch
174(AnyEvent might or might not keep a reference to this file handle). C<poll> 182for events (AnyEvent might or might not keep a reference to this file
183handle). Note that only file handles pointing to things for which
184non-blocking operation makes sense are allowed. This includes sockets,
185most character devices, pipes, fifos and so on, but not for example files
186or block devices.
187
175must be a string that is either C<r> or C<w>, which creates a watcher 188C<poll> must be a string that is either C<r> or C<w>, which creates a
176waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the 189watcher waiting for "r"eadable or "w"ritable events, respectively.
190
177callback to invoke each time the file handle becomes ready. 191C<cb> is the callback to invoke each time the file handle becomes ready.
178 192
179Although the callback might get passed parameters, their value and 193Although the callback might get passed parameters, their value and
180presence is undefined and you cannot rely on them. Portable AnyEvent 194presence is undefined and you cannot rely on them. Portable AnyEvent
181callbacks cannot use arguments passed to I/O watcher callbacks. 195callbacks cannot use arguments passed to I/O watcher callbacks.
182 196
314In either case, if you care (and in most cases, you don't), then you 328In either case, if you care (and in most cases, you don't), then you
315can get whatever behaviour you want with any event loop, by taking the 329can get whatever behaviour you want with any event loop, by taking the
316difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 330difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
317account. 331account.
318 332
333=item AnyEvent->now_update
334
335Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
336the current time for each loop iteration (see the discussion of L<<
337AnyEvent->now >>, above).
338
339When a callback runs for a long time (or when the process sleeps), then
340this "current" time will differ substantially from the real time, which
341might affect timers and time-outs.
342
343When this is the case, you can call this method, which will update the
344event loop's idea of "current time".
345
346Note that updating the time I<might> cause some events to be handled.
347
319=back 348=back
320 349
321=head2 SIGNAL WATCHERS 350=head2 SIGNAL WATCHERS
322 351
323You can watch for signals using a signal watcher, C<signal> is the signal 352You can watch for signals using a signal watcher, C<signal> is the signal
363 392
364There 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
365I<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
366have exited already (and no SIGCHLD will be sent anymore). 395have exited already (and no SIGCHLD will be sent anymore).
367 396
368Not 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
369event 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
370loaded 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.
371 403
372This 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
373AnyEvent 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
374C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 406watcher before you C<fork> the child (alternatively, you can call
407C<AnyEvent::detect>).
375 408
376Example: fork a process and wait for it 409Example: fork a process and wait for it
377 410
378 my $done = AnyEvent->condvar; 411 my $done = AnyEvent->condvar;
379 412
389 ); 422 );
390 423
391 # do something else, then wait for process exit 424 # do something else, then wait for process exit
392 $done->recv; 425 $done->recv;
393 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
394=head2 CONDITION VARIABLES 462=head2 CONDITION VARIABLES
395 463
396If 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
397require you to run some blocking "loop", "run" or similar function that 465require you to run some blocking "loop", "run" or similar function that
398will actively watch for new events and call your callbacks. 466will actively watch for new events and call your callbacks.
531 599
532=item $cv->begin ([group callback]) 600=item $cv->begin ([group callback])
533 601
534=item $cv->end 602=item $cv->end
535 603
536These two methods are EXPERIMENTAL and MIGHT CHANGE.
537
538These two methods can be used to combine many transactions/events into 604These two methods can be used to combine many transactions/events into
539one. 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
540to use a condition variable for the whole process. 606to use a condition variable for the whole process.
541 607
542Every 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
543C<< ->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
544>>, 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
545is 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
546callback was set, C<send> will be called without any arguments. 612callback was set, C<send> will be called without any arguments.
547 613
548Let'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:
549 645
550 my $cv = AnyEvent->condvar; 646 my $cv = AnyEvent->condvar;
551 647
552 my %result; 648 my %result;
553 $cv->begin (sub { $cv->send (\%result) }); 649 $cv->begin (sub { $cv->send (\%result) });
573loop, which serves two important purposes: first, it sets the callback 669loop, which serves two important purposes: first, it sets the callback
574to 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
575C<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
576doesn't execute once). 672doesn't execute once).
577 673
578This is the general pattern when you "fan out" into multiple subrequests: 674This is the general pattern when you "fan out" into multiple (but
579use 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
580is 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
581C<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>.
582 679
583=back 680=back
584 681
585=head3 METHODS FOR CONSUMERS 682=head3 METHODS FOR CONSUMERS
586 683
666 AnyEvent::Impl::Tk based on Tk, very bad choice. 763 AnyEvent::Impl::Tk based on Tk, very bad choice.
667 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).
668 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 765 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
669 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.
670 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
671There is no support for WxWidgets, as WxWidgets has no support for 772There is no support for WxWidgets, as WxWidgets has no support for
672watching file handles. However, you can use WxWidgets through the 773watching file handles. However, you can use WxWidgets through the
673POE 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
674second, which was considered to be too horrible to even consider for 775second, which was considered to be too horrible to even consider for
675AnyEvent. Likewise, other POE backends can be used by AnyEvent by using 776AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
867no warnings; 968no warnings;
868use strict qw(vars subs); 969use strict qw(vars subs);
869 970
870use Carp; 971use Carp;
871 972
872our $VERSION = 4.341; 973our $VERSION = 4.8;
873our $MODEL; 974our $MODEL;
874 975
875our $AUTOLOAD; 976our $AUTOLOAD;
876our @ISA; 977our @ISA;
877 978
878our @REGISTRY; 979our @REGISTRY;
879 980
880our $WIN32; 981our $WIN32;
881 982
882BEGIN { 983BEGIN {
883 my $win32 = ! ! ($^O =~ /mswin32/i); 984 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
884 eval "sub WIN32(){ $win32 }"; 985 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
986
987 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
988 if ${^TAINT};
885} 989}
886 990
887our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 991our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
888 992
889our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 993our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
907 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1011 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
908 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1012 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
909 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1013 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
910 [Wx:: => AnyEvent::Impl::POE::], 1014 [Wx:: => AnyEvent::Impl::POE::],
911 [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
912); 1023);
913 1024
914our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); 1025our %method = map +($_ => 1),
1026 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
915 1027
916our @post_detect; 1028our @post_detect;
917 1029
918sub post_detect(&) { 1030sub post_detect(&) {
919 my ($cb) = @_; 1031 my ($cb) = @_;
924 1 1036 1
925 } else { 1037 } else {
926 push @post_detect, $cb; 1038 push @post_detect, $cb;
927 1039
928 defined wantarray 1040 defined wantarray
929 ? bless \$cb, "AnyEvent::Util::PostDetect" 1041 ? bless \$cb, "AnyEvent::Util::postdetect"
930 : () 1042 : ()
931 } 1043 }
932} 1044}
933 1045
934sub AnyEvent::Util::PostDetect::DESTROY { 1046sub AnyEvent::Util::postdetect::DESTROY {
935 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1047 @post_detect = grep $_ != ${$_[0]}, @post_detect;
936} 1048}
937 1049
938sub detect() { 1050sub detect() {
939 unless ($MODEL) { 1051 unless ($MODEL) {
976 last; 1088 last;
977 } 1089 }
978 } 1090 }
979 1091
980 $MODEL 1092 $MODEL
981 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 1093 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
982 } 1094 }
983 } 1095 }
984 1096
985 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1097 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
986 1098
1007} 1119}
1008 1120
1009# 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
1010# to support binding more than one watcher per filehandle (they usually 1122# to support binding more than one watcher per filehandle (they usually
1011# 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).
1012sub _dupfh($$$$) { 1124sub _dupfh($$;$$) {
1013 my ($poll, $fh, $r, $w) = @_; 1125 my ($poll, $fh, $r, $w) = @_;
1014 1126
1015 # cygwin requires the fh mode to be matching, unix doesn't 1127 # cygwin requires the fh mode to be matching, unix doesn't
1016 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1128 my ($rw, $mode) = $poll eq "r" ? ($r, "<")
1017 : $poll eq "w" ? ($w, ">") 1129 : $poll eq "w" ? ($w, ">")
1018 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; 1130 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1019 1131
1020 open my $fh2, "$mode&" . fileno $fh 1132 open my $fh2, "$mode&" . fileno $fh
1021 or die "cannot dup() filehandle: $!"; 1133 or die "cannot dup() filehandle: $!,";
1022 1134
1023 # we assume CLOEXEC is already set by perl in all important cases 1135 # we assume CLOEXEC is already set by perl in all important cases
1024 1136
1025 ($fh2, $rw) 1137 ($fh2, $rw)
1026} 1138}
1027 1139
1028package AnyEvent::Base; 1140package AnyEvent::Base;
1029 1141
1030# default implementation for now and time 1142# default implementations for many methods
1031 1143
1032BEGIN { 1144BEGIN {
1033 if (eval "use Time::HiRes (); time (); 1") { 1145 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1034 *_time = \&Time::HiRes::time; 1146 *_time = \&Time::HiRes::time;
1035 # if (eval "use POSIX (); (POSIX::times())... 1147 # if (eval "use POSIX (); (POSIX::times())...
1036 } else { 1148 } else {
1037 *_time = sub { time }; # epic fail 1149 *_time = sub { time }; # epic fail
1038 } 1150 }
1039} 1151}
1040 1152
1041sub time { _time } 1153sub time { _time }
1042sub now { _time } 1154sub now { _time }
1155sub now_update { }
1043 1156
1044# default implementation for ->condvar 1157# default implementation for ->condvar
1045 1158
1046sub condvar { 1159sub condvar {
1047 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1160 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1048} 1161}
1049 1162
1050# default implementation for ->signal 1163# default implementation for ->signal
1051 1164
1052our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1165our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1064 1177
1065sub signal { 1178sub signal {
1066 my (undef, %arg) = @_; 1179 my (undef, %arg) = @_;
1067 1180
1068 unless ($SIGPIPE_R) { 1181 unless ($SIGPIPE_R) {
1182 require Fcntl;
1183
1069 if (AnyEvent::WIN32) { 1184 if (AnyEvent::WIN32) {
1185 require AnyEvent::Util;
1186
1070 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1187 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1071 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; 1188 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1072 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case 1189 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1073 } else { 1190 } else {
1074 pipe $SIGPIPE_R, $SIGPIPE_W; 1191 pipe $SIGPIPE_R, $SIGPIPE_W;
1075 require Fcntl;
1076 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; 1192 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1077 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case 1193 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1194
1195 # not strictly required, as $^F is normally 2, but let's make sure...
1196 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1197 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1078 } 1198 }
1079 1199
1080 $SIGPIPE_R 1200 $SIGPIPE_R
1081 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1201 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1082 1202
1086 my $signal = uc $arg{signal} 1206 my $signal = uc $arg{signal}
1087 or Carp::croak "required option 'signal' is missing"; 1207 or Carp::croak "required option 'signal' is missing";
1088 1208
1089 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1209 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1090 $SIG{$signal} ||= sub { 1210 $SIG{$signal} ||= sub {
1211 local $!;
1091 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1212 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1092 undef $SIG_EV{$signal}; 1213 undef $SIG_EV{$signal};
1093 }; 1214 };
1094 1215
1095 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1216 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1096} 1217}
1097 1218
1098sub AnyEvent::Base::Signal::DESTROY { 1219sub AnyEvent::Base::signal::DESTROY {
1099 my ($signal, $cb) = @{$_[0]}; 1220 my ($signal, $cb) = @{$_[0]};
1100 1221
1101 delete $SIG_CB{$signal}{$cb}; 1222 delete $SIG_CB{$signal}{$cb};
1102 1223
1224 # delete doesn't work with older perls - they then
1225 # print weird messages, or just unconditionally exit
1226 # instead of getting the default action.
1103 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; 1227 undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1104} 1228}
1105 1229
1106# default implementation for ->child 1230# default implementation for ->child
1107 1231
1108our %PID_CB; 1232our %PID_CB;
1109our $CHLD_W; 1233our $CHLD_W;
1110our $CHLD_DELAY_W; 1234our $CHLD_DELAY_W;
1111our $PID_IDLE;
1112our $WNOHANG; 1235our $WNOHANG;
1113 1236
1114sub _child_wait { 1237sub _sigchld {
1115 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1238 while (0 < (my $pid = waitpid -1, $WNOHANG)) {
1116 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1239 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),
1117 (values %{ $PID_CB{0} || {} }); 1240 (values %{ $PID_CB{0} || {} });
1118 } 1241 }
1119
1120 undef $PID_IDLE;
1121}
1122
1123sub _sigchld {
1124 # make sure we deliver these changes "synchronous" with the event loop.
1125 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1126 undef $CHLD_DELAY_W;
1127 &_child_wait;
1128 });
1129} 1242}
1130 1243
1131sub child { 1244sub child {
1132 my (undef, %arg) = @_; 1245 my (undef, %arg) = @_;
1133 1246
1134 defined (my $pid = $arg{pid} + 0) 1247 defined (my $pid = $arg{pid} + 0)
1135 or Carp::croak "required option 'pid' is missing"; 1248 or Carp::croak "required option 'pid' is missing";
1136 1249
1137 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1250 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1138 1251
1139 unless ($WNOHANG) {
1140 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1252 $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1141 }
1142 1253
1143 unless ($CHLD_W) { 1254 unless ($CHLD_W) {
1144 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1255 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1145 # child could be a zombie already, so make at least one round 1256 # child could be a zombie already, so make at least one round
1146 &_sigchld; 1257 &_sigchld;
1147 } 1258 }
1148 1259
1149 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1260 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1150} 1261}
1151 1262
1152sub AnyEvent::Base::Child::DESTROY { 1263sub AnyEvent::Base::child::DESTROY {
1153 my ($pid, $cb) = @{$_[0]}; 1264 my ($pid, $cb) = @{$_[0]};
1154 1265
1155 delete $PID_CB{$pid}{$cb}; 1266 delete $PID_CB{$pid}{$cb};
1156 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1267 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1157 1268
1158 undef $CHLD_W unless keys %PID_CB; 1269 undef $CHLD_W unless keys %PID_CB;
1270}
1271
1272# idle emulation is done by simply using a timer, regardless
1273# of whether the process is idle or not, and not letting
1274# the callback use more than 50% of the time.
1275sub idle {
1276 my (undef, %arg) = @_;
1277
1278 my ($cb, $w, $rcb) = $arg{cb};
1279
1280 $rcb = sub {
1281 if ($cb) {
1282 $w = _time;
1283 &$cb;
1284 $w = _time - $w;
1285
1286 # never use more then 50% of the time for the idle watcher,
1287 # within some limits
1288 $w = 0.0001 if $w < 0.0001;
1289 $w = 5 if $w > 5;
1290
1291 $w = AnyEvent->timer (after => $w, cb => $rcb);
1292 } else {
1293 # clean up...
1294 undef $w;
1295 undef $rcb;
1296 }
1297 };
1298
1299 $w = AnyEvent->timer (after => 0.05, cb => $rcb);
1300
1301 bless \\$cb, "AnyEvent::Base::idle"
1302}
1303
1304sub AnyEvent::Base::idle::DESTROY {
1305 undef $${$_[0]};
1159} 1306}
1160 1307
1161package AnyEvent::CondVar; 1308package AnyEvent::CondVar;
1162 1309
1163our @ISA = AnyEvent::CondVar::Base::; 1310our @ISA = AnyEvent::CondVar::Base::;
1237so on. 1384so on.
1238 1385
1239=head1 ENVIRONMENT VARIABLES 1386=head1 ENVIRONMENT VARIABLES
1240 1387
1241The following environment variables are used by this module or its 1388The following environment variables are used by this module or its
1242submodules: 1389submodules.
1390
1391Note that AnyEvent will remove I<all> environment variables starting with
1392C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
1393enabled.
1243 1394
1244=over 4 1395=over 4
1245 1396
1246=item C<PERL_ANYEVENT_VERBOSE> 1397=item C<PERL_ANYEVENT_VERBOSE>
1247 1398
1259=item C<PERL_ANYEVENT_STRICT> 1410=item C<PERL_ANYEVENT_STRICT>
1260 1411
1261AnyEvent does not do much argument checking by default, as thorough 1412AnyEvent does not do much argument checking by default, as thorough
1262argument checking is very costly. Setting this variable to a true value 1413argument checking is very costly. Setting this variable to a true value
1263will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly 1414will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1264check the arguments passed to most method calls. If it finds any problems 1415check the arguments passed to most method calls. If it finds any problems,
1265it will croak. 1416it will croak.
1266 1417
1267In other words, enables "strict" mode. 1418In other words, enables "strict" mode.
1268 1419
1269Unlike C<use strict>, it is definitely recommended ot keep it off in 1420Unlike C<use strict>, it is definitely recommended to keep it off in
1270production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while 1421production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
1271developing programs can be very useful, however. 1422developing programs can be very useful, however.
1272 1423
1273=item C<PERL_ANYEVENT_MODEL> 1424=item C<PERL_ANYEVENT_MODEL>
1274 1425
1319 1470
1320=item C<PERL_ANYEVENT_MAX_FORKS> 1471=item C<PERL_ANYEVENT_MAX_FORKS>
1321 1472
1322The maximum number of child processes that C<AnyEvent::Util::fork_call> 1473The maximum number of child processes that C<AnyEvent::Util::fork_call>
1323will create in parallel. 1474will create in parallel.
1475
1476=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1477
1478The default value for the C<max_outstanding> parameter for the default DNS
1479resolver - this is the maximum number of parallel DNS requests that are
1480sent to the DNS server.
1481
1482=item C<PERL_ANYEVENT_RESOLV_CONF>
1483
1484The file to use instead of F</etc/resolv.conf> (or OS-specific
1485configuration) in the default resolver. When set to the empty string, no
1486default config will be used.
1324 1487
1325=back 1488=back
1326 1489
1327=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1490=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1328 1491
1573 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 1736 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1574 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 1737 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1575 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 1738 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1576 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 1739 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1577 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 1740 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1741 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
1742 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1578 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 1743 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1579 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 1744 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1580 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 1745 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1581 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 1746 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1582 1747
1611performance becomes really bad with lots of file descriptors (and few of 1776performance becomes really bad with lots of file descriptors (and few of
1612them active), of course, but this was not subject of this benchmark. 1777them active), of course, but this was not subject of this benchmark.
1613 1778
1614The C<Event> module has a relatively high setup and callback invocation 1779The C<Event> module has a relatively high setup and callback invocation
1615cost, but overall scores in on the third place. 1780cost, but overall scores in on the third place.
1781
1782C<IO::Async> performs admirably well, about on par with C<Event>, even
1783when using its pure perl backend.
1616 1784
1617C<Glib>'s memory usage is quite a bit higher, but it features a 1785C<Glib>'s memory usage is quite a bit higher, but it features a
1618faster callback invocation and overall ends up in the same class as 1786faster callback invocation and overall ends up in the same class as
1619C<Event>. However, Glib scales extremely badly, doubling the number of 1787C<Event>. However, Glib scales extremely badly, doubling the number of
1620watchers increases the processing time by more than a factor of four, 1788watchers increases the processing time by more than a factor of four,
1698it to another server. This includes deleting the old timeout and creating 1866it to another server. This includes deleting the old timeout and creating
1699a new one that moves the timeout into the future. 1867a new one that moves the timeout into the future.
1700 1868
1701=head3 Results 1869=head3 Results
1702 1870
1703 name sockets create request 1871 name sockets create request
1704 EV 20000 69.01 11.16 1872 EV 20000 69.01 11.16
1705 Perl 20000 73.32 35.87 1873 Perl 20000 73.32 35.87
1874 IOAsync 20000 157.00 98.14 epoll
1875 IOAsync 20000 159.31 616.06 poll
1706 Event 20000 212.62 257.32 1876 Event 20000 212.62 257.32
1707 Glib 20000 651.16 1896.30 1877 Glib 20000 651.16 1896.30
1708 POE 20000 349.67 12317.24 uses POE::Loop::Event 1878 POE 20000 349.67 12317.24 uses POE::Loop::Event
1709 1879
1710=head3 Discussion 1880=head3 Discussion
1711 1881
1712This benchmark I<does> measure scalability and overall performance of the 1882This benchmark I<does> measure scalability and overall performance of the
1713particular event loop. 1883particular event loop.
1715EV is again fastest. Since it is using epoll on my system, the setup time 1885EV is again fastest. Since it is using epoll on my system, the setup time
1716is relatively high, though. 1886is relatively high, though.
1717 1887
1718Perl surprisingly comes second. It is much faster than the C-based event 1888Perl surprisingly comes second. It is much faster than the C-based event
1719loops Event and Glib. 1889loops Event and Glib.
1890
1891IO::Async performs very well when using its epoll backend, and still quite
1892good compared to Glib when using its pure perl backend.
1720 1893
1721Event suffers from high setup time as well (look at its code and you will 1894Event suffers from high setup time as well (look at its code and you will
1722understand why). Callback invocation also has a high overhead compared to 1895understand why). Callback invocation also has a high overhead compared to
1723the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 1896the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1724uses select or poll in basically all documented configurations. 1897uses select or poll in basically all documented configurations.
1787=item * C-based event loops perform very well with small number of 1960=item * C-based event loops perform very well with small number of
1788watchers, as the management overhead dominates. 1961watchers, as the management overhead dominates.
1789 1962
1790=back 1963=back
1791 1964
1965=head2 THE IO::Lambda BENCHMARK
1966
1967Recently I was told about the benchmark in the IO::Lambda manpage, which
1968could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
1969simply compares IO::Lambda with POE, and IO::Lambda looks better (which
1970shouldn't come as a surprise to anybody). As such, the benchmark is
1971fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
1972very optimal. But how would AnyEvent compare when used without the extra
1973baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
1974
1975The benchmark itself creates an echo-server, and then, for 500 times,
1976connects to the echo server, sends a line, waits for the reply, and then
1977creates the next connection. This is a rather bad benchmark, as it doesn't
1978test the efficiency of the framework or much non-blocking I/O, but it is a
1979benchmark nevertheless.
1980
1981 name runtime
1982 Lambda/select 0.330 sec
1983 + optimized 0.122 sec
1984 Lambda/AnyEvent 0.327 sec
1985 + optimized 0.138 sec
1986 Raw sockets/select 0.077 sec
1987 POE/select, components 0.662 sec
1988 POE/select, raw sockets 0.226 sec
1989 POE/select, optimized 0.404 sec
1990
1991 AnyEvent/select/nb 0.085 sec
1992 AnyEvent/EV/nb 0.068 sec
1993 +state machine 0.134 sec
1994
1995The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
1996benchmarks actually make blocking connects and use 100% blocking I/O,
1997defeating the purpose of an event-based solution. All of the newly
1998written AnyEvent benchmarks use 100% non-blocking connects (using
1999AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
2000resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
2001generally require a lot more bookkeeping and event handling than blocking
2002connects (which involve a single syscall only).
2003
2004The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
2005offers similar expressive power as POE and IO::Lambda, using conventional
2006Perl syntax. This means that both the echo server and the client are 100%
2007non-blocking, further placing it at a disadvantage.
2008
2009As you can see, the AnyEvent + EV combination even beats the
2010hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2011backend easily beats IO::Lambda and POE.
2012
2013And even the 100% non-blocking version written using the high-level (and
2014slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
2015large margin, even though it does all of DNS, tcp-connect and socket I/O
2016in a non-blocking way.
2017
2018The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2019F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2020part of the IO::lambda distribution and were used without any changes.
2021
1792 2022
1793=head1 SIGNALS 2023=head1 SIGNALS
1794 2024
1795AnyEvent currently installs handlers for these signals: 2025AnyEvent currently installs handlers for these signals:
1796 2026
1799=item SIGCHLD 2029=item SIGCHLD
1800 2030
1801A handler for C<SIGCHLD> is installed by AnyEvent's child watcher 2031A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1802emulation for event loops that do not support them natively. Also, some 2032emulation for event loops that do not support them natively. Also, some
1803event loops install a similar handler. 2033event loops install a similar handler.
2034
2035If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will
2036reset it to default, to avoid losing child exit statuses.
1804 2037
1805=item SIGPIPE 2038=item SIGPIPE
1806 2039
1807A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> 2040A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1808when AnyEvent gets loaded. 2041when AnyEvent gets loaded.
1820 2053
1821=back 2054=back
1822 2055
1823=cut 2056=cut
1824 2057
2058undef $SIG{CHLD}
2059 if $SIG{CHLD} eq 'IGNORE';
2060
1825$SIG{PIPE} = sub { } 2061$SIG{PIPE} = sub { }
1826 unless defined $SIG{PIPE}; 2062 unless defined $SIG{PIPE};
1827
1828 2063
1829=head1 FORK 2064=head1 FORK
1830 2065
1831Most event libraries are not fork-safe. The ones who are usually are 2066Most event libraries are not fork-safe. The ones who are usually are
1832because they rely on inefficient but fork-safe C<select> or C<poll> 2067because they rely on inefficient but fork-safe C<select> or C<poll>
1853 use AnyEvent; 2088 use AnyEvent;
1854 2089
1855Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2090Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1856be used to probe what backend is used and gain other information (which is 2091be used to probe what backend is used and gain other information (which is
1857probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and 2092probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1858$ENV{PERL_ANYEGENT_STRICT}. 2093$ENV{PERL_ANYEVENT_STRICT}.
2094
2095Note that AnyEvent will remove I<all> environment variables starting with
2096C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2097enabled.
1859 2098
1860 2099
1861=head1 BUGS 2100=head1 BUGS
1862 2101
1863Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 2102Perl 5.8 has numerous memleaks that sometimes hit this module and are hard

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines