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.202 by root, Wed Apr 1 15:29:00 2009 UTC vs.
Revision 1.228 by root, Wed Jul 8 01:11: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> (I<not> file descriptor, see below) to
174for events (AnyEvent might or might not keep a reference to this file 182watch for events (AnyEvent might or might not keep a reference to this
175handle). Note that only file handles pointing to things for which 183file handle). 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.
179 187
180C<poll> must be a string that is either C<r> or C<w>, which creates a 188C<poll> must be a string that is either C<r> or C<w>, which creates a
201 chomp (my $input = <STDIN>); 209 chomp (my $input = <STDIN>);
202 warn "read: $input\n"; 210 warn "read: $input\n";
203 undef $w; 211 undef $w;
204 }); 212 });
205 213
214=head3 GETTING A FILE HANDLE FROM A FILE DESCRIPTOR
215
216It is not uncommon to only have a file descriptor, while AnyEvent requires
217a Perl file handle.
218
219There are basically two methods to convert a file descriptor into a file handle. If you own
220the file descriptor, you can open it with C<&=>, as in:
221
222 open my $fh, "<&=$fileno" or die "xxx: ยง!";
223
224This will "own" the file descriptor, meaning that when C<$fh> is
225destroyed, it will automatically close the C<$fileno>. Also, note that
226the open mode (read, write, read/write) must correspond with how the
227underlying file descriptor was opened.
228
229In many cases, taking over the file descriptor is now what you want, in
230which case the only alternative is to dup the file descriptor:
231
232 open my $fh, "<&$fileno" or die "xxx: $!";
233
234This has the advantage of not closing the file descriptor and the
235disadvantage of making a slow copy.
236
206=head2 TIME WATCHERS 237=head2 TIME WATCHERS
207 238
208You can create a time watcher by calling the C<< AnyEvent->timer >> 239You can create a time watcher by calling the C<< AnyEvent->timer >>
209method with the following mandatory arguments: 240method with the following mandatory arguments:
210 241
320In either case, if you care (and in most cases, you don't), then you 351In either case, if you care (and in most cases, you don't), then you
321can get whatever behaviour you want with any event loop, by taking the 352can get whatever behaviour you want with any event loop, by taking the
322difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 353difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
323account. 354account.
324 355
356=item AnyEvent->now_update
357
358Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
359the current time for each loop iteration (see the discussion of L<<
360AnyEvent->now >>, above).
361
362When a callback runs for a long time (or when the process sleeps), then
363this "current" time will differ substantially from the real time, which
364might affect timers and time-outs.
365
366When this is the case, you can call this method, which will update the
367event loop's idea of "current time".
368
369Note that updating the time I<might> cause some events to be handled.
370
325=back 371=back
326 372
327=head2 SIGNAL WATCHERS 373=head2 SIGNAL WATCHERS
328 374
329You can watch for signals using a signal watcher, C<signal> is the signal 375You can watch for signals using a signal watcher, C<signal> is the signal
369 415
370There is a slight catch to child watchers, however: you usually start them 416There is a slight catch to child watchers, however: you usually start them
371I<after> the child process was created, and this means the process could 417I<after> the child process was created, and this means the process could
372have exited already (and no SIGCHLD will be sent anymore). 418have exited already (and no SIGCHLD will be sent anymore).
373 419
374Not all event models handle this correctly (POE doesn't), but even for 420Not all event models handle this correctly (neither POE nor IO::Async do,
421see their AnyEvent::Impl manpages for details), but even for event models
375event models that I<do> handle this correctly, they usually need to be 422that I<do> handle this correctly, they usually need to be loaded before
376loaded before the process exits (i.e. before you fork in the first place). 423the process exits (i.e. before you fork in the first place). AnyEvent's
424pure perl event loop handles all cases correctly regardless of when you
425start the watcher.
377 426
378This means you cannot create a child watcher as the very first thing in an 427This means you cannot create a child watcher as the very first
379AnyEvent program, you I<have> to create at least one watcher before you 428thing in an AnyEvent program, you I<have> to create at least one
380C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 429watcher before you C<fork> the child (alternatively, you can call
430C<AnyEvent::detect>).
381 431
382Example: fork a process and wait for it 432Example: fork a process and wait for it
383 433
384 my $done = AnyEvent->condvar; 434 my $done = AnyEvent->condvar;
385 435
395 ); 445 );
396 446
397 # do something else, then wait for process exit 447 # do something else, then wait for process exit
398 $done->recv; 448 $done->recv;
399 449
450=head2 IDLE WATCHERS
451
452Sometimes there is a need to do something, but it is not so important
453to do it instantly, but only when there is nothing better to do. This
454"nothing better to do" is usually defined to be "no other events need
455attention by the event loop".
456
457Idle watchers ideally get invoked when the event loop has nothing
458better to do, just before it would block the process to wait for new
459events. Instead of blocking, the idle watcher is invoked.
460
461Most event loops unfortunately do not really support idle watchers (only
462EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
463will simply call the callback "from time to time".
464
465Example: read lines from STDIN, but only process them when the
466program is otherwise idle:
467
468 my @lines; # read data
469 my $idle_w;
470 my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
471 push @lines, scalar <STDIN>;
472
473 # start an idle watcher, if not already done
474 $idle_w ||= AnyEvent->idle (cb => sub {
475 # handle only one line, when there are lines left
476 if (my $line = shift @lines) {
477 print "handled when idle: $line";
478 } else {
479 # otherwise disable the idle watcher again
480 undef $idle_w;
481 }
482 });
483 });
484
400=head2 CONDITION VARIABLES 485=head2 CONDITION VARIABLES
401 486
402If you are familiar with some event loops you will know that all of them 487If you are familiar with some event loops you will know that all of them
403require you to run some blocking "loop", "run" or similar function that 488require you to run some blocking "loop", "run" or similar function that
404will actively watch for new events and call your callbacks. 489will actively watch for new events and call your callbacks.
537 622
538=item $cv->begin ([group callback]) 623=item $cv->begin ([group callback])
539 624
540=item $cv->end 625=item $cv->end
541 626
542These two methods are EXPERIMENTAL and MIGHT CHANGE.
543
544These two methods can be used to combine many transactions/events into 627These two methods can be used to combine many transactions/events into
545one. For example, a function that pings many hosts in parallel might want 628one. For example, a function that pings many hosts in parallel might want
546to use a condition variable for the whole process. 629to use a condition variable for the whole process.
547 630
548Every call to C<< ->begin >> will increment a counter, and every call to 631Every call to C<< ->begin >> will increment a counter, and every call to
549C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 632C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
550>>, the (last) callback passed to C<begin> will be executed. That callback 633>>, the (last) callback passed to C<begin> will be executed. That callback
551is I<supposed> to call C<< ->send >>, but that is not required. If no 634is I<supposed> to call C<< ->send >>, but that is not required. If no
552callback was set, C<send> will be called without any arguments. 635callback was set, C<send> will be called without any arguments.
553 636
554Let's clarify this with the ping example: 637You can think of C<< $cv->send >> giving you an OR condition (one call
638sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
639condition (all C<begin> calls must be C<end>'ed before the condvar sends).
640
641Let's start with a simple example: you have two I/O watchers (for example,
642STDOUT and STDERR for a program), and you want to wait for both streams to
643close before activating a condvar:
644
645 my $cv = AnyEvent->condvar;
646
647 $cv->begin; # first watcher
648 my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
649 defined sysread $fh1, my $buf, 4096
650 or $cv->end;
651 });
652
653 $cv->begin; # second watcher
654 my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
655 defined sysread $fh2, my $buf, 4096
656 or $cv->end;
657 });
658
659 $cv->recv;
660
661This works because for every event source (EOF on file handle), there is
662one call to C<begin>, so the condvar waits for all calls to C<end> before
663sending.
664
665The ping example mentioned above is slightly more complicated, as the
666there are results to be passwd back, and the number of tasks that are
667begung can potentially be zero:
555 668
556 my $cv = AnyEvent->condvar; 669 my $cv = AnyEvent->condvar;
557 670
558 my %result; 671 my %result;
559 $cv->begin (sub { $cv->send (\%result) }); 672 $cv->begin (sub { $cv->send (\%result) });
579loop, which serves two important purposes: first, it sets the callback 692loop, which serves two important purposes: first, it sets the callback
580to be called once the counter reaches C<0>, and second, it ensures that 693to be called once the counter reaches C<0>, and second, it ensures that
581C<send> is called even when C<no> hosts are being pinged (the loop 694C<send> is called even when C<no> hosts are being pinged (the loop
582doesn't execute once). 695doesn't execute once).
583 696
584This is the general pattern when you "fan out" into multiple subrequests: 697This is the general pattern when you "fan out" into multiple (but
585use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 698potentially none) subrequests: use an outer C<begin>/C<end> pair to set
586is called at least once, and then, for each subrequest you start, call 699the callback and ensure C<end> is called at least once, and then, for each
587C<begin> and for each subrequest you finish, call C<end>. 700subrequest you start, call C<begin> and for each subrequest you finish,
701call C<end>.
588 702
589=back 703=back
590 704
591=head3 METHODS FOR CONSUMERS 705=head3 METHODS FOR CONSUMERS
592 706
672 AnyEvent::Impl::Tk based on Tk, very bad choice. 786 AnyEvent::Impl::Tk based on Tk, very bad choice.
673 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). 787 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
674 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 788 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
675 AnyEvent::Impl::POE based on POE, not generic enough for full support. 789 AnyEvent::Impl::POE based on POE, not generic enough for full support.
676 790
791 # warning, support for IO::Async is only partial, as it is too broken
792 # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
793 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
794
677There is no support for WxWidgets, as WxWidgets has no support for 795There is no support for WxWidgets, as WxWidgets has no support for
678watching file handles. However, you can use WxWidgets through the 796watching file handles. However, you can use WxWidgets through the
679POE Adaptor, as POE has a Wx backend that simply polls 20 times per 797POE Adaptor, as POE has a Wx backend that simply polls 20 times per
680second, which was considered to be too horrible to even consider for 798second, which was considered to be too horrible to even consider for
681AnyEvent. Likewise, other POE backends can be used by AnyEvent by using 799AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
873no warnings; 991no warnings;
874use strict qw(vars subs); 992use strict qw(vars subs);
875 993
876use Carp; 994use Carp;
877 995
878our $VERSION = 4.35; 996our $VERSION = 4.8;
879our $MODEL; 997our $MODEL;
880 998
881our $AUTOLOAD; 999our $AUTOLOAD;
882our @ISA; 1000our @ISA;
883 1001
884our @REGISTRY; 1002our @REGISTRY;
885 1003
886our $WIN32; 1004our $WIN32;
887 1005
888BEGIN { 1006BEGIN {
889 my $win32 = ! ! ($^O =~ /mswin32/i); 1007 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
890 eval "sub WIN32(){ $win32 }"; 1008 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
1009
1010 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1011 if ${^TAINT};
891} 1012}
892 1013
893our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1014our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
894 1015
895our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1016our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
913 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1034 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
914 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1035 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
915 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1036 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
916 [Wx:: => AnyEvent::Impl::POE::], 1037 [Wx:: => AnyEvent::Impl::POE::],
917 [Prima:: => AnyEvent::Impl::POE::], 1038 [Prima:: => AnyEvent::Impl::POE::],
1039 # IO::Async is just too broken - we would need workaorunds for its
1040 # byzantine signal and broken child handling, among others.
1041 # IO::Async is rather hard to detect, as it doesn't have any
1042 # obvious default class.
1043# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1044# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1045# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
918); 1046);
919 1047
920our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); 1048our %method = map +($_ => 1),
1049 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
921 1050
922our @post_detect; 1051our @post_detect;
923 1052
924sub post_detect(&) { 1053sub post_detect(&) {
925 my ($cb) = @_; 1054 my ($cb) = @_;
930 1 1059 1
931 } else { 1060 } else {
932 push @post_detect, $cb; 1061 push @post_detect, $cb;
933 1062
934 defined wantarray 1063 defined wantarray
935 ? bless \$cb, "AnyEvent::Util::PostDetect" 1064 ? bless \$cb, "AnyEvent::Util::postdetect"
936 : () 1065 : ()
937 } 1066 }
938} 1067}
939 1068
940sub AnyEvent::Util::PostDetect::DESTROY { 1069sub AnyEvent::Util::postdetect::DESTROY {
941 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1070 @post_detect = grep $_ != ${$_[0]}, @post_detect;
942} 1071}
943 1072
944sub detect() { 1073sub detect() {
945 unless ($MODEL) { 1074 unless ($MODEL) {
982 last; 1111 last;
983 } 1112 }
984 } 1113 }
985 1114
986 $MODEL 1115 $MODEL
987 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 1116 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
988 } 1117 }
989 } 1118 }
990 1119
991 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1120 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
992 1121
1013} 1142}
1014 1143
1015# utility function to dup a filehandle. this is used by many backends 1144# utility function to dup a filehandle. this is used by many backends
1016# to support binding more than one watcher per filehandle (they usually 1145# 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). 1146# allow only one watcher per fd, so we dup it to get a different one).
1018sub _dupfh($$$$) { 1147sub _dupfh($$;$$) {
1019 my ($poll, $fh, $r, $w) = @_; 1148 my ($poll, $fh, $r, $w) = @_;
1020 1149
1021 # cygwin requires the fh mode to be matching, unix doesn't 1150 # cygwin requires the fh mode to be matching, unix doesn't
1022 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1151 my ($rw, $mode) = $poll eq "r" ? ($r, "<")
1023 : $poll eq "w" ? ($w, ">") 1152 : $poll eq "w" ? ($w, ">")
1024 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; 1153 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1025 1154
1026 open my $fh2, "$mode&" . fileno $fh 1155 open my $fh2, "$mode&" . fileno $fh
1027 or die "cannot dup() filehandle: $!"; 1156 or die "cannot dup() filehandle: $!,";
1028 1157
1029 # we assume CLOEXEC is already set by perl in all important cases 1158 # we assume CLOEXEC is already set by perl in all important cases
1030 1159
1031 ($fh2, $rw) 1160 ($fh2, $rw)
1032} 1161}
1033 1162
1034package AnyEvent::Base; 1163package AnyEvent::Base;
1035 1164
1036# default implementation for now and time 1165# default implementations for many methods
1037 1166
1038BEGIN { 1167BEGIN {
1039 if (eval "use Time::HiRes (); time (); 1") { 1168 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1040 *_time = \&Time::HiRes::time; 1169 *_time = \&Time::HiRes::time;
1041 # if (eval "use POSIX (); (POSIX::times())... 1170 # if (eval "use POSIX (); (POSIX::times())...
1042 } else { 1171 } else {
1043 *_time = sub { time }; # epic fail 1172 *_time = sub { time }; # epic fail
1044 } 1173 }
1045} 1174}
1046 1175
1047sub time { _time } 1176sub time { _time }
1048sub now { _time } 1177sub now { _time }
1178sub now_update { }
1049 1179
1050# default implementation for ->condvar 1180# default implementation for ->condvar
1051 1181
1052sub condvar { 1182sub condvar {
1053 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1183 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1054} 1184}
1055 1185
1056# default implementation for ->signal 1186# default implementation for ->signal
1057 1187
1058our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1188our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1082 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case 1212 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1083 } else { 1213 } else {
1084 pipe $SIGPIPE_R, $SIGPIPE_W; 1214 pipe $SIGPIPE_R, $SIGPIPE_W;
1085 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; 1215 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 1216 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1217
1218 # not strictly required, as $^F is normally 2, but let's make sure...
1219 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1220 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1087 } 1221 }
1088 1222
1089 $SIGPIPE_R 1223 $SIGPIPE_R
1090 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1224 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 1225
1096 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1226 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1097 } 1227 }
1098 1228
1099 my $signal = uc $arg{signal} 1229 my $signal = uc $arg{signal}
1104 local $!; 1234 local $!;
1105 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1235 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1106 undef $SIG_EV{$signal}; 1236 undef $SIG_EV{$signal};
1107 }; 1237 };
1108 1238
1109 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1239 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1110} 1240}
1111 1241
1112sub AnyEvent::Base::Signal::DESTROY { 1242sub AnyEvent::Base::signal::DESTROY {
1113 my ($signal, $cb) = @{$_[0]}; 1243 my ($signal, $cb) = @{$_[0]};
1114 1244
1115 delete $SIG_CB{$signal}{$cb}; 1245 delete $SIG_CB{$signal}{$cb};
1116 1246
1247 # delete doesn't work with older perls - they then
1248 # print weird messages, or just unconditionally exit
1249 # instead of getting the default action.
1117 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; 1250 undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1118} 1251}
1119 1252
1120# default implementation for ->child 1253# default implementation for ->child
1121 1254
1122our %PID_CB; 1255our %PID_CB;
1123our $CHLD_W; 1256our $CHLD_W;
1124our $CHLD_DELAY_W; 1257our $CHLD_DELAY_W;
1125our $PID_IDLE;
1126our $WNOHANG; 1258our $WNOHANG;
1127 1259
1128sub _child_wait { 1260sub _sigchld {
1129 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1261 while (0 < (my $pid = waitpid -1, $WNOHANG)) {
1130 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1262 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),
1131 (values %{ $PID_CB{0} || {} }); 1263 (values %{ $PID_CB{0} || {} });
1132 } 1264 }
1133
1134 undef $PID_IDLE;
1135}
1136
1137sub _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} 1265}
1144 1266
1145sub child { 1267sub child {
1146 my (undef, %arg) = @_; 1268 my (undef, %arg) = @_;
1147 1269
1148 defined (my $pid = $arg{pid} + 0) 1270 defined (my $pid = $arg{pid} + 0)
1149 or Carp::croak "required option 'pid' is missing"; 1271 or Carp::croak "required option 'pid' is missing";
1150 1272
1151 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1273 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1152 1274
1153 unless ($WNOHANG) {
1154 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1275 $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1155 }
1156 1276
1157 unless ($CHLD_W) { 1277 unless ($CHLD_W) {
1158 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1278 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1159 # child could be a zombie already, so make at least one round 1279 # child could be a zombie already, so make at least one round
1160 &_sigchld; 1280 &_sigchld;
1161 } 1281 }
1162 1282
1163 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1283 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1164} 1284}
1165 1285
1166sub AnyEvent::Base::Child::DESTROY { 1286sub AnyEvent::Base::child::DESTROY {
1167 my ($pid, $cb) = @{$_[0]}; 1287 my ($pid, $cb) = @{$_[0]};
1168 1288
1169 delete $PID_CB{$pid}{$cb}; 1289 delete $PID_CB{$pid}{$cb};
1170 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1290 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1171 1291
1172 undef $CHLD_W unless keys %PID_CB; 1292 undef $CHLD_W unless keys %PID_CB;
1293}
1294
1295# idle emulation is done by simply using a timer, regardless
1296# of whether the process is idle or not, and not letting
1297# the callback use more than 50% of the time.
1298sub idle {
1299 my (undef, %arg) = @_;
1300
1301 my ($cb, $w, $rcb) = $arg{cb};
1302
1303 $rcb = sub {
1304 if ($cb) {
1305 $w = _time;
1306 &$cb;
1307 $w = _time - $w;
1308
1309 # never use more then 50% of the time for the idle watcher,
1310 # within some limits
1311 $w = 0.0001 if $w < 0.0001;
1312 $w = 5 if $w > 5;
1313
1314 $w = AnyEvent->timer (after => $w, cb => $rcb);
1315 } else {
1316 # clean up...
1317 undef $w;
1318 undef $rcb;
1319 }
1320 };
1321
1322 $w = AnyEvent->timer (after => 0.05, cb => $rcb);
1323
1324 bless \\$cb, "AnyEvent::Base::idle"
1325}
1326
1327sub AnyEvent::Base::idle::DESTROY {
1328 undef $${$_[0]};
1173} 1329}
1174 1330
1175package AnyEvent::CondVar; 1331package AnyEvent::CondVar;
1176 1332
1177our @ISA = AnyEvent::CondVar::Base::; 1333our @ISA = AnyEvent::CondVar::Base::;
1251so on. 1407so on.
1252 1408
1253=head1 ENVIRONMENT VARIABLES 1409=head1 ENVIRONMENT VARIABLES
1254 1410
1255The following environment variables are used by this module or its 1411The following environment variables are used by this module or its
1256submodules: 1412submodules.
1413
1414Note that AnyEvent will remove I<all> environment variables starting with
1415C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
1416enabled.
1257 1417
1258=over 4 1418=over 4
1259 1419
1260=item C<PERL_ANYEVENT_VERBOSE> 1420=item C<PERL_ANYEVENT_VERBOSE>
1261 1421
1273=item C<PERL_ANYEVENT_STRICT> 1433=item C<PERL_ANYEVENT_STRICT>
1274 1434
1275AnyEvent does not do much argument checking by default, as thorough 1435AnyEvent does not do much argument checking by default, as thorough
1276argument checking is very costly. Setting this variable to a true value 1436argument checking is very costly. Setting this variable to a true value
1277will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly 1437will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1278check the arguments passed to most method calls. If it finds any problems 1438check the arguments passed to most method calls. If it finds any problems,
1279it will croak. 1439it will croak.
1280 1440
1281In other words, enables "strict" mode. 1441In other words, enables "strict" mode.
1282 1442
1283Unlike C<use strict>, it is definitely recommended ot keep it off in 1443Unlike C<use strict>, it is definitely recommended to keep it off in
1284production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while 1444production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
1285developing programs can be very useful, however. 1445developing programs can be very useful, however.
1286 1446
1287=item C<PERL_ANYEVENT_MODEL> 1447=item C<PERL_ANYEVENT_MODEL>
1288 1448
1333 1493
1334=item C<PERL_ANYEVENT_MAX_FORKS> 1494=item C<PERL_ANYEVENT_MAX_FORKS>
1335 1495
1336The maximum number of child processes that C<AnyEvent::Util::fork_call> 1496The maximum number of child processes that C<AnyEvent::Util::fork_call>
1337will create in parallel. 1497will create in parallel.
1498
1499=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1500
1501The default value for the C<max_outstanding> parameter for the default DNS
1502resolver - this is the maximum number of parallel DNS requests that are
1503sent to the DNS server.
1504
1505=item C<PERL_ANYEVENT_RESOLV_CONF>
1506
1507The file to use instead of F</etc/resolv.conf> (or OS-specific
1508configuration) in the default resolver. When set to the empty string, no
1509default config will be used.
1510
1511=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1512
1513When neither C<ca_file> nor C<ca_path> was specified during
1514L<AnyEvent::TLS> context creation, and either of these environment
1515variables exist, they will be used to specify CA certificate locations
1516instead of a system-dependent default.
1338 1517
1339=back 1518=back
1340 1519
1341=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1520=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1342 1521
1587 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 1766 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1588 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 1767 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1589 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 1768 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1590 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 1769 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1591 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 1770 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1771 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
1772 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1592 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 1773 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1593 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 1774 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1594 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 1775 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1595 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 1776 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1596 1777
1625performance becomes really bad with lots of file descriptors (and few of 1806performance becomes really bad with lots of file descriptors (and few of
1626them active), of course, but this was not subject of this benchmark. 1807them active), of course, but this was not subject of this benchmark.
1627 1808
1628The C<Event> module has a relatively high setup and callback invocation 1809The C<Event> module has a relatively high setup and callback invocation
1629cost, but overall scores in on the third place. 1810cost, but overall scores in on the third place.
1811
1812C<IO::Async> performs admirably well, about on par with C<Event>, even
1813when using its pure perl backend.
1630 1814
1631C<Glib>'s memory usage is quite a bit higher, but it features a 1815C<Glib>'s memory usage is quite a bit higher, but it features a
1632faster callback invocation and overall ends up in the same class as 1816faster callback invocation and overall ends up in the same class as
1633C<Event>. However, Glib scales extremely badly, doubling the number of 1817C<Event>. However, Glib scales extremely badly, doubling the number of
1634watchers increases the processing time by more than a factor of four, 1818watchers increases the processing time by more than a factor of four,
1712it to another server. This includes deleting the old timeout and creating 1896it to another server. This includes deleting the old timeout and creating
1713a new one that moves the timeout into the future. 1897a new one that moves the timeout into the future.
1714 1898
1715=head3 Results 1899=head3 Results
1716 1900
1717 name sockets create request 1901 name sockets create request
1718 EV 20000 69.01 11.16 1902 EV 20000 69.01 11.16
1719 Perl 20000 73.32 35.87 1903 Perl 20000 73.32 35.87
1904 IOAsync 20000 157.00 98.14 epoll
1905 IOAsync 20000 159.31 616.06 poll
1720 Event 20000 212.62 257.32 1906 Event 20000 212.62 257.32
1721 Glib 20000 651.16 1896.30 1907 Glib 20000 651.16 1896.30
1722 POE 20000 349.67 12317.24 uses POE::Loop::Event 1908 POE 20000 349.67 12317.24 uses POE::Loop::Event
1723 1909
1724=head3 Discussion 1910=head3 Discussion
1725 1911
1726This benchmark I<does> measure scalability and overall performance of the 1912This benchmark I<does> measure scalability and overall performance of the
1727particular event loop. 1913particular event loop.
1729EV is again fastest. Since it is using epoll on my system, the setup time 1915EV is again fastest. Since it is using epoll on my system, the setup time
1730is relatively high, though. 1916is relatively high, though.
1731 1917
1732Perl surprisingly comes second. It is much faster than the C-based event 1918Perl surprisingly comes second. It is much faster than the C-based event
1733loops Event and Glib. 1919loops Event and Glib.
1920
1921IO::Async performs very well when using its epoll backend, and still quite
1922good compared to Glib when using its pure perl backend.
1734 1923
1735Event suffers from high setup time as well (look at its code and you will 1924Event suffers from high setup time as well (look at its code and you will
1736understand why). Callback invocation also has a high overhead compared to 1925understand why). Callback invocation also has a high overhead compared to
1737the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 1926the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1738uses select or poll in basically all documented configurations. 1927uses select or poll in basically all documented configurations.
1801=item * C-based event loops perform very well with small number of 1990=item * C-based event loops perform very well with small number of
1802watchers, as the management overhead dominates. 1991watchers, as the management overhead dominates.
1803 1992
1804=back 1993=back
1805 1994
1995=head2 THE IO::Lambda BENCHMARK
1996
1997Recently I was told about the benchmark in the IO::Lambda manpage, which
1998could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
1999simply compares IO::Lambda with POE, and IO::Lambda looks better (which
2000shouldn't come as a surprise to anybody). As such, the benchmark is
2001fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
2002very optimal. But how would AnyEvent compare when used without the extra
2003baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
2004
2005The benchmark itself creates an echo-server, and then, for 500 times,
2006connects to the echo server, sends a line, waits for the reply, and then
2007creates the next connection. This is a rather bad benchmark, as it doesn't
2008test the efficiency of the framework or much non-blocking I/O, but it is a
2009benchmark nevertheless.
2010
2011 name runtime
2012 Lambda/select 0.330 sec
2013 + optimized 0.122 sec
2014 Lambda/AnyEvent 0.327 sec
2015 + optimized 0.138 sec
2016 Raw sockets/select 0.077 sec
2017 POE/select, components 0.662 sec
2018 POE/select, raw sockets 0.226 sec
2019 POE/select, optimized 0.404 sec
2020
2021 AnyEvent/select/nb 0.085 sec
2022 AnyEvent/EV/nb 0.068 sec
2023 +state machine 0.134 sec
2024
2025The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
2026benchmarks actually make blocking connects and use 100% blocking I/O,
2027defeating the purpose of an event-based solution. All of the newly
2028written AnyEvent benchmarks use 100% non-blocking connects (using
2029AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
2030resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
2031generally require a lot more bookkeeping and event handling than blocking
2032connects (which involve a single syscall only).
2033
2034The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
2035offers similar expressive power as POE and IO::Lambda, using conventional
2036Perl syntax. This means that both the echo server and the client are 100%
2037non-blocking, further placing it at a disadvantage.
2038
2039As you can see, the AnyEvent + EV combination even beats the
2040hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2041backend easily beats IO::Lambda and POE.
2042
2043And even the 100% non-blocking version written using the high-level (and
2044slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
2045large margin, even though it does all of DNS, tcp-connect and socket I/O
2046in a non-blocking way.
2047
2048The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2049F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2050part of the IO::lambda distribution and were used without any changes.
2051
1806 2052
1807=head1 SIGNALS 2053=head1 SIGNALS
1808 2054
1809AnyEvent currently installs handlers for these signals: 2055AnyEvent currently installs handlers for these signals:
1810 2056
1813=item SIGCHLD 2059=item SIGCHLD
1814 2060
1815A handler for C<SIGCHLD> is installed by AnyEvent's child watcher 2061A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1816emulation for event loops that do not support them natively. Also, some 2062emulation for event loops that do not support them natively. Also, some
1817event loops install a similar handler. 2063event loops install a similar handler.
2064
2065If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will
2066reset it to default, to avoid losing child exit statuses.
1818 2067
1819=item SIGPIPE 2068=item SIGPIPE
1820 2069
1821A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> 2070A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1822when AnyEvent gets loaded. 2071when AnyEvent gets loaded.
1834 2083
1835=back 2084=back
1836 2085
1837=cut 2086=cut
1838 2087
2088undef $SIG{CHLD}
2089 if $SIG{CHLD} eq 'IGNORE';
2090
1839$SIG{PIPE} = sub { } 2091$SIG{PIPE} = sub { }
1840 unless defined $SIG{PIPE}; 2092 unless defined $SIG{PIPE};
1841
1842 2093
1843=head1 FORK 2094=head1 FORK
1844 2095
1845Most event libraries are not fork-safe. The ones who are usually are 2096Most event libraries are not fork-safe. The ones who are usually are
1846because they rely on inefficient but fork-safe C<select> or C<poll> 2097because they rely on inefficient but fork-safe C<select> or C<poll>
1867 use AnyEvent; 2118 use AnyEvent;
1868 2119
1869Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2120Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1870be used to probe what backend is used and gain other information (which is 2121be used to probe what backend is used and gain other information (which is
1871probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and 2122probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1872$ENV{PERL_ANYEGENT_STRICT}. 2123$ENV{PERL_ANYEVENT_STRICT}.
2124
2125Note that AnyEvent will remove I<all> environment variables starting with
2126C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2127enabled.
1873 2128
1874 2129
1875=head1 BUGS 2130=head1 BUGS
1876 2131
1877Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 2132Perl 5.8 has numerous memleaks that sometimes hit this module and are hard

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines