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.174 by root, Thu Jul 24 06:40:22 2008 UTC vs.
Revision 1.277 by root, Sun Aug 9 13:27:23 2009 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - the DBI of event loop programming
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops 5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6and POE are various supported event loops/environments.
6 7
7=head1 SYNOPSIS 8=head1 SYNOPSIS
8 9
9 use AnyEvent; 10 use AnyEvent;
10 11
12 # file descriptor readable
11 my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { ... }); 13 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
12 14
15 # one-shot or repeating timers
13 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); 16 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
14 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... 17 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
15 18
16 print AnyEvent->now; # prints current event loop time 19 print AnyEvent->now; # prints current event loop time
17 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. 20 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
18 21
22 # POSIX signal
19 my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... }); 23 my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
20 24
25 # child process exit
21 my $w = AnyEvent->child (pid => $pid, cb => sub { 26 my $w = AnyEvent->child (pid => $pid, cb => sub {
22 my ($pid, $status) = @_; 27 my ($pid, $status) = @_;
23 ... 28 ...
24 }); 29 });
30
31 # called when event loop idle (if applicable)
32 my $w = AnyEvent->idle (cb => sub { ... });
25 33
26 my $w = AnyEvent->condvar; # stores whether a condition was flagged 34 my $w = AnyEvent->condvar; # stores whether a condition was flagged
27 $w->send; # wake up current and all future recv's 35 $w->send; # wake up current and all future recv's
28 $w->recv; # enters "main loop" till $condvar gets ->send 36 $w->recv; # enters "main loop" till $condvar gets ->send
29 # use a condvar in callback mode: 37 # use a condvar in callback mode:
32=head1 INTRODUCTION/TUTORIAL 40=head1 INTRODUCTION/TUTORIAL
33 41
34This manpage is mainly a reference manual. If you are interested 42This manpage is mainly a reference manual. If you are interested
35in a tutorial or some gentle introduction, have a look at the 43in a tutorial or some gentle introduction, have a look at the
36L<AnyEvent::Intro> manpage. 44L<AnyEvent::Intro> manpage.
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
52Repository>, at L<http://anyevent.schmorp.de>, for more info.
37 53
38=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 54=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
39 55
40Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 56Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
41nowadays. So what is different about AnyEvent? 57nowadays. So what is different about AnyEvent?
137These watchers are normal Perl objects with normal Perl lifetime. After 153These watchers are normal Perl objects with normal Perl lifetime. After
138creating a watcher it will immediately "watch" for events and invoke the 154creating a watcher it will immediately "watch" for events and invoke the
139callback when the event occurs (of course, only when the event model 155callback when the event occurs (of course, only when the event model
140is in control). 156is in control).
141 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
142To 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
143variable 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
144to it). 166to it).
145 167
146All 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.
159my variables are only visible after the statement in which they are 181my variables are only visible after the statement in which they are
160declared. 182declared.
161 183
162=head2 I/O WATCHERS 184=head2 I/O WATCHERS
163 185
186 $w = AnyEvent->io (
187 fh => <filehandle_or_fileno>,
188 poll => <"r" or "w">,
189 cb => <callback>,
190 );
191
164You can create an I/O watcher by calling the C<< AnyEvent->io >> method 192You can create an I/O watcher by calling the C<< AnyEvent->io >> method
165with the following mandatory key-value pairs as arguments: 193with the following mandatory key-value pairs as arguments:
166 194
167C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events 195C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
168(AnyEvent might or might not keep a reference to this file handle). C<poll> 196for events (AnyEvent might or might not keep a reference to this file
197handle). Note that only file handles pointing to things for which
198non-blocking operation makes sense are allowed. This includes sockets,
199most character devices, pipes, fifos and so on, but not for example files
200or block devices.
201
169must be a string that is either C<r> or C<w>, which creates a watcher 202C<poll> must be a string that is either C<r> or C<w>, which creates a
170waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the 203watcher waiting for "r"eadable or "w"ritable events, respectively.
204
171callback to invoke each time the file handle becomes ready. 205C<cb> is the callback to invoke each time the file handle becomes ready.
172 206
173Although the callback might get passed parameters, their value and 207Although the callback might get passed parameters, their value and
174presence is undefined and you cannot rely on them. Portable AnyEvent 208presence is undefined and you cannot rely on them. Portable AnyEvent
175callbacks cannot use arguments passed to I/O watcher callbacks. 209callbacks cannot use arguments passed to I/O watcher callbacks.
176 210
191 undef $w; 225 undef $w;
192 }); 226 });
193 227
194=head2 TIME WATCHERS 228=head2 TIME WATCHERS
195 229
230 $w = AnyEvent->timer (after => <seconds>, cb => <callback>);
231
232 $w = AnyEvent->timer (
233 after => <fractional_seconds>,
234 interval => <fractional_seconds>,
235 cb => <callback>,
236 );
237
196You can create a time watcher by calling the C<< AnyEvent->timer >> 238You can create a time watcher by calling the C<< AnyEvent->timer >>
197method with the following mandatory arguments: 239method with the following mandatory arguments:
198 240
199C<after> specifies after how many seconds (fractional values are 241C<after> specifies after how many seconds (fractional values are
200supported) the callback should be invoked. C<cb> is the callback to invoke 242supported) the callback should be invoked. C<cb> is the callback to invoke
308In either case, if you care (and in most cases, you don't), then you 350In either case, if you care (and in most cases, you don't), then you
309can get whatever behaviour you want with any event loop, by taking the 351can get whatever behaviour you want with any event loop, by taking the
310difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 352difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
311account. 353account.
312 354
355=item AnyEvent->now_update
356
357Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
358the current time for each loop iteration (see the discussion of L<<
359AnyEvent->now >>, above).
360
361When a callback runs for a long time (or when the process sleeps), then
362this "current" time will differ substantially from the real time, which
363might affect timers and time-outs.
364
365When this is the case, you can call this method, which will update the
366event loop's idea of "current time".
367
368Note that updating the time I<might> cause some events to be handled.
369
313=back 370=back
314 371
315=head2 SIGNAL WATCHERS 372=head2 SIGNAL WATCHERS
373
374 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
316 375
317You can watch for signals using a signal watcher, C<signal> is the signal 376You can watch for signals using a signal watcher, C<signal> is the signal
318I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl 377I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
319callback to be invoked whenever a signal occurs. 378callback to be invoked whenever a signal occurs.
320 379
326invocation, and callback invocation will be synchronous. Synchronous means 385invocation, and callback invocation will be synchronous. Synchronous means
327that it might take a while until the signal gets handled by the process, 386that it might take a while until the signal gets handled by the process,
328but it is guaranteed not to interrupt any other callbacks. 387but it is guaranteed not to interrupt any other callbacks.
329 388
330The main advantage of using these watchers is that you can share a signal 389The main advantage of using these watchers is that you can share a signal
331between multiple watchers. 390between multiple watchers, and AnyEvent will ensure that signals will not
391interrupt your program at bad times.
332 392
333This watcher might use C<%SIG>, so programs overwriting those signals 393This watcher might use C<%SIG> (depending on the event loop used),
334directly will likely not work correctly. 394so programs overwriting those signals directly will likely not work
395correctly.
335 396
336Example: exit on SIGINT 397Example: exit on SIGINT
337 398
338 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 399 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
339 400
401=head3 Signal Races, Delays and Workarounds
402
403Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
404callbacks to signals in a generic way, which is a pity, as you cannot
405do race-free signal handling in perl, requiring C libraries for
406this. AnyEvent will try to do it's best, which means in some cases,
407signals will be delayed. The maximum time a signal might be delayed is
408specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
409variable can be changed only before the first signal watcher is created,
410and should be left alone otherwise. This variable determines how often
411AnyEvent polls for signals (in case a wake-up was missed). Higher values
412will cause fewer spurious wake-ups, which is better for power and CPU
413saving.
414
415All these problems can be avoided by installing the optional
416L<Async::Interrupt> module, which works with most event loops. It will not
417work with inherently broken event loops such as L<Event> or L<Event::Lib>
418(and not with L<POE> currently, as POE does it's own workaround with
419one-second latency). For those, you just have to suffer the delays.
420
340=head2 CHILD PROCESS WATCHERS 421=head2 CHILD PROCESS WATCHERS
341 422
423 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
424
342You can also watch on a child process exit and catch its exit status. 425You can also watch on a child process exit and catch its exit status.
343 426
344The child process is specified by the C<pid> argument (if set to C<0>, it 427The child process is specified by the C<pid> argument (one some backends,
345watches for any child process exit). The watcher will trigger as often 428using C<0> watches for any child process exit, on others this will
346as status change for the child are received. This works by installing a 429croak). The watcher will be triggered only when the child process has
347signal handler for C<SIGCHLD>. The callback will be called with the pid 430finished and an exit status is available, not on any trace events
348and exit status (as returned by waitpid), so unlike other watcher types, 431(stopped/continued).
349you I<can> rely on child watcher callback arguments. 432
433The callback will be called with the pid and exit status (as returned by
434waitpid), so unlike other watcher types, you I<can> rely on child watcher
435callback arguments.
436
437This watcher type works by installing a signal handler for C<SIGCHLD>,
438and since it cannot be shared, nothing else should use SIGCHLD or reap
439random child processes (waiting for specific child processes, e.g. inside
440C<system>, is just fine).
350 441
351There is a slight catch to child watchers, however: you usually start them 442There is a slight catch to child watchers, however: you usually start them
352I<after> the child process was created, and this means the process could 443I<after> the child process was created, and this means the process could
353have exited already (and no SIGCHLD will be sent anymore). 444have exited already (and no SIGCHLD will be sent anymore).
354 445
355Not all event models handle this correctly (POE doesn't), but even for 446Not all event models handle this correctly (neither POE nor IO::Async do,
447see their AnyEvent::Impl manpages for details), but even for event models
356event models that I<do> handle this correctly, they usually need to be 448that I<do> handle this correctly, they usually need to be loaded before
357loaded before the process exits (i.e. before you fork in the first place). 449the process exits (i.e. before you fork in the first place). AnyEvent's
450pure perl event loop handles all cases correctly regardless of when you
451start the watcher.
358 452
359This means you cannot create a child watcher as the very first thing in an 453This means you cannot create a child watcher as the very first
360AnyEvent program, you I<have> to create at least one watcher before you 454thing in an AnyEvent program, you I<have> to create at least one
361C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 455watcher before you C<fork> the child (alternatively, you can call
456C<AnyEvent::detect>).
457
458As most event loops do not support waiting for child events, they will be
459emulated by AnyEvent in most cases, in which the latency and race problems
460mentioned in the description of signal watchers apply.
362 461
363Example: fork a process and wait for it 462Example: fork a process and wait for it
364 463
365 my $done = AnyEvent->condvar; 464 my $done = AnyEvent->condvar;
366 465
376 ); 475 );
377 476
378 # do something else, then wait for process exit 477 # do something else, then wait for process exit
379 $done->recv; 478 $done->recv;
380 479
480=head2 IDLE WATCHERS
481
482 $w = AnyEvent->idle (cb => <callback>);
483
484Sometimes there is a need to do something, but it is not so important
485to do it instantly, but only when there is nothing better to do. This
486"nothing better to do" is usually defined to be "no other events need
487attention by the event loop".
488
489Idle watchers ideally get invoked when the event loop has nothing
490better to do, just before it would block the process to wait for new
491events. Instead of blocking, the idle watcher is invoked.
492
493Most event loops unfortunately do not really support idle watchers (only
494EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
495will simply call the callback "from time to time".
496
497Example: read lines from STDIN, but only process them when the
498program is otherwise idle:
499
500 my @lines; # read data
501 my $idle_w;
502 my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
503 push @lines, scalar <STDIN>;
504
505 # start an idle watcher, if not already done
506 $idle_w ||= AnyEvent->idle (cb => sub {
507 # handle only one line, when there are lines left
508 if (my $line = shift @lines) {
509 print "handled when idle: $line";
510 } else {
511 # otherwise disable the idle watcher again
512 undef $idle_w;
513 }
514 });
515 });
516
381=head2 CONDITION VARIABLES 517=head2 CONDITION VARIABLES
518
519 $cv = AnyEvent->condvar;
520
521 $cv->send (<list>);
522 my @res = $cv->recv;
382 523
383If you are familiar with some event loops you will know that all of them 524If you are familiar with some event loops you will know that all of them
384require you to run some blocking "loop", "run" or similar function that 525require you to run some blocking "loop", "run" or similar function that
385will actively watch for new events and call your callbacks. 526will actively watch for new events and call your callbacks.
386 527
387AnyEvent is different, it expects somebody else to run the event loop and 528AnyEvent is slightly different: it expects somebody else to run the event
388will only block when necessary (usually when told by the user). 529loop and will only block when necessary (usually when told by the user).
389 530
390The instrument to do that is called a "condition variable", so called 531The instrument to do that is called a "condition variable", so called
391because they represent a condition that must become true. 532because they represent a condition that must become true.
392 533
534Now is probably a good time to look at the examples further below.
535
393Condition variables can be created by calling the C<< AnyEvent->condvar 536Condition variables can be created by calling the C<< AnyEvent->condvar
394>> method, usually without arguments. The only argument pair allowed is 537>> method, usually without arguments. The only argument pair allowed is
395
396C<cb>, which specifies a callback to be called when the condition variable 538C<cb>, which specifies a callback to be called when the condition variable
397becomes true, with the condition variable as the first argument (but not 539becomes true, with the condition variable as the first argument (but not
398the results). 540the results).
399 541
400After creation, the condition variable is "false" until it becomes "true" 542After creation, the condition variable is "false" until it becomes "true"
405Condition variables are similar to callbacks, except that you can 547Condition variables are similar to callbacks, except that you can
406optionally wait for them. They can also be called merge points - points 548optionally wait for them. They can also be called merge points - points
407in time where multiple outstanding events have been processed. And yet 549in time where multiple outstanding events have been processed. And yet
408another way to call them is transactions - each condition variable can be 550another way to call them is transactions - each condition variable can be
409used to represent a transaction, which finishes at some point and delivers 551used to represent a transaction, which finishes at some point and delivers
410a result. 552a result. And yet some people know them as "futures" - a promise to
553compute/deliver something that you can wait for.
411 554
412Condition variables are very useful to signal that something has finished, 555Condition variables are very useful to signal that something has finished,
413for example, if you write a module that does asynchronous http requests, 556for example, if you write a module that does asynchronous http requests,
414then a condition variable would be the ideal candidate to signal the 557then a condition variable would be the ideal candidate to signal the
415availability of results. The user can either act when the callback is 558availability of results. The user can either act when the callback is
449 after => 1, 592 after => 1,
450 cb => sub { $result_ready->send }, 593 cb => sub { $result_ready->send },
451 ); 594 );
452 595
453 # this "blocks" (while handling events) till the callback 596 # this "blocks" (while handling events) till the callback
454 # calls send 597 # calls -<send
455 $result_ready->recv; 598 $result_ready->recv;
456 599
457Example: wait for a timer, but take advantage of the fact that 600Example: wait for a timer, but take advantage of the fact that condition
458condition variables are also code references. 601variables are also callable directly.
459 602
460 my $done = AnyEvent->condvar; 603 my $done = AnyEvent->condvar;
461 my $delay = AnyEvent->timer (after => 5, cb => $done); 604 my $delay = AnyEvent->timer (after => 5, cb => $done);
462 $done->recv; 605 $done->recv;
463 606
469 612
470 ... 613 ...
471 614
472 my @info = $couchdb->info->recv; 615 my @info = $couchdb->info->recv;
473 616
474And this is how you would just ste a callback to be called whenever the 617And this is how you would just set a callback to be called whenever the
475results are available: 618results are available:
476 619
477 $couchdb->info->cb (sub { 620 $couchdb->info->cb (sub {
478 my @info = $_[0]->recv; 621 my @info = $_[0]->recv;
479 }); 622 });
497immediately from within send. 640immediately from within send.
498 641
499Any arguments passed to the C<send> call will be returned by all 642Any arguments passed to the C<send> call will be returned by all
500future C<< ->recv >> calls. 643future C<< ->recv >> calls.
501 644
502Condition variables are overloaded so one can call them directly 645Condition variables are overloaded so one can call them directly (as if
503(as a code reference). Calling them directly is the same as calling 646they were a code reference). Calling them directly is the same as calling
504C<send>. Note, however, that many C-based event loops do not handle 647C<send>.
505overloading, so as tempting as it may be, passing a condition variable
506instead of a callback does not work. Both the pure perl and EV loops
507support overloading, however, as well as all functions that use perl to
508invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
509example).
510 648
511=item $cv->croak ($error) 649=item $cv->croak ($error)
512 650
513Similar to send, but causes all call's to C<< ->recv >> to invoke 651Similar to send, but causes all call's to C<< ->recv >> to invoke
514C<Carp::croak> with the given error message/object/scalar. 652C<Carp::croak> with the given error message/object/scalar.
515 653
516This can be used to signal any errors to the condition variable 654This can be used to signal any errors to the condition variable
517user/consumer. 655user/consumer. Doing it this way instead of calling C<croak> directly
656delays the error detetcion, but has the overwhelmign advantage that it
657diagnoses the error at the place where the result is expected, and not
658deep in some event clalback without connection to the actual code causing
659the problem.
518 660
519=item $cv->begin ([group callback]) 661=item $cv->begin ([group callback])
520 662
521=item $cv->end 663=item $cv->end
522
523These two methods are EXPERIMENTAL and MIGHT CHANGE.
524 664
525These two methods can be used to combine many transactions/events into 665These two methods can be used to combine many transactions/events into
526one. For example, a function that pings many hosts in parallel might want 666one. For example, a function that pings many hosts in parallel might want
527to use a condition variable for the whole process. 667to use a condition variable for the whole process.
528 668
530C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 670C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
531>>, the (last) callback passed to C<begin> will be executed. That callback 671>>, the (last) callback passed to C<begin> will be executed. That callback
532is I<supposed> to call C<< ->send >>, but that is not required. If no 672is I<supposed> to call C<< ->send >>, but that is not required. If no
533callback was set, C<send> will be called without any arguments. 673callback was set, C<send> will be called without any arguments.
534 674
535Let's clarify this with the ping example: 675You can think of C<< $cv->send >> giving you an OR condition (one call
676sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
677condition (all C<begin> calls must be C<end>'ed before the condvar sends).
678
679Let's start with a simple example: you have two I/O watchers (for example,
680STDOUT and STDERR for a program), and you want to wait for both streams to
681close before activating a condvar:
682
683 my $cv = AnyEvent->condvar;
684
685 $cv->begin; # first watcher
686 my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
687 defined sysread $fh1, my $buf, 4096
688 or $cv->end;
689 });
690
691 $cv->begin; # second watcher
692 my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
693 defined sysread $fh2, my $buf, 4096
694 or $cv->end;
695 });
696
697 $cv->recv;
698
699This works because for every event source (EOF on file handle), there is
700one call to C<begin>, so the condvar waits for all calls to C<end> before
701sending.
702
703The ping example mentioned above is slightly more complicated, as the
704there are results to be passwd back, and the number of tasks that are
705begung can potentially be zero:
536 706
537 my $cv = AnyEvent->condvar; 707 my $cv = AnyEvent->condvar;
538 708
539 my %result; 709 my %result;
540 $cv->begin (sub { $cv->send (\%result) }); 710 $cv->begin (sub { $cv->send (\%result) });
560loop, which serves two important purposes: first, it sets the callback 730loop, which serves two important purposes: first, it sets the callback
561to be called once the counter reaches C<0>, and second, it ensures that 731to be called once the counter reaches C<0>, and second, it ensures that
562C<send> is called even when C<no> hosts are being pinged (the loop 732C<send> is called even when C<no> hosts are being pinged (the loop
563doesn't execute once). 733doesn't execute once).
564 734
565This is the general pattern when you "fan out" into multiple subrequests: 735This is the general pattern when you "fan out" into multiple (but
566use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 736potentially none) subrequests: use an outer C<begin>/C<end> pair to set
567is called at least once, and then, for each subrequest you start, call 737the callback and ensure C<end> is called at least once, and then, for each
568C<begin> and for each subrequest you finish, call C<end>. 738subrequest you start, call C<begin> and for each subrequest you finish,
739call C<end>.
569 740
570=back 741=back
571 742
572=head3 METHODS FOR CONSUMERS 743=head3 METHODS FOR CONSUMERS
573 744
589function will call C<croak>. 760function will call C<croak>.
590 761
591In list context, all parameters passed to C<send> will be returned, 762In list context, all parameters passed to C<send> will be returned,
592in scalar context only the first one will be returned. 763in scalar context only the first one will be returned.
593 764
765Note that doing a blocking wait in a callback is not supported by any
766event loop, that is, recursive invocation of a blocking C<< ->recv
767>> is not allowed, and the C<recv> call will C<croak> if such a
768condition is detected. This condition can be slightly loosened by using
769L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
770any thread that doesn't run the event loop itself.
771
594Not all event models support a blocking wait - some die in that case 772Not all event models support a blocking wait - some die in that case
595(programs might want to do that to stay interactive), so I<if you are 773(programs might want to do that to stay interactive), so I<if you are
596using this from a module, never require a blocking wait>, but let the 774using this from a module, never require a blocking wait>. Instead, let the
597caller decide whether the call will block or not (for example, by coupling 775caller decide whether the call will block or not (for example, by coupling
598condition variables with some kind of request results and supporting 776condition variables with some kind of request results and supporting
599callbacks so the caller knows that getting the result will not block, 777callbacks so the caller knows that getting the result will not block,
600while still supporting blocking waits if the caller so desires). 778while still supporting blocking waits if the caller so desires).
601 779
602Another reason I<never> to C<< ->recv >> in a module is that you cannot
603sensibly have two C<< ->recv >>'s in parallel, as that would require
604multiple interpreters or coroutines/threads, none of which C<AnyEvent>
605can supply.
606
607The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
608fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
609versions and also integrates coroutines into AnyEvent, making blocking
610C<< ->recv >> calls perfectly safe as long as they are done from another
611coroutine (one that doesn't run the event loop).
612
613You can ensure that C<< -recv >> never blocks by setting a callback and 780You can ensure that C<< -recv >> never blocks by setting a callback and
614only calling C<< ->recv >> from within that callback (or at a later 781only calling C<< ->recv >> from within that callback (or at a later
615time). This will work even when the event loop does not support blocking 782time). This will work even when the event loop does not support blocking
616waits otherwise. 783waits otherwise.
617 784
623=item $cb = $cv->cb ($cb->($cv)) 790=item $cb = $cv->cb ($cb->($cv))
624 791
625This is a mutator function that returns the callback set and optionally 792This is a mutator function that returns the callback set and optionally
626replaces it before doing so. 793replaces it before doing so.
627 794
628The callback will be called when the condition becomes "true", i.e. when 795The callback will be called when the condition becomes (or already was)
629C<send> or C<croak> are called, with the only argument being the condition 796"true", i.e. when C<send> or C<croak> are called (or were called), with
630variable itself. Calling C<recv> inside the callback or at any later time 797the only argument being the condition variable itself. Calling C<recv>
631is guaranteed not to block. 798inside the callback or at any later time is guaranteed not to block.
632 799
633=back 800=back
634 801
802=head1 SUPPORTED EVENT LOOPS/BACKENDS
803
804The available backend classes are (every class has its own manpage):
805
806=over 4
807
808=item Backends that are autoprobed when no other event loop can be found.
809
810EV is the preferred backend when no other event loop seems to be in
811use. If EV is not installed, then AnyEvent will fall back to its own
812pure-perl implementation, which is available everywhere as it comes with
813AnyEvent itself.
814
815 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
816 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
817
818=item Backends that are transparently being picked up when they are used.
819
820These will be used when they are currently loaded when the first watcher
821is created, in which case it is assumed that the application is using
822them. This means that AnyEvent will automatically pick the right backend
823when the main program loads an event module before anything starts to
824create watchers. Nothing special needs to be done by the main program.
825
826 AnyEvent::Impl::Event based on Event, very stable, few glitches.
827 AnyEvent::Impl::Glib based on Glib, slow but very stable.
828 AnyEvent::Impl::Tk based on Tk, very broken.
829 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
830 AnyEvent::Impl::POE based on POE, very slow, some limitations.
831 AnyEvent::Impl::Irssi used when running within irssi.
832
833=item Backends with special needs.
834
835Qt requires the Qt::Application to be instantiated first, but will
836otherwise be picked up automatically. As long as the main program
837instantiates the application before any AnyEvent watchers are created,
838everything should just work.
839
840 AnyEvent::Impl::Qt based on Qt.
841
842Support for IO::Async can only be partial, as it is too broken and
843architecturally limited to even support the AnyEvent API. It also
844is the only event loop that needs the loop to be set explicitly, so
845it can only be used by a main program knowing about AnyEvent. See
846L<AnyEvent::Impl::Async> for the gory details.
847
848 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
849
850=item Event loops that are indirectly supported via other backends.
851
852Some event loops can be supported via other modules:
853
854There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
855
856B<WxWidgets> has no support for watching file handles. However, you can
857use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
858polls 20 times per second, which was considered to be too horrible to even
859consider for AnyEvent.
860
861B<Prima> is not supported as nobody seems to be using it, but it has a POE
862backend, so it can be supported through POE.
863
864AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
865load L<POE> when detecting them, in the hope that POE will pick them up,
866in which case everything will be automatic.
867
868=back
869
635=head1 GLOBAL VARIABLES AND FUNCTIONS 870=head1 GLOBAL VARIABLES AND FUNCTIONS
636 871
872These are not normally required to use AnyEvent, but can be useful to
873write AnyEvent extension modules.
874
637=over 4 875=over 4
638 876
639=item $AnyEvent::MODEL 877=item $AnyEvent::MODEL
640 878
641Contains C<undef> until the first watcher is being created. Then it 879Contains C<undef> until the first watcher is being created, before the
880backend has been autodetected.
881
642contains the event model that is being used, which is the name of the 882Afterwards it contains the event model that is being used, which is the
643Perl class implementing the model. This class is usually one of the 883name of the Perl class implementing the model. This class is usually one
644C<AnyEvent::Impl:xxx> modules, but can be any other class in the case 884of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
645AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). 885case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
646 886will be C<urxvt::anyevent>).
647The known classes so far are:
648
649 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
650 AnyEvent::Impl::Event based on Event, second best choice.
651 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
652 AnyEvent::Impl::Glib based on Glib, third-best choice.
653 AnyEvent::Impl::Tk based on Tk, very bad choice.
654 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
655 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
656 AnyEvent::Impl::POE based on POE, not generic enough for full support.
657
658There is no support for WxWidgets, as WxWidgets has no support for
659watching file handles. However, you can use WxWidgets through the
660POE Adaptor, as POE has a Wx backend that simply polls 20 times per
661second, which was considered to be too horrible to even consider for
662AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
663it's adaptor.
664
665AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
666autodetecting them.
667 887
668=item AnyEvent::detect 888=item AnyEvent::detect
669 889
670Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 890Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
671if necessary. You should only call this function right before you would 891if necessary. You should only call this function right before you would
672have created an AnyEvent watcher anyway, that is, as late as possible at 892have created an AnyEvent watcher anyway, that is, as late as possible at
673runtime. 893runtime, and not e.g. while initialising of your module.
894
895If you need to do some initialisation before AnyEvent watchers are
896created, use C<post_detect>.
674 897
675=item $guard = AnyEvent::post_detect { BLOCK } 898=item $guard = AnyEvent::post_detect { BLOCK }
676 899
677Arranges for the code block to be executed as soon as the event model is 900Arranges for the code block to be executed as soon as the event model is
678autodetected (or immediately if this has already happened). 901autodetected (or immediately if this has already happened).
679 902
903The block will be executed I<after> the actual backend has been detected
904(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
905created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
906other initialisations - see the sources of L<AnyEvent::Strict> or
907L<AnyEvent::AIO> to see how this is used.
908
909The most common usage is to create some global watchers, without forcing
910event module detection too early, for example, L<AnyEvent::AIO> creates
911and installs the global L<IO::AIO> watcher in a C<post_detect> block to
912avoid autodetecting the event module at load time.
913
680If called in scalar or list context, then it creates and returns an object 914If called in scalar or list context, then it creates and returns an object
681that automatically removes the callback again when it is destroyed. See 915that automatically removes the callback again when it is destroyed (or
916C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
682L<Coro::BDB> for a case where this is useful. 917a case where this is useful.
918
919Example: Create a watcher for the IO::AIO module and store it in
920C<$WATCHER>. Only do so after the event loop is initialised, though.
921
922 our WATCHER;
923
924 my $guard = AnyEvent::post_detect {
925 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
926 };
927
928 # the ||= is important in case post_detect immediately runs the block,
929 # as to not clobber the newly-created watcher. assigning both watcher and
930 # post_detect guard to the same variable has the advantage of users being
931 # able to just C<undef $WATCHER> if the watcher causes them grief.
932
933 $WATCHER ||= $guard;
683 934
684=item @AnyEvent::post_detect 935=item @AnyEvent::post_detect
685 936
686If there are any code references in this array (you can C<push> to it 937If there are any code references in this array (you can C<push> to it
687before or after loading AnyEvent), then they will called directly after 938before or after loading AnyEvent), then they will called directly after
688the event loop has been chosen. 939the event loop has been chosen.
689 940
690You should check C<$AnyEvent::MODEL> before adding to this array, though: 941You should check C<$AnyEvent::MODEL> before adding to this array, though:
691if it contains a true value then the event loop has already been detected, 942if it is defined then the event loop has already been detected, and the
692and the array will be ignored. 943array will be ignored.
693 944
694Best use C<AnyEvent::post_detect { BLOCK }> instead. 945Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
946it,as it takes care of these details.
947
948This variable is mainly useful for modules that can do something useful
949when AnyEvent is used and thus want to know when it is initialised, but do
950not need to even load it by default. This array provides the means to hook
951into AnyEvent passively, without loading it.
695 952
696=back 953=back
697 954
698=head1 WHAT TO DO IN A MODULE 955=head1 WHAT TO DO IN A MODULE
699 956
754 1011
755 1012
756=head1 OTHER MODULES 1013=head1 OTHER MODULES
757 1014
758The following is a non-exhaustive list of additional modules that use 1015The following is a non-exhaustive list of additional modules that use
759AnyEvent and can therefore be mixed easily with other AnyEvent modules 1016AnyEvent as a client and can therefore be mixed easily with other AnyEvent
760in the same program. Some of the modules come with AnyEvent, some are 1017modules and other event loops in the same program. Some of the modules
761available via CPAN. 1018come with AnyEvent, most are available via CPAN.
762 1019
763=over 4 1020=over 4
764 1021
765=item L<AnyEvent::Util> 1022=item L<AnyEvent::Util>
766 1023
775 1032
776=item L<AnyEvent::Handle> 1033=item L<AnyEvent::Handle>
777 1034
778Provide read and write buffers, manages watchers for reads and writes, 1035Provide read and write buffers, manages watchers for reads and writes,
779supports raw and formatted I/O, I/O queued and fully transparent and 1036supports raw and formatted I/O, I/O queued and fully transparent and
780non-blocking SSL/TLS. 1037non-blocking SSL/TLS (via L<AnyEvent::TLS>.
781 1038
782=item L<AnyEvent::DNS> 1039=item L<AnyEvent::DNS>
783 1040
784Provides rich asynchronous DNS resolver capabilities. 1041Provides rich asynchronous DNS resolver capabilities.
785 1042
813 1070
814=item L<AnyEvent::GPSD> 1071=item L<AnyEvent::GPSD>
815 1072
816A non-blocking interface to gpsd, a daemon delivering GPS information. 1073A non-blocking interface to gpsd, a daemon delivering GPS information.
817 1074
1075=item L<AnyEvent::IRC>
1076
1077AnyEvent based IRC client module family (replacing the older Net::IRC3).
1078
1079=item L<AnyEvent::XMPP>
1080
1081AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1082Net::XMPP2>.
1083
818=item L<AnyEvent::IGS> 1084=item L<AnyEvent::IGS>
819 1085
820A non-blocking interface to the Internet Go Server protocol (used by 1086A non-blocking interface to the Internet Go Server protocol (used by
821L<App::IGS>). 1087L<App::IGS>).
822 1088
823=item L<Net::IRC3>
824
825AnyEvent based IRC client module family.
826
827=item L<Net::XMPP2>
828
829AnyEvent based XMPP (Jabber protocol) module family.
830
831=item L<Net::FCP> 1089=item L<Net::FCP>
832 1090
833AnyEvent-based implementation of the Freenet Client Protocol, birthplace 1091AnyEvent-based implementation of the Freenet Client Protocol, birthplace
834of AnyEvent. 1092of AnyEvent.
835 1093
839 1097
840=item L<Coro> 1098=item L<Coro>
841 1099
842Has special support for AnyEvent via L<Coro::AnyEvent>. 1100Has special support for AnyEvent via L<Coro::AnyEvent>.
843 1101
844=item L<IO::Lambda>
845
846The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
847
848=back 1102=back
849 1103
850=cut 1104=cut
851 1105
852package AnyEvent; 1106package AnyEvent;
853 1107
1108# basically a tuned-down version of common::sense
1109sub common_sense {
854no warnings; 1110 # no warnings
855use strict; 1111 ${^WARNING_BITS} ^= ${^WARNING_BITS};
1112 # use strict vars subs
1113 $^H |= 0x00000600;
1114}
856 1115
1116BEGIN { AnyEvent::common_sense }
1117
857use Carp; 1118use Carp ();
858 1119
859our $VERSION = 4.22; 1120our $VERSION = 4.92;
860our $MODEL; 1121our $MODEL;
861 1122
862our $AUTOLOAD; 1123our $AUTOLOAD;
863our @ISA; 1124our @ISA;
864 1125
865our @REGISTRY; 1126our @REGISTRY;
866 1127
867our $WIN32; 1128our $WIN32;
868 1129
1130our $VERBOSE;
1131
869BEGIN { 1132BEGIN {
870 my $win32 = ! ! ($^O =~ /mswin32/i); 1133 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
871 eval "sub WIN32(){ $win32 }"; 1134 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
872}
873 1135
1136 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1137 if ${^TAINT};
1138
874our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1139 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1140
1141}
1142
1143our $MAX_SIGNAL_LATENCY = 10;
875 1144
876our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1145our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
877 1146
878{ 1147{
879 my $idx; 1148 my $idx;
881 for reverse split /\s*,\s*/, 1150 for reverse split /\s*,\s*/,
882 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1151 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
883} 1152}
884 1153
885my @models = ( 1154my @models = (
886 [EV:: => AnyEvent::Impl::EV::], 1155 [EV:: => AnyEvent::Impl::EV:: , 1],
887 [Event:: => AnyEvent::Impl::Event::],
888 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1156 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
889 # everything below here will not be autoprobed 1157 # everything below here will not (normally) be autoprobed
890 # as the pureperl backend should work everywhere 1158 # as the pureperl backend should work everywhere
891 # and is usually faster 1159 # and is usually faster
1160 [Event:: => AnyEvent::Impl::Event::, 1],
1161 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1162 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1163 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
892 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1164 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
893 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
894 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
895 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1165 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
896 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1166 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
897 [Wx:: => AnyEvent::Impl::POE::], 1167 [Wx:: => AnyEvent::Impl::POE::],
898 [Prima:: => AnyEvent::Impl::POE::], 1168 [Prima:: => AnyEvent::Impl::POE::],
1169 # IO::Async is just too broken - we would need workarounds for its
1170 # byzantine signal and broken child handling, among others.
1171 # IO::Async is rather hard to detect, as it doesn't have any
1172 # obvious default class.
1173 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1174 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1175 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1176 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
899); 1177);
900 1178
901our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); 1179our %method = map +($_ => 1),
1180 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
902 1181
903our @post_detect; 1182our @post_detect;
904 1183
905sub post_detect(&) { 1184sub post_detect(&) {
906 my ($cb) = @_; 1185 my ($cb) = @_;
907 1186
908 if ($MODEL) { 1187 if ($MODEL) {
909 $cb->(); 1188 $cb->();
910 1189
911 1 1190 undef
912 } else { 1191 } else {
913 push @post_detect, $cb; 1192 push @post_detect, $cb;
914 1193
915 defined wantarray 1194 defined wantarray
916 ? bless \$cb, "AnyEvent::Util::PostDetect" 1195 ? bless \$cb, "AnyEvent::Util::postdetect"
917 : () 1196 : ()
918 } 1197 }
919} 1198}
920 1199
921sub AnyEvent::Util::PostDetect::DESTROY { 1200sub AnyEvent::Util::postdetect::DESTROY {
922 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1201 @post_detect = grep $_ != ${$_[0]}, @post_detect;
923} 1202}
924 1203
925sub detect() { 1204sub detect() {
926 unless ($MODEL) { 1205 unless ($MODEL) {
927 no strict 'refs';
928 local $SIG{__DIE__}; 1206 local $SIG{__DIE__};
929 1207
930 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1208 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
931 my $model = "AnyEvent::Impl::$1"; 1209 my $model = "AnyEvent::Impl::$1";
932 if (eval "require $model") { 1210 if (eval "require $model") {
933 $MODEL = $model; 1211 $MODEL = $model;
934 warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; 1212 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
935 } else { 1213 } else {
936 warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; 1214 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
937 } 1215 }
938 } 1216 }
939 1217
940 # check for already loaded models 1218 # check for already loaded models
941 unless ($MODEL) { 1219 unless ($MODEL) {
942 for (@REGISTRY, @models) { 1220 for (@REGISTRY, @models) {
943 my ($package, $model) = @$_; 1221 my ($package, $model) = @$_;
944 if (${"$package\::VERSION"} > 0) { 1222 if (${"$package\::VERSION"} > 0) {
945 if (eval "require $model") { 1223 if (eval "require $model") {
946 $MODEL = $model; 1224 $MODEL = $model;
947 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; 1225 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
948 last; 1226 last;
949 } 1227 }
950 } 1228 }
951 } 1229 }
952 1230
953 unless ($MODEL) { 1231 unless ($MODEL) {
954 # try to load a model 1232 # try to autoload a model
955
956 for (@REGISTRY, @models) { 1233 for (@REGISTRY, @models) {
957 my ($package, $model) = @$_; 1234 my ($package, $model, $autoload) = @$_;
1235 if (
1236 $autoload
958 if (eval "require $package" 1237 and eval "require $package"
959 and ${"$package\::VERSION"} > 0 1238 and ${"$package\::VERSION"} > 0
960 and eval "require $model") { 1239 and eval "require $model"
1240 ) {
961 $MODEL = $model; 1241 $MODEL = $model;
962 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; 1242 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
963 last; 1243 last;
964 } 1244 }
965 } 1245 }
966 1246
967 $MODEL 1247 $MODEL
968 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 1248 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
969 } 1249 }
970 } 1250 }
971 1251
972 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1252 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
973 1253
983 1263
984sub AUTOLOAD { 1264sub AUTOLOAD {
985 (my $func = $AUTOLOAD) =~ s/.*://; 1265 (my $func = $AUTOLOAD) =~ s/.*://;
986 1266
987 $method{$func} 1267 $method{$func}
988 or croak "$func: not a valid method for AnyEvent objects"; 1268 or Carp::croak "$func: not a valid method for AnyEvent objects";
989 1269
990 detect unless $MODEL; 1270 detect unless $MODEL;
991 1271
992 my $class = shift; 1272 my $class = shift;
993 $class->$func (@_); 1273 $class->$func (@_);
994} 1274}
995 1275
996# utility function to dup a filehandle. this is used by many backends 1276# utility function to dup a filehandle. this is used by many backends
997# to support binding more than one watcher per filehandle (they usually 1277# to support binding more than one watcher per filehandle (they usually
998# allow only one watcher per fd, so we dup it to get a different one). 1278# allow only one watcher per fd, so we dup it to get a different one).
999sub _dupfh($$$$) { 1279sub _dupfh($$;$$) {
1000 my ($poll, $fh, $r, $w) = @_; 1280 my ($poll, $fh, $r, $w) = @_;
1001 1281
1002 require Fcntl;
1003
1004 # cygwin requires the fh mode to be matching, unix doesn't 1282 # cygwin requires the fh mode to be matching, unix doesn't
1005 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1283 my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1006 : $poll eq "w" ? ($w, ">")
1007 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1008 1284
1009 open my $fh2, "$mode&" . fileno $fh 1285 open my $fh2, $mode, $fh
1010 or die "cannot dup() filehandle: $!"; 1286 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1011 1287
1012 # we assume CLOEXEC is already set by perl in all important cases 1288 # we assume CLOEXEC is already set by perl in all important cases
1013 1289
1014 ($fh2, $rw) 1290 ($fh2, $rw)
1015} 1291}
1016 1292
1293#############################################################################
1294# "new" API, currently only emulation of it
1295#############################################################################
1296
1297package AE;
1298
1299our $VERSION = $AnyEvent::VERSION;
1300
1301sub io($$$) {
1302 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1303}
1304
1305sub timer($$$) {
1306 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1307}
1308
1309sub signal($$) {
1310 AnyEvent->signal (signal => $_[0], cb => $_[1])
1311}
1312
1313sub child($$) {
1314 AnyEvent->child (pid => $_[0], cb => $_[1])
1315}
1316
1317sub idle($) {
1318 AnyEvent->idle (cb => $_[0])
1319}
1320
1321sub cv(;&) {
1322 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1323}
1324
1325sub now() {
1326 AnyEvent->now
1327}
1328
1329sub now_update() {
1330 AnyEvent->now_update
1331}
1332
1333sub time() {
1334 AnyEvent->time
1335}
1336
1017package AnyEvent::Base; 1337package AnyEvent::Base;
1018 1338
1019# default implementation for now and time 1339# default implementations for many methods
1020 1340
1021use Time::HiRes (); 1341sub _time {
1342 # probe for availability of Time::HiRes
1343 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1344 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1345 *_time = \&Time::HiRes::time;
1346 # if (eval "use POSIX (); (POSIX::times())...
1347 } else {
1348 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1349 *_time = sub { time }; # epic fail
1350 }
1022 1351
1023sub time { Time::HiRes::time } 1352 &_time
1024sub now { Time::HiRes::time } 1353}
1354
1355sub time { _time }
1356sub now { _time }
1357sub now_update { }
1025 1358
1026# default implementation for ->condvar 1359# default implementation for ->condvar
1027 1360
1028sub condvar { 1361sub condvar {
1029 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1362 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1030} 1363}
1031 1364
1032# default implementation for ->signal 1365# default implementation for ->signal
1033 1366
1034our %SIG_CB; 1367our $HAVE_ASYNC_INTERRUPT;
1368
1369sub _have_async_interrupt() {
1370 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1371 && eval "use Async::Interrupt 1.0 (); 1")
1372 unless defined $HAVE_ASYNC_INTERRUPT;
1373
1374 $HAVE_ASYNC_INTERRUPT
1375}
1376
1377our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1378our (%SIG_ASY, %SIG_ASY_W);
1379our ($SIG_COUNT, $SIG_TW);
1380
1381sub _signal_exec {
1382 $HAVE_ASYNC_INTERRUPT
1383 ? $SIGPIPE_R->drain
1384 : sysread $SIGPIPE_R, my $dummy, 9;
1385
1386 while (%SIG_EV) {
1387 for (keys %SIG_EV) {
1388 delete $SIG_EV{$_};
1389 $_->() for values %{ $SIG_CB{$_} || {} };
1390 }
1391 }
1392}
1393
1394# install a dummy wakeup watcher to reduce signal catching latency
1395sub _sig_add() {
1396 unless ($SIG_COUNT++) {
1397 # try to align timer on a full-second boundary, if possible
1398 my $NOW = AE::now;
1399
1400 $SIG_TW = AE::timer
1401 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1402 $MAX_SIGNAL_LATENCY,
1403 sub { } # just for the PERL_ASYNC_CHECK
1404 ;
1405 }
1406}
1407
1408sub _sig_del {
1409 undef $SIG_TW
1410 unless --$SIG_COUNT;
1411}
1412
1413our $_sig_name_init; $_sig_name_init = sub {
1414 eval q{ # poor man's autoloading
1415 undef $_sig_name_init;
1416
1417 if (_have_async_interrupt) {
1418 *sig2num = \&Async::Interrupt::sig2num;
1419 *sig2name = \&Async::Interrupt::sig2name;
1420 } else {
1421 require Config;
1422
1423 my %signame2num;
1424 @signame2num{ split ' ', $Config::Config{sig_name} }
1425 = split ' ', $Config::Config{sig_num};
1426
1427 my @signum2name;
1428 @signum2name[values %signame2num] = keys %signame2num;
1429
1430 *sig2num = sub($) {
1431 $_[0] > 0 ? shift : $signame2num{+shift}
1432 };
1433 *sig2name = sub ($) {
1434 $_[0] > 0 ? $signum2name[+shift] : shift
1435 };
1436 }
1437 };
1438 die if $@;
1439};
1440
1441sub sig2num ($) { &$_sig_name_init; &sig2num }
1442sub sig2name($) { &$_sig_name_init; &sig2name }
1035 1443
1036sub signal { 1444sub signal {
1445 eval q{ # poor man's autoloading {}
1446 # probe for availability of Async::Interrupt
1447 if (_have_async_interrupt) {
1448 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1449
1450 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1451 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1452
1453 } else {
1454 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1455
1456 require Fcntl;
1457
1458 if (AnyEvent::WIN32) {
1459 require AnyEvent::Util;
1460
1461 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1462 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1463 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1464 } else {
1465 pipe $SIGPIPE_R, $SIGPIPE_W;
1466 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1467 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1468
1469 # not strictly required, as $^F is normally 2, but let's make sure...
1470 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1471 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1472 }
1473
1474 $SIGPIPE_R
1475 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1476
1477 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1478 }
1479
1480 *signal = sub {
1037 my (undef, %arg) = @_; 1481 my (undef, %arg) = @_;
1038 1482
1039 my $signal = uc $arg{signal} 1483 my $signal = uc $arg{signal}
1040 or Carp::croak "required option 'signal' is missing"; 1484 or Carp::croak "required option 'signal' is missing";
1041 1485
1486 if ($HAVE_ASYNC_INTERRUPT) {
1487 # async::interrupt
1488
1489 $signal = sig2num $signal;
1042 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1490 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1491
1492 $SIG_ASY{$signal} ||= new Async::Interrupt
1493 cb => sub { undef $SIG_EV{$signal} },
1494 signal => $signal,
1495 pipe => [$SIGPIPE_R->filenos],
1496 pipe_autodrain => 0,
1497 ;
1498
1499 } else {
1500 # pure perl
1501
1502 # AE::Util has been loaded in signal
1503 $signal = sig2name $signal;
1504 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1505
1043 $SIG{$signal} ||= sub { 1506 $SIG{$signal} ||= sub {
1044 $_->() for values %{ $SIG_CB{$signal} || {} }; 1507 local $!;
1508 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1509 undef $SIG_EV{$signal};
1510 };
1511
1512 # can't do signal processing without introducing races in pure perl,
1513 # so limit the signal latency.
1514 _sig_add;
1515 }
1516
1517 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1518 };
1519
1520 *AnyEvent::Base::signal::DESTROY = sub {
1521 my ($signal, $cb) = @{$_[0]};
1522
1523 _sig_del;
1524
1525 delete $SIG_CB{$signal}{$cb};
1526
1527 $HAVE_ASYNC_INTERRUPT
1528 ? delete $SIG_ASY{$signal}
1529 : # delete doesn't work with older perls - they then
1530 # print weird messages, or just unconditionally exit
1531 # instead of getting the default action.
1532 undef $SIG{$signal}
1533 unless keys %{ $SIG_CB{$signal} };
1534 };
1045 }; 1535 };
1046 1536 die if $@;
1047 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1537 &signal
1048}
1049
1050sub AnyEvent::Base::Signal::DESTROY {
1051 my ($signal, $cb) = @{$_[0]};
1052
1053 delete $SIG_CB{$signal}{$cb};
1054
1055 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1056} 1538}
1057 1539
1058# default implementation for ->child 1540# default implementation for ->child
1059 1541
1060our %PID_CB; 1542our %PID_CB;
1061our $CHLD_W; 1543our $CHLD_W;
1062our $CHLD_DELAY_W; 1544our $CHLD_DELAY_W;
1063our $PID_IDLE;
1064our $WNOHANG; 1545our $WNOHANG;
1065 1546
1066sub _child_wait { 1547sub _emit_childstatus($$) {
1067 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1548 my (undef, $rpid, $rstatus) = @_;
1549
1550 $_->($rpid, $rstatus)
1068 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1551 for values %{ $PID_CB{$rpid} || {} },
1069 (values %{ $PID_CB{0} || {} }); 1552 values %{ $PID_CB{0} || {} };
1070 }
1071
1072 undef $PID_IDLE;
1073} 1553}
1074 1554
1075sub _sigchld { 1555sub _sigchld {
1076 # make sure we deliver these changes "synchronous" with the event loop. 1556 my $pid;
1077 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub { 1557
1078 undef $CHLD_DELAY_W; 1558 AnyEvent->_emit_childstatus ($pid, $?)
1079 &_child_wait; 1559 while ($pid = waitpid -1, $WNOHANG) > 0;
1080 });
1081} 1560}
1082 1561
1083sub child { 1562sub child {
1084 my (undef, %arg) = @_; 1563 my (undef, %arg) = @_;
1085 1564
1086 defined (my $pid = $arg{pid} + 0) 1565 defined (my $pid = $arg{pid} + 0)
1087 or Carp::croak "required option 'pid' is missing"; 1566 or Carp::croak "required option 'pid' is missing";
1088 1567
1089 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1568 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1090 1569
1091 unless ($WNOHANG) { 1570 # WNOHANG is almost cetrainly 1 everywhere
1571 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1572 ? 1
1092 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1573 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1093 }
1094 1574
1095 unless ($CHLD_W) { 1575 unless ($CHLD_W) {
1096 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1576 $CHLD_W = AE::signal CHLD => \&_sigchld;
1097 # child could be a zombie already, so make at least one round 1577 # child could be a zombie already, so make at least one round
1098 &_sigchld; 1578 &_sigchld;
1099 } 1579 }
1100 1580
1101 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1581 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1102} 1582}
1103 1583
1104sub AnyEvent::Base::Child::DESTROY { 1584sub AnyEvent::Base::child::DESTROY {
1105 my ($pid, $cb) = @{$_[0]}; 1585 my ($pid, $cb) = @{$_[0]};
1106 1586
1107 delete $PID_CB{$pid}{$cb}; 1587 delete $PID_CB{$pid}{$cb};
1108 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1588 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1109 1589
1110 undef $CHLD_W unless keys %PID_CB; 1590 undef $CHLD_W unless keys %PID_CB;
1111} 1591}
1112 1592
1593# idle emulation is done by simply using a timer, regardless
1594# of whether the process is idle or not, and not letting
1595# the callback use more than 50% of the time.
1596sub idle {
1597 my (undef, %arg) = @_;
1598
1599 my ($cb, $w, $rcb) = $arg{cb};
1600
1601 $rcb = sub {
1602 if ($cb) {
1603 $w = _time;
1604 &$cb;
1605 $w = _time - $w;
1606
1607 # never use more then 50% of the time for the idle watcher,
1608 # within some limits
1609 $w = 0.0001 if $w < 0.0001;
1610 $w = 5 if $w > 5;
1611
1612 $w = AE::timer $w, 0, $rcb;
1613 } else {
1614 # clean up...
1615 undef $w;
1616 undef $rcb;
1617 }
1618 };
1619
1620 $w = AE::timer 0.05, 0, $rcb;
1621
1622 bless \\$cb, "AnyEvent::Base::idle"
1623}
1624
1625sub AnyEvent::Base::idle::DESTROY {
1626 undef $${$_[0]};
1627}
1628
1113package AnyEvent::CondVar; 1629package AnyEvent::CondVar;
1114 1630
1115our @ISA = AnyEvent::CondVar::Base::; 1631our @ISA = AnyEvent::CondVar::Base::;
1116 1632
1117package AnyEvent::CondVar::Base; 1633package AnyEvent::CondVar::Base;
1118 1634
1119use overload 1635#use overload
1120 '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1636# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1121 fallback => 1; 1637# fallback => 1;
1638
1639# save 300+ kilobytes by dirtily hardcoding overloading
1640${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
1641*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
1642*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
1643${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1644
1645our $WAITING;
1122 1646
1123sub _send { 1647sub _send {
1124 # nop 1648 # nop
1125} 1649}
1126 1650
1139sub ready { 1663sub ready {
1140 $_[0]{_ae_sent} 1664 $_[0]{_ae_sent}
1141} 1665}
1142 1666
1143sub _wait { 1667sub _wait {
1668 $WAITING
1669 and !$_[0]{_ae_sent}
1670 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1671
1672 local $WAITING = 1;
1144 AnyEvent->one_event while !$_[0]{_ae_sent}; 1673 AnyEvent->one_event while !$_[0]{_ae_sent};
1145} 1674}
1146 1675
1147sub recv { 1676sub recv {
1148 $_[0]->_wait; 1677 $_[0]->_wait;
1150 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1679 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1151 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1680 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1152} 1681}
1153 1682
1154sub cb { 1683sub cb {
1155 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1684 my $cv = shift;
1685
1686 @_
1687 and $cv->{_ae_cb} = shift
1688 and $cv->{_ae_sent}
1689 and (delete $cv->{_ae_cb})->($cv);
1690
1156 $_[0]{_ae_cb} 1691 $cv->{_ae_cb}
1157} 1692}
1158 1693
1159sub begin { 1694sub begin {
1160 ++$_[0]{_ae_counter}; 1695 ++$_[0]{_ae_counter};
1161 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1696 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1167} 1702}
1168 1703
1169# undocumented/compatibility with pre-3.4 1704# undocumented/compatibility with pre-3.4
1170*broadcast = \&send; 1705*broadcast = \&send;
1171*wait = \&_wait; 1706*wait = \&_wait;
1707
1708=head1 ERROR AND EXCEPTION HANDLING
1709
1710In general, AnyEvent does not do any error handling - it relies on the
1711caller to do that if required. The L<AnyEvent::Strict> module (see also
1712the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
1713checking of all AnyEvent methods, however, which is highly useful during
1714development.
1715
1716As for exception handling (i.e. runtime errors and exceptions thrown while
1717executing a callback), this is not only highly event-loop specific, but
1718also not in any way wrapped by this module, as this is the job of the main
1719program.
1720
1721The pure perl event loop simply re-throws the exception (usually
1722within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
1723$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1724so on.
1725
1726=head1 ENVIRONMENT VARIABLES
1727
1728The following environment variables are used by this module or its
1729submodules.
1730
1731Note that AnyEvent will remove I<all> environment variables starting with
1732C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
1733enabled.
1734
1735=over 4
1736
1737=item C<PERL_ANYEVENT_VERBOSE>
1738
1739By default, AnyEvent will be completely silent except in fatal
1740conditions. You can set this environment variable to make AnyEvent more
1741talkative.
1742
1743When set to C<1> or higher, causes AnyEvent to warn about unexpected
1744conditions, such as not being able to load the event model specified by
1745C<PERL_ANYEVENT_MODEL>.
1746
1747When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1748model it chooses.
1749
1750When set to C<8> or higher, then AnyEvent will report extra information on
1751which optional modules it loads and how it implements certain features.
1752
1753=item C<PERL_ANYEVENT_STRICT>
1754
1755AnyEvent does not do much argument checking by default, as thorough
1756argument checking is very costly. Setting this variable to a true value
1757will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1758check the arguments passed to most method calls. If it finds any problems,
1759it will croak.
1760
1761In other words, enables "strict" mode.
1762
1763Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1764>>, it is definitely recommended to keep it off in production. Keeping
1765C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1766can be very useful, however.
1767
1768=item C<PERL_ANYEVENT_MODEL>
1769
1770This can be used to specify the event model to be used by AnyEvent, before
1771auto detection and -probing kicks in. It must be a string consisting
1772entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1773and the resulting module name is loaded and if the load was successful,
1774used as event model. If it fails to load AnyEvent will proceed with
1775auto detection and -probing.
1776
1777This functionality might change in future versions.
1778
1779For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1780could start your program like this:
1781
1782 PERL_ANYEVENT_MODEL=Perl perl ...
1783
1784=item C<PERL_ANYEVENT_PROTOCOLS>
1785
1786Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1787for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1788of auto probing).
1789
1790Must be set to a comma-separated list of protocols or address families,
1791current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1792used, and preference will be given to protocols mentioned earlier in the
1793list.
1794
1795This variable can effectively be used for denial-of-service attacks
1796against local programs (e.g. when setuid), although the impact is likely
1797small, as the program has to handle conenction and other failures anyways.
1798
1799Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1800but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1801- only support IPv4, never try to resolve or contact IPv6
1802addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1803IPv6, but prefer IPv6 over IPv4.
1804
1805=item C<PERL_ANYEVENT_EDNS0>
1806
1807Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1808for DNS. This extension is generally useful to reduce DNS traffic, but
1809some (broken) firewalls drop such DNS packets, which is why it is off by
1810default.
1811
1812Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1813EDNS0 in its DNS requests.
1814
1815=item C<PERL_ANYEVENT_MAX_FORKS>
1816
1817The maximum number of child processes that C<AnyEvent::Util::fork_call>
1818will create in parallel.
1819
1820=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1821
1822The default value for the C<max_outstanding> parameter for the default DNS
1823resolver - this is the maximum number of parallel DNS requests that are
1824sent to the DNS server.
1825
1826=item C<PERL_ANYEVENT_RESOLV_CONF>
1827
1828The file to use instead of F</etc/resolv.conf> (or OS-specific
1829configuration) in the default resolver. When set to the empty string, no
1830default config will be used.
1831
1832=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1833
1834When neither C<ca_file> nor C<ca_path> was specified during
1835L<AnyEvent::TLS> context creation, and either of these environment
1836variables exist, they will be used to specify CA certificate locations
1837instead of a system-dependent default.
1838
1839=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1840
1841When these are set to C<1>, then the respective modules are not
1842loaded. Mostly good for testing AnyEvent itself.
1843
1844=back
1172 1845
1173=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1846=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1174 1847
1175This is an advanced topic that you do not normally need to use AnyEvent in 1848This is an advanced topic that you do not normally need to use AnyEvent in
1176a module. This section is only of use to event loop authors who want to 1849a module. This section is only of use to event loop authors who want to
1210 1883
1211I<rxvt-unicode> also cheats a bit by not providing blocking access to 1884I<rxvt-unicode> also cheats a bit by not providing blocking access to
1212condition variables: code blocking while waiting for a condition will 1885condition variables: code blocking while waiting for a condition will
1213C<die>. This still works with most modules/usages, and blocking calls must 1886C<die>. This still works with most modules/usages, and blocking calls must
1214not be done in an interactive application, so it makes sense. 1887not be done in an interactive application, so it makes sense.
1215
1216=head1 ENVIRONMENT VARIABLES
1217
1218The following environment variables are used by this module:
1219
1220=over 4
1221
1222=item C<PERL_ANYEVENT_VERBOSE>
1223
1224By default, AnyEvent will be completely silent except in fatal
1225conditions. You can set this environment variable to make AnyEvent more
1226talkative.
1227
1228When set to C<1> or higher, causes AnyEvent to warn about unexpected
1229conditions, such as not being able to load the event model specified by
1230C<PERL_ANYEVENT_MODEL>.
1231
1232When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1233model it chooses.
1234
1235=item C<PERL_ANYEVENT_STRICT>
1236
1237AnyEvent does not do much argument checking by default, as thorough
1238argument checking is very costly. Setting this variable to a true value
1239will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1240check the arguments passed to most method calls. If it finds any problems
1241it will croak.
1242
1243In other words, enables "strict" mode.
1244
1245Unlike C<use strict> it is definitely recommended ot keep it off in
1246production.
1247
1248=item C<PERL_ANYEVENT_MODEL>
1249
1250This can be used to specify the event model to be used by AnyEvent, before
1251auto detection and -probing kicks in. It must be a string consisting
1252entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1253and the resulting module name is loaded and if the load was successful,
1254used as event model. If it fails to load AnyEvent will proceed with
1255auto detection and -probing.
1256
1257This functionality might change in future versions.
1258
1259For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1260could start your program like this:
1261
1262 PERL_ANYEVENT_MODEL=Perl perl ...
1263
1264=item C<PERL_ANYEVENT_PROTOCOLS>
1265
1266Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1267for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1268of auto probing).
1269
1270Must be set to a comma-separated list of protocols or address families,
1271current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1272used, and preference will be given to protocols mentioned earlier in the
1273list.
1274
1275This variable can effectively be used for denial-of-service attacks
1276against local programs (e.g. when setuid), although the impact is likely
1277small, as the program has to handle connection errors already-
1278
1279Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1280but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1281- only support IPv4, never try to resolve or contact IPv6
1282addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1283IPv6, but prefer IPv6 over IPv4.
1284
1285=item C<PERL_ANYEVENT_EDNS0>
1286
1287Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1288for DNS. This extension is generally useful to reduce DNS traffic, but
1289some (broken) firewalls drop such DNS packets, which is why it is off by
1290default.
1291
1292Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1293EDNS0 in its DNS requests.
1294
1295=item C<PERL_ANYEVENT_MAX_FORKS>
1296
1297The maximum number of child processes that C<AnyEvent::Util::fork_call>
1298will create in parallel.
1299
1300=back
1301 1888
1302=head1 EXAMPLE PROGRAM 1889=head1 EXAMPLE PROGRAM
1303 1890
1304The following program uses an I/O watcher to read data from STDIN, a timer 1891The following program uses an I/O watcher to read data from STDIN, a timer
1305to display a message once per second, and a condition variable to quit the 1892to display a message once per second, and a condition variable to quit the
1499watcher. 2086watcher.
1500 2087
1501=head3 Results 2088=head3 Results
1502 2089
1503 name watchers bytes create invoke destroy comment 2090 name watchers bytes create invoke destroy comment
1504 EV/EV 400000 244 0.56 0.46 0.31 EV native interface 2091 EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1505 EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers 2092 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1506 CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal 2093 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1507 Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation 2094 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1508 Event/Event 16000 516 31.88 31.30 0.85 Event native interface 2095 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1509 Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers 2096 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
2097 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
2098 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1510 Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour 2099 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1511 Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers 2100 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1512 POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event 2101 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1513 POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select 2102 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1514 2103
1515=head3 Discussion 2104=head3 Discussion
1516 2105
1517The benchmark does I<not> measure scalability of the event loop very 2106The benchmark does I<not> measure scalability of the event loop very
1518well. For example, a select-based event loop (such as the pure perl one) 2107well. For example, a select-based event loop (such as the pure perl one)
1543performance becomes really bad with lots of file descriptors (and few of 2132performance becomes really bad with lots of file descriptors (and few of
1544them active), of course, but this was not subject of this benchmark. 2133them active), of course, but this was not subject of this benchmark.
1545 2134
1546The C<Event> module has a relatively high setup and callback invocation 2135The C<Event> module has a relatively high setup and callback invocation
1547cost, but overall scores in on the third place. 2136cost, but overall scores in on the third place.
2137
2138C<IO::Async> performs admirably well, about on par with C<Event>, even
2139when using its pure perl backend.
1548 2140
1549C<Glib>'s memory usage is quite a bit higher, but it features a 2141C<Glib>'s memory usage is quite a bit higher, but it features a
1550faster callback invocation and overall ends up in the same class as 2142faster callback invocation and overall ends up in the same class as
1551C<Event>. However, Glib scales extremely badly, doubling the number of 2143C<Event>. However, Glib scales extremely badly, doubling the number of
1552watchers increases the processing time by more than a factor of four, 2144watchers increases the processing time by more than a factor of four,
1630it to another server. This includes deleting the old timeout and creating 2222it to another server. This includes deleting the old timeout and creating
1631a new one that moves the timeout into the future. 2223a new one that moves the timeout into the future.
1632 2224
1633=head3 Results 2225=head3 Results
1634 2226
1635 name sockets create request 2227 name sockets create request
1636 EV 20000 69.01 11.16 2228 EV 20000 69.01 11.16
1637 Perl 20000 73.32 35.87 2229 Perl 20000 73.32 35.87
2230 IOAsync 20000 157.00 98.14 epoll
2231 IOAsync 20000 159.31 616.06 poll
1638 Event 20000 212.62 257.32 2232 Event 20000 212.62 257.32
1639 Glib 20000 651.16 1896.30 2233 Glib 20000 651.16 1896.30
1640 POE 20000 349.67 12317.24 uses POE::Loop::Event 2234 POE 20000 349.67 12317.24 uses POE::Loop::Event
1641 2235
1642=head3 Discussion 2236=head3 Discussion
1643 2237
1644This benchmark I<does> measure scalability and overall performance of the 2238This benchmark I<does> measure scalability and overall performance of the
1645particular event loop. 2239particular event loop.
1647EV is again fastest. Since it is using epoll on my system, the setup time 2241EV is again fastest. Since it is using epoll on my system, the setup time
1648is relatively high, though. 2242is relatively high, though.
1649 2243
1650Perl surprisingly comes second. It is much faster than the C-based event 2244Perl surprisingly comes second. It is much faster than the C-based event
1651loops Event and Glib. 2245loops Event and Glib.
2246
2247IO::Async performs very well when using its epoll backend, and still quite
2248good compared to Glib when using its pure perl backend.
1652 2249
1653Event suffers from high setup time as well (look at its code and you will 2250Event suffers from high setup time as well (look at its code and you will
1654understand why). Callback invocation also has a high overhead compared to 2251understand why). Callback invocation also has a high overhead compared to
1655the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 2252the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1656uses select or poll in basically all documented configurations. 2253uses select or poll in basically all documented configurations.
1719=item * C-based event loops perform very well with small number of 2316=item * C-based event loops perform very well with small number of
1720watchers, as the management overhead dominates. 2317watchers, as the management overhead dominates.
1721 2318
1722=back 2319=back
1723 2320
2321=head2 THE IO::Lambda BENCHMARK
2322
2323Recently I was told about the benchmark in the IO::Lambda manpage, which
2324could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
2325simply compares IO::Lambda with POE, and IO::Lambda looks better (which
2326shouldn't come as a surprise to anybody). As such, the benchmark is
2327fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
2328very optimal. But how would AnyEvent compare when used without the extra
2329baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
2330
2331The benchmark itself creates an echo-server, and then, for 500 times,
2332connects to the echo server, sends a line, waits for the reply, and then
2333creates the next connection. This is a rather bad benchmark, as it doesn't
2334test the efficiency of the framework or much non-blocking I/O, but it is a
2335benchmark nevertheless.
2336
2337 name runtime
2338 Lambda/select 0.330 sec
2339 + optimized 0.122 sec
2340 Lambda/AnyEvent 0.327 sec
2341 + optimized 0.138 sec
2342 Raw sockets/select 0.077 sec
2343 POE/select, components 0.662 sec
2344 POE/select, raw sockets 0.226 sec
2345 POE/select, optimized 0.404 sec
2346
2347 AnyEvent/select/nb 0.085 sec
2348 AnyEvent/EV/nb 0.068 sec
2349 +state machine 0.134 sec
2350
2351The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
2352benchmarks actually make blocking connects and use 100% blocking I/O,
2353defeating the purpose of an event-based solution. All of the newly
2354written AnyEvent benchmarks use 100% non-blocking connects (using
2355AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
2356resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
2357generally require a lot more bookkeeping and event handling than blocking
2358connects (which involve a single syscall only).
2359
2360The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
2361offers similar expressive power as POE and IO::Lambda, using conventional
2362Perl syntax. This means that both the echo server and the client are 100%
2363non-blocking, further placing it at a disadvantage.
2364
2365As you can see, the AnyEvent + EV combination even beats the
2366hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2367backend easily beats IO::Lambda and POE.
2368
2369And even the 100% non-blocking version written using the high-level (and
2370slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
2371large margin, even though it does all of DNS, tcp-connect and socket I/O
2372in a non-blocking way.
2373
2374The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2375F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2376part of the IO::lambda distribution and were used without any changes.
2377
2378
2379=head1 SIGNALS
2380
2381AnyEvent currently installs handlers for these signals:
2382
2383=over 4
2384
2385=item SIGCHLD
2386
2387A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2388emulation for event loops that do not support them natively. Also, some
2389event loops install a similar handler.
2390
2391Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2392AnyEvent will reset it to default, to avoid losing child exit statuses.
2393
2394=item SIGPIPE
2395
2396A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2397when AnyEvent gets loaded.
2398
2399The rationale for this is that AnyEvent users usually do not really depend
2400on SIGPIPE delivery (which is purely an optimisation for shell use, or
2401badly-written programs), but C<SIGPIPE> can cause spurious and rare
2402program exits as a lot of people do not expect C<SIGPIPE> when writing to
2403some random socket.
2404
2405The rationale for installing a no-op handler as opposed to ignoring it is
2406that this way, the handler will be restored to defaults on exec.
2407
2408Feel free to install your own handler, or reset it to defaults.
2409
2410=back
2411
2412=cut
2413
2414undef $SIG{CHLD}
2415 if $SIG{CHLD} eq 'IGNORE';
2416
2417$SIG{PIPE} = sub { }
2418 unless defined $SIG{PIPE};
2419
2420=head1 RECOMMENDED/OPTIONAL MODULES
2421
2422One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2423it's built-in modules) are required to use it.
2424
2425That does not mean that AnyEvent won't take advantage of some additional
2426modules if they are installed.
2427
2428This section epxlains which additional modules will be used, and how they
2429affect AnyEvent's operetion.
2430
2431=over 4
2432
2433=item L<Async::Interrupt>
2434
2435This slightly arcane module is used to implement fast signal handling: To
2436my knowledge, there is no way to do completely race-free and quick
2437signal handling in pure perl. To ensure that signals still get
2438delivered, AnyEvent will start an interval timer to wake up perl (and
2439catch the signals) with some delay (default is 10 seconds, look for
2440C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2441
2442If this module is available, then it will be used to implement signal
2443catching, which means that signals will not be delayed, and the event loop
2444will not be interrupted regularly, which is more efficient (And good for
2445battery life on laptops).
2446
2447This affects not just the pure-perl event loop, but also other event loops
2448that have no signal handling on their own (e.g. Glib, Tk, Qt).
2449
2450Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
2451and either employ their own workarounds (POE) or use AnyEvent's workaround
2452(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
2453does nothing for those backends.
2454
2455=item L<EV>
2456
2457This module isn't really "optional", as it is simply one of the backend
2458event loops that AnyEvent can use. However, it is simply the best event
2459loop available in terms of features, speed and stability: It supports
2460the AnyEvent API optimally, implements all the watcher types in XS, does
2461automatic timer adjustments even when no monotonic clock is available,
2462can take avdantage of advanced kernel interfaces such as C<epoll> and
2463C<kqueue>, and is the fastest backend I<by far>. You can even embed
2464L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2465
2466=item L<Guard>
2467
2468The guard module, when used, will be used to implement
2469C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2470lot less memory), but otherwise doesn't affect guard operation much. It is
2471purely used for performance.
2472
2473=item L<JSON> and L<JSON::XS>
2474
2475This module is required when you want to read or write JSON data via
2476L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2477advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2478
2479In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2480installed.
2481
2482=item L<Net::SSLeay>
2483
2484Implementing TLS/SSL in Perl is certainly interesting, but not very
2485worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2486the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2487
2488=item L<Time::HiRes>
2489
2490This module is part of perl since release 5.008. It will be used when the
2491chosen event library does not come with a timing source on it's own. The
2492pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2493try to use a monotonic clock for timing stability.
2494
2495=back
2496
1724 2497
1725=head1 FORK 2498=head1 FORK
1726 2499
1727Most event libraries are not fork-safe. The ones who are usually are 2500Most event libraries are not fork-safe. The ones who are usually are
1728because they rely on inefficient but fork-safe C<select> or C<poll> 2501because they rely on inefficient but fork-safe C<select> or C<poll>
1729calls. Only L<EV> is fully fork-aware. 2502calls. Only L<EV> is fully fork-aware.
1730 2503
1731If you have to fork, you must either do so I<before> creating your first 2504If you have to fork, you must either do so I<before> creating your first
1732watcher OR you must not use AnyEvent at all in the child. 2505watcher OR you must not use AnyEvent at all in the child OR you must do
2506something completely out of the scope of AnyEvent.
1733 2507
1734 2508
1735=head1 SECURITY CONSIDERATIONS 2509=head1 SECURITY CONSIDERATIONS
1736 2510
1737AnyEvent can be forced to load any event model via 2511AnyEvent can be forced to load any event model via
1749 use AnyEvent; 2523 use AnyEvent;
1750 2524
1751Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2525Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1752be used to probe what backend is used and gain other information (which is 2526be used to probe what backend is used and gain other information (which is
1753probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and 2527probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1754$ENV{PERL_ANYEGENT_STRICT}. 2528$ENV{PERL_ANYEVENT_STRICT}.
2529
2530Note that AnyEvent will remove I<all> environment variables starting with
2531C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2532enabled.
1755 2533
1756 2534
1757=head1 BUGS 2535=head1 BUGS
1758 2536
1759Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 2537Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1760to work around. If you suffer from memleaks, first upgrade to Perl 5.10 2538to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1761and check wether the leaks still show up. (Perl 5.10.0 has other annoying 2539and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1762mamleaks, such as leaking on C<map> and C<grep> but it is usually not as 2540memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1763pronounced). 2541pronounced).
1764 2542
1765 2543
1766=head1 SEE ALSO 2544=head1 SEE ALSO
1767 2545
1771L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2549L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1772 2550
1773Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2551Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1774L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2552L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1775L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2553L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1776L<AnyEvent::Impl::POE>. 2554L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
1777 2555
1778Non-blocking file handles, sockets, TCP clients and 2556Non-blocking file handles, sockets, TCP clients and
1779servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. 2557servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1780 2558
1781Asynchronous DNS: L<AnyEvent::DNS>. 2559Asynchronous DNS: L<AnyEvent::DNS>.
1782 2560
1783Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 2561Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
2562L<Coro::Event>,
1784 2563
1785Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 2564Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
2565L<AnyEvent::HTTP>.
1786 2566
1787 2567
1788=head1 AUTHOR 2568=head1 AUTHOR
1789 2569
1790 Marc Lehmann <schmorp@schmorp.de> 2570 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines