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.196 by root, Thu Mar 26 07:47:42 2009 UTC vs.
Revision 1.281 by root, Mon Aug 10 01:17:38 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?
165my variables are only visible after the statement in which they are 181my variables are only visible after the statement in which they are
166declared. 182declared.
167 183
168=head2 I/O WATCHERS 184=head2 I/O WATCHERS
169 185
186 $w = AnyEvent->io (
187 fh => <filehandle_or_fileno>,
188 poll => <"r" or "w">,
189 cb => <callback>,
190 );
191
170You 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
171with the following mandatory key-value pairs as arguments: 193with the following mandatory key-value pairs as arguments:
172 194
173C<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
174(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
175must 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
176waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the 203watcher waiting for "r"eadable or "w"ritable events, respectively.
204
177callback to invoke each time the file handle becomes ready. 205C<cb> is the callback to invoke each time the file handle becomes ready.
178 206
179Although the callback might get passed parameters, their value and 207Although the callback might get passed parameters, their value and
180presence is undefined and you cannot rely on them. Portable AnyEvent 208presence is undefined and you cannot rely on them. Portable AnyEvent
181callbacks cannot use arguments passed to I/O watcher callbacks. 209callbacks cannot use arguments passed to I/O watcher callbacks.
182 210
197 undef $w; 225 undef $w;
198 }); 226 });
199 227
200=head2 TIME WATCHERS 228=head2 TIME WATCHERS
201 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
202You can create a time watcher by calling the C<< AnyEvent->timer >> 238You can create a time watcher by calling the C<< AnyEvent->timer >>
203method with the following mandatory arguments: 239method with the following mandatory arguments:
204 240
205C<after> specifies after how many seconds (fractional values are 241C<after> specifies after how many seconds (fractional values are
206supported) 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
314In 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
315can 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
316difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 352difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
317account. 353account.
318 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
319=back 370=back
320 371
321=head2 SIGNAL WATCHERS 372=head2 SIGNAL WATCHERS
373
374 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
322 375
323You 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
324I<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
325callback to be invoked whenever a signal occurs. 378callback to be invoked whenever a signal occurs.
326 379
332invocation, and callback invocation will be synchronous. Synchronous means 385invocation, and callback invocation will be synchronous. Synchronous means
333that 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,
334but it is guaranteed not to interrupt any other callbacks. 387but it is guaranteed not to interrupt any other callbacks.
335 388
336The 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
337between multiple watchers. 390between multiple watchers, and AnyEvent will ensure that signals will not
391interrupt your program at bad times.
338 392
339This watcher might use C<%SIG>, so programs overwriting those signals 393This watcher might use C<%SIG> (depending on the event loop used),
340directly will likely not work correctly. 394so programs overwriting those signals directly will likely not work
395correctly.
341 396
342Example: exit on SIGINT 397Example: exit on SIGINT
343 398
344 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 399 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
345 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
346=head2 CHILD PROCESS WATCHERS 421=head2 CHILD PROCESS WATCHERS
347 422
423 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
424
348You 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.
349 426
350The 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,
351watches for any child process exit). The watcher will triggered only when 428using C<0> watches for any child process exit, on others this will
352the child process has finished and an exit status is available, not on 429croak). The watcher will be triggered only when the child process has
353any trace events (stopped/continued). 430finished and an exit status is available, not on any trace events
431(stopped/continued).
354 432
355The callback will be called with the pid and exit status (as returned by 433The callback will be called with the pid and exit status (as returned by
356waitpid), so unlike other watcher types, you I<can> rely on child watcher 434waitpid), so unlike other watcher types, you I<can> rely on child watcher
357callback arguments. 435callback arguments.
358 436
363 441
364There 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
365I<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
366have exited already (and no SIGCHLD will be sent anymore). 444have exited already (and no SIGCHLD will be sent anymore).
367 445
368Not 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
369event 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
370loaded 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.
371 452
372This 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
373AnyEvent 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
374C<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.
375 461
376Example: fork a process and wait for it 462Example: fork a process and wait for it
377 463
378 my $done = AnyEvent->condvar; 464 my $done = AnyEvent->condvar;
379 465
389 ); 475 );
390 476
391 # do something else, then wait for process exit 477 # do something else, then wait for process exit
392 $done->recv; 478 $done->recv;
393 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
394=head2 CONDITION VARIABLES 517=head2 CONDITION VARIABLES
518
519 $cv = AnyEvent->condvar;
520
521 $cv->send (<list>);
522 my @res = $cv->recv;
395 523
396If 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
397require you to run some blocking "loop", "run" or similar function that 525require you to run some blocking "loop", "run" or similar function that
398will actively watch for new events and call your callbacks. 526will actively watch for new events and call your callbacks.
399 527
400AnyEvent is different, it expects somebody else to run the event loop and 528AnyEvent is slightly different: it expects somebody else to run the event
401will only block when necessary (usually when told by the user). 529loop and will only block when necessary (usually when told by the user).
402 530
403The instrument to do that is called a "condition variable", so called 531The instrument to do that is called a "condition variable", so called
404because they represent a condition that must become true. 532because they represent a condition that must become true.
405 533
534Now is probably a good time to look at the examples further below.
535
406Condition variables can be created by calling the C<< AnyEvent->condvar 536Condition variables can be created by calling the C<< AnyEvent->condvar
407>> method, usually without arguments. The only argument pair allowed is 537>> method, usually without arguments. The only argument pair allowed is
408
409C<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
410becomes true, with the condition variable as the first argument (but not 539becomes true, with the condition variable as the first argument (but not
411the results). 540the results).
412 541
413After creation, the condition variable is "false" until it becomes "true" 542After creation, the condition variable is "false" until it becomes "true"
418Condition variables are similar to callbacks, except that you can 547Condition variables are similar to callbacks, except that you can
419optionally wait for them. They can also be called merge points - points 548optionally wait for them. They can also be called merge points - points
420in time where multiple outstanding events have been processed. And yet 549in time where multiple outstanding events have been processed. And yet
421another way to call them is transactions - each condition variable can be 550another way to call them is transactions - each condition variable can be
422used to represent a transaction, which finishes at some point and delivers 551used to represent a transaction, which finishes at some point and delivers
423a result. 552a result. And yet some people know them as "futures" - a promise to
553compute/deliver something that you can wait for.
424 554
425Condition variables are very useful to signal that something has finished, 555Condition variables are very useful to signal that something has finished,
426for example, if you write a module that does asynchronous http requests, 556for example, if you write a module that does asynchronous http requests,
427then a condition variable would be the ideal candidate to signal the 557then a condition variable would be the ideal candidate to signal the
428availability of results. The user can either act when the callback is 558availability of results. The user can either act when the callback is
462 after => 1, 592 after => 1,
463 cb => sub { $result_ready->send }, 593 cb => sub { $result_ready->send },
464 ); 594 );
465 595
466 # this "blocks" (while handling events) till the callback 596 # this "blocks" (while handling events) till the callback
467 # calls send 597 # calls -<send
468 $result_ready->recv; 598 $result_ready->recv;
469 599
470Example: wait for a timer, but take advantage of the fact that 600Example: wait for a timer, but take advantage of the fact that condition
471condition variables are also code references. 601variables are also callable directly.
472 602
473 my $done = AnyEvent->condvar; 603 my $done = AnyEvent->condvar;
474 my $delay = AnyEvent->timer (after => 5, cb => $done); 604 my $delay = AnyEvent->timer (after => 5, cb => $done);
475 $done->recv; 605 $done->recv;
476 606
482 612
483 ... 613 ...
484 614
485 my @info = $couchdb->info->recv; 615 my @info = $couchdb->info->recv;
486 616
487And 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
488results are available: 618results are available:
489 619
490 $couchdb->info->cb (sub { 620 $couchdb->info->cb (sub {
491 my @info = $_[0]->recv; 621 my @info = $_[0]->recv;
492 }); 622 });
510immediately from within send. 640immediately from within send.
511 641
512Any 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
513future C<< ->recv >> calls. 643future C<< ->recv >> calls.
514 644
515Condition variables are overloaded so one can call them directly 645Condition variables are overloaded so one can call them directly (as if
516(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
517C<send>. Note, however, that many C-based event loops do not handle 647C<send>.
518overloading, so as tempting as it may be, passing a condition variable
519instead of a callback does not work. Both the pure perl and EV loops
520support overloading, however, as well as all functions that use perl to
521invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
522example).
523 648
524=item $cv->croak ($error) 649=item $cv->croak ($error)
525 650
526Similar 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
527C<Carp::croak> with the given error message/object/scalar. 652C<Carp::croak> with the given error message/object/scalar.
528 653
529This can be used to signal any errors to the condition variable 654This can be used to signal any errors to the condition variable
530user/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.
531 660
532=item $cv->begin ([group callback]) 661=item $cv->begin ([group callback])
533 662
534=item $cv->end 663=item $cv->end
535
536These two methods are EXPERIMENTAL and MIGHT CHANGE.
537 664
538These two methods can be used to combine many transactions/events into 665These two methods can be used to combine many transactions/events into
539one. 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
540to use a condition variable for the whole process. 667to use a condition variable for the whole process.
541 668
542Every call to C<< ->begin >> will increment a counter, and every call to 669Every call to C<< ->begin >> will increment a counter, and every call to
543C<< ->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
544>>, the (last) callback passed to C<begin> will be executed. That callback 671>>, the (last) callback passed to C<begin> will be executed, passing the
545is I<supposed> to call C<< ->send >>, but that is not required. If no 672condvar as first argument. That callback is I<supposed> to call C<< ->send
546callback was set, C<send> will be called without any arguments. 673>>, but that is not required. If no group callback was set, C<send> will
674be called without any arguments.
547 675
548Let's clarify this with the ping example: 676You can think of C<< $cv->send >> giving you an OR condition (one call
677sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
678condition (all C<begin> calls must be C<end>'ed before the condvar sends).
679
680Let's start with a simple example: you have two I/O watchers (for example,
681STDOUT and STDERR for a program), and you want to wait for both streams to
682close before activating a condvar:
549 683
550 my $cv = AnyEvent->condvar; 684 my $cv = AnyEvent->condvar;
551 685
686 $cv->begin; # first watcher
687 my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
688 defined sysread $fh1, my $buf, 4096
689 or $cv->end;
690 });
691
692 $cv->begin; # second watcher
693 my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
694 defined sysread $fh2, my $buf, 4096
695 or $cv->end;
696 });
697
698 $cv->recv;
699
700This works because for every event source (EOF on file handle), there is
701one call to C<begin>, so the condvar waits for all calls to C<end> before
702sending.
703
704The ping example mentioned above is slightly more complicated, as the
705there are results to be passwd back, and the number of tasks that are
706begung can potentially be zero:
707
708 my $cv = AnyEvent->condvar;
709
552 my %result; 710 my %result;
553 $cv->begin (sub { $cv->send (\%result) }); 711 $cv->begin (sub { shift->send (\%result) });
554 712
555 for my $host (@list_of_hosts) { 713 for my $host (@list_of_hosts) {
556 $cv->begin; 714 $cv->begin;
557 ping_host_then_call_callback $host, sub { 715 ping_host_then_call_callback $host, sub {
558 $result{$host} = ...; 716 $result{$host} = ...;
573loop, which serves two important purposes: first, it sets the callback 731loop, which serves two important purposes: first, it sets the callback
574to be called once the counter reaches C<0>, and second, it ensures that 732to be called once the counter reaches C<0>, and second, it ensures that
575C<send> is called even when C<no> hosts are being pinged (the loop 733C<send> is called even when C<no> hosts are being pinged (the loop
576doesn't execute once). 734doesn't execute once).
577 735
578This is the general pattern when you "fan out" into multiple subrequests: 736This is the general pattern when you "fan out" into multiple (but
579use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 737potentially none) subrequests: use an outer C<begin>/C<end> pair to set
580is called at least once, and then, for each subrequest you start, call 738the callback and ensure C<end> is called at least once, and then, for each
581C<begin> and for each subrequest you finish, call C<end>. 739subrequest you start, call C<begin> and for each subrequest you finish,
740call C<end>.
582 741
583=back 742=back
584 743
585=head3 METHODS FOR CONSUMERS 744=head3 METHODS FOR CONSUMERS
586 745
602function will call C<croak>. 761function will call C<croak>.
603 762
604In list context, all parameters passed to C<send> will be returned, 763In list context, all parameters passed to C<send> will be returned,
605in scalar context only the first one will be returned. 764in scalar context only the first one will be returned.
606 765
766Note that doing a blocking wait in a callback is not supported by any
767event loop, that is, recursive invocation of a blocking C<< ->recv
768>> is not allowed, and the C<recv> call will C<croak> if such a
769condition is detected. This condition can be slightly loosened by using
770L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
771any thread that doesn't run the event loop itself.
772
607Not all event models support a blocking wait - some die in that case 773Not all event models support a blocking wait - some die in that case
608(programs might want to do that to stay interactive), so I<if you are 774(programs might want to do that to stay interactive), so I<if you are
609using this from a module, never require a blocking wait>, but let the 775using this from a module, never require a blocking wait>. Instead, let the
610caller decide whether the call will block or not (for example, by coupling 776caller decide whether the call will block or not (for example, by coupling
611condition variables with some kind of request results and supporting 777condition variables with some kind of request results and supporting
612callbacks so the caller knows that getting the result will not block, 778callbacks so the caller knows that getting the result will not block,
613while still supporting blocking waits if the caller so desires). 779while still supporting blocking waits if the caller so desires).
614 780
615Another reason I<never> to C<< ->recv >> in a module is that you cannot
616sensibly have two C<< ->recv >>'s in parallel, as that would require
617multiple interpreters or coroutines/threads, none of which C<AnyEvent>
618can supply.
619
620The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
621fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
622versions and also integrates coroutines into AnyEvent, making blocking
623C<< ->recv >> calls perfectly safe as long as they are done from another
624coroutine (one that doesn't run the event loop).
625
626You can ensure that C<< -recv >> never blocks by setting a callback and 781You can ensure that C<< -recv >> never blocks by setting a callback and
627only calling C<< ->recv >> from within that callback (or at a later 782only calling C<< ->recv >> from within that callback (or at a later
628time). This will work even when the event loop does not support blocking 783time). This will work even when the event loop does not support blocking
629waits otherwise. 784waits otherwise.
630 785
636=item $cb = $cv->cb ($cb->($cv)) 791=item $cb = $cv->cb ($cb->($cv))
637 792
638This is a mutator function that returns the callback set and optionally 793This is a mutator function that returns the callback set and optionally
639replaces it before doing so. 794replaces it before doing so.
640 795
641The callback will be called when the condition becomes "true", i.e. when 796The callback will be called when the condition becomes (or already was)
642C<send> or C<croak> are called, with the only argument being the condition 797"true", i.e. when C<send> or C<croak> are called (or were called), with
643variable itself. Calling C<recv> inside the callback or at any later time 798the only argument being the condition variable itself. Calling C<recv>
644is guaranteed not to block. 799inside the callback or at any later time is guaranteed not to block.
645 800
646=back 801=back
647 802
803=head1 SUPPORTED EVENT LOOPS/BACKENDS
804
805The available backend classes are (every class has its own manpage):
806
807=over 4
808
809=item Backends that are autoprobed when no other event loop can be found.
810
811EV is the preferred backend when no other event loop seems to be in
812use. If EV is not installed, then AnyEvent will fall back to its own
813pure-perl implementation, which is available everywhere as it comes with
814AnyEvent itself.
815
816 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
817 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
818
819=item Backends that are transparently being picked up when they are used.
820
821These will be used when they are currently loaded when the first watcher
822is created, in which case it is assumed that the application is using
823them. This means that AnyEvent will automatically pick the right backend
824when the main program loads an event module before anything starts to
825create watchers. Nothing special needs to be done by the main program.
826
827 AnyEvent::Impl::Event based on Event, very stable, few glitches.
828 AnyEvent::Impl::Glib based on Glib, slow but very stable.
829 AnyEvent::Impl::Tk based on Tk, very broken.
830 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
831 AnyEvent::Impl::POE based on POE, very slow, some limitations.
832 AnyEvent::Impl::Irssi used when running within irssi.
833
834=item Backends with special needs.
835
836Qt requires the Qt::Application to be instantiated first, but will
837otherwise be picked up automatically. As long as the main program
838instantiates the application before any AnyEvent watchers are created,
839everything should just work.
840
841 AnyEvent::Impl::Qt based on Qt.
842
843Support for IO::Async can only be partial, as it is too broken and
844architecturally limited to even support the AnyEvent API. It also
845is the only event loop that needs the loop to be set explicitly, so
846it can only be used by a main program knowing about AnyEvent. See
847L<AnyEvent::Impl::Async> for the gory details.
848
849 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
850
851=item Event loops that are indirectly supported via other backends.
852
853Some event loops can be supported via other modules:
854
855There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
856
857B<WxWidgets> has no support for watching file handles. However, you can
858use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
859polls 20 times per second, which was considered to be too horrible to even
860consider for AnyEvent.
861
862B<Prima> is not supported as nobody seems to be using it, but it has a POE
863backend, so it can be supported through POE.
864
865AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
866load L<POE> when detecting them, in the hope that POE will pick them up,
867in which case everything will be automatic.
868
869=back
870
648=head1 GLOBAL VARIABLES AND FUNCTIONS 871=head1 GLOBAL VARIABLES AND FUNCTIONS
649 872
873These are not normally required to use AnyEvent, but can be useful to
874write AnyEvent extension modules.
875
650=over 4 876=over 4
651 877
652=item $AnyEvent::MODEL 878=item $AnyEvent::MODEL
653 879
654Contains C<undef> until the first watcher is being created. Then it 880Contains C<undef> until the first watcher is being created, before the
881backend has been autodetected.
882
655contains the event model that is being used, which is the name of the 883Afterwards it contains the event model that is being used, which is the
656Perl class implementing the model. This class is usually one of the 884name of the Perl class implementing the model. This class is usually one
657C<AnyEvent::Impl:xxx> modules, but can be any other class in the case 885of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
658AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). 886case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
659 887will be C<urxvt::anyevent>).
660The known classes so far are:
661
662 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
663 AnyEvent::Impl::Event based on Event, second best choice.
664 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
665 AnyEvent::Impl::Glib based on Glib, third-best choice.
666 AnyEvent::Impl::Tk based on Tk, very bad choice.
667 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
668 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
669 AnyEvent::Impl::POE based on POE, not generic enough for full support.
670
671There is no support for WxWidgets, as WxWidgets has no support for
672watching file handles. However, you can use WxWidgets through the
673POE Adaptor, as POE has a Wx backend that simply polls 20 times per
674second, which was considered to be too horrible to even consider for
675AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
676it's adaptor.
677
678AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
679autodetecting them.
680 888
681=item AnyEvent::detect 889=item AnyEvent::detect
682 890
683Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 891Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
684if necessary. You should only call this function right before you would 892if necessary. You should only call this function right before you would
685have created an AnyEvent watcher anyway, that is, as late as possible at 893have created an AnyEvent watcher anyway, that is, as late as possible at
686runtime. 894runtime, and not e.g. while initialising of your module.
895
896If you need to do some initialisation before AnyEvent watchers are
897created, use C<post_detect>.
687 898
688=item $guard = AnyEvent::post_detect { BLOCK } 899=item $guard = AnyEvent::post_detect { BLOCK }
689 900
690Arranges for the code block to be executed as soon as the event model is 901Arranges for the code block to be executed as soon as the event model is
691autodetected (or immediately if this has already happened). 902autodetected (or immediately if this has already happened).
692 903
904The block will be executed I<after> the actual backend has been detected
905(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
906created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
907other initialisations - see the sources of L<AnyEvent::Strict> or
908L<AnyEvent::AIO> to see how this is used.
909
910The most common usage is to create some global watchers, without forcing
911event module detection too early, for example, L<AnyEvent::AIO> creates
912and installs the global L<IO::AIO> watcher in a C<post_detect> block to
913avoid autodetecting the event module at load time.
914
693If called in scalar or list context, then it creates and returns an object 915If called in scalar or list context, then it creates and returns an object
694that automatically removes the callback again when it is destroyed. See 916that automatically removes the callback again when it is destroyed (or
917C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
695L<Coro::BDB> for a case where this is useful. 918a case where this is useful.
919
920Example: Create a watcher for the IO::AIO module and store it in
921C<$WATCHER>. Only do so after the event loop is initialised, though.
922
923 our WATCHER;
924
925 my $guard = AnyEvent::post_detect {
926 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
927 };
928
929 # the ||= is important in case post_detect immediately runs the block,
930 # as to not clobber the newly-created watcher. assigning both watcher and
931 # post_detect guard to the same variable has the advantage of users being
932 # able to just C<undef $WATCHER> if the watcher causes them grief.
933
934 $WATCHER ||= $guard;
696 935
697=item @AnyEvent::post_detect 936=item @AnyEvent::post_detect
698 937
699If there are any code references in this array (you can C<push> to it 938If there are any code references in this array (you can C<push> to it
700before or after loading AnyEvent), then they will called directly after 939before or after loading AnyEvent), then they will called directly after
701the event loop has been chosen. 940the event loop has been chosen.
702 941
703You should check C<$AnyEvent::MODEL> before adding to this array, though: 942You should check C<$AnyEvent::MODEL> before adding to this array, though:
704if it contains a true value then the event loop has already been detected, 943if it is defined then the event loop has already been detected, and the
705and the array will be ignored. 944array will be ignored.
706 945
707Best use C<AnyEvent::post_detect { BLOCK }> instead. 946Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
947it,as it takes care of these details.
948
949This variable is mainly useful for modules that can do something useful
950when AnyEvent is used and thus want to know when it is initialised, but do
951not need to even load it by default. This array provides the means to hook
952into AnyEvent passively, without loading it.
708 953
709=back 954=back
710 955
711=head1 WHAT TO DO IN A MODULE 956=head1 WHAT TO DO IN A MODULE
712 957
767 1012
768 1013
769=head1 OTHER MODULES 1014=head1 OTHER MODULES
770 1015
771The following is a non-exhaustive list of additional modules that use 1016The following is a non-exhaustive list of additional modules that use
772AnyEvent and can therefore be mixed easily with other AnyEvent modules 1017AnyEvent as a client and can therefore be mixed easily with other AnyEvent
773in the same program. Some of the modules come with AnyEvent, some are 1018modules and other event loops in the same program. Some of the modules
774available via CPAN. 1019come with AnyEvent, most are available via CPAN.
775 1020
776=over 4 1021=over 4
777 1022
778=item L<AnyEvent::Util> 1023=item L<AnyEvent::Util>
779 1024
788 1033
789=item L<AnyEvent::Handle> 1034=item L<AnyEvent::Handle>
790 1035
791Provide read and write buffers, manages watchers for reads and writes, 1036Provide read and write buffers, manages watchers for reads and writes,
792supports raw and formatted I/O, I/O queued and fully transparent and 1037supports raw and formatted I/O, I/O queued and fully transparent and
793non-blocking SSL/TLS. 1038non-blocking SSL/TLS (via L<AnyEvent::TLS>.
794 1039
795=item L<AnyEvent::DNS> 1040=item L<AnyEvent::DNS>
796 1041
797Provides rich asynchronous DNS resolver capabilities. 1042Provides rich asynchronous DNS resolver capabilities.
798 1043
826 1071
827=item L<AnyEvent::GPSD> 1072=item L<AnyEvent::GPSD>
828 1073
829A non-blocking interface to gpsd, a daemon delivering GPS information. 1074A non-blocking interface to gpsd, a daemon delivering GPS information.
830 1075
1076=item L<AnyEvent::IRC>
1077
1078AnyEvent based IRC client module family (replacing the older Net::IRC3).
1079
1080=item L<AnyEvent::XMPP>
1081
1082AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1083Net::XMPP2>.
1084
831=item L<AnyEvent::IGS> 1085=item L<AnyEvent::IGS>
832 1086
833A non-blocking interface to the Internet Go Server protocol (used by 1087A non-blocking interface to the Internet Go Server protocol (used by
834L<App::IGS>). 1088L<App::IGS>).
835 1089
836=item L<AnyEvent::IRC>
837
838AnyEvent based IRC client module family (replacing the older Net::IRC3).
839
840=item L<Net::XMPP2>
841
842AnyEvent based XMPP (Jabber protocol) module family.
843
844=item L<Net::FCP> 1090=item L<Net::FCP>
845 1091
846AnyEvent-based implementation of the Freenet Client Protocol, birthplace 1092AnyEvent-based implementation of the Freenet Client Protocol, birthplace
847of AnyEvent. 1093of AnyEvent.
848 1094
852 1098
853=item L<Coro> 1099=item L<Coro>
854 1100
855Has special support for AnyEvent via L<Coro::AnyEvent>. 1101Has special support for AnyEvent via L<Coro::AnyEvent>.
856 1102
857=item L<IO::Lambda>
858
859The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
860
861=back 1103=back
862 1104
863=cut 1105=cut
864 1106
865package AnyEvent; 1107package AnyEvent;
866 1108
1109# basically a tuned-down version of common::sense
1110sub common_sense {
867no warnings; 1111 # no warnings
1112 ${^WARNING_BITS} ^= ${^WARNING_BITS};
868use strict qw(vars subs); 1113 # use strict vars subs
1114 $^H |= 0x00000600;
1115}
869 1116
1117BEGIN { AnyEvent::common_sense }
1118
870use Carp; 1119use Carp ();
871 1120
872our $VERSION = 4.341; 1121our $VERSION = '5.01';
873our $MODEL; 1122our $MODEL;
874 1123
875our $AUTOLOAD; 1124our $AUTOLOAD;
876our @ISA; 1125our @ISA;
877 1126
878our @REGISTRY; 1127our @REGISTRY;
879 1128
880our $WIN32; 1129our $WIN32;
881 1130
1131our $VERBOSE;
1132
882BEGIN { 1133BEGIN {
883 my $win32 = ! ! ($^O =~ /mswin32/i); 1134 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
884 eval "sub WIN32(){ $win32 }"; 1135 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
885}
886 1136
1137 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1138 if ${^TAINT};
1139
887our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1140 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1141
1142}
1143
1144our $MAX_SIGNAL_LATENCY = 10;
888 1145
889our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1146our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
890 1147
891{ 1148{
892 my $idx; 1149 my $idx;
894 for reverse split /\s*,\s*/, 1151 for reverse split /\s*,\s*/,
895 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1152 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
896} 1153}
897 1154
898my @models = ( 1155my @models = (
899 [EV:: => AnyEvent::Impl::EV::], 1156 [EV:: => AnyEvent::Impl::EV:: , 1],
900 [Event:: => AnyEvent::Impl::Event::],
901 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1157 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
902 # everything below here will not be autoprobed 1158 # everything below here will not (normally) be autoprobed
903 # as the pureperl backend should work everywhere 1159 # as the pureperl backend should work everywhere
904 # and is usually faster 1160 # and is usually faster
1161 [Event:: => AnyEvent::Impl::Event::, 1],
1162 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1163 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1164 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
905 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1165 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
906 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
907 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
908 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1166 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
909 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1167 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
910 [Wx:: => AnyEvent::Impl::POE::], 1168 [Wx:: => AnyEvent::Impl::POE::],
911 [Prima:: => AnyEvent::Impl::POE::], 1169 [Prima:: => AnyEvent::Impl::POE::],
1170 # IO::Async is just too broken - we would need workarounds for its
1171 # byzantine signal and broken child handling, among others.
1172 # IO::Async is rather hard to detect, as it doesn't have any
1173 # obvious default class.
1174 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1175 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1176 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1177 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
912); 1178);
913 1179
914our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); 1180our %method = map +($_ => 1),
1181 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
915 1182
916our @post_detect; 1183our @post_detect;
917 1184
918sub post_detect(&) { 1185sub post_detect(&) {
919 my ($cb) = @_; 1186 my ($cb) = @_;
920 1187
921 if ($MODEL) { 1188 if ($MODEL) {
922 $cb->(); 1189 $cb->();
923 1190
924 1 1191 undef
925 } else { 1192 } else {
926 push @post_detect, $cb; 1193 push @post_detect, $cb;
927 1194
928 defined wantarray 1195 defined wantarray
929 ? bless \$cb, "AnyEvent::Util::PostDetect" 1196 ? bless \$cb, "AnyEvent::Util::postdetect"
930 : () 1197 : ()
931 } 1198 }
932} 1199}
933 1200
934sub AnyEvent::Util::PostDetect::DESTROY { 1201sub AnyEvent::Util::postdetect::DESTROY {
935 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1202 @post_detect = grep $_ != ${$_[0]}, @post_detect;
936} 1203}
937 1204
938sub detect() { 1205sub detect() {
939 unless ($MODEL) { 1206 unless ($MODEL) {
940 no strict 'refs';
941 local $SIG{__DIE__}; 1207 local $SIG{__DIE__};
942 1208
943 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1209 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
944 my $model = "AnyEvent::Impl::$1"; 1210 my $model = "AnyEvent::Impl::$1";
945 if (eval "require $model") { 1211 if (eval "require $model") {
946 $MODEL = $model; 1212 $MODEL = $model;
947 warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; 1213 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
948 } else { 1214 } else {
949 warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; 1215 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
950 } 1216 }
951 } 1217 }
952 1218
953 # check for already loaded models 1219 # check for already loaded models
954 unless ($MODEL) { 1220 unless ($MODEL) {
955 for (@REGISTRY, @models) { 1221 for (@REGISTRY, @models) {
956 my ($package, $model) = @$_; 1222 my ($package, $model) = @$_;
957 if (${"$package\::VERSION"} > 0) { 1223 if (${"$package\::VERSION"} > 0) {
958 if (eval "require $model") { 1224 if (eval "require $model") {
959 $MODEL = $model; 1225 $MODEL = $model;
960 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; 1226 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
961 last; 1227 last;
962 } 1228 }
963 } 1229 }
964 } 1230 }
965 1231
966 unless ($MODEL) { 1232 unless ($MODEL) {
967 # try to load a model 1233 # try to autoload a model
968
969 for (@REGISTRY, @models) { 1234 for (@REGISTRY, @models) {
970 my ($package, $model) = @$_; 1235 my ($package, $model, $autoload) = @$_;
1236 if (
1237 $autoload
971 if (eval "require $package" 1238 and eval "require $package"
972 and ${"$package\::VERSION"} > 0 1239 and ${"$package\::VERSION"} > 0
973 and eval "require $model") { 1240 and eval "require $model"
1241 ) {
974 $MODEL = $model; 1242 $MODEL = $model;
975 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; 1243 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
976 last; 1244 last;
977 } 1245 }
978 } 1246 }
979 1247
980 $MODEL 1248 $MODEL
981 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 1249 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
982 } 1250 }
983 } 1251 }
984 1252
985 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1253 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
986 1254
996 1264
997sub AUTOLOAD { 1265sub AUTOLOAD {
998 (my $func = $AUTOLOAD) =~ s/.*://; 1266 (my $func = $AUTOLOAD) =~ s/.*://;
999 1267
1000 $method{$func} 1268 $method{$func}
1001 or croak "$func: not a valid method for AnyEvent objects"; 1269 or Carp::croak "$func: not a valid method for AnyEvent objects";
1002 1270
1003 detect unless $MODEL; 1271 detect unless $MODEL;
1004 1272
1005 my $class = shift; 1273 my $class = shift;
1006 $class->$func (@_); 1274 $class->$func (@_);
1007} 1275}
1008 1276
1009# utility function to dup a filehandle. this is used by many backends 1277# utility function to dup a filehandle. this is used by many backends
1010# to support binding more than one watcher per filehandle (they usually 1278# to support binding more than one watcher per filehandle (they usually
1011# allow only one watcher per fd, so we dup it to get a different one). 1279# allow only one watcher per fd, so we dup it to get a different one).
1012sub _dupfh($$$$) { 1280sub _dupfh($$;$$) {
1013 my ($poll, $fh, $r, $w) = @_; 1281 my ($poll, $fh, $r, $w) = @_;
1014 1282
1015 # cygwin requires the fh mode to be matching, unix doesn't 1283 # cygwin requires the fh mode to be matching, unix doesn't
1016 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1284 my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1017 : $poll eq "w" ? ($w, ">")
1018 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1019 1285
1020 open my $fh2, "$mode&" . fileno $fh 1286 open my $fh2, $mode, $fh
1021 or die "cannot dup() filehandle: $!"; 1287 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1022 1288
1023 # we assume CLOEXEC is already set by perl in all important cases 1289 # we assume CLOEXEC is already set by perl in all important cases
1024 1290
1025 ($fh2, $rw) 1291 ($fh2, $rw)
1026} 1292}
1027 1293
1294=head1 SIMPLIFIED AE API
1295
1296Starting with version 5.0, AnyEvent officially supports a second, much
1297simpler, API that is designed to reduce the calling, typing and memory
1298overhead.
1299
1300See the L<AE> manpage for details.
1301
1302=cut
1303
1304package AE;
1305
1306our $VERSION = $AnyEvent::VERSION;
1307
1308sub io($$$) {
1309 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1310}
1311
1312sub timer($$$) {
1313 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1314}
1315
1316sub signal($$) {
1317 AnyEvent->signal (signal => $_[0], cb => $_[1])
1318}
1319
1320sub child($$) {
1321 AnyEvent->child (pid => $_[0], cb => $_[1])
1322}
1323
1324sub idle($) {
1325 AnyEvent->idle (cb => $_[0])
1326}
1327
1328sub cv(;&) {
1329 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1330}
1331
1332sub now() {
1333 AnyEvent->now
1334}
1335
1336sub now_update() {
1337 AnyEvent->now_update
1338}
1339
1340sub time() {
1341 AnyEvent->time
1342}
1343
1028package AnyEvent::Base; 1344package AnyEvent::Base;
1029 1345
1030# default implementation for now and time 1346# default implementations for many methods
1031 1347
1032BEGIN { 1348sub _time {
1349 # probe for availability of Time::HiRes
1033 if (eval "use Time::HiRes (); time (); 1") { 1350 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1351 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1034 *_time = \&Time::HiRes::time; 1352 *_time = \&Time::HiRes::time;
1035 # if (eval "use POSIX (); (POSIX::times())... 1353 # if (eval "use POSIX (); (POSIX::times())...
1036 } else { 1354 } else {
1355 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1037 *_time = sub { time }; # epic fail 1356 *_time = sub { time }; # epic fail
1038 } 1357 }
1358
1359 &_time
1039} 1360}
1040 1361
1041sub time { _time } 1362sub time { _time }
1042sub now { _time } 1363sub now { _time }
1364sub now_update { }
1043 1365
1044# default implementation for ->condvar 1366# default implementation for ->condvar
1045 1367
1046sub condvar { 1368sub condvar {
1047 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1369 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1048} 1370}
1049 1371
1050# default implementation for ->signal 1372# default implementation for ->signal
1051 1373
1374our $HAVE_ASYNC_INTERRUPT;
1375
1376sub _have_async_interrupt() {
1377 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1378 && eval "use Async::Interrupt 1.0 (); 1")
1379 unless defined $HAVE_ASYNC_INTERRUPT;
1380
1381 $HAVE_ASYNC_INTERRUPT
1382}
1383
1052our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1384our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1385our (%SIG_ASY, %SIG_ASY_W);
1386our ($SIG_COUNT, $SIG_TW);
1053 1387
1054sub _signal_exec { 1388sub _signal_exec {
1389 $HAVE_ASYNC_INTERRUPT
1390 ? $SIGPIPE_R->drain
1391 : sysread $SIGPIPE_R, my $dummy, 9;
1392
1055 while (%SIG_EV) { 1393 while (%SIG_EV) {
1056 sysread $SIGPIPE_R, my $dummy, 4;
1057 for (keys %SIG_EV) { 1394 for (keys %SIG_EV) {
1058 delete $SIG_EV{$_}; 1395 delete $SIG_EV{$_};
1059 $_->() for values %{ $SIG_CB{$_} || {} }; 1396 $_->() for values %{ $SIG_CB{$_} || {} };
1060 } 1397 }
1061 } 1398 }
1062} 1399}
1063 1400
1401# install a dummy wakeup watcher to reduce signal catching latency
1402sub _sig_add() {
1403 unless ($SIG_COUNT++) {
1404 # try to align timer on a full-second boundary, if possible
1405 my $NOW = AE::now;
1406
1407 $SIG_TW = AE::timer
1408 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1409 $MAX_SIGNAL_LATENCY,
1410 sub { } # just for the PERL_ASYNC_CHECK
1411 ;
1412 }
1413}
1414
1415sub _sig_del {
1416 undef $SIG_TW
1417 unless --$SIG_COUNT;
1418}
1419
1420our $_sig_name_init; $_sig_name_init = sub {
1421 eval q{ # poor man's autoloading
1422 undef $_sig_name_init;
1423
1424 if (_have_async_interrupt) {
1425 *sig2num = \&Async::Interrupt::sig2num;
1426 *sig2name = \&Async::Interrupt::sig2name;
1427 } else {
1428 require Config;
1429
1430 my %signame2num;
1431 @signame2num{ split ' ', $Config::Config{sig_name} }
1432 = split ' ', $Config::Config{sig_num};
1433
1434 my @signum2name;
1435 @signum2name[values %signame2num] = keys %signame2num;
1436
1437 *sig2num = sub($) {
1438 $_[0] > 0 ? shift : $signame2num{+shift}
1439 };
1440 *sig2name = sub ($) {
1441 $_[0] > 0 ? $signum2name[+shift] : shift
1442 };
1443 }
1444 };
1445 die if $@;
1446};
1447
1448sub sig2num ($) { &$_sig_name_init; &sig2num }
1449sub sig2name($) { &$_sig_name_init; &sig2name }
1450
1064sub signal { 1451sub signal {
1065 my (undef, %arg) = @_; 1452 eval q{ # poor man's autoloading {}
1453 # probe for availability of Async::Interrupt
1454 if (_have_async_interrupt) {
1455 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1066 1456
1067 unless ($SIGPIPE_R) { 1457 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1068 if (AnyEvent::WIN32) { 1458 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1069 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1459
1070 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1071 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1072 } else { 1460 } else {
1073 pipe $SIGPIPE_R, $SIGPIPE_W; 1461 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1462
1074 require Fcntl; 1463 require Fcntl;
1464
1465 if (AnyEvent::WIN32) {
1466 require AnyEvent::Util;
1467
1468 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1469 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1470 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1471 } else {
1472 pipe $SIGPIPE_R, $SIGPIPE_W;
1075 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; 1473 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1076 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case 1474 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1475
1476 # not strictly required, as $^F is normally 2, but let's make sure...
1477 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1478 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1479 }
1480
1481 $SIGPIPE_R
1482 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1483
1484 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1077 } 1485 }
1078 1486
1079 $SIGPIPE_R 1487 *signal = sub {
1080 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1488 my (undef, %arg) = @_;
1081 1489
1082 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1083 }
1084
1085 my $signal = uc $arg{signal} 1490 my $signal = uc $arg{signal}
1086 or Carp::croak "required option 'signal' is missing"; 1491 or Carp::croak "required option 'signal' is missing";
1087 1492
1493 if ($HAVE_ASYNC_INTERRUPT) {
1494 # async::interrupt
1495
1496 $signal = sig2num $signal;
1088 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1497 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1498
1499 $SIG_ASY{$signal} ||= new Async::Interrupt
1500 cb => sub { undef $SIG_EV{$signal} },
1501 signal => $signal,
1502 pipe => [$SIGPIPE_R->filenos],
1503 pipe_autodrain => 0,
1504 ;
1505
1506 } else {
1507 # pure perl
1508
1509 # AE::Util has been loaded in signal
1510 $signal = sig2name $signal;
1511 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1512
1089 $SIG{$signal} ||= sub { 1513 $SIG{$signal} ||= sub {
1514 local $!;
1090 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1515 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1091 undef $SIG_EV{$signal}; 1516 undef $SIG_EV{$signal};
1517 };
1518
1519 # can't do signal processing without introducing races in pure perl,
1520 # so limit the signal latency.
1521 _sig_add;
1522 }
1523
1524 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1525 };
1526
1527 *AnyEvent::Base::signal::DESTROY = sub {
1528 my ($signal, $cb) = @{$_[0]};
1529
1530 _sig_del;
1531
1532 delete $SIG_CB{$signal}{$cb};
1533
1534 $HAVE_ASYNC_INTERRUPT
1535 ? delete $SIG_ASY{$signal}
1536 : # delete doesn't work with older perls - they then
1537 # print weird messages, or just unconditionally exit
1538 # instead of getting the default action.
1539 undef $SIG{$signal}
1540 unless keys %{ $SIG_CB{$signal} };
1541 };
1092 }; 1542 };
1093 1543 die if $@;
1094 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1544 &signal
1095}
1096
1097sub AnyEvent::Base::Signal::DESTROY {
1098 my ($signal, $cb) = @{$_[0]};
1099
1100 delete $SIG_CB{$signal}{$cb};
1101
1102 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1103} 1545}
1104 1546
1105# default implementation for ->child 1547# default implementation for ->child
1106 1548
1107our %PID_CB; 1549our %PID_CB;
1108our $CHLD_W; 1550our $CHLD_W;
1109our $CHLD_DELAY_W; 1551our $CHLD_DELAY_W;
1110our $PID_IDLE;
1111our $WNOHANG; 1552our $WNOHANG;
1112 1553
1113sub _child_wait { 1554sub _emit_childstatus($$) {
1114 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1555 my (undef, $rpid, $rstatus) = @_;
1556
1557 $_->($rpid, $rstatus)
1115 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1558 for values %{ $PID_CB{$rpid} || {} },
1116 (values %{ $PID_CB{0} || {} }); 1559 values %{ $PID_CB{0} || {} };
1117 }
1118
1119 undef $PID_IDLE;
1120} 1560}
1121 1561
1122sub _sigchld { 1562sub _sigchld {
1123 # make sure we deliver these changes "synchronous" with the event loop. 1563 my $pid;
1124 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub { 1564
1125 undef $CHLD_DELAY_W; 1565 AnyEvent->_emit_childstatus ($pid, $?)
1126 &_child_wait; 1566 while ($pid = waitpid -1, $WNOHANG) > 0;
1127 });
1128} 1567}
1129 1568
1130sub child { 1569sub child {
1131 my (undef, %arg) = @_; 1570 my (undef, %arg) = @_;
1132 1571
1133 defined (my $pid = $arg{pid} + 0) 1572 defined (my $pid = $arg{pid} + 0)
1134 or Carp::croak "required option 'pid' is missing"; 1573 or Carp::croak "required option 'pid' is missing";
1135 1574
1136 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1575 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1137 1576
1138 unless ($WNOHANG) { 1577 # WNOHANG is almost cetrainly 1 everywhere
1578 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1579 ? 1
1139 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1580 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1140 }
1141 1581
1142 unless ($CHLD_W) { 1582 unless ($CHLD_W) {
1143 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1583 $CHLD_W = AE::signal CHLD => \&_sigchld;
1144 # child could be a zombie already, so make at least one round 1584 # child could be a zombie already, so make at least one round
1145 &_sigchld; 1585 &_sigchld;
1146 } 1586 }
1147 1587
1148 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1588 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1149} 1589}
1150 1590
1151sub AnyEvent::Base::Child::DESTROY { 1591sub AnyEvent::Base::child::DESTROY {
1152 my ($pid, $cb) = @{$_[0]}; 1592 my ($pid, $cb) = @{$_[0]};
1153 1593
1154 delete $PID_CB{$pid}{$cb}; 1594 delete $PID_CB{$pid}{$cb};
1155 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1595 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1156 1596
1157 undef $CHLD_W unless keys %PID_CB; 1597 undef $CHLD_W unless keys %PID_CB;
1158} 1598}
1159 1599
1600# idle emulation is done by simply using a timer, regardless
1601# of whether the process is idle or not, and not letting
1602# the callback use more than 50% of the time.
1603sub idle {
1604 my (undef, %arg) = @_;
1605
1606 my ($cb, $w, $rcb) = $arg{cb};
1607
1608 $rcb = sub {
1609 if ($cb) {
1610 $w = _time;
1611 &$cb;
1612 $w = _time - $w;
1613
1614 # never use more then 50% of the time for the idle watcher,
1615 # within some limits
1616 $w = 0.0001 if $w < 0.0001;
1617 $w = 5 if $w > 5;
1618
1619 $w = AE::timer $w, 0, $rcb;
1620 } else {
1621 # clean up...
1622 undef $w;
1623 undef $rcb;
1624 }
1625 };
1626
1627 $w = AE::timer 0.05, 0, $rcb;
1628
1629 bless \\$cb, "AnyEvent::Base::idle"
1630}
1631
1632sub AnyEvent::Base::idle::DESTROY {
1633 undef $${$_[0]};
1634}
1635
1160package AnyEvent::CondVar; 1636package AnyEvent::CondVar;
1161 1637
1162our @ISA = AnyEvent::CondVar::Base::; 1638our @ISA = AnyEvent::CondVar::Base::;
1163 1639
1164package AnyEvent::CondVar::Base; 1640package AnyEvent::CondVar::Base;
1165 1641
1166use overload 1642#use overload
1167 '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1643# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1168 fallback => 1; 1644# fallback => 1;
1645
1646# save 300+ kilobytes by dirtily hardcoding overloading
1647${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
1648*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
1649*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
1650${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1651
1652our $WAITING;
1169 1653
1170sub _send { 1654sub _send {
1171 # nop 1655 # nop
1172} 1656}
1173 1657
1186sub ready { 1670sub ready {
1187 $_[0]{_ae_sent} 1671 $_[0]{_ae_sent}
1188} 1672}
1189 1673
1190sub _wait { 1674sub _wait {
1675 $WAITING
1676 and !$_[0]{_ae_sent}
1677 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1678
1679 local $WAITING = 1;
1191 AnyEvent->one_event while !$_[0]{_ae_sent}; 1680 AnyEvent->one_event while !$_[0]{_ae_sent};
1192} 1681}
1193 1682
1194sub recv { 1683sub recv {
1195 $_[0]->_wait; 1684 $_[0]->_wait;
1197 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1686 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1198 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1687 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1199} 1688}
1200 1689
1201sub cb { 1690sub cb {
1202 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1691 my $cv = shift;
1692
1693 @_
1694 and $cv->{_ae_cb} = shift
1695 and $cv->{_ae_sent}
1696 and (delete $cv->{_ae_cb})->($cv);
1697
1203 $_[0]{_ae_cb} 1698 $cv->{_ae_cb}
1204} 1699}
1205 1700
1206sub begin { 1701sub begin {
1207 ++$_[0]{_ae_counter}; 1702 ++$_[0]{_ae_counter};
1208 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1703 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1236so on. 1731so on.
1237 1732
1238=head1 ENVIRONMENT VARIABLES 1733=head1 ENVIRONMENT VARIABLES
1239 1734
1240The following environment variables are used by this module or its 1735The following environment variables are used by this module or its
1241submodules: 1736submodules.
1737
1738Note that AnyEvent will remove I<all> environment variables starting with
1739C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
1740enabled.
1242 1741
1243=over 4 1742=over 4
1244 1743
1245=item C<PERL_ANYEVENT_VERBOSE> 1744=item C<PERL_ANYEVENT_VERBOSE>
1246 1745
1253C<PERL_ANYEVENT_MODEL>. 1752C<PERL_ANYEVENT_MODEL>.
1254 1753
1255When set to C<2> or higher, cause AnyEvent to report to STDERR which event 1754When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1256model it chooses. 1755model it chooses.
1257 1756
1757When set to C<8> or higher, then AnyEvent will report extra information on
1758which optional modules it loads and how it implements certain features.
1759
1258=item C<PERL_ANYEVENT_STRICT> 1760=item C<PERL_ANYEVENT_STRICT>
1259 1761
1260AnyEvent does not do much argument checking by default, as thorough 1762AnyEvent does not do much argument checking by default, as thorough
1261argument checking is very costly. Setting this variable to a true value 1763argument checking is very costly. Setting this variable to a true value
1262will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly 1764will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1263check the arguments passed to most method calls. If it finds any problems 1765check the arguments passed to most method calls. If it finds any problems,
1264it will croak. 1766it will croak.
1265 1767
1266In other words, enables "strict" mode. 1768In other words, enables "strict" mode.
1267 1769
1268Unlike C<use strict>, it is definitely recommended ot keep it off in 1770Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1269production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while 1771>>, it is definitely recommended to keep it off in production. Keeping
1270developing programs can be very useful, however. 1772C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1773can be very useful, however.
1271 1774
1272=item C<PERL_ANYEVENT_MODEL> 1775=item C<PERL_ANYEVENT_MODEL>
1273 1776
1274This can be used to specify the event model to be used by AnyEvent, before 1777This can be used to specify the event model to be used by AnyEvent, before
1275auto detection and -probing kicks in. It must be a string consisting 1778auto detection and -probing kicks in. It must be a string consisting
1318 1821
1319=item C<PERL_ANYEVENT_MAX_FORKS> 1822=item C<PERL_ANYEVENT_MAX_FORKS>
1320 1823
1321The maximum number of child processes that C<AnyEvent::Util::fork_call> 1824The maximum number of child processes that C<AnyEvent::Util::fork_call>
1322will create in parallel. 1825will create in parallel.
1826
1827=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1828
1829The default value for the C<max_outstanding> parameter for the default DNS
1830resolver - this is the maximum number of parallel DNS requests that are
1831sent to the DNS server.
1832
1833=item C<PERL_ANYEVENT_RESOLV_CONF>
1834
1835The file to use instead of F</etc/resolv.conf> (or OS-specific
1836configuration) in the default resolver. When set to the empty string, no
1837default config will be used.
1838
1839=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1840
1841When neither C<ca_file> nor C<ca_path> was specified during
1842L<AnyEvent::TLS> context creation, and either of these environment
1843variables exist, they will be used to specify CA certificate locations
1844instead of a system-dependent default.
1845
1846=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1847
1848When these are set to C<1>, then the respective modules are not
1849loaded. Mostly good for testing AnyEvent itself.
1323 1850
1324=back 1851=back
1325 1852
1326=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1853=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1327 1854
1535through AnyEvent. The benchmark creates a lot of timers (with a zero 2062through AnyEvent. The benchmark creates a lot of timers (with a zero
1536timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2063timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1537which it is), lets them fire exactly once and destroys them again. 2064which it is), lets them fire exactly once and destroys them again.
1538 2065
1539Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2066Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1540distribution. 2067distribution. It uses the L<AE> interface, which makes a real difference
2068for the EV and Perl backends only.
1541 2069
1542=head3 Explanation of the columns 2070=head3 Explanation of the columns
1543 2071
1544I<watcher> is the number of event watchers created/destroyed. Since 2072I<watcher> is the number of event watchers created/destroyed. Since
1545different event models feature vastly different performances, each event 2073different event models feature vastly different performances, each event
1566watcher. 2094watcher.
1567 2095
1568=head3 Results 2096=head3 Results
1569 2097
1570 name watchers bytes create invoke destroy comment 2098 name watchers bytes create invoke destroy comment
1571 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2099 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1572 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2100 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1573 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2101 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1574 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2102 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1575 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2103 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1576 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2104 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2105 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2106 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1577 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2107 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1578 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2108 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1579 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2109 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1580 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2110 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1581 2111
1582=head3 Discussion 2112=head3 Discussion
1583 2113
1584The benchmark does I<not> measure scalability of the event loop very 2114The benchmark does I<not> measure scalability of the event loop very
1585well. For example, a select-based event loop (such as the pure perl one) 2115well. For example, a select-based event loop (such as the pure perl one)
1597benchmark machine, handling an event takes roughly 1600 CPU cycles with 2127benchmark machine, handling an event takes roughly 1600 CPU cycles with
1598EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2128EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1599cycles with POE. 2129cycles with POE.
1600 2130
1601C<EV> is the sole leader regarding speed and memory use, which are both 2131C<EV> is the sole leader regarding speed and memory use, which are both
1602maximal/minimal, respectively. Even when going through AnyEvent, it uses 2132maximal/minimal, respectively. When using the L<AE> API there is zero
2133overhead (when going through the AnyEvent API create is about 5-6 times
2134slower, with other times being equal, so still uses far less memory than
1603far less memory than any other event loop and is still faster than Event 2135any other event loop and is still faster than Event natively).
1604natively.
1605 2136
1606The pure perl implementation is hit in a few sweet spots (both the 2137The pure perl implementation is hit in a few sweet spots (both the
1607constant timeout and the use of a single fd hit optimisations in the perl 2138constant timeout and the use of a single fd hit optimisations in the perl
1608interpreter and the backend itself). Nevertheless this shows that it 2139interpreter and the backend itself). Nevertheless this shows that it
1609adds very little overhead in itself. Like any select-based backend its 2140adds very little overhead in itself. Like any select-based backend its
1610performance becomes really bad with lots of file descriptors (and few of 2141performance becomes really bad with lots of file descriptors (and few of
1611them active), of course, but this was not subject of this benchmark. 2142them active), of course, but this was not subject of this benchmark.
1612 2143
1613The C<Event> module has a relatively high setup and callback invocation 2144The C<Event> module has a relatively high setup and callback invocation
1614cost, but overall scores in on the third place. 2145cost, but overall scores in on the third place.
2146
2147C<IO::Async> performs admirably well, about on par with C<Event>, even
2148when using its pure perl backend.
1615 2149
1616C<Glib>'s memory usage is quite a bit higher, but it features a 2150C<Glib>'s memory usage is quite a bit higher, but it features a
1617faster callback invocation and overall ends up in the same class as 2151faster callback invocation and overall ends up in the same class as
1618C<Event>. However, Glib scales extremely badly, doubling the number of 2152C<Event>. However, Glib scales extremely badly, doubling the number of
1619watchers increases the processing time by more than a factor of four, 2153watchers increases the processing time by more than a factor of four,
1680In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2214In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1681(1%) are active. This mirrors the activity of large servers with many 2215(1%) are active. This mirrors the activity of large servers with many
1682connections, most of which are idle at any one point in time. 2216connections, most of which are idle at any one point in time.
1683 2217
1684Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2218Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1685distribution. 2219distribution. It uses the L<AE> interface, which makes a real difference
2220for the EV and Perl backends only.
1686 2221
1687=head3 Explanation of the columns 2222=head3 Explanation of the columns
1688 2223
1689I<sockets> is the number of sockets, and twice the number of "servers" (as 2224I<sockets> is the number of sockets, and twice the number of "servers" (as
1690each server has a read and write socket end). 2225each server has a read and write socket end).
1697it to another server. This includes deleting the old timeout and creating 2232it to another server. This includes deleting the old timeout and creating
1698a new one that moves the timeout into the future. 2233a new one that moves the timeout into the future.
1699 2234
1700=head3 Results 2235=head3 Results
1701 2236
1702 name sockets create request 2237 name sockets create request
1703 EV 20000 69.01 11.16 2238 EV 20000 62.66 7.99
1704 Perl 20000 73.32 35.87 2239 Perl 20000 68.32 32.64
1705 Event 20000 212.62 257.32 2240 IOAsync 20000 174.06 101.15 epoll
1706 Glib 20000 651.16 1896.30 2241 IOAsync 20000 174.67 610.84 poll
2242 Event 20000 202.69 242.91
2243 Glib 20000 557.01 1689.52
1707 POE 20000 349.67 12317.24 uses POE::Loop::Event 2244 POE 20000 341.54 12086.32 uses POE::Loop::Event
1708 2245
1709=head3 Discussion 2246=head3 Discussion
1710 2247
1711This benchmark I<does> measure scalability and overall performance of the 2248This benchmark I<does> measure scalability and overall performance of the
1712particular event loop. 2249particular event loop.
1714EV is again fastest. Since it is using epoll on my system, the setup time 2251EV is again fastest. Since it is using epoll on my system, the setup time
1715is relatively high, though. 2252is relatively high, though.
1716 2253
1717Perl surprisingly comes second. It is much faster than the C-based event 2254Perl surprisingly comes second. It is much faster than the C-based event
1718loops Event and Glib. 2255loops Event and Glib.
2256
2257IO::Async performs very well when using its epoll backend, and still quite
2258good compared to Glib when using its pure perl backend.
1719 2259
1720Event suffers from high setup time as well (look at its code and you will 2260Event suffers from high setup time as well (look at its code and you will
1721understand why). Callback invocation also has a high overhead compared to 2261understand why). Callback invocation also has a high overhead compared to
1722the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 2262the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1723uses select or poll in basically all documented configurations. 2263uses select or poll in basically all documented configurations.
1786=item * C-based event loops perform very well with small number of 2326=item * C-based event loops perform very well with small number of
1787watchers, as the management overhead dominates. 2327watchers, as the management overhead dominates.
1788 2328
1789=back 2329=back
1790 2330
2331=head2 THE IO::Lambda BENCHMARK
2332
2333Recently I was told about the benchmark in the IO::Lambda manpage, which
2334could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
2335simply compares IO::Lambda with POE, and IO::Lambda looks better (which
2336shouldn't come as a surprise to anybody). As such, the benchmark is
2337fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
2338very optimal. But how would AnyEvent compare when used without the extra
2339baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
2340
2341The benchmark itself creates an echo-server, and then, for 500 times,
2342connects to the echo server, sends a line, waits for the reply, and then
2343creates the next connection. This is a rather bad benchmark, as it doesn't
2344test the efficiency of the framework or much non-blocking I/O, but it is a
2345benchmark nevertheless.
2346
2347 name runtime
2348 Lambda/select 0.330 sec
2349 + optimized 0.122 sec
2350 Lambda/AnyEvent 0.327 sec
2351 + optimized 0.138 sec
2352 Raw sockets/select 0.077 sec
2353 POE/select, components 0.662 sec
2354 POE/select, raw sockets 0.226 sec
2355 POE/select, optimized 0.404 sec
2356
2357 AnyEvent/select/nb 0.085 sec
2358 AnyEvent/EV/nb 0.068 sec
2359 +state machine 0.134 sec
2360
2361The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
2362benchmarks actually make blocking connects and use 100% blocking I/O,
2363defeating the purpose of an event-based solution. All of the newly
2364written AnyEvent benchmarks use 100% non-blocking connects (using
2365AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
2366resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
2367generally require a lot more bookkeeping and event handling than blocking
2368connects (which involve a single syscall only).
2369
2370The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
2371offers similar expressive power as POE and IO::Lambda, using conventional
2372Perl syntax. This means that both the echo server and the client are 100%
2373non-blocking, further placing it at a disadvantage.
2374
2375As you can see, the AnyEvent + EV combination even beats the
2376hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2377backend easily beats IO::Lambda and POE.
2378
2379And even the 100% non-blocking version written using the high-level (and
2380slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
2381large margin, even though it does all of DNS, tcp-connect and socket I/O
2382in a non-blocking way.
2383
2384The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2385F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2386part of the IO::lambda distribution and were used without any changes.
2387
1791 2388
1792=head1 SIGNALS 2389=head1 SIGNALS
1793 2390
1794AnyEvent currently installs handlers for these signals: 2391AnyEvent currently installs handlers for these signals:
1795 2392
1798=item SIGCHLD 2395=item SIGCHLD
1799 2396
1800A handler for C<SIGCHLD> is installed by AnyEvent's child watcher 2397A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1801emulation for event loops that do not support them natively. Also, some 2398emulation for event loops that do not support them natively. Also, some
1802event loops install a similar handler. 2399event loops install a similar handler.
2400
2401Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2402AnyEvent will reset it to default, to avoid losing child exit statuses.
1803 2403
1804=item SIGPIPE 2404=item SIGPIPE
1805 2405
1806A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> 2406A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1807when AnyEvent gets loaded. 2407when AnyEvent gets loaded.
1819 2419
1820=back 2420=back
1821 2421
1822=cut 2422=cut
1823 2423
2424undef $SIG{CHLD}
2425 if $SIG{CHLD} eq 'IGNORE';
2426
1824$SIG{PIPE} = sub { } 2427$SIG{PIPE} = sub { }
1825 unless defined $SIG{PIPE}; 2428 unless defined $SIG{PIPE};
2429
2430=head1 RECOMMENDED/OPTIONAL MODULES
2431
2432One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2433it's built-in modules) are required to use it.
2434
2435That does not mean that AnyEvent won't take advantage of some additional
2436modules if they are installed.
2437
2438This section epxlains which additional modules will be used, and how they
2439affect AnyEvent's operetion.
2440
2441=over 4
2442
2443=item L<Async::Interrupt>
2444
2445This slightly arcane module is used to implement fast signal handling: To
2446my knowledge, there is no way to do completely race-free and quick
2447signal handling in pure perl. To ensure that signals still get
2448delivered, AnyEvent will start an interval timer to wake up perl (and
2449catch the signals) with some delay (default is 10 seconds, look for
2450C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2451
2452If this module is available, then it will be used to implement signal
2453catching, which means that signals will not be delayed, and the event loop
2454will not be interrupted regularly, which is more efficient (And good for
2455battery life on laptops).
2456
2457This affects not just the pure-perl event loop, but also other event loops
2458that have no signal handling on their own (e.g. Glib, Tk, Qt).
2459
2460Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
2461and either employ their own workarounds (POE) or use AnyEvent's workaround
2462(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
2463does nothing for those backends.
2464
2465=item L<EV>
2466
2467This module isn't really "optional", as it is simply one of the backend
2468event loops that AnyEvent can use. However, it is simply the best event
2469loop available in terms of features, speed and stability: It supports
2470the AnyEvent API optimally, implements all the watcher types in XS, does
2471automatic timer adjustments even when no monotonic clock is available,
2472can take avdantage of advanced kernel interfaces such as C<epoll> and
2473C<kqueue>, and is the fastest backend I<by far>. You can even embed
2474L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2475
2476=item L<Guard>
2477
2478The guard module, when used, will be used to implement
2479C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2480lot less memory), but otherwise doesn't affect guard operation much. It is
2481purely used for performance.
2482
2483=item L<JSON> and L<JSON::XS>
2484
2485This module is required when you want to read or write JSON data via
2486L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2487advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2488
2489In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2490installed.
2491
2492=item L<Net::SSLeay>
2493
2494Implementing TLS/SSL in Perl is certainly interesting, but not very
2495worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2496the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2497
2498=item L<Time::HiRes>
2499
2500This module is part of perl since release 5.008. It will be used when the
2501chosen event library does not come with a timing source on it's own. The
2502pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2503try to use a monotonic clock for timing stability.
2504
2505=back
1826 2506
1827 2507
1828=head1 FORK 2508=head1 FORK
1829 2509
1830Most event libraries are not fork-safe. The ones who are usually are 2510Most event libraries are not fork-safe. The ones who are usually are
1831because they rely on inefficient but fork-safe C<select> or C<poll> 2511because they rely on inefficient but fork-safe C<select> or C<poll>
1832calls. Only L<EV> is fully fork-aware. 2512calls. Only L<EV> is fully fork-aware.
1833 2513
1834If you have to fork, you must either do so I<before> creating your first 2514If you have to fork, you must either do so I<before> creating your first
1835watcher OR you must not use AnyEvent at all in the child. 2515watcher OR you must not use AnyEvent at all in the child OR you must do
2516something completely out of the scope of AnyEvent.
1836 2517
1837 2518
1838=head1 SECURITY CONSIDERATIONS 2519=head1 SECURITY CONSIDERATIONS
1839 2520
1840AnyEvent can be forced to load any event model via 2521AnyEvent can be forced to load any event model via
1852 use AnyEvent; 2533 use AnyEvent;
1853 2534
1854Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2535Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1855be used to probe what backend is used and gain other information (which is 2536be used to probe what backend is used and gain other information (which is
1856probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and 2537probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1857$ENV{PERL_ANYEGENT_STRICT}. 2538$ENV{PERL_ANYEVENT_STRICT}.
2539
2540Note that AnyEvent will remove I<all> environment variables starting with
2541C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2542enabled.
1858 2543
1859 2544
1860=head1 BUGS 2545=head1 BUGS
1861 2546
1862Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 2547Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1863to work around. If you suffer from memleaks, first upgrade to Perl 5.10 2548to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1864and check wether the leaks still show up. (Perl 5.10.0 has other annoying 2549and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1865mamleaks, such as leaking on C<map> and C<grep> but it is usually not as 2550memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1866pronounced). 2551pronounced).
1867 2552
1868 2553
1869=head1 SEE ALSO 2554=head1 SEE ALSO
1870 2555
1874L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2559L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1875 2560
1876Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2561Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1877L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2562L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1878L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2563L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1879L<AnyEvent::Impl::POE>. 2564L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
1880 2565
1881Non-blocking file handles, sockets, TCP clients and 2566Non-blocking file handles, sockets, TCP clients and
1882servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. 2567servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1883 2568
1884Asynchronous DNS: L<AnyEvent::DNS>. 2569Asynchronous DNS: L<AnyEvent::DNS>.
1885 2570
1886Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 2571Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
2572L<Coro::Event>,
1887 2573
1888Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 2574Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
2575L<AnyEvent::HTTP>.
1889 2576
1890 2577
1891=head1 AUTHOR 2578=head1 AUTHOR
1892 2579
1893 Marc Lehmann <schmorp@schmorp.de> 2580 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines