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.134 by root, Sun May 25 04:44:04 2008 UTC vs.
Revision 1.167 by root, Tue Jul 8 23:44:51 2008 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, POE - various supported event loops
6 6
17 }); 17 });
18 18
19 my $w = AnyEvent->condvar; # stores whether a condition was flagged 19 my $w = AnyEvent->condvar; # stores whether a condition was flagged
20 $w->send; # wake up current and all future recv's 20 $w->send; # wake up current and all future recv's
21 $w->recv; # enters "main loop" till $condvar gets ->send 21 $w->recv; # enters "main loop" till $condvar gets ->send
22
23=head1 INTRODUCTION/TUTORIAL
24
25This manpage is mainly a reference manual. If you are interested
26in a tutorial or some gentle introduction, have a look at the
27L<AnyEvent::Intro> manpage.
22 28
23=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 29=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24 30
25Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 31Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26nowadays. So what is different about AnyEvent? 32nowadays. So what is different about AnyEvent?
48isn't itself. What's worse, all the potential users of your module are 54isn't itself. What's worse, all the potential users of your module are
49I<also> forced to use the same event loop you use. 55I<also> forced to use the same event loop you use.
50 56
51AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 57AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
52fine. AnyEvent + Tk works fine etc. etc. but none of these work together 58fine. AnyEvent + Tk works fine etc. etc. but none of these work together
53with the rest: POE + IO::Async? no go. Tk + Event? no go. Again: if 59with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
54your module uses one of those, every user of your module has to use it, 60your module uses one of those, every user of your module has to use it,
55too. But if your module uses AnyEvent, it works transparently with all 61too. But if your module uses AnyEvent, it works transparently with all
56event models it supports (including stuff like POE and IO::Async, as long 62event models it supports (including stuff like POE and IO::Async, as long
57as those use one of the supported event loops. It is trivial to add new 63as those use one of the supported event loops. It is trivial to add new
58event loops to AnyEvent, too, so it is future-proof). 64event loops to AnyEvent, too, so it is future-proof).
62modules, you get an enormous amount of code and strict rules you have to 68modules, you get an enormous amount of code and strict rules you have to
63follow. AnyEvent, on the other hand, is lean and up to the point, by only 69follow. AnyEvent, on the other hand, is lean and up to the point, by only
64offering the functionality that is necessary, in as thin as a wrapper as 70offering the functionality that is necessary, in as thin as a wrapper as
65technically possible. 71technically possible.
66 72
73Of course, AnyEvent comes with a big (and fully optional!) toolbox
74of useful functionality, such as an asynchronous DNS resolver, 100%
75non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms
76such as Windows) and lots of real-world knowledge and workarounds for
77platform bugs and differences.
78
67Of course, if you want lots of policy (this can arguably be somewhat 79Now, if you I<do want> lots of policy (this can arguably be somewhat
68useful) and you want to force your users to use the one and only event 80useful) and you want to force your users to use the one and only event
69model, you should I<not> use this module. 81model, you should I<not> use this module.
70 82
71=head1 DESCRIPTION 83=head1 DESCRIPTION
72 84
102starts using it, all bets are off. Maybe you should tell their authors to 114starts using it, all bets are off. Maybe you should tell their authors to
103use AnyEvent so their modules work together with others seamlessly... 115use AnyEvent so their modules work together with others seamlessly...
104 116
105The pure-perl implementation of AnyEvent is called 117The pure-perl implementation of AnyEvent is called
106C<AnyEvent::Impl::Perl>. Like other event modules you can load it 118C<AnyEvent::Impl::Perl>. Like other event modules you can load it
107explicitly. 119explicitly and enjoy the high availability of that event loop :)
108 120
109=head1 WATCHERS 121=head1 WATCHERS
110 122
111AnyEvent has the central concept of a I<watcher>, which is an object that 123AnyEvent has the central concept of a I<watcher>, which is an object that
112stores relevant data for each kind of event you are waiting for, such as 124stores relevant data for each kind of event you are waiting for, such as
126Many watchers either are used with "recursion" (repeating timers for 138Many watchers either are used with "recursion" (repeating timers for
127example), or need to refer to their watcher object in other ways. 139example), or need to refer to their watcher object in other ways.
128 140
129An any way to achieve that is this pattern: 141An any way to achieve that is this pattern:
130 142
131 my $w; $w = AnyEvent->type (arg => value ..., cb => sub { 143 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
132 # you can use $w here, for example to undef it 144 # you can use $w here, for example to undef it
133 undef $w; 145 undef $w;
134 }); 146 });
135 147
136Note that C<my $w; $w => combination. This is necessary because in Perl, 148Note that C<my $w; $w => combination. This is necessary because in Perl,
137my variables are only visible after the statement in which they are 149my variables are only visible after the statement in which they are
138declared. 150declared.
139 151
140=head2 I/O WATCHERS 152=head2 I/O WATCHERS
141 153
142You can create an I/O watcher by calling the C<< AnyEvent->io >> method 154You can create an I/O watcher by calling the C<< AnyEvent->io >> method
143with the following mandatory key-value pairs as arguments: 155with the following mandatory key-value pairs as arguments:
144 156
145C<fh> the Perl I<file handle> (I<not> file descriptor) to watch 157C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events
146for events. C<poll> must be a string that is either C<r> or C<w>, 158(AnyEvent might or might not keep a reference to this file handle). C<poll>
147which creates a watcher waiting for "r"eadable or "w"ritable events, 159must be a string that is either C<r> or C<w>, which creates a watcher
148respectively. C<cb> is the callback to invoke each time the file handle 160waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the
149becomes ready. 161callback to invoke each time the file handle becomes ready.
150 162
151Although the callback might get passed parameters, their value and 163Although the callback might get passed parameters, their value and
152presence is undefined and you cannot rely on them. Portable AnyEvent 164presence is undefined and you cannot rely on them. Portable AnyEvent
153callbacks cannot use arguments passed to I/O watcher callbacks. 165callbacks cannot use arguments passed to I/O watcher callbacks.
154 166
158 170
159Some event loops issue spurious readyness notifications, so you should 171Some event loops issue spurious readyness notifications, so you should
160always use non-blocking calls when reading/writing from/to your file 172always use non-blocking calls when reading/writing from/to your file
161handles. 173handles.
162 174
163Example:
164
165 # wait for readability of STDIN, then read a line and disable the watcher 175Example: wait for readability of STDIN, then read a line and disable the
176watcher.
177
166 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { 178 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
167 chomp (my $input = <STDIN>); 179 chomp (my $input = <STDIN>);
168 warn "read: $input\n"; 180 warn "read: $input\n";
169 undef $w; 181 undef $w;
170 }); 182 });
180 192
181Although the callback might get passed parameters, their value and 193Although the callback might get passed parameters, their value and
182presence is undefined and you cannot rely on them. Portable AnyEvent 194presence is undefined and you cannot rely on them. Portable AnyEvent
183callbacks cannot use arguments passed to time watcher callbacks. 195callbacks cannot use arguments passed to time watcher callbacks.
184 196
185The timer callback will be invoked at most once: if you want a repeating 197The callback will normally be invoked once only. If you specify another
186timer you have to create a new watcher (this is a limitation by both Tk 198parameter, C<interval>, as a strictly positive number (> 0), then the
187and Glib). 199callback will be invoked regularly at that interval (in fractional
200seconds) after the first invocation. If C<interval> is specified with a
201false value, then it is treated as if it were missing.
188 202
189Example: 203The callback will be rescheduled before invoking the callback, but no
204attempt is done to avoid timer drift in most backends, so the interval is
205only approximate.
190 206
191 # fire an event after 7.7 seconds 207Example: fire an event after 7.7 seconds.
208
192 my $w = AnyEvent->timer (after => 7.7, cb => sub { 209 my $w = AnyEvent->timer (after => 7.7, cb => sub {
193 warn "timeout\n"; 210 warn "timeout\n";
194 }); 211 });
195 212
196 # to cancel the timer: 213 # to cancel the timer:
197 undef $w; 214 undef $w;
198 215
199Example 2:
200
201 # fire an event after 0.5 seconds, then roughly every second 216Example 2: fire an event after 0.5 seconds, then roughly every second.
202 my $w;
203 217
204 my $cb = sub {
205 # cancel the old timer while creating a new one
206 $w = AnyEvent->timer (after => 1, cb => $cb); 218 my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
219 warn "timeout\n";
207 }; 220 };
208
209 # start the "loop" by creating the first watcher
210 $w = AnyEvent->timer (after => 0.5, cb => $cb);
211 221
212=head3 TIMING ISSUES 222=head3 TIMING ISSUES
213 223
214There are two ways to handle timers: based on real time (relative, "fire 224There are two ways to handle timers: based on real time (relative, "fire
215in 10 seconds") and based on wallclock time (absolute, "fire at 12 225in 10 seconds") and based on wallclock time (absolute, "fire at 12
227timers. 237timers.
228 238
229AnyEvent always prefers relative timers, if available, matching the 239AnyEvent always prefers relative timers, if available, matching the
230AnyEvent API. 240AnyEvent API.
231 241
242AnyEvent has two additional methods that return the "current time":
243
244=over 4
245
246=item AnyEvent->time
247
248This returns the "current wallclock time" as a fractional number of
249seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>
250return, and the result is guaranteed to be compatible with those).
251
252It progresses independently of any event loop processing, i.e. each call
253will check the system clock, which usually gets updated frequently.
254
255=item AnyEvent->now
256
257This also returns the "current wallclock time", but unlike C<time>, above,
258this value might change only once per event loop iteration, depending on
259the event loop (most return the same time as C<time>, above). This is the
260time that AnyEvent's timers get scheduled against.
261
262I<In almost all cases (in all cases if you don't care), this is the
263function to call when you want to know the current time.>
264
265This function is also often faster then C<< AnyEvent->time >>, and
266thus the preferred method if you want some timestamp (for example,
267L<AnyEvent::Handle> uses this to update it's activity timeouts).
268
269The rest of this section is only of relevance if you try to be very exact
270with your timing, you can skip it without bad conscience.
271
272For a practical example of when these times differ, consider L<Event::Lib>
273and L<EV> and the following set-up:
274
275The event loop is running and has just invoked one of your callback at
276time=500 (assume no other callbacks delay processing). In your callback,
277you wait a second by executing C<sleep 1> (blocking the process for a
278second) and then (at time=501) you create a relative timer that fires
279after three seconds.
280
281With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will
282both return C<501>, because that is the current time, and the timer will
283be scheduled to fire at time=504 (C<501> + C<3>).
284
285With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current
286time), but C<< AnyEvent->now >> returns C<500>, as that is the time the
287last event processing phase started. With L<EV>, your timer gets scheduled
288to run at time=503 (C<500> + C<3>).
289
290In one sense, L<Event::Lib> is more exact, as it uses the current time
291regardless of any delays introduced by event processing. However, most
292callbacks do not expect large delays in processing, so this causes a
293higher drift (and a lot more system calls to get the current time).
294
295In another sense, L<EV> is more exact, as your timer will be scheduled at
296the same time, regardless of how long event processing actually took.
297
298In either case, if you care (and in most cases, you don't), then you
299can get whatever behaviour you want with any event loop, by taking the
300difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
301account.
302
303=back
304
232=head2 SIGNAL WATCHERS 305=head2 SIGNAL WATCHERS
233 306
234You can watch for signals using a signal watcher, C<signal> is the signal 307You can watch for signals using a signal watcher, C<signal> is the signal
235I<name> without any C<SIG> prefix, C<cb> is the Perl callback to 308I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
236be invoked whenever a signal occurs. 309callback to be invoked whenever a signal occurs.
237 310
238Although the callback might get passed parameters, their value and 311Although the callback might get passed parameters, their value and
239presence is undefined and you cannot rely on them. Portable AnyEvent 312presence is undefined and you cannot rely on them. Portable AnyEvent
240callbacks cannot use arguments passed to signal watcher callbacks. 313callbacks cannot use arguments passed to signal watcher callbacks.
241 314
277AnyEvent program, you I<have> to create at least one watcher before you 350AnyEvent program, you I<have> to create at least one watcher before you
278C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 351C<fork> the child (alternatively, you can call C<AnyEvent::detect>).
279 352
280Example: fork a process and wait for it 353Example: fork a process and wait for it
281 354
282 my $done = AnyEvent->condvar; 355 my $done = AnyEvent->condvar;
283 356
284 my $pid = fork or exit 5; 357 my $pid = fork or exit 5;
285 358
286 my $w = AnyEvent->child ( 359 my $w = AnyEvent->child (
287 pid => $pid, 360 pid => $pid,
288 cb => sub { 361 cb => sub {
289 my ($pid, $status) = @_; 362 my ($pid, $status) = @_;
290 warn "pid $pid exited with status $status"; 363 warn "pid $pid exited with status $status";
291 $done->send; 364 $done->send;
292 }, 365 },
293 ); 366 );
294 367
295 # do something else, then wait for process exit 368 # do something else, then wait for process exit
296 $done->recv; 369 $done->recv;
297 370
298=head2 CONDITION VARIABLES 371=head2 CONDITION VARIABLES
299 372
300If you are familiar with some event loops you will know that all of them 373If you are familiar with some event loops you will know that all of them
301require you to run some blocking "loop", "run" or similar function that 374require you to run some blocking "loop", "run" or similar function that
312C<cb>, which specifies a callback to be called when the condition variable 385C<cb>, which specifies a callback to be called when the condition variable
313becomes true. 386becomes true.
314 387
315After creation, the condition variable is "false" until it becomes "true" 388After creation, the condition variable is "false" until it becomes "true"
316by calling the C<send> method (or calling the condition variable as if it 389by calling the C<send> method (or calling the condition variable as if it
317were a callback). 390were a callback, read about the caveats in the description for the C<<
391->send >> method).
318 392
319Condition variables are similar to callbacks, except that you can 393Condition variables are similar to callbacks, except that you can
320optionally wait for them. They can also be called merge points - points 394optionally wait for them. They can also be called merge points - points
321in time where multiple outstanding events have been processed. And yet 395in time where multiple outstanding events have been processed. And yet
322another way to call them is transactions - each condition variable can be 396another way to call them is transactions - each condition variable can be
394immediately from within send. 468immediately from within send.
395 469
396Any arguments passed to the C<send> call will be returned by all 470Any arguments passed to the C<send> call will be returned by all
397future C<< ->recv >> calls. 471future C<< ->recv >> calls.
398 472
399Condition variables are overloaded so one can call them directly (as a 473Condition variables are overloaded so one can call them directly
400code reference). Calling them directly is the same as calling C<send>. 474(as a code reference). Calling them directly is the same as calling
475C<send>. Note, however, that many C-based event loops do not handle
476overloading, so as tempting as it may be, passing a condition variable
477instead of a callback does not work. Both the pure perl and EV loops
478support overloading, however, as well as all functions that use perl to
479invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
480example).
401 481
402=item $cv->croak ($error) 482=item $cv->croak ($error)
403 483
404Similar to send, but causes all call's to C<< ->recv >> to invoke 484Similar to send, but causes all call's to C<< ->recv >> to invoke
405C<Carp::croak> with the given error message/object/scalar. 485C<Carp::croak> with the given error message/object/scalar.
515 595
516This is a mutator function that returns the callback set and optionally 596This is a mutator function that returns the callback set and optionally
517replaces it before doing so. 597replaces it before doing so.
518 598
519The callback will be called when the condition becomes "true", i.e. when 599The callback will be called when the condition becomes "true", i.e. when
520C<send> or C<croak> are called. Calling C<recv> inside the callback 600C<send> or C<croak> are called, with the only argument being the condition
521or at any later time is guaranteed not to block. 601variable itself. Calling C<recv> inside the callback or at any later time
602is guaranteed not to block.
522 603
523=back 604=back
524 605
525=head1 GLOBAL VARIABLES AND FUNCTIONS 606=head1 GLOBAL VARIABLES AND FUNCTIONS
526 607
655=item L<AnyEvent::Util> 736=item L<AnyEvent::Util>
656 737
657Contains various utility functions that replace often-used but blocking 738Contains various utility functions that replace often-used but blocking
658functions such as C<inet_aton> by event-/callback-based versions. 739functions such as C<inet_aton> by event-/callback-based versions.
659 740
660=item L<AnyEvent::Handle>
661
662Provide read and write buffers and manages watchers for reads and writes.
663
664=item L<AnyEvent::Socket> 741=item L<AnyEvent::Socket>
665 742
666Provides various utility functions for (internet protocol) sockets, 743Provides various utility functions for (internet protocol) sockets,
667addresses and name resolution. Also functions to create non-blocking tcp 744addresses and name resolution. Also functions to create non-blocking tcp
668connections or tcp servers, with IPv6 and SRV record support and more. 745connections or tcp servers, with IPv6 and SRV record support and more.
669 746
747=item L<AnyEvent::Handle>
748
749Provide read and write buffers, manages watchers for reads and writes,
750supports raw and formatted I/O, I/O queued and fully transparent and
751non-blocking SSL/TLS.
752
670=item L<AnyEvent::DNS> 753=item L<AnyEvent::DNS>
671 754
672Provides rich asynchronous DNS resolver capabilities. 755Provides rich asynchronous DNS resolver capabilities.
673 756
757=item L<AnyEvent::HTTP>
758
759A simple-to-use HTTP library that is capable of making a lot of concurrent
760HTTP requests.
761
674=item L<AnyEvent::HTTPD> 762=item L<AnyEvent::HTTPD>
675 763
676Provides a simple web application server framework. 764Provides a simple web application server framework.
677 765
678=item L<AnyEvent::FastPing> 766=item L<AnyEvent::FastPing>
679 767
680The fastest ping in the west. 768The fastest ping in the west.
769
770=item L<AnyEvent::DBI>
771
772Executes L<DBI> requests asynchronously in a proxy process.
773
774=item L<AnyEvent::AIO>
775
776Truly asynchronous I/O, should be in the toolbox of every event
777programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
778together.
779
780=item L<AnyEvent::BDB>
781
782Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
783L<BDB> and AnyEvent together.
784
785=item L<AnyEvent::GPSD>
786
787A non-blocking interface to gpsd, a daemon delivering GPS information.
788
789=item L<AnyEvent::IGS>
790
791A non-blocking interface to the Internet Go Server protocol (used by
792L<App::IGS>).
681 793
682=item L<Net::IRC3> 794=item L<Net::IRC3>
683 795
684AnyEvent based IRC client module family. 796AnyEvent based IRC client module family.
685 797
698 810
699=item L<Coro> 811=item L<Coro>
700 812
701Has special support for AnyEvent via L<Coro::AnyEvent>. 813Has special support for AnyEvent via L<Coro::AnyEvent>.
702 814
703=item L<AnyEvent::AIO>, L<IO::AIO>
704
705Truly asynchronous I/O, should be in the toolbox of every event
706programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
707together.
708
709=item L<AnyEvent::BDB>, L<BDB>
710
711Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
712IO::AIO and AnyEvent together.
713
714=item L<IO::Lambda> 815=item L<IO::Lambda>
715 816
716The lambda approach to I/O - don't ask, look there. Can use AnyEvent. 817The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
717 818
718=back 819=back
724no warnings; 825no warnings;
725use strict; 826use strict;
726 827
727use Carp; 828use Carp;
728 829
729our $VERSION = '4.03'; 830our $VERSION = 4.2;
730our $MODEL; 831our $MODEL;
731 832
732our $AUTOLOAD; 833our $AUTOLOAD;
733our @ISA; 834our @ISA;
734 835
836our @REGISTRY;
837
838our $WIN32;
839
840BEGIN {
841 my $win32 = ! ! ($^O =~ /mswin32/i);
842 eval "sub WIN32(){ $win32 }";
843}
844
735our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 845our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
736 846
737our @REGISTRY; 847our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
738
739our %PROTOCOL; # (ipv4|ipv6) => (1|2)
740 848
741{ 849{
742 my $idx; 850 my $idx;
743 $PROTOCOL{$_} = ++$idx 851 $PROTOCOL{$_} = ++$idx
852 for reverse split /\s*,\s*/,
744 for split /\s*,\s*/, $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 853 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
745} 854}
746 855
747my @models = ( 856my @models = (
748 [EV:: => AnyEvent::Impl::EV::], 857 [EV:: => AnyEvent::Impl::EV::],
749 [Event:: => AnyEvent::Impl::Event::], 858 [Event:: => AnyEvent::Impl::Event::],
750 [Tk:: => AnyEvent::Impl::Tk::],
751 [Wx:: => AnyEvent::Impl::POE::],
752 [Prima:: => AnyEvent::Impl::POE::],
753 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 859 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
754 # everything below here will not be autoprobed as the pureperl backend should work everywhere 860 # everything below here will not be autoprobed
755 [Glib:: => AnyEvent::Impl::Glib::], 861 # as the pureperl backend should work everywhere
862 # and is usually faster
863 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
864 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
756 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 865 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
757 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 866 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
758 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 867 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
868 [Wx:: => AnyEvent::Impl::POE::],
869 [Prima:: => AnyEvent::Impl::POE::],
759); 870);
760 871
761our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); 872our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);
762 873
763our @post_detect; 874our @post_detect;
764 875
765sub post_detect(&) { 876sub post_detect(&) {
766 my ($cb) = @_; 877 my ($cb) = @_;
783} 894}
784 895
785sub detect() { 896sub detect() {
786 unless ($MODEL) { 897 unless ($MODEL) {
787 no strict 'refs'; 898 no strict 'refs';
899 local $SIG{__DIE__};
788 900
789 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 901 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
790 my $model = "AnyEvent::Impl::$1"; 902 my $model = "AnyEvent::Impl::$1";
791 if (eval "require $model") { 903 if (eval "require $model") {
792 $MODEL = $model; 904 $MODEL = $model;
826 $MODEL 938 $MODEL
827 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 939 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
828 } 940 }
829 } 941 }
830 942
831 unshift @ISA, $MODEL;
832 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 943 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
944
945 if ($ENV{PERL_ANYEVENT_STRICT}) {
946 unshift @AnyEvent::Base::Strict::ISA, $MODEL;
947 unshift @ISA, AnyEvent::Base::Strict::
948 } else {
949 unshift @ISA, $MODEL;
950 }
833 951
834 (shift @post_detect)->() while @post_detect; 952 (shift @post_detect)->() while @post_detect;
835 } 953 }
836 954
837 $MODEL 955 $MODEL
848 my $class = shift; 966 my $class = shift;
849 $class->$func (@_); 967 $class->$func (@_);
850} 968}
851 969
852package AnyEvent::Base; 970package AnyEvent::Base;
971
972# default implementation for now and time
973
974use Time::HiRes ();
975
976sub time { Time::HiRes::time }
977sub now { Time::HiRes::time }
853 978
854# default implementation for ->condvar 979# default implementation for ->condvar
855 980
856sub condvar { 981sub condvar {
857 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 982 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
878sub AnyEvent::Base::Signal::DESTROY { 1003sub AnyEvent::Base::Signal::DESTROY {
879 my ($signal, $cb) = @{$_[0]}; 1004 my ($signal, $cb) = @{$_[0]};
880 1005
881 delete $SIG_CB{$signal}{$cb}; 1006 delete $SIG_CB{$signal}{$cb};
882 1007
883 $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; 1008 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
884} 1009}
885 1010
886# default implementation for ->child 1011# default implementation for ->child
887 1012
888our %PID_CB; 1013our %PID_CB;
915 or Carp::croak "required option 'pid' is missing"; 1040 or Carp::croak "required option 'pid' is missing";
916 1041
917 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1042 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
918 1043
919 unless ($WNOHANG) { 1044 unless ($WNOHANG) {
920 $WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1; 1045 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
921 } 1046 }
922 1047
923 unless ($CHLD_W) { 1048 unless ($CHLD_W) {
924 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1049 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
925 # child could be a zombie already, so make at least one round 1050 # child could be a zombie already, so make at least one round
995} 1120}
996 1121
997# undocumented/compatibility with pre-3.4 1122# undocumented/compatibility with pre-3.4
998*broadcast = \&send; 1123*broadcast = \&send;
999*wait = \&_wait; 1124*wait = \&_wait;
1125
1126package AnyEvent::Base::Strict;
1127
1128use Carp qw(croak);
1129
1130# supply checks for argument validity for many functions
1131
1132sub io {
1133 my $class = shift;
1134 my %arg = @_;
1135
1136 ref $arg{cb}
1137 or croak "AnyEvent->io called with illegal cb argument '$arg{cb}'";
1138 delete $arg{cb};
1139
1140 fileno $arg{fh}
1141 or croak "AnyEvent->io called with illegal fh argument '$arg{fh}'";
1142 delete $arg{fh};
1143
1144 $arg{poll} =~ /^[rw]$/
1145 or croak "AnyEvent->io called with illegal poll argument '$arg{poll}'";
1146 delete $arg{poll};
1147
1148 croak "AnyEvent->io called with unsupported parameter(s) " . join ", ", keys %arg
1149 if keys %arg;
1150
1151 $class->SUPER::io (@_)
1152}
1153
1154sub timer {
1155 my $class = shift;
1156 my %arg = @_;
1157
1158 ref $arg{cb}
1159 or croak "AnyEvent->timer called with illegal cb argument '$arg{cb}'";
1160 delete $arg{cb};
1161
1162 exists $arg{after}
1163 or croak "AnyEvent->timer called without mandatory 'after' parameter";
1164 delete $arg{after};
1165
1166 $arg{interval} > 0 || !$arg{interval}
1167 or croak "AnyEvent->timer called with illegal interval argument '$arg{interval}'";
1168 delete $arg{interval};
1169
1170 croak "AnyEvent->timer called with unsupported parameter(s) " . join ", ", keys %arg
1171 if keys %arg;
1172
1173 $class->SUPER::timer (@_)
1174}
1175
1176sub signal {
1177 my $class = shift;
1178 my %arg = @_;
1179
1180 ref $arg{cb}
1181 or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'";
1182 delete $arg{cb};
1183
1184 eval "require POSIX; defined &POSIX::SIG$arg{signal}"
1185 or croak "AnyEvent->signal called with illegal signal name '$arg{signal}'";
1186 delete $arg{signal};
1187
1188 croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg
1189 if keys %arg;
1190
1191 $class->SUPER::signal (@_)
1192}
1193
1194sub child {
1195 my $class = shift;
1196 my %arg = @_;
1197
1198 ref $arg{cb}
1199 or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'";
1200 delete $arg{cb};
1201
1202 $arg{pid} =~ /^-?\d+$/
1203 or croak "AnyEvent->signal called with illegal pid value '$arg{pid}'";
1204 delete $arg{pid};
1205
1206 croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg
1207 if keys %arg;
1208
1209 $class->SUPER::child (@_)
1210}
1211
1212sub condvar {
1213 my $class = shift;
1214 my %arg = @_;
1215
1216 !exists $arg{cb} or ref $arg{cb}
1217 or croak "AnyEvent->condvar called with illegal cb argument '$arg{cb}'";
1218 delete $arg{cb};
1219
1220 croak "AnyEvent->condvar called with unsupported parameter(s) " . join ", ", keys %arg
1221 if keys %arg;
1222
1223 $class->SUPER::condvar (@_)
1224}
1225
1226sub time {
1227 my $class = shift;
1228
1229 @_
1230 and croak "AnyEvent->time wrongly called with paramaters";
1231
1232 $class->SUPER::time (@_)
1233}
1234
1235sub now {
1236 my $class = shift;
1237
1238 @_
1239 and croak "AnyEvent->now wrongly called with paramaters";
1240
1241 $class->SUPER::now (@_)
1242}
1000 1243
1001=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1244=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1002 1245
1003This is an advanced topic that you do not normally need to use AnyEvent in 1246This is an advanced topic that you do not normally need to use AnyEvent in
1004a module. This section is only of use to event loop authors who want to 1247a module. This section is only of use to event loop authors who want to
1058C<PERL_ANYEVENT_MODEL>. 1301C<PERL_ANYEVENT_MODEL>.
1059 1302
1060When set to C<2> or higher, cause AnyEvent to report to STDERR which event 1303When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1061model it chooses. 1304model it chooses.
1062 1305
1306=item C<PERL_ANYEVENT_STRICT>
1307
1308AnyEvent does not do much argument checking by default, as thorough
1309argument checking is very costly. Setting this variable to a true value
1310will cause AnyEvent to thoroughly check the arguments passed to most
1311method calls and croaks if it finds any problems. In other words, enables
1312"strict" mode. Unlike C<use strict> it is definitely recommended ot keep
1313it off in production.
1314
1063=item C<PERL_ANYEVENT_MODEL> 1315=item C<PERL_ANYEVENT_MODEL>
1064 1316
1065This can be used to specify the event model to be used by AnyEvent, before 1317This can be used to specify the event model to be used by AnyEvent, before
1066auto detection and -probing kicks in. It must be a string consisting 1318auto detection and -probing kicks in. It must be a string consisting
1067entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 1319entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1072This functionality might change in future versions. 1324This functionality might change in future versions.
1073 1325
1074For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 1326For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1075could start your program like this: 1327could start your program like this:
1076 1328
1077 PERL_ANYEVENT_MODEL=Perl perl ... 1329 PERL_ANYEVENT_MODEL=Perl perl ...
1078 1330
1079=item C<PERL_ANYEVENT_PROTOCOLS> 1331=item C<PERL_ANYEVENT_PROTOCOLS>
1080 1332
1081Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences 1333Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1082for IPv4 or IPv6. The default is unspecified (and might change, or be the result 1334for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1104some (broken) firewalls drop such DNS packets, which is why it is off by 1356some (broken) firewalls drop such DNS packets, which is why it is off by
1105default. 1357default.
1106 1358
1107Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce 1359Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1108EDNS0 in its DNS requests. 1360EDNS0 in its DNS requests.
1361
1362=item C<PERL_ANYEVENT_MAX_FORKS>
1363
1364The maximum number of child processes that C<AnyEvent::Util::fork_call>
1365will create in parallel.
1109 1366
1110=back 1367=back
1111 1368
1112=head1 EXAMPLE PROGRAM 1369=head1 EXAMPLE PROGRAM
1113 1370
1552specified in the variable. 1809specified in the variable.
1553 1810
1554You can make AnyEvent completely ignore this variable by deleting it 1811You can make AnyEvent completely ignore this variable by deleting it
1555before the first watcher gets created, e.g. with a C<BEGIN> block: 1812before the first watcher gets created, e.g. with a C<BEGIN> block:
1556 1813
1557 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } 1814 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1558 1815
1559 use AnyEvent; 1816 use AnyEvent;
1560 1817
1561Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 1818Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1562be used to probe what backend is used and gain other information (which is 1819be used to probe what backend is used and gain other information (which is
1563probably even less useful to an attacker than PERL_ANYEVENT_MODEL). 1820probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1821$ENV{PERL_ANYEGENT_STRICT}.
1822
1823
1824=head1 BUGS
1825
1826Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1827to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1828and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1829mamleaks, such as leaking on C<map> and C<grep> but it is usually not as
1830pronounced).
1564 1831
1565 1832
1566=head1 SEE ALSO 1833=head1 SEE ALSO
1567 1834
1568Utility functions: L<AnyEvent::Util>. 1835Utility functions: L<AnyEvent::Util>.
1585Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 1852Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1586 1853
1587 1854
1588=head1 AUTHOR 1855=head1 AUTHOR
1589 1856
1590 Marc Lehmann <schmorp@schmorp.de> 1857 Marc Lehmann <schmorp@schmorp.de>
1591 http://home.schmorp.de/ 1858 http://home.schmorp.de/
1592 1859
1593=cut 1860=cut
1594 1861
15951 18621
1596 1863

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines