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.164 by root, Tue Jul 8 19:50:25 2008 UTC vs.
Revision 1.211 by root, Sat Jun 6 12:04:30 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 { ... });
14
15 # one-shot or repeating timers
16 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
18
19 print AnyEvent->now; # prints current event loop time
20 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
21
22 # POSIX signal
23 my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
24
25 # child process exit
26 my $w = AnyEvent->child (pid => $pid, cb => sub {
27 my ($pid, $status) = @_;
12 ... 28 ...
13 }); 29 });
14 30
15 my $w = AnyEvent->timer (after => $seconds, cb => sub { 31 # called when event loop idle (if applicable)
16 ... 32 my $w = AnyEvent->idle (cb => sub { ... });
17 });
18 33
19 my $w = AnyEvent->condvar; # stores whether a condition was flagged 34 my $w = AnyEvent->condvar; # stores whether a condition was flagged
20 $w->send; # wake up current and all future recv's 35 $w->send; # wake up current and all future recv's
21 $w->recv; # enters "main loop" till $condvar gets ->send 36 $w->recv; # enters "main loop" till $condvar gets ->send
37 # use a condvar in callback mode:
38 $w->cb (sub { $_[0]->recv });
22 39
23=head1 INTRODUCTION/TUTORIAL 40=head1 INTRODUCTION/TUTORIAL
24 41
25This manpage is mainly a reference manual. If you are interested 42This manpage is mainly a reference manual. If you are interested
26in a tutorial or some gentle introduction, have a look at the 43in a tutorial or some gentle introduction, have a look at the
33 50
34Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of 51Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
35policy> and AnyEvent is I<small and efficient>. 52policy> and AnyEvent is I<small and efficient>.
36 53
37First and foremost, I<AnyEvent is not an event model> itself, it only 54First and foremost, I<AnyEvent is not an event model> itself, it only
38interfaces to whatever event model the main program happens to use in a 55interfaces to whatever event model the main program happens to use, in a
39pragmatic way. For event models and certain classes of immortals alike, 56pragmatic way. For event models and certain classes of immortals alike,
40the statement "there can only be one" is a bitter reality: In general, 57the statement "there can only be one" is a bitter reality: In general,
41only one event loop can be active at the same time in a process. AnyEvent 58only one event loop can be active at the same time in a process. AnyEvent
42helps hiding the differences between those event loops. 59cannot change this, but it can hide the differences between those event
60loops.
43 61
44The goal of AnyEvent is to offer module authors the ability to do event 62The goal of AnyEvent is to offer module authors the ability to do event
45programming (waiting for I/O or timer events) without subscribing to a 63programming (waiting for I/O or timer events) without subscribing to a
46religion, a way of living, and most importantly: without forcing your 64religion, a way of living, and most importantly: without forcing your
47module users into the same thing by forcing them to use the same event 65module users into the same thing by forcing them to use the same event
48model you use. 66model you use.
49 67
50For modules like POE or IO::Async (which is a total misnomer as it is 68For modules like POE or IO::Async (which is a total misnomer as it is
51actually doing all I/O I<synchronously>...), using them in your module is 69actually doing all I/O I<synchronously>...), using them in your module is
52like joining a cult: After you joined, you are dependent on them and you 70like joining a cult: After you joined, you are dependent on them and you
53cannot use anything else, as it is simply incompatible to everything that 71cannot use anything else, as they are simply incompatible to everything
54isn't itself. What's worse, all the potential users of your module are 72that isn't them. What's worse, all the potential users of your
55I<also> forced to use the same event loop you use. 73module are I<also> forced to use the same event loop you use.
56 74
57AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 75AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
58fine. AnyEvent + Tk works fine etc. etc. but none of these work together 76fine. AnyEvent + Tk works fine etc. etc. but none of these work together
59with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if 77with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
60your module uses one of those, every user of your module has to use it, 78your module uses one of those, every user of your module has to use it,
61too. But if your module uses AnyEvent, it works transparently with all 79too. But if your module uses AnyEvent, it works transparently with all
62event models it supports (including stuff like POE and IO::Async, as long 80event models it supports (including stuff like IO::Async, as long as those
63as those use one of the supported event loops. It is trivial to add new 81use one of the supported event loops. It is trivial to add new event loops
64event loops to AnyEvent, too, so it is future-proof). 82to AnyEvent, too, so it is future-proof).
65 83
66In addition to being free of having to use I<the one and only true event 84In addition to being free of having to use I<the one and only true event
67model>, AnyEvent also is free of bloat and policy: with POE or similar 85model>, AnyEvent also is free of bloat and policy: with POE or similar
68modules, you get an enormous amount of code and strict rules you have to 86modules, you get an enormous amount of code and strict rules you have to
69follow. AnyEvent, on the other hand, is lean and up to the point, by only 87follow. AnyEvent, on the other hand, is lean and up to the point, by only
127These watchers are normal Perl objects with normal Perl lifetime. After 145These watchers are normal Perl objects with normal Perl lifetime. After
128creating a watcher it will immediately "watch" for events and invoke the 146creating a watcher it will immediately "watch" for events and invoke the
129callback when the event occurs (of course, only when the event model 147callback when the event occurs (of course, only when the event model
130is in control). 148is in control).
131 149
150Note that B<callbacks must not permanently change global variables>
151potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
152callbacks must not C<die> >>. The former is good programming practise in
153Perl and the latter stems from the fact that exception handling differs
154widely between event loops.
155
132To disable the watcher you have to destroy it (e.g. by setting the 156To disable the watcher you have to destroy it (e.g. by setting the
133variable you store it in to C<undef> or otherwise deleting all references 157variable you store it in to C<undef> or otherwise deleting all references
134to it). 158to it).
135 159
136All watchers are created by calling a method on the C<AnyEvent> class. 160All watchers are created by calling a method on the C<AnyEvent> class.
152=head2 I/O WATCHERS 176=head2 I/O WATCHERS
153 177
154You 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
155with the following mandatory key-value pairs as arguments: 179with the following mandatory key-value pairs as arguments:
156 180
157C<fh> the Perl I<file handle> (I<not> file descriptor) to watch 181C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch
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
158for events. C<poll> must be a string that is either C<r> or C<w>, 188C<poll> must be a string that is either C<r> or C<w>, which creates a
159which creates a watcher waiting for "r"eadable or "w"ritable events, 189watcher waiting for "r"eadable or "w"ritable events, respectively.
190
160respectively. C<cb> is the callback to invoke each time the file handle 191C<cb> is the callback to invoke each time the file handle becomes ready.
161becomes ready.
162 192
163Although the callback might get passed parameters, their value and 193Although the callback might get passed parameters, their value and
164presence is undefined and you cannot rely on them. Portable AnyEvent 194presence is undefined and you cannot rely on them. Portable AnyEvent
165callbacks cannot use arguments passed to I/O watcher callbacks. 195callbacks cannot use arguments passed to I/O watcher callbacks.
166 196
193Although the callback might get passed parameters, their value and 223Although the callback might get passed parameters, their value and
194presence is undefined and you cannot rely on them. Portable AnyEvent 224presence is undefined and you cannot rely on them. Portable AnyEvent
195callbacks cannot use arguments passed to time watcher callbacks. 225callbacks cannot use arguments passed to time watcher callbacks.
196 226
197The callback will normally be invoked once only. If you specify another 227The callback will normally be invoked once only. If you specify another
198parameter, C<interval>, as a positive number, then the callback will be 228parameter, C<interval>, as a strictly positive number (> 0), then the
199invoked regularly at that interval (in fractional seconds) after the first 229callback will be invoked regularly at that interval (in fractional
200invocation. 230seconds) after the first invocation. If C<interval> is specified with a
231false value, then it is treated as if it were missing.
201 232
202The callback will be rescheduled before invoking the callback, but no 233The callback will be rescheduled before invoking the callback, but no
203attempt is done to avoid timer drift in most backends, so the interval is 234attempt is done to avoid timer drift in most backends, so the interval is
204only approximate. 235only approximate.
205 236
297In 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
298can 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
299difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 330difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
300account. 331account.
301 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
302=back 348=back
303 349
304=head2 SIGNAL WATCHERS 350=head2 SIGNAL WATCHERS
305 351
306You 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
307I<name> without any C<SIG> prefix, C<cb> is the Perl callback to 353I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
308be invoked whenever a signal occurs. 354callback to be invoked whenever a signal occurs.
309 355
310Although the callback might get passed parameters, their value and 356Although the callback might get passed parameters, their value and
311presence is undefined and you cannot rely on them. Portable AnyEvent 357presence is undefined and you cannot rely on them. Portable AnyEvent
312callbacks cannot use arguments passed to signal watcher callbacks. 358callbacks cannot use arguments passed to signal watcher callbacks.
313 359
329=head2 CHILD PROCESS WATCHERS 375=head2 CHILD PROCESS WATCHERS
330 376
331You can also watch on a child process exit and catch its exit status. 377You can also watch on a child process exit and catch its exit status.
332 378
333The child process is specified by the C<pid> argument (if set to C<0>, it 379The child process is specified by the C<pid> argument (if set to C<0>, it
334watches for any child process exit). The watcher will trigger as often 380watches for any child process exit). The watcher will triggered only when
335as status change for the child are received. This works by installing a 381the child process has finished and an exit status is available, not on
336signal handler for C<SIGCHLD>. The callback will be called with the pid 382any trace events (stopped/continued).
337and exit status (as returned by waitpid), so unlike other watcher types, 383
338you I<can> rely on child watcher callback arguments. 384The callback will be called with the pid and exit status (as returned by
385waitpid), so unlike other watcher types, you I<can> rely on child watcher
386callback arguments.
387
388This watcher type works by installing a signal handler for C<SIGCHLD>,
389and since it cannot be shared, nothing else should use SIGCHLD or reap
390random child processes (waiting for specific child processes, e.g. inside
391C<system>, is just fine).
339 392
340There 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
341I<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
342have exited already (and no SIGCHLD will be sent anymore). 395have exited already (and no SIGCHLD will be sent anymore).
343 396
365 ); 418 );
366 419
367 # do something else, then wait for process exit 420 # do something else, then wait for process exit
368 $done->recv; 421 $done->recv;
369 422
423=head2 IDLE WATCHERS
424
425Sometimes there is a need to do something, but it is not so important
426to do it instantly, but only when there is nothing better to do. This
427"nothing better to do" is usually defined to be "no other events need
428attention by the event loop".
429
430Idle watchers ideally get invoked when the event loop has nothing
431better to do, just before it would block the process to wait for new
432events. Instead of blocking, the idle watcher is invoked.
433
434Most event loops unfortunately do not really support idle watchers (only
435EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
436will simply call the callback "from time to time".
437
438Example: read lines from STDIN, but only process them when the
439program is otherwise idle:
440
441 my @lines; # read data
442 my $idle_w;
443 my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
444 push @lines, scalar <STDIN>;
445
446 # start an idle watcher, if not already done
447 $idle_w ||= AnyEvent->idle (cb => sub {
448 # handle only one line, when there are lines left
449 if (my $line = shift @lines) {
450 print "handled when idle: $line";
451 } else {
452 # otherwise disable the idle watcher again
453 undef $idle_w;
454 }
455 });
456 });
457
370=head2 CONDITION VARIABLES 458=head2 CONDITION VARIABLES
371 459
372If you are familiar with some event loops you will know that all of them 460If you are familiar with some event loops you will know that all of them
373require you to run some blocking "loop", "run" or similar function that 461require you to run some blocking "loop", "run" or similar function that
374will actively watch for new events and call your callbacks. 462will actively watch for new events and call your callbacks.
379The instrument to do that is called a "condition variable", so called 467The instrument to do that is called a "condition variable", so called
380because they represent a condition that must become true. 468because they represent a condition that must become true.
381 469
382Condition variables can be created by calling the C<< AnyEvent->condvar 470Condition variables can be created by calling the C<< AnyEvent->condvar
383>> method, usually without arguments. The only argument pair allowed is 471>> method, usually without arguments. The only argument pair allowed is
472
384C<cb>, which specifies a callback to be called when the condition variable 473C<cb>, which specifies a callback to be called when the condition variable
385becomes true. 474becomes true, with the condition variable as the first argument (but not
475the results).
386 476
387After creation, the condition variable is "false" until it becomes "true" 477After creation, the condition variable is "false" until it becomes "true"
388by calling the C<send> method (or calling the condition variable as if it 478by calling the C<send> method (or calling the condition variable as if it
389were a callback, read about the caveats in the description for the C<< 479were a callback, read about the caveats in the description for the C<<
390->send >> method). 480->send >> method).
446 536
447 my $done = AnyEvent->condvar; 537 my $done = AnyEvent->condvar;
448 my $delay = AnyEvent->timer (after => 5, cb => $done); 538 my $delay = AnyEvent->timer (after => 5, cb => $done);
449 $done->recv; 539 $done->recv;
450 540
541Example: Imagine an API that returns a condvar and doesn't support
542callbacks. This is how you make a synchronous call, for example from
543the main program:
544
545 use AnyEvent::CouchDB;
546
547 ...
548
549 my @info = $couchdb->info->recv;
550
551And this is how you would just ste a callback to be called whenever the
552results are available:
553
554 $couchdb->info->cb (sub {
555 my @info = $_[0]->recv;
556 });
557
451=head3 METHODS FOR PRODUCERS 558=head3 METHODS FOR PRODUCERS
452 559
453These methods should only be used by the producing side, i.e. the 560These methods should only be used by the producing side, i.e. the
454code/module that eventually sends the signal. Note that it is also 561code/module that eventually sends the signal. Note that it is also
455the producer side which creates the condvar in most cases, but it isn't 562the producer side which creates the condvar in most cases, but it isn't
588=item $bool = $cv->ready 695=item $bool = $cv->ready
589 696
590Returns true when the condition is "true", i.e. whether C<send> or 697Returns true when the condition is "true", i.e. whether C<send> or
591C<croak> have been called. 698C<croak> have been called.
592 699
593=item $cb = $cv->cb ([new callback]) 700=item $cb = $cv->cb ($cb->($cv))
594 701
595This is a mutator function that returns the callback set and optionally 702This is a mutator function that returns the callback set and optionally
596replaces it before doing so. 703replaces it before doing so.
597 704
598The callback will be called when the condition becomes "true", i.e. when 705The callback will be called when the condition becomes "true", i.e. when
788=item L<AnyEvent::IGS> 895=item L<AnyEvent::IGS>
789 896
790A non-blocking interface to the Internet Go Server protocol (used by 897A non-blocking interface to the Internet Go Server protocol (used by
791L<App::IGS>). 898L<App::IGS>).
792 899
793=item L<Net::IRC3> 900=item L<AnyEvent::IRC>
794 901
795AnyEvent based IRC client module family. 902AnyEvent based IRC client module family (replacing the older Net::IRC3).
796 903
797=item L<Net::XMPP2> 904=item L<Net::XMPP2>
798 905
799AnyEvent based XMPP (Jabber protocol) module family. 906AnyEvent based XMPP (Jabber protocol) module family.
800 907
820=cut 927=cut
821 928
822package AnyEvent; 929package AnyEvent;
823 930
824no warnings; 931no warnings;
825use strict; 932use strict qw(vars subs);
826 933
827use Carp; 934use Carp;
828 935
829our $VERSION = 4.2; 936our $VERSION = 4.41;
830our $MODEL; 937our $MODEL;
831 938
832our $AUTOLOAD; 939our $AUTOLOAD;
833our @ISA; 940our @ISA;
834 941
866 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 973 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
867 [Wx:: => AnyEvent::Impl::POE::], 974 [Wx:: => AnyEvent::Impl::POE::],
868 [Prima:: => AnyEvent::Impl::POE::], 975 [Prima:: => AnyEvent::Impl::POE::],
869); 976);
870 977
871our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); 978our %method = map +($_ => 1),
979 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
872 980
873our @post_detect; 981our @post_detect;
874 982
875sub post_detect(&) { 983sub post_detect(&) {
876 my ($cb) = @_; 984 my ($cb) = @_;
881 1 989 1
882 } else { 990 } else {
883 push @post_detect, $cb; 991 push @post_detect, $cb;
884 992
885 defined wantarray 993 defined wantarray
886 ? bless \$cb, "AnyEvent::Util::PostDetect" 994 ? bless \$cb, "AnyEvent::Util::postdetect"
887 : () 995 : ()
888 } 996 }
889} 997}
890 998
891sub AnyEvent::Util::PostDetect::DESTROY { 999sub AnyEvent::Util::postdetect::DESTROY {
892 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1000 @post_detect = grep $_ != ${$_[0]}, @post_detect;
893} 1001}
894 1002
895sub detect() { 1003sub detect() {
896 unless ($MODEL) { 1004 unless ($MODEL) {
933 last; 1041 last;
934 } 1042 }
935 } 1043 }
936 1044
937 $MODEL 1045 $MODEL
938 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 1046 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
939 } 1047 }
940 } 1048 }
941 1049
1050 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1051
942 unshift @ISA, $MODEL; 1052 unshift @ISA, $MODEL;
943 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1053
1054 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
944 1055
945 (shift @post_detect)->() while @post_detect; 1056 (shift @post_detect)->() while @post_detect;
946 } 1057 }
947 1058
948 $MODEL 1059 $MODEL
958 1069
959 my $class = shift; 1070 my $class = shift;
960 $class->$func (@_); 1071 $class->$func (@_);
961} 1072}
962 1073
1074# utility function to dup a filehandle. this is used by many backends
1075# to support binding more than one watcher per filehandle (they usually
1076# allow only one watcher per fd, so we dup it to get a different one).
1077sub _dupfh($$$$) {
1078 my ($poll, $fh, $r, $w) = @_;
1079
1080 # cygwin requires the fh mode to be matching, unix doesn't
1081 my ($rw, $mode) = $poll eq "r" ? ($r, "<")
1082 : $poll eq "w" ? ($w, ">")
1083 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1084
1085 open my $fh2, "$mode&" . fileno $fh
1086 or die "cannot dup() filehandle: $!,";
1087
1088 # we assume CLOEXEC is already set by perl in all important cases
1089
1090 ($fh2, $rw)
1091}
1092
963package AnyEvent::Base; 1093package AnyEvent::Base;
964 1094
965# default implementation for now and time 1095# default implementations for many methods
966 1096
967use Time::HiRes (); 1097BEGIN {
1098 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1099 *_time = \&Time::HiRes::time;
1100 # if (eval "use POSIX (); (POSIX::times())...
1101 } else {
1102 *_time = sub { time }; # epic fail
1103 }
1104}
968 1105
969sub time { Time::HiRes::time } 1106sub time { _time }
970sub now { Time::HiRes::time } 1107sub now { _time }
1108sub now_update { }
971 1109
972# default implementation for ->condvar 1110# default implementation for ->condvar
973 1111
974sub condvar { 1112sub condvar {
975 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1113 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
976} 1114}
977 1115
978# default implementation for ->signal 1116# default implementation for ->signal
979 1117
980our %SIG_CB; 1118our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1119
1120sub _signal_exec {
1121 sysread $SIGPIPE_R, my $dummy, 4;
1122
1123 while (%SIG_EV) {
1124 for (keys %SIG_EV) {
1125 delete $SIG_EV{$_};
1126 $_->() for values %{ $SIG_CB{$_} || {} };
1127 }
1128 }
1129}
981 1130
982sub signal { 1131sub signal {
983 my (undef, %arg) = @_; 1132 my (undef, %arg) = @_;
984 1133
1134 unless ($SIGPIPE_R) {
1135 require Fcntl;
1136
1137 if (AnyEvent::WIN32) {
1138 require AnyEvent::Util;
1139
1140 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1141 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1142 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1143 } else {
1144 pipe $SIGPIPE_R, $SIGPIPE_W;
1145 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1146 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1147
1148 # not strictly required, as $^F is normally 2, but let's make sure...
1149 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1150 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1151 }
1152
1153 $SIGPIPE_R
1154 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1155
1156 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1157 }
1158
985 my $signal = uc $arg{signal} 1159 my $signal = uc $arg{signal}
986 or Carp::croak "required option 'signal' is missing"; 1160 or Carp::croak "required option 'signal' is missing";
987 1161
988 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1162 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
989 $SIG{$signal} ||= sub { 1163 $SIG{$signal} ||= sub {
990 $_->() for values %{ $SIG_CB{$signal} || {} }; 1164 local $!;
1165 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1166 undef $SIG_EV{$signal};
991 }; 1167 };
992 1168
993 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1169 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
994} 1170}
995 1171
996sub AnyEvent::Base::Signal::DESTROY { 1172sub AnyEvent::Base::signal::DESTROY {
997 my ($signal, $cb) = @{$_[0]}; 1173 my ($signal, $cb) = @{$_[0]};
998 1174
999 delete $SIG_CB{$signal}{$cb}; 1175 delete $SIG_CB{$signal}{$cb};
1000 1176
1177 # delete doesn't work with older perls - they then
1178 # print weird messages, or just unconditionally exit
1179 # instead of getting the default action.
1001 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; 1180 undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1002} 1181}
1003 1182
1004# default implementation for ->child 1183# default implementation for ->child
1005 1184
1006our %PID_CB; 1185our %PID_CB;
1007our $CHLD_W; 1186our $CHLD_W;
1008our $CHLD_DELAY_W; 1187our $CHLD_DELAY_W;
1009our $PID_IDLE;
1010our $WNOHANG; 1188our $WNOHANG;
1011 1189
1012sub _child_wait { 1190sub _sigchld {
1013 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1191 while (0 < (my $pid = waitpid -1, $WNOHANG)) {
1014 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1192 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),
1015 (values %{ $PID_CB{0} || {} }); 1193 (values %{ $PID_CB{0} || {} });
1016 } 1194 }
1017
1018 undef $PID_IDLE;
1019}
1020
1021sub _sigchld {
1022 # make sure we deliver these changes "synchronous" with the event loop.
1023 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1024 undef $CHLD_DELAY_W;
1025 &_child_wait;
1026 });
1027} 1195}
1028 1196
1029sub child { 1197sub child {
1030 my (undef, %arg) = @_; 1198 my (undef, %arg) = @_;
1031 1199
1032 defined (my $pid = $arg{pid} + 0) 1200 defined (my $pid = $arg{pid} + 0)
1033 or Carp::croak "required option 'pid' is missing"; 1201 or Carp::croak "required option 'pid' is missing";
1034 1202
1035 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1203 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1036 1204
1037 unless ($WNOHANG) {
1038 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1205 $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1039 }
1040 1206
1041 unless ($CHLD_W) { 1207 unless ($CHLD_W) {
1042 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1208 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1043 # child could be a zombie already, so make at least one round 1209 # child could be a zombie already, so make at least one round
1044 &_sigchld; 1210 &_sigchld;
1045 } 1211 }
1046 1212
1047 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1213 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1048} 1214}
1049 1215
1050sub AnyEvent::Base::Child::DESTROY { 1216sub AnyEvent::Base::child::DESTROY {
1051 my ($pid, $cb) = @{$_[0]}; 1217 my ($pid, $cb) = @{$_[0]};
1052 1218
1053 delete $PID_CB{$pid}{$cb}; 1219 delete $PID_CB{$pid}{$cb};
1054 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1220 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1055 1221
1056 undef $CHLD_W unless keys %PID_CB; 1222 undef $CHLD_W unless keys %PID_CB;
1223}
1224
1225# idle emulation is done by simply using a timer, regardless
1226# of whether the process is idle or not, and not letting
1227# the callback use more than 50% of the time.
1228sub idle {
1229 my (undef, %arg) = @_;
1230
1231 my ($cb, $w, $rcb) = $arg{cb};
1232
1233 $rcb = sub {
1234 if ($cb) {
1235 $w = _time;
1236 &$cb;
1237 $w = _time - $w;
1238
1239 # never use more then 50% of the time for the idle watcher,
1240 # within some limits
1241 $w = 0.0001 if $w < 0.0001;
1242 $w = 5 if $w > 5;
1243
1244 $w = AnyEvent->timer (after => $w, cb => $rcb);
1245 } else {
1246 # clean up...
1247 undef $w;
1248 undef $rcb;
1249 }
1250 };
1251
1252 $w = AnyEvent->timer (after => 0.05, cb => $rcb);
1253
1254 bless \\$cb, "AnyEvent::Base::idle"
1255}
1256
1257sub AnyEvent::Base::idle::DESTROY {
1258 undef $${$_[0]};
1057} 1259}
1058 1260
1059package AnyEvent::CondVar; 1261package AnyEvent::CondVar;
1060 1262
1061our @ISA = AnyEvent::CondVar::Base::; 1263our @ISA = AnyEvent::CondVar::Base::;
1113} 1315}
1114 1316
1115# undocumented/compatibility with pre-3.4 1317# undocumented/compatibility with pre-3.4
1116*broadcast = \&send; 1318*broadcast = \&send;
1117*wait = \&_wait; 1319*wait = \&_wait;
1320
1321=head1 ERROR AND EXCEPTION HANDLING
1322
1323In general, AnyEvent does not do any error handling - it relies on the
1324caller to do that if required. The L<AnyEvent::Strict> module (see also
1325the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
1326checking of all AnyEvent methods, however, which is highly useful during
1327development.
1328
1329As for exception handling (i.e. runtime errors and exceptions thrown while
1330executing a callback), this is not only highly event-loop specific, but
1331also not in any way wrapped by this module, as this is the job of the main
1332program.
1333
1334The pure perl event loop simply re-throws the exception (usually
1335within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
1336$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1337so on.
1338
1339=head1 ENVIRONMENT VARIABLES
1340
1341The following environment variables are used by this module or its
1342submodules:
1343
1344=over 4
1345
1346=item C<PERL_ANYEVENT_VERBOSE>
1347
1348By default, AnyEvent will be completely silent except in fatal
1349conditions. You can set this environment variable to make AnyEvent more
1350talkative.
1351
1352When set to C<1> or higher, causes AnyEvent to warn about unexpected
1353conditions, such as not being able to load the event model specified by
1354C<PERL_ANYEVENT_MODEL>.
1355
1356When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1357model it chooses.
1358
1359=item C<PERL_ANYEVENT_STRICT>
1360
1361AnyEvent does not do much argument checking by default, as thorough
1362argument checking is very costly. Setting this variable to a true value
1363will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1364check the arguments passed to most method calls. If it finds any problems
1365it will croak.
1366
1367In other words, enables "strict" mode.
1368
1369Unlike C<use strict>, it is definitely recommended ot keep it off in
1370production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
1371developing programs can be very useful, however.
1372
1373=item C<PERL_ANYEVENT_MODEL>
1374
1375This can be used to specify the event model to be used by AnyEvent, before
1376auto detection and -probing kicks in. It must be a string consisting
1377entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1378and the resulting module name is loaded and if the load was successful,
1379used as event model. If it fails to load AnyEvent will proceed with
1380auto detection and -probing.
1381
1382This functionality might change in future versions.
1383
1384For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1385could start your program like this:
1386
1387 PERL_ANYEVENT_MODEL=Perl perl ...
1388
1389=item C<PERL_ANYEVENT_PROTOCOLS>
1390
1391Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1392for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1393of auto probing).
1394
1395Must be set to a comma-separated list of protocols or address families,
1396current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1397used, and preference will be given to protocols mentioned earlier in the
1398list.
1399
1400This variable can effectively be used for denial-of-service attacks
1401against local programs (e.g. when setuid), although the impact is likely
1402small, as the program has to handle conenction and other failures anyways.
1403
1404Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1405but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1406- only support IPv4, never try to resolve or contact IPv6
1407addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1408IPv6, but prefer IPv6 over IPv4.
1409
1410=item C<PERL_ANYEVENT_EDNS0>
1411
1412Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1413for DNS. This extension is generally useful to reduce DNS traffic, but
1414some (broken) firewalls drop such DNS packets, which is why it is off by
1415default.
1416
1417Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1418EDNS0 in its DNS requests.
1419
1420=item C<PERL_ANYEVENT_MAX_FORKS>
1421
1422The maximum number of child processes that C<AnyEvent::Util::fork_call>
1423will create in parallel.
1424
1425=back
1118 1426
1119=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1427=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1120 1428
1121This is an advanced topic that you do not normally need to use AnyEvent in 1429This is an advanced topic that you do not normally need to use AnyEvent in
1122a module. This section is only of use to event loop authors who want to 1430a module. This section is only of use to event loop authors who want to
1156 1464
1157I<rxvt-unicode> also cheats a bit by not providing blocking access to 1465I<rxvt-unicode> also cheats a bit by not providing blocking access to
1158condition variables: code blocking while waiting for a condition will 1466condition variables: code blocking while waiting for a condition will
1159C<die>. This still works with most modules/usages, and blocking calls must 1467C<die>. This still works with most modules/usages, and blocking calls must
1160not be done in an interactive application, so it makes sense. 1468not be done in an interactive application, so it makes sense.
1161
1162=head1 ENVIRONMENT VARIABLES
1163
1164The following environment variables are used by this module:
1165
1166=over 4
1167
1168=item C<PERL_ANYEVENT_VERBOSE>
1169
1170By default, AnyEvent will be completely silent except in fatal
1171conditions. You can set this environment variable to make AnyEvent more
1172talkative.
1173
1174When set to C<1> or higher, causes AnyEvent to warn about unexpected
1175conditions, such as not being able to load the event model specified by
1176C<PERL_ANYEVENT_MODEL>.
1177
1178When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1179model it chooses.
1180
1181=item C<PERL_ANYEVENT_MODEL>
1182
1183This can be used to specify the event model to be used by AnyEvent, before
1184auto detection and -probing kicks in. It must be a string consisting
1185entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1186and the resulting module name is loaded and if the load was successful,
1187used as event model. If it fails to load AnyEvent will proceed with
1188auto detection and -probing.
1189
1190This functionality might change in future versions.
1191
1192For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1193could start your program like this:
1194
1195 PERL_ANYEVENT_MODEL=Perl perl ...
1196
1197=item C<PERL_ANYEVENT_PROTOCOLS>
1198
1199Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1200for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1201of auto probing).
1202
1203Must be set to a comma-separated list of protocols or address families,
1204current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1205used, and preference will be given to protocols mentioned earlier in the
1206list.
1207
1208This variable can effectively be used for denial-of-service attacks
1209against local programs (e.g. when setuid), although the impact is likely
1210small, as the program has to handle connection errors already-
1211
1212Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1213but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1214- only support IPv4, never try to resolve or contact IPv6
1215addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1216IPv6, but prefer IPv6 over IPv4.
1217
1218=item C<PERL_ANYEVENT_EDNS0>
1219
1220Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1221for DNS. This extension is generally useful to reduce DNS traffic, but
1222some (broken) firewalls drop such DNS packets, which is why it is off by
1223default.
1224
1225Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1226EDNS0 in its DNS requests.
1227
1228=item C<PERL_ANYEVENT_MAX_FORKS>
1229
1230The maximum number of child processes that C<AnyEvent::Util::fork_call>
1231will create in parallel.
1232
1233=back
1234 1469
1235=head1 EXAMPLE PROGRAM 1470=head1 EXAMPLE PROGRAM
1236 1471
1237The following program uses an I/O watcher to read data from STDIN, a timer 1472The following program uses an I/O watcher to read data from STDIN, a timer
1238to display a message once per second, and a condition variable to quit the 1473to display a message once per second, and a condition variable to quit the
1432watcher. 1667watcher.
1433 1668
1434=head3 Results 1669=head3 Results
1435 1670
1436 name watchers bytes create invoke destroy comment 1671 name watchers bytes create invoke destroy comment
1437 EV/EV 400000 244 0.56 0.46 0.31 EV native interface 1672 EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1438 EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers 1673 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1439 CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal 1674 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1440 Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation 1675 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1441 Event/Event 16000 516 31.88 31.30 0.85 Event native interface 1676 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1442 Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers 1677 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1443 Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour 1678 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1444 Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers 1679 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1445 POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event 1680 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1446 POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select 1681 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1447 1682
1448=head3 Discussion 1683=head3 Discussion
1449 1684
1450The benchmark does I<not> measure scalability of the event loop very 1685The benchmark does I<not> measure scalability of the event loop very
1451well. For example, a select-based event loop (such as the pure perl one) 1686well. For example, a select-based event loop (such as the pure perl one)
1653watchers, as the management overhead dominates. 1888watchers, as the management overhead dominates.
1654 1889
1655=back 1890=back
1656 1891
1657 1892
1893=head1 SIGNALS
1894
1895AnyEvent currently installs handlers for these signals:
1896
1897=over 4
1898
1899=item SIGCHLD
1900
1901A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1902emulation for event loops that do not support them natively. Also, some
1903event loops install a similar handler.
1904
1905=item SIGPIPE
1906
1907A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1908when AnyEvent gets loaded.
1909
1910The rationale for this is that AnyEvent users usually do not really depend
1911on SIGPIPE delivery (which is purely an optimisation for shell use, or
1912badly-written programs), but C<SIGPIPE> can cause spurious and rare
1913program exits as a lot of people do not expect C<SIGPIPE> when writing to
1914some random socket.
1915
1916The rationale for installing a no-op handler as opposed to ignoring it is
1917that this way, the handler will be restored to defaults on exec.
1918
1919Feel free to install your own handler, or reset it to defaults.
1920
1921=back
1922
1923=cut
1924
1925$SIG{PIPE} = sub { }
1926 unless defined $SIG{PIPE};
1927
1928
1658=head1 FORK 1929=head1 FORK
1659 1930
1660Most event libraries are not fork-safe. The ones who are usually are 1931Most event libraries are not fork-safe. The ones who are usually are
1661because they rely on inefficient but fork-safe C<select> or C<poll> 1932because they rely on inefficient but fork-safe C<select> or C<poll>
1662calls. Only L<EV> is fully fork-aware. 1933calls. Only L<EV> is fully fork-aware.
1681 1952
1682 use AnyEvent; 1953 use AnyEvent;
1683 1954
1684Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 1955Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1685be used to probe what backend is used and gain other information (which is 1956be used to probe what backend is used and gain other information (which is
1686probably even less useful to an attacker than PERL_ANYEVENT_MODEL). 1957probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1958$ENV{PERL_ANYEGENT_STRICT}.
1687 1959
1688 1960
1689=head1 BUGS 1961=head1 BUGS
1690 1962
1691Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 1963Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1692to work around. If you suffer from memleaks, first upgrade to Perl 5.10 1964to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1693and check wether the leaks still show up. (Perl 5.10.0 has other annoying 1965and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1694mamleaks, such as leaking on C<map> and C<grep> but it is usually not as 1966memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1695pronounced). 1967pronounced).
1696 1968
1697 1969
1698=head1 SEE ALSO 1970=head1 SEE ALSO
1699 1971

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines