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.159 by root, Fri Jun 6 16:19:19 2008 UTC vs.
Revision 1.249 by root, Mon Jul 20 06:00:42 2009 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - events independent of event loop implementation
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
27L<AnyEvent::Intro> manpage. 44L<AnyEvent::Intro> manpage.
28 45
46=head1 SUPPORT
47
48There is a mailinglist for discussing all things AnyEvent, and an IRC
49channel, too.
50
51See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52Respository>, at L<http://anyevent.schmorp.de>, for more info.
53
29=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 54=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
30 55
31Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 56Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
32nowadays. So what is different about AnyEvent? 57nowadays. So what is different about AnyEvent?
33 58
34Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of 59Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
35policy> and AnyEvent is I<small and efficient>. 60policy> and AnyEvent is I<small and efficient>.
36 61
37First and foremost, I<AnyEvent is not an event model> itself, it only 62First 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 63interfaces to whatever event model the main program happens to use, in a
39pragmatic way. For event models and certain classes of immortals alike, 64pragmatic way. For event models and certain classes of immortals alike,
40the statement "there can only be one" is a bitter reality: In general, 65the 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 66only one event loop can be active at the same time in a process. AnyEvent
42helps hiding the differences between those event loops. 67cannot change this, but it can hide the differences between those event
68loops.
43 69
44The goal of AnyEvent is to offer module authors the ability to do event 70The 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 71programming (waiting for I/O or timer events) without subscribing to a
46religion, a way of living, and most importantly: without forcing your 72religion, a way of living, and most importantly: without forcing your
47module users into the same thing by forcing them to use the same event 73module users into the same thing by forcing them to use the same event
48model you use. 74model you use.
49 75
50For modules like POE or IO::Async (which is a total misnomer as it is 76For 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 77actually 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 78like 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 79cannot use anything else, as they are simply incompatible to everything
54isn't itself. What's worse, all the potential users of your module are 80that isn't them. What's worse, all the potential users of your
55I<also> forced to use the same event loop you use. 81module are I<also> forced to use the same event loop you use.
56 82
57AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 83AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
58fine. AnyEvent + Tk works fine etc. etc. but none of these work together 84fine. 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 85with 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, 86your 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 87too. But if your module uses AnyEvent, it works transparently with all
62event models it supports (including stuff like POE and IO::Async, as long 88event 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 89use one of the supported event loops. It is trivial to add new event loops
64event loops to AnyEvent, too, so it is future-proof). 90to AnyEvent, too, so it is future-proof).
65 91
66In addition to being free of having to use I<the one and only true event 92In 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 93model>, 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 94modules, 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 95follow. 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 153These watchers are normal Perl objects with normal Perl lifetime. After
128creating a watcher it will immediately "watch" for events and invoke the 154creating a watcher it will immediately "watch" for events and invoke the
129callback when the event occurs (of course, only when the event model 155callback when the event occurs (of course, only when the event model
130is in control). 156is in control).
131 157
158Note that B<callbacks must not permanently change global variables>
159potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
160callbacks must not C<die> >>. The former is good programming practise in
161Perl and the latter stems from the fact that exception handling differs
162widely between event loops.
163
132To disable the watcher you have to destroy it (e.g. by setting the 164To 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 165variable you store it in to C<undef> or otherwise deleting all references
134to it). 166to it).
135 167
136All watchers are created by calling a method on the C<AnyEvent> class. 168All watchers are created by calling a method on the C<AnyEvent> class.
152=head2 I/O WATCHERS 184=head2 I/O WATCHERS
153 185
154You can create an I/O watcher by calling the C<< AnyEvent->io >> method 186You can create an I/O watcher by calling the C<< AnyEvent->io >> method
155with the following mandatory key-value pairs as arguments: 187with the following mandatory key-value pairs as arguments:
156 188
157C<fh> the Perl I<file handle> (I<not> file descriptor) to watch 189C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
190for events (AnyEvent might or might not keep a reference to this file
191handle). Note that only file handles pointing to things for which
192non-blocking operation makes sense are allowed. This includes sockets,
193most character devices, pipes, fifos and so on, but not for example files
194or block devices.
195
158for events. C<poll> must be a string that is either C<r> or C<w>, 196C<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, 197watcher waiting for "r"eadable or "w"ritable events, respectively.
198
160respectively. C<cb> is the callback to invoke each time the file handle 199C<cb> is the callback to invoke each time the file handle becomes ready.
161becomes ready.
162 200
163Although the callback might get passed parameters, their value and 201Although the callback might get passed parameters, their value and
164presence is undefined and you cannot rely on them. Portable AnyEvent 202presence is undefined and you cannot rely on them. Portable AnyEvent
165callbacks cannot use arguments passed to I/O watcher callbacks. 203callbacks cannot use arguments passed to I/O watcher callbacks.
166 204
170 208
171Some event loops issue spurious readyness notifications, so you should 209Some event loops issue spurious readyness notifications, so you should
172always use non-blocking calls when reading/writing from/to your file 210always use non-blocking calls when reading/writing from/to your file
173handles. 211handles.
174 212
175Example:
176
177 # wait for readability of STDIN, then read a line and disable the watcher 213Example: wait for readability of STDIN, then read a line and disable the
214watcher.
215
178 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { 216 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
179 chomp (my $input = <STDIN>); 217 chomp (my $input = <STDIN>);
180 warn "read: $input\n"; 218 warn "read: $input\n";
181 undef $w; 219 undef $w;
182 }); 220 });
192 230
193Although the callback might get passed parameters, their value and 231Although the callback might get passed parameters, their value and
194presence is undefined and you cannot rely on them. Portable AnyEvent 232presence is undefined and you cannot rely on them. Portable AnyEvent
195callbacks cannot use arguments passed to time watcher callbacks. 233callbacks cannot use arguments passed to time watcher callbacks.
196 234
197The timer callback will be invoked at most once: if you want a repeating 235The callback will normally be invoked once only. If you specify another
198timer you have to create a new watcher (this is a limitation by both Tk 236parameter, C<interval>, as a strictly positive number (> 0), then the
199and Glib). 237callback will be invoked regularly at that interval (in fractional
238seconds) after the first invocation. If C<interval> is specified with a
239false value, then it is treated as if it were missing.
200 240
201Example: 241The callback will be rescheduled before invoking the callback, but no
242attempt is done to avoid timer drift in most backends, so the interval is
243only approximate.
202 244
203 # fire an event after 7.7 seconds 245Example: fire an event after 7.7 seconds.
246
204 my $w = AnyEvent->timer (after => 7.7, cb => sub { 247 my $w = AnyEvent->timer (after => 7.7, cb => sub {
205 warn "timeout\n"; 248 warn "timeout\n";
206 }); 249 });
207 250
208 # to cancel the timer: 251 # to cancel the timer:
209 undef $w; 252 undef $w;
210 253
211Example 2:
212
213 # fire an event after 0.5 seconds, then roughly every second 254Example 2: fire an event after 0.5 seconds, then roughly every second.
214 my $w;
215 255
216 my $cb = sub {
217 # cancel the old timer while creating a new one
218 $w = AnyEvent->timer (after => 1, cb => $cb); 256 my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
257 warn "timeout\n";
219 }; 258 };
220
221 # start the "loop" by creating the first watcher
222 $w = AnyEvent->timer (after => 0.5, cb => $cb);
223 259
224=head3 TIMING ISSUES 260=head3 TIMING ISSUES
225 261
226There are two ways to handle timers: based on real time (relative, "fire 262There are two ways to handle timers: based on real time (relative, "fire
227in 10 seconds") and based on wallclock time (absolute, "fire at 12 263in 10 seconds") and based on wallclock time (absolute, "fire at 12
300In either case, if you care (and in most cases, you don't), then you 336In either case, if you care (and in most cases, you don't), then you
301can get whatever behaviour you want with any event loop, by taking the 337can get whatever behaviour you want with any event loop, by taking the
302difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 338difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
303account. 339account.
304 340
341=item AnyEvent->now_update
342
343Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
344the current time for each loop iteration (see the discussion of L<<
345AnyEvent->now >>, above).
346
347When a callback runs for a long time (or when the process sleeps), then
348this "current" time will differ substantially from the real time, which
349might affect timers and time-outs.
350
351When this is the case, you can call this method, which will update the
352event loop's idea of "current time".
353
354Note that updating the time I<might> cause some events to be handled.
355
305=back 356=back
306 357
307=head2 SIGNAL WATCHERS 358=head2 SIGNAL WATCHERS
308 359
309You can watch for signals using a signal watcher, C<signal> is the signal 360You can watch for signals using a signal watcher, C<signal> is the signal
310I<name> without any C<SIG> prefix, C<cb> is the Perl callback to 361I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
311be invoked whenever a signal occurs. 362callback to be invoked whenever a signal occurs.
312 363
313Although the callback might get passed parameters, their value and 364Although the callback might get passed parameters, their value and
314presence is undefined and you cannot rely on them. Portable AnyEvent 365presence is undefined and you cannot rely on them. Portable AnyEvent
315callbacks cannot use arguments passed to signal watcher callbacks. 366callbacks cannot use arguments passed to signal watcher callbacks.
316 367
318invocation, and callback invocation will be synchronous. Synchronous means 369invocation, and callback invocation will be synchronous. Synchronous means
319that it might take a while until the signal gets handled by the process, 370that it might take a while until the signal gets handled by the process,
320but it is guaranteed not to interrupt any other callbacks. 371but it is guaranteed not to interrupt any other callbacks.
321 372
322The main advantage of using these watchers is that you can share a signal 373The main advantage of using these watchers is that you can share a signal
323between multiple watchers. 374between multiple watchers, and AnyEvent will ensure that signals will not
375interrupt your program at bad times.
324 376
325This watcher might use C<%SIG>, so programs overwriting those signals 377This watcher might use C<%SIG> (depending on the event loop used),
326directly will likely not work correctly. 378so programs overwriting those signals directly will likely not work
379correctly.
327 380
328Example: exit on SIGINT 381Example: exit on SIGINT
329 382
330 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 383 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
331 384
385=head3 Signal Races, Delays and Workarounds
386
387Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
388callbacks to signals in a generic way, which is a pity, as you cannot do
389race-free signal handling in perl. AnyEvent will try to do it's best, but
390in some cases, signals will be delayed. The maximum time a signal might
391be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10
392seconds). This variable can be changed only before the first signal
393watcher is created, and should be left alone otherwise. Higher values
394will cause fewer spurious wake-ups, which is better for power and CPU
395saving. All these problems can be avoided by installing the optional
396L<Async::Interrupt> module. This will not work with inherently broken
397event loops such as L<Event> or L<Event::Lib> (and not with L<POE>
398currently, as POE does it's own workaround with one-second latency). With
399those, you just have to suffer the delays.
400
332=head2 CHILD PROCESS WATCHERS 401=head2 CHILD PROCESS WATCHERS
333 402
334You can also watch on a child process exit and catch its exit status. 403You can also watch on a child process exit and catch its exit status.
335 404
336The child process is specified by the C<pid> argument (if set to C<0>, it 405The child process is specified by the C<pid> argument (if set to C<0>, it
337watches for any child process exit). The watcher will trigger as often 406watches for any child process exit). The watcher will triggered only when
338as status change for the child are received. This works by installing a 407the child process has finished and an exit status is available, not on
339signal handler for C<SIGCHLD>. The callback will be called with the pid 408any trace events (stopped/continued).
340and exit status (as returned by waitpid), so unlike other watcher types, 409
341you I<can> rely on child watcher callback arguments. 410The callback will be called with the pid and exit status (as returned by
411waitpid), so unlike other watcher types, you I<can> rely on child watcher
412callback arguments.
413
414This watcher type works by installing a signal handler for C<SIGCHLD>,
415and since it cannot be shared, nothing else should use SIGCHLD or reap
416random child processes (waiting for specific child processes, e.g. inside
417C<system>, is just fine).
342 418
343There is a slight catch to child watchers, however: you usually start them 419There is a slight catch to child watchers, however: you usually start them
344I<after> the child process was created, and this means the process could 420I<after> the child process was created, and this means the process could
345have exited already (and no SIGCHLD will be sent anymore). 421have exited already (and no SIGCHLD will be sent anymore).
346 422
347Not all event models handle this correctly (POE doesn't), but even for 423Not all event models handle this correctly (neither POE nor IO::Async do,
424see their AnyEvent::Impl manpages for details), but even for event models
348event models that I<do> handle this correctly, they usually need to be 425that I<do> handle this correctly, they usually need to be loaded before
349loaded before the process exits (i.e. before you fork in the first place). 426the process exits (i.e. before you fork in the first place). AnyEvent's
427pure perl event loop handles all cases correctly regardless of when you
428start the watcher.
350 429
351This means you cannot create a child watcher as the very first thing in an 430This means you cannot create a child watcher as the very first
352AnyEvent program, you I<have> to create at least one watcher before you 431thing in an AnyEvent program, you I<have> to create at least one
353C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 432watcher before you C<fork> the child (alternatively, you can call
433C<AnyEvent::detect>).
434
435As most event loops do not support waiting for child events, they will be
436emulated by AnyEvent in most cases, in which the latency and race problems
437mentioned in the description of signal watchers apply.
354 438
355Example: fork a process and wait for it 439Example: fork a process and wait for it
356 440
357 my $done = AnyEvent->condvar; 441 my $done = AnyEvent->condvar;
358 442
368 ); 452 );
369 453
370 # do something else, then wait for process exit 454 # do something else, then wait for process exit
371 $done->recv; 455 $done->recv;
372 456
457=head2 IDLE WATCHERS
458
459Sometimes there is a need to do something, but it is not so important
460to do it instantly, but only when there is nothing better to do. This
461"nothing better to do" is usually defined to be "no other events need
462attention by the event loop".
463
464Idle watchers ideally get invoked when the event loop has nothing
465better to do, just before it would block the process to wait for new
466events. Instead of blocking, the idle watcher is invoked.
467
468Most event loops unfortunately do not really support idle watchers (only
469EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
470will simply call the callback "from time to time".
471
472Example: read lines from STDIN, but only process them when the
473program is otherwise idle:
474
475 my @lines; # read data
476 my $idle_w;
477 my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
478 push @lines, scalar <STDIN>;
479
480 # start an idle watcher, if not already done
481 $idle_w ||= AnyEvent->idle (cb => sub {
482 # handle only one line, when there are lines left
483 if (my $line = shift @lines) {
484 print "handled when idle: $line";
485 } else {
486 # otherwise disable the idle watcher again
487 undef $idle_w;
488 }
489 });
490 });
491
373=head2 CONDITION VARIABLES 492=head2 CONDITION VARIABLES
374 493
375If you are familiar with some event loops you will know that all of them 494If you are familiar with some event loops you will know that all of them
376require you to run some blocking "loop", "run" or similar function that 495require you to run some blocking "loop", "run" or similar function that
377will actively watch for new events and call your callbacks. 496will actively watch for new events and call your callbacks.
378 497
379AnyEvent is different, it expects somebody else to run the event loop and 498AnyEvent is slightly different: it expects somebody else to run the event
380will only block when necessary (usually when told by the user). 499loop and will only block when necessary (usually when told by the user).
381 500
382The instrument to do that is called a "condition variable", so called 501The instrument to do that is called a "condition variable", so called
383because they represent a condition that must become true. 502because they represent a condition that must become true.
503
504Now is probably a good time to look at the examples further below.
384 505
385Condition variables can be created by calling the C<< AnyEvent->condvar 506Condition variables can be created by calling the C<< AnyEvent->condvar
386>> method, usually without arguments. The only argument pair allowed is 507>> method, usually without arguments. The only argument pair allowed is
387C<cb>, which specifies a callback to be called when the condition variable 508C<cb>, which specifies a callback to be called when the condition variable
388becomes true. 509becomes true, with the condition variable as the first argument (but not
510the results).
389 511
390After creation, the condition variable is "false" until it becomes "true" 512After creation, the condition variable is "false" until it becomes "true"
391by calling the C<send> method (or calling the condition variable as if it 513by calling the C<send> method (or calling the condition variable as if it
392were a callback, read about the caveats in the description for the C<< 514were a callback, read about the caveats in the description for the C<<
393->send >> method). 515->send >> method).
439 after => 1, 561 after => 1,
440 cb => sub { $result_ready->send }, 562 cb => sub { $result_ready->send },
441 ); 563 );
442 564
443 # this "blocks" (while handling events) till the callback 565 # this "blocks" (while handling events) till the callback
444 # calls send 566 # calls -<send
445 $result_ready->recv; 567 $result_ready->recv;
446 568
447Example: wait for a timer, but take advantage of the fact that 569Example: wait for a timer, but take advantage of the fact that condition
448condition variables are also code references. 570variables are also callable directly.
449 571
450 my $done = AnyEvent->condvar; 572 my $done = AnyEvent->condvar;
451 my $delay = AnyEvent->timer (after => 5, cb => $done); 573 my $delay = AnyEvent->timer (after => 5, cb => $done);
452 $done->recv; 574 $done->recv;
575
576Example: Imagine an API that returns a condvar and doesn't support
577callbacks. This is how you make a synchronous call, for example from
578the main program:
579
580 use AnyEvent::CouchDB;
581
582 ...
583
584 my @info = $couchdb->info->recv;
585
586And this is how you would just set a callback to be called whenever the
587results are available:
588
589 $couchdb->info->cb (sub {
590 my @info = $_[0]->recv;
591 });
453 592
454=head3 METHODS FOR PRODUCERS 593=head3 METHODS FOR PRODUCERS
455 594
456These methods should only be used by the producing side, i.e. the 595These methods should only be used by the producing side, i.e. the
457code/module that eventually sends the signal. Note that it is also 596code/module that eventually sends the signal. Note that it is also
470immediately from within send. 609immediately from within send.
471 610
472Any arguments passed to the C<send> call will be returned by all 611Any arguments passed to the C<send> call will be returned by all
473future C<< ->recv >> calls. 612future C<< ->recv >> calls.
474 613
475Condition variables are overloaded so one can call them directly 614Condition variables are overloaded so one can call them directly (as if
476(as a code reference). Calling them directly is the same as calling 615they were a code reference). Calling them directly is the same as calling
477C<send>. Note, however, that many C-based event loops do not handle 616C<send>.
478overloading, so as tempting as it may be, passing a condition variable
479instead of a callback does not work. Both the pure perl and EV loops
480support overloading, however, as well as all functions that use perl to
481invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
482example).
483 617
484=item $cv->croak ($error) 618=item $cv->croak ($error)
485 619
486Similar to send, but causes all call's to C<< ->recv >> to invoke 620Similar to send, but causes all call's to C<< ->recv >> to invoke
487C<Carp::croak> with the given error message/object/scalar. 621C<Carp::croak> with the given error message/object/scalar.
488 622
489This can be used to signal any errors to the condition variable 623This can be used to signal any errors to the condition variable
490user/consumer. 624user/consumer. Doing it this way instead of calling C<croak> directly
625delays the error detetcion, but has the overwhelmign advantage that it
626diagnoses the error at the place where the result is expected, and not
627deep in some event clalback without connection to the actual code causing
628the problem.
491 629
492=item $cv->begin ([group callback]) 630=item $cv->begin ([group callback])
493 631
494=item $cv->end 632=item $cv->end
495
496These two methods are EXPERIMENTAL and MIGHT CHANGE.
497 633
498These two methods can be used to combine many transactions/events into 634These two methods can be used to combine many transactions/events into
499one. For example, a function that pings many hosts in parallel might want 635one. For example, a function that pings many hosts in parallel might want
500to use a condition variable for the whole process. 636to use a condition variable for the whole process.
501 637
503C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 639C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
504>>, the (last) callback passed to C<begin> will be executed. That callback 640>>, the (last) callback passed to C<begin> will be executed. That callback
505is I<supposed> to call C<< ->send >>, but that is not required. If no 641is I<supposed> to call C<< ->send >>, but that is not required. If no
506callback was set, C<send> will be called without any arguments. 642callback was set, C<send> will be called without any arguments.
507 643
508Let's clarify this with the ping example: 644You can think of C<< $cv->send >> giving you an OR condition (one call
645sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
646condition (all C<begin> calls must be C<end>'ed before the condvar sends).
647
648Let's start with a simple example: you have two I/O watchers (for example,
649STDOUT and STDERR for a program), and you want to wait for both streams to
650close before activating a condvar:
651
652 my $cv = AnyEvent->condvar;
653
654 $cv->begin; # first watcher
655 my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
656 defined sysread $fh1, my $buf, 4096
657 or $cv->end;
658 });
659
660 $cv->begin; # second watcher
661 my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
662 defined sysread $fh2, my $buf, 4096
663 or $cv->end;
664 });
665
666 $cv->recv;
667
668This works because for every event source (EOF on file handle), there is
669one call to C<begin>, so the condvar waits for all calls to C<end> before
670sending.
671
672The ping example mentioned above is slightly more complicated, as the
673there are results to be passwd back, and the number of tasks that are
674begung can potentially be zero:
509 675
510 my $cv = AnyEvent->condvar; 676 my $cv = AnyEvent->condvar;
511 677
512 my %result; 678 my %result;
513 $cv->begin (sub { $cv->send (\%result) }); 679 $cv->begin (sub { $cv->send (\%result) });
533loop, which serves two important purposes: first, it sets the callback 699loop, which serves two important purposes: first, it sets the callback
534to be called once the counter reaches C<0>, and second, it ensures that 700to be called once the counter reaches C<0>, and second, it ensures that
535C<send> is called even when C<no> hosts are being pinged (the loop 701C<send> is called even when C<no> hosts are being pinged (the loop
536doesn't execute once). 702doesn't execute once).
537 703
538This is the general pattern when you "fan out" into multiple subrequests: 704This is the general pattern when you "fan out" into multiple (but
539use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 705potentially none) subrequests: use an outer C<begin>/C<end> pair to set
540is called at least once, and then, for each subrequest you start, call 706the callback and ensure C<end> is called at least once, and then, for each
541C<begin> and for each subrequest you finish, call C<end>. 707subrequest you start, call C<begin> and for each subrequest you finish,
708call C<end>.
542 709
543=back 710=back
544 711
545=head3 METHODS FOR CONSUMERS 712=head3 METHODS FOR CONSUMERS
546 713
562function will call C<croak>. 729function will call C<croak>.
563 730
564In list context, all parameters passed to C<send> will be returned, 731In list context, all parameters passed to C<send> will be returned,
565in scalar context only the first one will be returned. 732in scalar context only the first one will be returned.
566 733
734Note that doing a blocking wait in a callback is not supported by any
735event loop, that is, recursive invocation of a blocking C<< ->recv
736>> is not allowed, and the C<recv> call will C<croak> if such a
737condition is detected. This condition can be slightly loosened by using
738L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
739any thread that doesn't run the event loop itself.
740
567Not all event models support a blocking wait - some die in that case 741Not all event models support a blocking wait - some die in that case
568(programs might want to do that to stay interactive), so I<if you are 742(programs might want to do that to stay interactive), so I<if you are
569using this from a module, never require a blocking wait>, but let the 743using this from a module, never require a blocking wait>. Instead, let the
570caller decide whether the call will block or not (for example, by coupling 744caller decide whether the call will block or not (for example, by coupling
571condition variables with some kind of request results and supporting 745condition variables with some kind of request results and supporting
572callbacks so the caller knows that getting the result will not block, 746callbacks so the caller knows that getting the result will not block,
573while still supporting blocking waits if the caller so desires). 747while still supporting blocking waits if the caller so desires).
574 748
575Another reason I<never> to C<< ->recv >> in a module is that you cannot
576sensibly have two C<< ->recv >>'s in parallel, as that would require
577multiple interpreters or coroutines/threads, none of which C<AnyEvent>
578can supply.
579
580The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
581fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
582versions and also integrates coroutines into AnyEvent, making blocking
583C<< ->recv >> calls perfectly safe as long as they are done from another
584coroutine (one that doesn't run the event loop).
585
586You can ensure that C<< -recv >> never blocks by setting a callback and 749You can ensure that C<< -recv >> never blocks by setting a callback and
587only calling C<< ->recv >> from within that callback (or at a later 750only calling C<< ->recv >> from within that callback (or at a later
588time). This will work even when the event loop does not support blocking 751time). This will work even when the event loop does not support blocking
589waits otherwise. 752waits otherwise.
590 753
591=item $bool = $cv->ready 754=item $bool = $cv->ready
592 755
593Returns true when the condition is "true", i.e. whether C<send> or 756Returns true when the condition is "true", i.e. whether C<send> or
594C<croak> have been called. 757C<croak> have been called.
595 758
596=item $cb = $cv->cb ([new callback]) 759=item $cb = $cv->cb ($cb->($cv))
597 760
598This is a mutator function that returns the callback set and optionally 761This is a mutator function that returns the callback set and optionally
599replaces it before doing so. 762replaces it before doing so.
600 763
601The callback will be called when the condition becomes "true", i.e. when 764The callback will be called when the condition becomes "true", i.e. when
603variable itself. Calling C<recv> inside the callback or at any later time 766variable itself. Calling C<recv> inside the callback or at any later time
604is guaranteed not to block. 767is guaranteed not to block.
605 768
606=back 769=back
607 770
771=head1 SUPPORTED EVENT LOOPS/BACKENDS
772
773The available backend classes are (every class has its own manpage):
774
775=over 4
776
777=item Backends that are autoprobed when no other event loop can be found.
778
779EV is the preferred backend when no other event loop seems to be in
780use. If EV is not installed, then AnyEvent will try Event, and, failing
781that, will fall back to its own pure-perl implementation, which is
782available everywhere as it comes with AnyEvent itself.
783
784 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
785 AnyEvent::Impl::Event based on Event, very stable, few glitches.
786 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
787
788=item Backends that are transparently being picked up when they are used.
789
790These will be used when they are currently loaded when the first watcher
791is created, in which case it is assumed that the application is using
792them. This means that AnyEvent will automatically pick the right backend
793when the main program loads an event module before anything starts to
794create watchers. Nothing special needs to be done by the main program.
795
796 AnyEvent::Impl::Glib based on Glib, slow but very stable.
797 AnyEvent::Impl::Tk based on Tk, very broken.
798 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
799 AnyEvent::Impl::POE based on POE, very slow, some limitations.
800
801=item Backends with special needs.
802
803Qt requires the Qt::Application to be instantiated first, but will
804otherwise be picked up automatically. As long as the main program
805instantiates the application before any AnyEvent watchers are created,
806everything should just work.
807
808 AnyEvent::Impl::Qt based on Qt.
809
810Support for IO::Async can only be partial, as it is too broken and
811architecturally limited to even support the AnyEvent API. It also
812is the only event loop that needs the loop to be set explicitly, so
813it can only be used by a main program knowing about AnyEvent. See
814L<AnyEvent::Impl::Async> for the gory details.
815
816 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
817
818=item Event loops that are indirectly supported via other backends.
819
820Some event loops can be supported via other modules:
821
822There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
823
824B<WxWidgets> has no support for watching file handles. However, you can
825use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
826polls 20 times per second, which was considered to be too horrible to even
827consider for AnyEvent.
828
829B<Prima> is not supported as nobody seems to be using it, but it has a POE
830backend, so it can be supported through POE.
831
832AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
833load L<POE> when detecting them, in the hope that POE will pick them up,
834in which case everything will be automatic.
835
836=back
837
608=head1 GLOBAL VARIABLES AND FUNCTIONS 838=head1 GLOBAL VARIABLES AND FUNCTIONS
609 839
840These are not normally required to use AnyEvent, but can be useful to
841write AnyEvent extension modules.
842
610=over 4 843=over 4
611 844
612=item $AnyEvent::MODEL 845=item $AnyEvent::MODEL
613 846
614Contains C<undef> until the first watcher is being created. Then it 847Contains C<undef> until the first watcher is being created, before the
848backend has been autodetected.
849
615contains the event model that is being used, which is the name of the 850Afterwards it contains the event model that is being used, which is the
616Perl class implementing the model. This class is usually one of the 851name of the Perl class implementing the model. This class is usually one
617C<AnyEvent::Impl:xxx> modules, but can be any other class in the case 852of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
618AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). 853case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
619 854will be C<urxvt::anyevent>).
620The known classes so far are:
621
622 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
623 AnyEvent::Impl::Event based on Event, second best choice.
624 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
625 AnyEvent::Impl::Glib based on Glib, third-best choice.
626 AnyEvent::Impl::Tk based on Tk, very bad choice.
627 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
628 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
629 AnyEvent::Impl::POE based on POE, not generic enough for full support.
630
631There is no support for WxWidgets, as WxWidgets has no support for
632watching file handles. However, you can use WxWidgets through the
633POE Adaptor, as POE has a Wx backend that simply polls 20 times per
634second, which was considered to be too horrible to even consider for
635AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
636it's adaptor.
637
638AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
639autodetecting them.
640 855
641=item AnyEvent::detect 856=item AnyEvent::detect
642 857
643Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 858Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
644if necessary. You should only call this function right before you would 859if necessary. You should only call this function right before you would
645have created an AnyEvent watcher anyway, that is, as late as possible at 860have created an AnyEvent watcher anyway, that is, as late as possible at
646runtime. 861runtime, and not e.g. while initialising of your module.
862
863If you need to do some initialisation before AnyEvent watchers are
864created, use C<post_detect>.
647 865
648=item $guard = AnyEvent::post_detect { BLOCK } 866=item $guard = AnyEvent::post_detect { BLOCK }
649 867
650Arranges for the code block to be executed as soon as the event model is 868Arranges for the code block to be executed as soon as the event model is
651autodetected (or immediately if this has already happened). 869autodetected (or immediately if this has already happened).
870
871The block will be executed I<after> the actual backend has been detected
872(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
873created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
874other initialisations - see the sources of L<AnyEvent::Strict> or
875L<AnyEvent::AIO> to see how this is used.
876
877The most common usage is to create some global watchers, without forcing
878event module detection too early, for example, L<AnyEvent::AIO> creates
879and installs the global L<IO::AIO> watcher in a C<post_detect> block to
880avoid autodetecting the event module at load time.
652 881
653If called in scalar or list context, then it creates and returns an object 882If called in scalar or list context, then it creates and returns an object
654that automatically removes the callback again when it is destroyed. See 883that automatically removes the callback again when it is destroyed. See
655L<Coro::BDB> for a case where this is useful. 884L<Coro::BDB> for a case where this is useful.
656 885
659If there are any code references in this array (you can C<push> to it 888If there are any code references in this array (you can C<push> to it
660before or after loading AnyEvent), then they will called directly after 889before or after loading AnyEvent), then they will called directly after
661the event loop has been chosen. 890the event loop has been chosen.
662 891
663You should check C<$AnyEvent::MODEL> before adding to this array, though: 892You should check C<$AnyEvent::MODEL> before adding to this array, though:
664if it contains a true value then the event loop has already been detected, 893if it is defined then the event loop has already been detected, and the
665and the array will be ignored. 894array will be ignored.
666 895
667Best use C<AnyEvent::post_detect { BLOCK }> instead. 896Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
897it,as it takes care of these details.
898
899This variable is mainly useful for modules that can do something useful
900when AnyEvent is used and thus want to know when it is initialised, but do
901not need to even load it by default. This array provides the means to hook
902into AnyEvent passively, without loading it.
668 903
669=back 904=back
670 905
671=head1 WHAT TO DO IN A MODULE 906=head1 WHAT TO DO IN A MODULE
672 907
727 962
728 963
729=head1 OTHER MODULES 964=head1 OTHER MODULES
730 965
731The following is a non-exhaustive list of additional modules that use 966The following is a non-exhaustive list of additional modules that use
732AnyEvent and can therefore be mixed easily with other AnyEvent modules 967AnyEvent as a client and can therefore be mixed easily with other AnyEvent
733in the same program. Some of the modules come with AnyEvent, some are 968modules and other event loops in the same program. Some of the modules
734available via CPAN. 969come with AnyEvent, most are available via CPAN.
735 970
736=over 4 971=over 4
737 972
738=item L<AnyEvent::Util> 973=item L<AnyEvent::Util>
739 974
740Contains various utility functions that replace often-used but blocking 975Contains various utility functions that replace often-used but blocking
741functions such as C<inet_aton> by event-/callback-based versions. 976functions such as C<inet_aton> by event-/callback-based versions.
742
743=item L<AnyEvent::Handle>
744
745Provide read and write buffers and manages watchers for reads and writes.
746 977
747=item L<AnyEvent::Socket> 978=item L<AnyEvent::Socket>
748 979
749Provides various utility functions for (internet protocol) sockets, 980Provides various utility functions for (internet protocol) sockets,
750addresses and name resolution. Also functions to create non-blocking tcp 981addresses and name resolution. Also functions to create non-blocking tcp
751connections or tcp servers, with IPv6 and SRV record support and more. 982connections or tcp servers, with IPv6 and SRV record support and more.
752 983
984=item L<AnyEvent::Handle>
985
986Provide read and write buffers, manages watchers for reads and writes,
987supports raw and formatted I/O, I/O queued and fully transparent and
988non-blocking SSL/TLS (via L<AnyEvent::TLS>.
989
753=item L<AnyEvent::DNS> 990=item L<AnyEvent::DNS>
754 991
755Provides rich asynchronous DNS resolver capabilities. 992Provides rich asynchronous DNS resolver capabilities.
756 993
757=item L<AnyEvent::HTTP> 994=item L<AnyEvent::HTTP>
767 1004
768The fastest ping in the west. 1005The fastest ping in the west.
769 1006
770=item L<AnyEvent::DBI> 1007=item L<AnyEvent::DBI>
771 1008
772Executes DBI requests asynchronously in a proxy process. 1009Executes L<DBI> requests asynchronously in a proxy process.
773 1010
1011=item L<AnyEvent::AIO>
1012
1013Truly asynchronous I/O, should be in the toolbox of every event
1014programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1015together.
1016
1017=item L<AnyEvent::BDB>
1018
1019Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1020L<BDB> and AnyEvent together.
1021
1022=item L<AnyEvent::GPSD>
1023
1024A non-blocking interface to gpsd, a daemon delivering GPS information.
1025
774=item L<Net::IRC3> 1026=item L<AnyEvent::IRC>
775 1027
776AnyEvent based IRC client module family. 1028AnyEvent based IRC client module family (replacing the older Net::IRC3).
777 1029
778=item L<Net::XMPP2> 1030=item L<AnyEvent::XMPP>
779 1031
780AnyEvent based XMPP (Jabber protocol) module family. 1032AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1033Net::XMPP2>.
1034
1035=item L<AnyEvent::IGS>
1036
1037A non-blocking interface to the Internet Go Server protocol (used by
1038L<App::IGS>).
781 1039
782=item L<Net::FCP> 1040=item L<Net::FCP>
783 1041
784AnyEvent-based implementation of the Freenet Client Protocol, birthplace 1042AnyEvent-based implementation of the Freenet Client Protocol, birthplace
785of AnyEvent. 1043of AnyEvent.
790 1048
791=item L<Coro> 1049=item L<Coro>
792 1050
793Has special support for AnyEvent via L<Coro::AnyEvent>. 1051Has special support for AnyEvent via L<Coro::AnyEvent>.
794 1052
795=item L<AnyEvent::AIO>, L<IO::AIO>
796
797Truly asynchronous I/O, should be in the toolbox of every event
798programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
799together.
800
801=item L<AnyEvent::BDB>, L<BDB>
802
803Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
804IO::AIO and AnyEvent together.
805
806=item L<IO::Lambda>
807
808The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
809
810=back 1053=back
811 1054
812=cut 1055=cut
813 1056
814package AnyEvent; 1057package AnyEvent;
815 1058
1059# basically a tuned-down version of common::sense
1060sub common_sense {
816no warnings; 1061 # no warnings
817use strict; 1062 ${^WARNING_BITS} ^= ${^WARNING_BITS};
1063 # use strict vars subs
1064 $^H |= 0x00000600;
1065}
818 1066
1067BEGIN { AnyEvent::common_sense }
1068
819use Carp; 1069use Carp ();
820 1070
821our $VERSION = 4.151; 1071our $VERSION = 4.85;
822our $MODEL; 1072our $MODEL;
823 1073
824our $AUTOLOAD; 1074our $AUTOLOAD;
825our @ISA; 1075our @ISA;
826 1076
827our @REGISTRY; 1077our @REGISTRY;
828 1078
829our $WIN32; 1079our $WIN32;
830 1080
1081our $VERBOSE;
1082
831BEGIN { 1083BEGIN {
832 my $win32 = ! ! ($^O =~ /mswin32/i); 1084 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
833 eval "sub WIN32(){ $win32 }"; 1085 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
834}
835 1086
1087 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1088 if ${^TAINT};
1089
836our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1090 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1091
1092}
1093
1094our $MAX_SIGNAL_LATENCY = 10;
837 1095
838our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1096our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
839 1097
840{ 1098{
841 my $idx; 1099 my $idx;
849 [Event:: => AnyEvent::Impl::Event::], 1107 [Event:: => AnyEvent::Impl::Event::],
850 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1108 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
851 # everything below here will not be autoprobed 1109 # everything below here will not be autoprobed
852 # as the pureperl backend should work everywhere 1110 # as the pureperl backend should work everywhere
853 # and is usually faster 1111 # and is usually faster
854 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
855 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1112 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
856 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1113 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1114 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
857 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1115 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
858 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1116 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
859 [Wx:: => AnyEvent::Impl::POE::], 1117 [Wx:: => AnyEvent::Impl::POE::],
860 [Prima:: => AnyEvent::Impl::POE::], 1118 [Prima:: => AnyEvent::Impl::POE::],
1119 # IO::Async is just too broken - we would need workarounds for its
1120 # byzantine signal and broken child handling, among others.
1121 # IO::Async is rather hard to detect, as it doesn't have any
1122 # obvious default class.
1123# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1124# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1125# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
861); 1126);
862 1127
863our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); 1128our %method = map +($_ => 1),
1129 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
864 1130
865our @post_detect; 1131our @post_detect;
866 1132
867sub post_detect(&) { 1133sub post_detect(&) {
868 my ($cb) = @_; 1134 my ($cb) = @_;
873 1 1139 1
874 } else { 1140 } else {
875 push @post_detect, $cb; 1141 push @post_detect, $cb;
876 1142
877 defined wantarray 1143 defined wantarray
878 ? bless \$cb, "AnyEvent::Util::PostDetect" 1144 ? bless \$cb, "AnyEvent::Util::postdetect"
879 : () 1145 : ()
880 } 1146 }
881} 1147}
882 1148
883sub AnyEvent::Util::PostDetect::DESTROY { 1149sub AnyEvent::Util::postdetect::DESTROY {
884 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1150 @post_detect = grep $_ != ${$_[0]}, @post_detect;
885} 1151}
886 1152
887sub detect() { 1153sub detect() {
888 unless ($MODEL) { 1154 unless ($MODEL) {
889 no strict 'refs';
890 local $SIG{__DIE__}; 1155 local $SIG{__DIE__};
891 1156
892 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1157 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
893 my $model = "AnyEvent::Impl::$1"; 1158 my $model = "AnyEvent::Impl::$1";
894 if (eval "require $model") { 1159 if (eval "require $model") {
895 $MODEL = $model; 1160 $MODEL = $model;
896 warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; 1161 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
897 } else { 1162 } else {
898 warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; 1163 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
899 } 1164 }
900 } 1165 }
901 1166
902 # check for already loaded models 1167 # check for already loaded models
903 unless ($MODEL) { 1168 unless ($MODEL) {
904 for (@REGISTRY, @models) { 1169 for (@REGISTRY, @models) {
905 my ($package, $model) = @$_; 1170 my ($package, $model) = @$_;
906 if (${"$package\::VERSION"} > 0) { 1171 if (${"$package\::VERSION"} > 0) {
907 if (eval "require $model") { 1172 if (eval "require $model") {
908 $MODEL = $model; 1173 $MODEL = $model;
909 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; 1174 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
910 last; 1175 last;
911 } 1176 }
912 } 1177 }
913 } 1178 }
914 1179
919 my ($package, $model) = @$_; 1184 my ($package, $model) = @$_;
920 if (eval "require $package" 1185 if (eval "require $package"
921 and ${"$package\::VERSION"} > 0 1186 and ${"$package\::VERSION"} > 0
922 and eval "require $model") { 1187 and eval "require $model") {
923 $MODEL = $model; 1188 $MODEL = $model;
924 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; 1189 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
925 last; 1190 last;
926 } 1191 }
927 } 1192 }
928 1193
929 $MODEL 1194 $MODEL
930 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 1195 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
931 } 1196 }
932 } 1197 }
933 1198
1199 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1200
934 unshift @ISA, $MODEL; 1201 unshift @ISA, $MODEL;
935 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1202
1203 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
936 1204
937 (shift @post_detect)->() while @post_detect; 1205 (shift @post_detect)->() while @post_detect;
938 } 1206 }
939 1207
940 $MODEL 1208 $MODEL
942 1210
943sub AUTOLOAD { 1211sub AUTOLOAD {
944 (my $func = $AUTOLOAD) =~ s/.*://; 1212 (my $func = $AUTOLOAD) =~ s/.*://;
945 1213
946 $method{$func} 1214 $method{$func}
947 or croak "$func: not a valid method for AnyEvent objects"; 1215 or Carp::croak "$func: not a valid method for AnyEvent objects";
948 1216
949 detect unless $MODEL; 1217 detect unless $MODEL;
950 1218
951 my $class = shift; 1219 my $class = shift;
952 $class->$func (@_); 1220 $class->$func (@_);
953} 1221}
954 1222
1223# utility function to dup a filehandle. this is used by many backends
1224# to support binding more than one watcher per filehandle (they usually
1225# allow only one watcher per fd, so we dup it to get a different one).
1226sub _dupfh($$;$$) {
1227 my ($poll, $fh, $r, $w) = @_;
1228
1229 # cygwin requires the fh mode to be matching, unix doesn't
1230 my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1231
1232 open my $fh2, $mode, $fh
1233 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1234
1235 # we assume CLOEXEC is already set by perl in all important cases
1236
1237 ($fh2, $rw)
1238}
1239
955package AnyEvent::Base; 1240package AnyEvent::Base;
956 1241
957# default implementation for now and time 1242# default implementations for many methods
958 1243
959use Time::HiRes (); 1244sub _time {
1245 # probe for availability of Time::HiRes
1246 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1247 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1248 *_time = \&Time::HiRes::time;
1249 # if (eval "use POSIX (); (POSIX::times())...
1250 } else {
1251 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1252 *_time = sub { time }; # epic fail
1253 }
960 1254
961sub time { Time::HiRes::time } 1255 &_time
962sub now { Time::HiRes::time } 1256}
1257
1258sub time { _time }
1259sub now { _time }
1260sub now_update { }
963 1261
964# default implementation for ->condvar 1262# default implementation for ->condvar
965 1263
966sub condvar { 1264sub condvar {
967 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1265 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
968} 1266}
969 1267
970# default implementation for ->signal 1268# default implementation for ->signal
971 1269
972our %SIG_CB; 1270our $HAVE_ASYNC_INTERRUPT;
1271our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1272our (%SIG_ASY, %SIG_ASY_W);
1273our ($SIG_COUNT, $SIG_TW);
973 1274
1275sub _signal_exec {
1276 $HAVE_ASYNC_INTERRUPT
1277 ? $SIGPIPE_R->drain
1278 : sysread $SIGPIPE_R, my $dummy, 9;
1279
1280 while (%SIG_EV) {
1281 for (keys %SIG_EV) {
1282 delete $SIG_EV{$_};
1283 $_->() for values %{ $SIG_CB{$_} || {} };
1284 }
1285 }
1286}
1287
1288# install a dumym wakeupw atcher to reduce signal catching latency
1289sub _sig_add() {
1290 unless ($SIG_COUNT++) {
1291 # try to align timer on a full-second boundary, if possible
1292 my $NOW = AnyEvent->now;
1293
1294 $SIG_TW = AnyEvent->timer (
1295 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1296 interval => $MAX_SIGNAL_LATENCY,
1297 cb => sub { }, # just for the PERL_ASYNC_CHECK
1298 );
1299 }
1300}
1301
1302sub _sig_del {
1303 undef $SIG_TW
1304 unless --$SIG_COUNT;
1305}
1306
974sub signal { 1307sub _signal {
975 my (undef, %arg) = @_; 1308 my (undef, %arg) = @_;
976 1309
977 my $signal = uc $arg{signal} 1310 my $signal = uc $arg{signal}
978 or Carp::croak "required option 'signal' is missing"; 1311 or Carp::croak "required option 'signal' is missing";
979 1312
980 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1313 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1314
1315 if ($HAVE_ASYNC_INTERRUPT) {
1316 # async::interrupt
1317
1318 $SIG_ASY{$signal} ||= do {
1319 my $asy = new Async::Interrupt
1320 cb => sub { undef $SIG_EV{$signal} },
1321 signal => $signal,
1322 pipe => [$SIGPIPE_R->filenos],
1323 ;
1324 $asy->pipe_autodrain (0);
1325
1326 $asy
1327 };
1328
1329 } else {
1330 # pure perl
1331
981 $SIG{$signal} ||= sub { 1332 $SIG{$signal} ||= sub {
982 $_->() for values %{ $SIG_CB{$signal} || {} }; 1333 local $!;
1334 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1335 undef $SIG_EV{$signal};
1336 };
1337
1338 # can't do signal processing without introducing races in pure perl,
1339 # so limit the signal latency.
1340 _sig_add;
983 }; 1341 }
984 1342
985 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1343 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
986} 1344}
987 1345
1346sub signal {
1347 # probe for availability of Async::Interrupt
1348 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1349 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1350
1351 $HAVE_ASYNC_INTERRUPT = 1;
1352 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1353 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1354
1355 } else {
1356 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1357
1358 require Fcntl;
1359
1360 if (AnyEvent::WIN32) {
1361 require AnyEvent::Util;
1362
1363 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1364 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1365 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1366 } else {
1367 pipe $SIGPIPE_R, $SIGPIPE_W;
1368 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1369 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1370
1371 # not strictly required, as $^F is normally 2, but let's make sure...
1372 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1373 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1374 }
1375
1376 $SIGPIPE_R
1377 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1378
1379 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1380 }
1381
1382 *signal = \&_signal;
1383 &signal
1384}
1385
988sub AnyEvent::Base::Signal::DESTROY { 1386sub AnyEvent::Base::signal::DESTROY {
989 my ($signal, $cb) = @{$_[0]}; 1387 my ($signal, $cb) = @{$_[0]};
990 1388
1389 _sig_del;
1390
991 delete $SIG_CB{$signal}{$cb}; 1391 delete $SIG_CB{$signal}{$cb};
992 1392
993 $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; 1393 $HAVE_ASYNC_INTERRUPT
1394 ? delete $SIG_ASY{$signal}
1395 : # delete doesn't work with older perls - they then
1396 # print weird messages, or just unconditionally exit
1397 # instead of getting the default action.
1398 undef $SIG{$signal}
1399 unless keys %{ $SIG_CB{$signal} };
994} 1400}
995 1401
996# default implementation for ->child 1402# default implementation for ->child
997 1403
998our %PID_CB; 1404our %PID_CB;
999our $CHLD_W; 1405our $CHLD_W;
1000our $CHLD_DELAY_W; 1406our $CHLD_DELAY_W;
1001our $PID_IDLE;
1002our $WNOHANG; 1407our $WNOHANG;
1003 1408
1004sub _child_wait { 1409sub _sigchld {
1005 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1410 while (0 < (my $pid = waitpid -1, $WNOHANG)) {
1411 $_->($pid, $?)
1006 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1412 for values %{ $PID_CB{$pid} || {} },
1007 (values %{ $PID_CB{0} || {} }); 1413 values %{ $PID_CB{0} || {} };
1008 } 1414 }
1009
1010 undef $PID_IDLE;
1011}
1012
1013sub _sigchld {
1014 # make sure we deliver these changes "synchronous" with the event loop.
1015 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1016 undef $CHLD_DELAY_W;
1017 &_child_wait;
1018 });
1019} 1415}
1020 1416
1021sub child { 1417sub child {
1022 my (undef, %arg) = @_; 1418 my (undef, %arg) = @_;
1023 1419
1024 defined (my $pid = $arg{pid} + 0) 1420 defined (my $pid = $arg{pid} + 0)
1025 or Carp::croak "required option 'pid' is missing"; 1421 or Carp::croak "required option 'pid' is missing";
1026 1422
1027 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1423 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1028 1424
1029 unless ($WNOHANG) { 1425 # WNOHANG is almost cetrainly 1 everywhere
1426 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1427 ? 1
1030 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1428 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1031 }
1032 1429
1033 unless ($CHLD_W) { 1430 unless ($CHLD_W) {
1034 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1431 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1035 # child could be a zombie already, so make at least one round 1432 # child could be a zombie already, so make at least one round
1036 &_sigchld; 1433 &_sigchld;
1037 } 1434 }
1038 1435
1039 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1436 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1040} 1437}
1041 1438
1042sub AnyEvent::Base::Child::DESTROY { 1439sub AnyEvent::Base::child::DESTROY {
1043 my ($pid, $cb) = @{$_[0]}; 1440 my ($pid, $cb) = @{$_[0]};
1044 1441
1045 delete $PID_CB{$pid}{$cb}; 1442 delete $PID_CB{$pid}{$cb};
1046 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1443 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1047 1444
1048 undef $CHLD_W unless keys %PID_CB; 1445 undef $CHLD_W unless keys %PID_CB;
1049} 1446}
1050 1447
1448# idle emulation is done by simply using a timer, regardless
1449# of whether the process is idle or not, and not letting
1450# the callback use more than 50% of the time.
1451sub idle {
1452 my (undef, %arg) = @_;
1453
1454 my ($cb, $w, $rcb) = $arg{cb};
1455
1456 $rcb = sub {
1457 if ($cb) {
1458 $w = _time;
1459 &$cb;
1460 $w = _time - $w;
1461
1462 # never use more then 50% of the time for the idle watcher,
1463 # within some limits
1464 $w = 0.0001 if $w < 0.0001;
1465 $w = 5 if $w > 5;
1466
1467 $w = AnyEvent->timer (after => $w, cb => $rcb);
1468 } else {
1469 # clean up...
1470 undef $w;
1471 undef $rcb;
1472 }
1473 };
1474
1475 $w = AnyEvent->timer (after => 0.05, cb => $rcb);
1476
1477 bless \\$cb, "AnyEvent::Base::idle"
1478}
1479
1480sub AnyEvent::Base::idle::DESTROY {
1481 undef $${$_[0]};
1482}
1483
1051package AnyEvent::CondVar; 1484package AnyEvent::CondVar;
1052 1485
1053our @ISA = AnyEvent::CondVar::Base::; 1486our @ISA = AnyEvent::CondVar::Base::;
1054 1487
1055package AnyEvent::CondVar::Base; 1488package AnyEvent::CondVar::Base;
1056 1489
1057use overload 1490#use overload
1058 '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1491# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1059 fallback => 1; 1492# fallback => 1;
1493
1494# save 300+ kilobytes by dirtily hardcoding overloading
1495${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
1496*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
1497*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
1498${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1499
1500our $WAITING;
1060 1501
1061sub _send { 1502sub _send {
1062 # nop 1503 # nop
1063} 1504}
1064 1505
1077sub ready { 1518sub ready {
1078 $_[0]{_ae_sent} 1519 $_[0]{_ae_sent}
1079} 1520}
1080 1521
1081sub _wait { 1522sub _wait {
1523 $WAITING
1524 and !$_[0]{_ae_sent}
1525 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1526
1527 local $WAITING = 1;
1082 AnyEvent->one_event while !$_[0]{_ae_sent}; 1528 AnyEvent->one_event while !$_[0]{_ae_sent};
1083} 1529}
1084 1530
1085sub recv { 1531sub recv {
1086 $_[0]->_wait; 1532 $_[0]->_wait;
1105} 1551}
1106 1552
1107# undocumented/compatibility with pre-3.4 1553# undocumented/compatibility with pre-3.4
1108*broadcast = \&send; 1554*broadcast = \&send;
1109*wait = \&_wait; 1555*wait = \&_wait;
1556
1557=head1 ERROR AND EXCEPTION HANDLING
1558
1559In general, AnyEvent does not do any error handling - it relies on the
1560caller to do that if required. The L<AnyEvent::Strict> module (see also
1561the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
1562checking of all AnyEvent methods, however, which is highly useful during
1563development.
1564
1565As for exception handling (i.e. runtime errors and exceptions thrown while
1566executing a callback), this is not only highly event-loop specific, but
1567also not in any way wrapped by this module, as this is the job of the main
1568program.
1569
1570The pure perl event loop simply re-throws the exception (usually
1571within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
1572$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1573so on.
1574
1575=head1 ENVIRONMENT VARIABLES
1576
1577The following environment variables are used by this module or its
1578submodules.
1579
1580Note that AnyEvent will remove I<all> environment variables starting with
1581C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
1582enabled.
1583
1584=over 4
1585
1586=item C<PERL_ANYEVENT_VERBOSE>
1587
1588By default, AnyEvent will be completely silent except in fatal
1589conditions. You can set this environment variable to make AnyEvent more
1590talkative.
1591
1592When set to C<1> or higher, causes AnyEvent to warn about unexpected
1593conditions, such as not being able to load the event model specified by
1594C<PERL_ANYEVENT_MODEL>.
1595
1596When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1597model it chooses.
1598
1599When set to C<8> or higher, then AnyEvent will report extra information on
1600which optional modules it loads and how it implements certain features.
1601
1602=item C<PERL_ANYEVENT_STRICT>
1603
1604AnyEvent does not do much argument checking by default, as thorough
1605argument checking is very costly. Setting this variable to a true value
1606will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1607check the arguments passed to most method calls. If it finds any problems,
1608it will croak.
1609
1610In other words, enables "strict" mode.
1611
1612Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1613>>, it is definitely recommended to keep it off in production. Keeping
1614C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1615can be very useful, however.
1616
1617=item C<PERL_ANYEVENT_MODEL>
1618
1619This can be used to specify the event model to be used by AnyEvent, before
1620auto detection and -probing kicks in. It must be a string consisting
1621entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1622and the resulting module name is loaded and if the load was successful,
1623used as event model. If it fails to load AnyEvent will proceed with
1624auto detection and -probing.
1625
1626This functionality might change in future versions.
1627
1628For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1629could start your program like this:
1630
1631 PERL_ANYEVENT_MODEL=Perl perl ...
1632
1633=item C<PERL_ANYEVENT_PROTOCOLS>
1634
1635Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1636for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1637of auto probing).
1638
1639Must be set to a comma-separated list of protocols or address families,
1640current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1641used, and preference will be given to protocols mentioned earlier in the
1642list.
1643
1644This variable can effectively be used for denial-of-service attacks
1645against local programs (e.g. when setuid), although the impact is likely
1646small, as the program has to handle conenction and other failures anyways.
1647
1648Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1649but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1650- only support IPv4, never try to resolve or contact IPv6
1651addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1652IPv6, but prefer IPv6 over IPv4.
1653
1654=item C<PERL_ANYEVENT_EDNS0>
1655
1656Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1657for DNS. This extension is generally useful to reduce DNS traffic, but
1658some (broken) firewalls drop such DNS packets, which is why it is off by
1659default.
1660
1661Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1662EDNS0 in its DNS requests.
1663
1664=item C<PERL_ANYEVENT_MAX_FORKS>
1665
1666The maximum number of child processes that C<AnyEvent::Util::fork_call>
1667will create in parallel.
1668
1669=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1670
1671The default value for the C<max_outstanding> parameter for the default DNS
1672resolver - this is the maximum number of parallel DNS requests that are
1673sent to the DNS server.
1674
1675=item C<PERL_ANYEVENT_RESOLV_CONF>
1676
1677The file to use instead of F</etc/resolv.conf> (or OS-specific
1678configuration) in the default resolver. When set to the empty string, no
1679default config will be used.
1680
1681=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1682
1683When neither C<ca_file> nor C<ca_path> was specified during
1684L<AnyEvent::TLS> context creation, and either of these environment
1685variables exist, they will be used to specify CA certificate locations
1686instead of a system-dependent default.
1687
1688=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1689
1690When these are set to C<1>, then the respective modules are not
1691loaded. Mostly good for testing AnyEvent itself.
1692
1693=back
1110 1694
1111=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1695=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1112 1696
1113This is an advanced topic that you do not normally need to use AnyEvent in 1697This is an advanced topic that you do not normally need to use AnyEvent in
1114a module. This section is only of use to event loop authors who want to 1698a module. This section is only of use to event loop authors who want to
1148 1732
1149I<rxvt-unicode> also cheats a bit by not providing blocking access to 1733I<rxvt-unicode> also cheats a bit by not providing blocking access to
1150condition variables: code blocking while waiting for a condition will 1734condition variables: code blocking while waiting for a condition will
1151C<die>. This still works with most modules/usages, and blocking calls must 1735C<die>. This still works with most modules/usages, and blocking calls must
1152not be done in an interactive application, so it makes sense. 1736not be done in an interactive application, so it makes sense.
1153
1154=head1 ENVIRONMENT VARIABLES
1155
1156The following environment variables are used by this module:
1157
1158=over 4
1159
1160=item C<PERL_ANYEVENT_VERBOSE>
1161
1162By default, AnyEvent will be completely silent except in fatal
1163conditions. You can set this environment variable to make AnyEvent more
1164talkative.
1165
1166When set to C<1> or higher, causes AnyEvent to warn about unexpected
1167conditions, such as not being able to load the event model specified by
1168C<PERL_ANYEVENT_MODEL>.
1169
1170When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1171model it chooses.
1172
1173=item C<PERL_ANYEVENT_MODEL>
1174
1175This can be used to specify the event model to be used by AnyEvent, before
1176auto detection and -probing kicks in. It must be a string consisting
1177entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1178and the resulting module name is loaded and if the load was successful,
1179used as event model. If it fails to load AnyEvent will proceed with
1180auto detection and -probing.
1181
1182This functionality might change in future versions.
1183
1184For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1185could start your program like this:
1186
1187 PERL_ANYEVENT_MODEL=Perl perl ...
1188
1189=item C<PERL_ANYEVENT_PROTOCOLS>
1190
1191Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1192for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1193of auto probing).
1194
1195Must be set to a comma-separated list of protocols or address families,
1196current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1197used, and preference will be given to protocols mentioned earlier in the
1198list.
1199
1200This variable can effectively be used for denial-of-service attacks
1201against local programs (e.g. when setuid), although the impact is likely
1202small, as the program has to handle connection errors already-
1203
1204Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1205but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1206- only support IPv4, never try to resolve or contact IPv6
1207addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1208IPv6, but prefer IPv6 over IPv4.
1209
1210=item C<PERL_ANYEVENT_EDNS0>
1211
1212Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1213for DNS. This extension is generally useful to reduce DNS traffic, but
1214some (broken) firewalls drop such DNS packets, which is why it is off by
1215default.
1216
1217Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1218EDNS0 in its DNS requests.
1219
1220=item C<PERL_ANYEVENT_MAX_FORKS>
1221
1222The maximum number of child processes that C<AnyEvent::Util::fork_call>
1223will create in parallel.
1224
1225=back
1226 1737
1227=head1 EXAMPLE PROGRAM 1738=head1 EXAMPLE PROGRAM
1228 1739
1229The following program uses an I/O watcher to read data from STDIN, a timer 1740The following program uses an I/O watcher to read data from STDIN, a timer
1230to display a message once per second, and a condition variable to quit the 1741to display a message once per second, and a condition variable to quit the
1424watcher. 1935watcher.
1425 1936
1426=head3 Results 1937=head3 Results
1427 1938
1428 name watchers bytes create invoke destroy comment 1939 name watchers bytes create invoke destroy comment
1429 EV/EV 400000 244 0.56 0.46 0.31 EV native interface 1940 EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1430 EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers 1941 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1431 CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal 1942 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1432 Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation 1943 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1433 Event/Event 16000 516 31.88 31.30 0.85 Event native interface 1944 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1434 Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers 1945 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1946 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
1947 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1435 Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour 1948 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1436 Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers 1949 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1437 POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event 1950 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1438 POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select 1951 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1439 1952
1440=head3 Discussion 1953=head3 Discussion
1441 1954
1442The benchmark does I<not> measure scalability of the event loop very 1955The benchmark does I<not> measure scalability of the event loop very
1443well. For example, a select-based event loop (such as the pure perl one) 1956well. For example, a select-based event loop (such as the pure perl one)
1468performance becomes really bad with lots of file descriptors (and few of 1981performance becomes really bad with lots of file descriptors (and few of
1469them active), of course, but this was not subject of this benchmark. 1982them active), of course, but this was not subject of this benchmark.
1470 1983
1471The C<Event> module has a relatively high setup and callback invocation 1984The C<Event> module has a relatively high setup and callback invocation
1472cost, but overall scores in on the third place. 1985cost, but overall scores in on the third place.
1986
1987C<IO::Async> performs admirably well, about on par with C<Event>, even
1988when using its pure perl backend.
1473 1989
1474C<Glib>'s memory usage is quite a bit higher, but it features a 1990C<Glib>'s memory usage is quite a bit higher, but it features a
1475faster callback invocation and overall ends up in the same class as 1991faster callback invocation and overall ends up in the same class as
1476C<Event>. However, Glib scales extremely badly, doubling the number of 1992C<Event>. However, Glib scales extremely badly, doubling the number of
1477watchers increases the processing time by more than a factor of four, 1993watchers increases the processing time by more than a factor of four,
1555it to another server. This includes deleting the old timeout and creating 2071it to another server. This includes deleting the old timeout and creating
1556a new one that moves the timeout into the future. 2072a new one that moves the timeout into the future.
1557 2073
1558=head3 Results 2074=head3 Results
1559 2075
1560 name sockets create request 2076 name sockets create request
1561 EV 20000 69.01 11.16 2077 EV 20000 69.01 11.16
1562 Perl 20000 73.32 35.87 2078 Perl 20000 73.32 35.87
2079 IOAsync 20000 157.00 98.14 epoll
2080 IOAsync 20000 159.31 616.06 poll
1563 Event 20000 212.62 257.32 2081 Event 20000 212.62 257.32
1564 Glib 20000 651.16 1896.30 2082 Glib 20000 651.16 1896.30
1565 POE 20000 349.67 12317.24 uses POE::Loop::Event 2083 POE 20000 349.67 12317.24 uses POE::Loop::Event
1566 2084
1567=head3 Discussion 2085=head3 Discussion
1568 2086
1569This benchmark I<does> measure scalability and overall performance of the 2087This benchmark I<does> measure scalability and overall performance of the
1570particular event loop. 2088particular event loop.
1572EV is again fastest. Since it is using epoll on my system, the setup time 2090EV is again fastest. Since it is using epoll on my system, the setup time
1573is relatively high, though. 2091is relatively high, though.
1574 2092
1575Perl surprisingly comes second. It is much faster than the C-based event 2093Perl surprisingly comes second. It is much faster than the C-based event
1576loops Event and Glib. 2094loops Event and Glib.
2095
2096IO::Async performs very well when using its epoll backend, and still quite
2097good compared to Glib when using its pure perl backend.
1577 2098
1578Event suffers from high setup time as well (look at its code and you will 2099Event suffers from high setup time as well (look at its code and you will
1579understand why). Callback invocation also has a high overhead compared to 2100understand why). Callback invocation also has a high overhead compared to
1580the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 2101the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1581uses select or poll in basically all documented configurations. 2102uses select or poll in basically all documented configurations.
1644=item * C-based event loops perform very well with small number of 2165=item * C-based event loops perform very well with small number of
1645watchers, as the management overhead dominates. 2166watchers, as the management overhead dominates.
1646 2167
1647=back 2168=back
1648 2169
2170=head2 THE IO::Lambda BENCHMARK
2171
2172Recently I was told about the benchmark in the IO::Lambda manpage, which
2173could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
2174simply compares IO::Lambda with POE, and IO::Lambda looks better (which
2175shouldn't come as a surprise to anybody). As such, the benchmark is
2176fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
2177very optimal. But how would AnyEvent compare when used without the extra
2178baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
2179
2180The benchmark itself creates an echo-server, and then, for 500 times,
2181connects to the echo server, sends a line, waits for the reply, and then
2182creates the next connection. This is a rather bad benchmark, as it doesn't
2183test the efficiency of the framework or much non-blocking I/O, but it is a
2184benchmark nevertheless.
2185
2186 name runtime
2187 Lambda/select 0.330 sec
2188 + optimized 0.122 sec
2189 Lambda/AnyEvent 0.327 sec
2190 + optimized 0.138 sec
2191 Raw sockets/select 0.077 sec
2192 POE/select, components 0.662 sec
2193 POE/select, raw sockets 0.226 sec
2194 POE/select, optimized 0.404 sec
2195
2196 AnyEvent/select/nb 0.085 sec
2197 AnyEvent/EV/nb 0.068 sec
2198 +state machine 0.134 sec
2199
2200The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
2201benchmarks actually make blocking connects and use 100% blocking I/O,
2202defeating the purpose of an event-based solution. All of the newly
2203written AnyEvent benchmarks use 100% non-blocking connects (using
2204AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
2205resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
2206generally require a lot more bookkeeping and event handling than blocking
2207connects (which involve a single syscall only).
2208
2209The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
2210offers similar expressive power as POE and IO::Lambda, using conventional
2211Perl syntax. This means that both the echo server and the client are 100%
2212non-blocking, further placing it at a disadvantage.
2213
2214As you can see, the AnyEvent + EV combination even beats the
2215hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2216backend easily beats IO::Lambda and POE.
2217
2218And even the 100% non-blocking version written using the high-level (and
2219slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
2220large margin, even though it does all of DNS, tcp-connect and socket I/O
2221in a non-blocking way.
2222
2223The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2224F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2225part of the IO::lambda distribution and were used without any changes.
2226
2227
2228=head1 SIGNALS
2229
2230AnyEvent currently installs handlers for these signals:
2231
2232=over 4
2233
2234=item SIGCHLD
2235
2236A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2237emulation for event loops that do not support them natively. Also, some
2238event loops install a similar handler.
2239
2240Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2241AnyEvent will reset it to default, to avoid losing child exit statuses.
2242
2243=item SIGPIPE
2244
2245A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2246when AnyEvent gets loaded.
2247
2248The rationale for this is that AnyEvent users usually do not really depend
2249on SIGPIPE delivery (which is purely an optimisation for shell use, or
2250badly-written programs), but C<SIGPIPE> can cause spurious and rare
2251program exits as a lot of people do not expect C<SIGPIPE> when writing to
2252some random socket.
2253
2254The rationale for installing a no-op handler as opposed to ignoring it is
2255that this way, the handler will be restored to defaults on exec.
2256
2257Feel free to install your own handler, or reset it to defaults.
2258
2259=back
2260
2261=cut
2262
2263undef $SIG{CHLD}
2264 if $SIG{CHLD} eq 'IGNORE';
2265
2266$SIG{PIPE} = sub { }
2267 unless defined $SIG{PIPE};
2268
2269=head1 RECOMMENDED/OPTIONAL MODULES
2270
2271One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2272it's built-in modules) are required to use it.
2273
2274That does not mean that AnyEvent won't take advantage of some additional
2275modules if they are installed.
2276
2277This section epxlains which additional modules will be used, and how they
2278affect AnyEvent's operetion.
2279
2280=over 4
2281
2282=item L<Async::Interrupt>
2283
2284This slightly arcane module is used to implement fast signal handling: To
2285my knowledge, there is no way to do completely race-free and quick
2286signal handling in pure perl. To ensure that signals still get
2287delivered, AnyEvent will start an interval timer to wake up perl (and
2288catch the signals) with some delay (default is 10 seconds, look for
2289C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2290
2291If this module is available, then it will be used to implement signal
2292catching, which means that signals will not be delayed, and the event loop
2293will not be interrupted regularly, which is more efficient (And good for
2294battery life on laptops).
2295
2296This affects not just the pure-perl event loop, but also other event loops
2297that have no signal handling on their own (e.g. Glib, Tk, Qt).
2298
2299Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
2300and either employ their own workarounds (POE) or use AnyEvent's workaround
2301(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
2302does nothing for those backends.
2303
2304=item L<EV>
2305
2306This module isn't really "optional", as it is simply one of the backend
2307event loops that AnyEvent can use. However, it is simply the best event
2308loop available in terms of features, speed and stability: It supports
2309the AnyEvent API optimally, implements all the watcher types in XS, does
2310automatic timer adjustments even when no monotonic clock is available,
2311can take avdantage of advanced kernel interfaces such as C<epoll> and
2312C<kqueue>, and is the fastest backend I<by far>. You can even embed
2313L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2314
2315=item L<Guard>
2316
2317The guard module, when used, will be used to implement
2318C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2319lot less memory), but otherwise doesn't affect guard operation much. It is
2320purely used for performance.
2321
2322=item L<JSON> and L<JSON::XS>
2323
2324This module is required when you want to read or write JSON data via
2325L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2326advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2327
2328In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2329installed.
2330
2331=item L<Net::SSLeay>
2332
2333Implementing TLS/SSL in Perl is certainly interesting, but not very
2334worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2335the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2336
2337=item L<Time::HiRes>
2338
2339This module is part of perl since release 5.008. It will be used when the
2340chosen event library does not come with a timing source on it's own. The
2341pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2342try to use a monotonic clock for timing stability.
2343
2344=back
2345
1649 2346
1650=head1 FORK 2347=head1 FORK
1651 2348
1652Most event libraries are not fork-safe. The ones who are usually are 2349Most event libraries are not fork-safe. The ones who are usually are
1653because they rely on inefficient but fork-safe C<select> or C<poll> 2350because they rely on inefficient but fork-safe C<select> or C<poll>
1654calls. Only L<EV> is fully fork-aware. 2351calls. Only L<EV> is fully fork-aware.
1655 2352
1656If you have to fork, you must either do so I<before> creating your first 2353If you have to fork, you must either do so I<before> creating your first
1657watcher OR you must not use AnyEvent at all in the child. 2354watcher OR you must not use AnyEvent at all in the child OR you must do
2355something completely out of the scope of AnyEvent.
1658 2356
1659 2357
1660=head1 SECURITY CONSIDERATIONS 2358=head1 SECURITY CONSIDERATIONS
1661 2359
1662AnyEvent can be forced to load any event model via 2360AnyEvent can be forced to load any event model via
1673 2371
1674 use AnyEvent; 2372 use AnyEvent;
1675 2373
1676Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2374Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1677be used to probe what backend is used and gain other information (which is 2375be used to probe what backend is used and gain other information (which is
1678probably even less useful to an attacker than PERL_ANYEVENT_MODEL). 2376probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
2377$ENV{PERL_ANYEVENT_STRICT}.
2378
2379Note that AnyEvent will remove I<all> environment variables starting with
2380C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2381enabled.
1679 2382
1680 2383
1681=head1 BUGS 2384=head1 BUGS
1682 2385
1683Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 2386Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1684to work around. If you suffer from memleaks, first upgrade to Perl 5.10 2387to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1685and check wether the leaks still show up. (Perl 5.10.0 has other annoying 2388and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1686mamleaks, such as leaking on C<map> and C<grep> but it is usually not as 2389memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1687pronounced). 2390pronounced).
1688 2391
1689 2392
1690=head1 SEE ALSO 2393=head1 SEE ALSO
1691 2394
1695L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2398L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1696 2399
1697Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2400Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1698L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2401L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1699L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2402L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1700L<AnyEvent::Impl::POE>. 2403L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.
1701 2404
1702Non-blocking file handles, sockets, TCP clients and 2405Non-blocking file handles, sockets, TCP clients and
1703servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. 2406servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1704 2407
1705Asynchronous DNS: L<AnyEvent::DNS>. 2408Asynchronous DNS: L<AnyEvent::DNS>.
1706 2409
1707Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 2410Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
2411L<Coro::Event>,
1708 2412
1709Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 2413Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
2414L<AnyEvent::HTTP>.
1710 2415
1711 2416
1712=head1 AUTHOR 2417=head1 AUTHOR
1713 2418
1714 Marc Lehmann <schmorp@schmorp.de> 2419 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines