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.198 by root, Thu Mar 26 20:17:44 2009 UTC vs.
Revision 1.279 by root, Sun Aug 9 16:05:11 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
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. That callback
545is 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
546callback was set, C<send> will be called without any arguments. 673callback was set, C<send> will be called without any arguments.
547 674
548Let'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:
549 706
550 my $cv = AnyEvent->condvar; 707 my $cv = AnyEvent->condvar;
551 708
552 my %result; 709 my %result;
553 $cv->begin (sub { $cv->send (\%result) }); 710 $cv->begin (sub { $cv->send (\%result) });
573loop, which serves two important purposes: first, it sets the callback 730loop, which serves two important purposes: first, it sets the callback
574to 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
575C<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
576doesn't execute once). 733doesn't execute once).
577 734
578This is the general pattern when you "fan out" into multiple subrequests: 735This 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> 736potentially 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 737the 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>. 738subrequest you start, call C<begin> and for each subrequest you finish,
739call C<end>.
582 740
583=back 741=back
584 742
585=head3 METHODS FOR CONSUMERS 743=head3 METHODS FOR CONSUMERS
586 744
602function will call C<croak>. 760function will call C<croak>.
603 761
604In list context, all parameters passed to C<send> will be returned, 762In list context, all parameters passed to C<send> will be returned,
605in scalar context only the first one will be returned. 763in scalar context only the first one will be returned.
606 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
607Not 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
608(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
609using 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
610caller 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
611condition variables with some kind of request results and supporting 776condition variables with some kind of request results and supporting
612callbacks so the caller knows that getting the result will not block, 777callbacks so the caller knows that getting the result will not block,
613while still supporting blocking waits if the caller so desires). 778while still supporting blocking waits if the caller so desires).
614 779
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 780You can ensure that C<< -recv >> never blocks by setting a callback and
627only calling C<< ->recv >> from within that callback (or at a later 781only calling C<< ->recv >> from within that callback (or at a later
628time). 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
629waits otherwise. 783waits otherwise.
630 784
636=item $cb = $cv->cb ($cb->($cv)) 790=item $cb = $cv->cb ($cb->($cv))
637 791
638This is a mutator function that returns the callback set and optionally 792This is a mutator function that returns the callback set and optionally
639replaces it before doing so. 793replaces it before doing so.
640 794
641The callback will be called when the condition becomes "true", i.e. when 795The 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 796"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 797the only argument being the condition variable itself. Calling C<recv>
644is guaranteed not to block. 798inside the callback or at any later time is guaranteed not to block.
645 799
646=back 800=back
647 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
648=head1 GLOBAL VARIABLES AND FUNCTIONS 870=head1 GLOBAL VARIABLES AND FUNCTIONS
649 871
872These are not normally required to use AnyEvent, but can be useful to
873write AnyEvent extension modules.
874
650=over 4 875=over 4
651 876
652=item $AnyEvent::MODEL 877=item $AnyEvent::MODEL
653 878
654Contains 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
655contains 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
656Perl class implementing the model. This class is usually one of the 883name 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 884of 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>). 885case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
659 886will 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 887
681=item AnyEvent::detect 888=item AnyEvent::detect
682 889
683Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 890Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
684if necessary. You should only call this function right before you would 891if necessary. You should only call this function right before you would
685have 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
686runtime. 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>.
687 897
688=item $guard = AnyEvent::post_detect { BLOCK } 898=item $guard = AnyEvent::post_detect { BLOCK }
689 899
690Arranges 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
691autodetected (or immediately if this has already happened). 901autodetected (or immediately if this has already happened).
692 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
693If 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
694that 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
695L<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;
696 934
697=item @AnyEvent::post_detect 935=item @AnyEvent::post_detect
698 936
699If 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
700before or after loading AnyEvent), then they will called directly after 938before or after loading AnyEvent), then they will called directly after
701the event loop has been chosen. 939the event loop has been chosen.
702 940
703You should check C<$AnyEvent::MODEL> before adding to this array, though: 941You 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, 942if it is defined then the event loop has already been detected, and the
705and the array will be ignored. 943array will be ignored.
706 944
707Best 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.
708 952
709=back 953=back
710 954
711=head1 WHAT TO DO IN A MODULE 955=head1 WHAT TO DO IN A MODULE
712 956
767 1011
768 1012
769=head1 OTHER MODULES 1013=head1 OTHER MODULES
770 1014
771The following is a non-exhaustive list of additional modules that use 1015The following is a non-exhaustive list of additional modules that use
772AnyEvent and can therefore be mixed easily with other AnyEvent modules 1016AnyEvent 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 1017modules and other event loops in the same program. Some of the modules
774available via CPAN. 1018come with AnyEvent, most are available via CPAN.
775 1019
776=over 4 1020=over 4
777 1021
778=item L<AnyEvent::Util> 1022=item L<AnyEvent::Util>
779 1023
788 1032
789=item L<AnyEvent::Handle> 1033=item L<AnyEvent::Handle>
790 1034
791Provide read and write buffers, manages watchers for reads and writes, 1035Provide read and write buffers, manages watchers for reads and writes,
792supports 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
793non-blocking SSL/TLS. 1037non-blocking SSL/TLS (via L<AnyEvent::TLS>.
794 1038
795=item L<AnyEvent::DNS> 1039=item L<AnyEvent::DNS>
796 1040
797Provides rich asynchronous DNS resolver capabilities. 1041Provides rich asynchronous DNS resolver capabilities.
798 1042
826 1070
827=item L<AnyEvent::GPSD> 1071=item L<AnyEvent::GPSD>
828 1072
829A non-blocking interface to gpsd, a daemon delivering GPS information. 1073A non-blocking interface to gpsd, a daemon delivering GPS information.
830 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
831=item L<AnyEvent::IGS> 1084=item L<AnyEvent::IGS>
832 1085
833A non-blocking interface to the Internet Go Server protocol (used by 1086A non-blocking interface to the Internet Go Server protocol (used by
834L<App::IGS>). 1087L<App::IGS>).
835 1088
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> 1089=item L<Net::FCP>
845 1090
846AnyEvent-based implementation of the Freenet Client Protocol, birthplace 1091AnyEvent-based implementation of the Freenet Client Protocol, birthplace
847of AnyEvent. 1092of AnyEvent.
848 1093
852 1097
853=item L<Coro> 1098=item L<Coro>
854 1099
855Has special support for AnyEvent via L<Coro::AnyEvent>. 1100Has special support for AnyEvent via L<Coro::AnyEvent>.
856 1101
857=item L<IO::Lambda>
858
859The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
860
861=back 1102=back
862 1103
863=cut 1104=cut
864 1105
865package AnyEvent; 1106package AnyEvent;
866 1107
1108# basically a tuned-down version of common::sense
1109sub common_sense {
867no warnings; 1110 # no warnings
1111 ${^WARNING_BITS} ^= ${^WARNING_BITS};
868use strict qw(vars subs); 1112 # use strict vars subs
1113 $^H |= 0x00000600;
1114}
869 1115
1116BEGIN { AnyEvent::common_sense }
1117
870use Carp; 1118use Carp ();
871 1119
872our $VERSION = 4.341; 1120our $VERSION = '5.0';
873our $MODEL; 1121our $MODEL;
874 1122
875our $AUTOLOAD; 1123our $AUTOLOAD;
876our @ISA; 1124our @ISA;
877 1125
878our @REGISTRY; 1126our @REGISTRY;
879 1127
880our $WIN32; 1128our $WIN32;
881 1129
1130our $VERBOSE;
1131
882BEGIN { 1132BEGIN {
883 my $win32 = ! ! ($^O =~ /mswin32/i); 1133 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
884 eval "sub WIN32(){ $win32 }"; 1134 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
885}
886 1135
1136 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1137 if ${^TAINT};
1138
887our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1139 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1140
1141}
1142
1143our $MAX_SIGNAL_LATENCY = 10;
888 1144
889our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1145our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
890 1146
891{ 1147{
892 my $idx; 1148 my $idx;
894 for reverse split /\s*,\s*/, 1150 for reverse split /\s*,\s*/,
895 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1151 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
896} 1152}
897 1153
898my @models = ( 1154my @models = (
899 [EV:: => AnyEvent::Impl::EV::], 1155 [EV:: => AnyEvent::Impl::EV:: , 1],
900 [Event:: => AnyEvent::Impl::Event::],
901 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1156 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
902 # everything below here will not be autoprobed 1157 # everything below here will not (normally) be autoprobed
903 # as the pureperl backend should work everywhere 1158 # as the pureperl backend should work everywhere
904 # 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
905 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1164 [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 1165 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
909 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1166 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
910 [Wx:: => AnyEvent::Impl::POE::], 1167 [Wx:: => AnyEvent::Impl::POE::],
911 [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
912); 1177);
913 1178
914our %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);
915 1181
916our @post_detect; 1182our @post_detect;
917 1183
918sub post_detect(&) { 1184sub post_detect(&) {
919 my ($cb) = @_; 1185 my ($cb) = @_;
920 1186
921 if ($MODEL) { 1187 if ($MODEL) {
922 $cb->(); 1188 $cb->();
923 1189
924 1 1190 undef
925 } else { 1191 } else {
926 push @post_detect, $cb; 1192 push @post_detect, $cb;
927 1193
928 defined wantarray 1194 defined wantarray
929 ? bless \$cb, "AnyEvent::Util::PostDetect" 1195 ? bless \$cb, "AnyEvent::Util::postdetect"
930 : () 1196 : ()
931 } 1197 }
932} 1198}
933 1199
934sub AnyEvent::Util::PostDetect::DESTROY { 1200sub AnyEvent::Util::postdetect::DESTROY {
935 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1201 @post_detect = grep $_ != ${$_[0]}, @post_detect;
936} 1202}
937 1203
938sub detect() { 1204sub detect() {
939 unless ($MODEL) { 1205 unless ($MODEL) {
940 no strict 'refs';
941 local $SIG{__DIE__}; 1206 local $SIG{__DIE__};
942 1207
943 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1208 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
944 my $model = "AnyEvent::Impl::$1"; 1209 my $model = "AnyEvent::Impl::$1";
945 if (eval "require $model") { 1210 if (eval "require $model") {
946 $MODEL = $model; 1211 $MODEL = $model;
947 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;
948 } else { 1213 } else {
949 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;
950 } 1215 }
951 } 1216 }
952 1217
953 # check for already loaded models 1218 # check for already loaded models
954 unless ($MODEL) { 1219 unless ($MODEL) {
955 for (@REGISTRY, @models) { 1220 for (@REGISTRY, @models) {
956 my ($package, $model) = @$_; 1221 my ($package, $model) = @$_;
957 if (${"$package\::VERSION"} > 0) { 1222 if (${"$package\::VERSION"} > 0) {
958 if (eval "require $model") { 1223 if (eval "require $model") {
959 $MODEL = $model; 1224 $MODEL = $model;
960 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; 1225 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
961 last; 1226 last;
962 } 1227 }
963 } 1228 }
964 } 1229 }
965 1230
966 unless ($MODEL) { 1231 unless ($MODEL) {
967 # try to load a model 1232 # try to autoload a model
968
969 for (@REGISTRY, @models) { 1233 for (@REGISTRY, @models) {
970 my ($package, $model) = @$_; 1234 my ($package, $model, $autoload) = @$_;
1235 if (
1236 $autoload
971 if (eval "require $package" 1237 and eval "require $package"
972 and ${"$package\::VERSION"} > 0 1238 and ${"$package\::VERSION"} > 0
973 and eval "require $model") { 1239 and eval "require $model"
1240 ) {
974 $MODEL = $model; 1241 $MODEL = $model;
975 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; 1242 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
976 last; 1243 last;
977 } 1244 }
978 } 1245 }
979 1246
980 $MODEL 1247 $MODEL
981 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";
982 } 1249 }
983 } 1250 }
984 1251
985 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1252 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
986 1253
996 1263
997sub AUTOLOAD { 1264sub AUTOLOAD {
998 (my $func = $AUTOLOAD) =~ s/.*://; 1265 (my $func = $AUTOLOAD) =~ s/.*://;
999 1266
1000 $method{$func} 1267 $method{$func}
1001 or croak "$func: not a valid method for AnyEvent objects"; 1268 or Carp::croak "$func: not a valid method for AnyEvent objects";
1002 1269
1003 detect unless $MODEL; 1270 detect unless $MODEL;
1004 1271
1005 my $class = shift; 1272 my $class = shift;
1006 $class->$func (@_); 1273 $class->$func (@_);
1007} 1274}
1008 1275
1009# 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
1010# to support binding more than one watcher per filehandle (they usually 1277# 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). 1278# allow only one watcher per fd, so we dup it to get a different one).
1012sub _dupfh($$$$) { 1279sub _dupfh($$;$$) {
1013 my ($poll, $fh, $r, $w) = @_; 1280 my ($poll, $fh, $r, $w) = @_;
1014 1281
1015 # cygwin requires the fh mode to be matching, unix doesn't 1282 # cygwin requires the fh mode to be matching, unix doesn't
1016 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1283 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 1284
1020 open my $fh2, "$mode&" . fileno $fh 1285 open my $fh2, $mode, $fh
1021 or die "cannot dup() filehandle: $!"; 1286 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1022 1287
1023 # 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
1024 1289
1025 ($fh2, $rw) 1290 ($fh2, $rw)
1026} 1291}
1027 1292
1293=head1 SIMPLIFIED AE API
1294
1295Starting with version 5.0, AnyEvent officially supports a second, much
1296simpler, API that is designed to reduce the calling, typing and memory
1297overhead.
1298
1299See the L<AE> manpage for details.
1300
1301=cut
1302
1303package AE;
1304
1305our $VERSION = $AnyEvent::VERSION;
1306
1307sub io($$$) {
1308 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1309}
1310
1311sub timer($$$) {
1312 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1313}
1314
1315sub signal($$) {
1316 AnyEvent->signal (signal => $_[0], cb => $_[1])
1317}
1318
1319sub child($$) {
1320 AnyEvent->child (pid => $_[0], cb => $_[1])
1321}
1322
1323sub idle($) {
1324 AnyEvent->idle (cb => $_[0])
1325}
1326
1327sub cv(;&) {
1328 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1329}
1330
1331sub now() {
1332 AnyEvent->now
1333}
1334
1335sub now_update() {
1336 AnyEvent->now_update
1337}
1338
1339sub time() {
1340 AnyEvent->time
1341}
1342
1028package AnyEvent::Base; 1343package AnyEvent::Base;
1029 1344
1030# default implementation for now and time 1345# default implementations for many methods
1031 1346
1032BEGIN { 1347sub _time {
1348 # probe for availability of Time::HiRes
1033 if (eval "use Time::HiRes (); time (); 1") { 1349 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1350 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1034 *_time = \&Time::HiRes::time; 1351 *_time = \&Time::HiRes::time;
1035 # if (eval "use POSIX (); (POSIX::times())... 1352 # if (eval "use POSIX (); (POSIX::times())...
1036 } else { 1353 } else {
1354 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1037 *_time = sub { time }; # epic fail 1355 *_time = sub { time }; # epic fail
1038 } 1356 }
1357
1358 &_time
1039} 1359}
1040 1360
1041sub time { _time } 1361sub time { _time }
1042sub now { _time } 1362sub now { _time }
1363sub now_update { }
1043 1364
1044# default implementation for ->condvar 1365# default implementation for ->condvar
1045 1366
1046sub condvar { 1367sub condvar {
1047 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1368 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1048} 1369}
1049 1370
1050# default implementation for ->signal 1371# default implementation for ->signal
1051 1372
1373our $HAVE_ASYNC_INTERRUPT;
1374
1375sub _have_async_interrupt() {
1376 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1377 && eval "use Async::Interrupt 1.0 (); 1")
1378 unless defined $HAVE_ASYNC_INTERRUPT;
1379
1380 $HAVE_ASYNC_INTERRUPT
1381}
1382
1052our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1383our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1384our (%SIG_ASY, %SIG_ASY_W);
1385our ($SIG_COUNT, $SIG_TW);
1053 1386
1054sub _signal_exec { 1387sub _signal_exec {
1388 $HAVE_ASYNC_INTERRUPT
1389 ? $SIGPIPE_R->drain
1055 sysread $SIGPIPE_R, my $dummy, 4; 1390 : sysread $SIGPIPE_R, my $dummy, 9;
1056 1391
1057 while (%SIG_EV) { 1392 while (%SIG_EV) {
1058 for (keys %SIG_EV) { 1393 for (keys %SIG_EV) {
1059 delete $SIG_EV{$_}; 1394 delete $SIG_EV{$_};
1060 $_->() for values %{ $SIG_CB{$_} || {} }; 1395 $_->() for values %{ $SIG_CB{$_} || {} };
1061 } 1396 }
1062 } 1397 }
1063} 1398}
1064 1399
1400# install a dummy wakeup watcher to reduce signal catching latency
1401sub _sig_add() {
1402 unless ($SIG_COUNT++) {
1403 # try to align timer on a full-second boundary, if possible
1404 my $NOW = AE::now;
1405
1406 $SIG_TW = AE::timer
1407 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1408 $MAX_SIGNAL_LATENCY,
1409 sub { } # just for the PERL_ASYNC_CHECK
1410 ;
1411 }
1412}
1413
1414sub _sig_del {
1415 undef $SIG_TW
1416 unless --$SIG_COUNT;
1417}
1418
1419our $_sig_name_init; $_sig_name_init = sub {
1420 eval q{ # poor man's autoloading
1421 undef $_sig_name_init;
1422
1423 if (_have_async_interrupt) {
1424 *sig2num = \&Async::Interrupt::sig2num;
1425 *sig2name = \&Async::Interrupt::sig2name;
1426 } else {
1427 require Config;
1428
1429 my %signame2num;
1430 @signame2num{ split ' ', $Config::Config{sig_name} }
1431 = split ' ', $Config::Config{sig_num};
1432
1433 my @signum2name;
1434 @signum2name[values %signame2num] = keys %signame2num;
1435
1436 *sig2num = sub($) {
1437 $_[0] > 0 ? shift : $signame2num{+shift}
1438 };
1439 *sig2name = sub ($) {
1440 $_[0] > 0 ? $signum2name[+shift] : shift
1441 };
1442 }
1443 };
1444 die if $@;
1445};
1446
1447sub sig2num ($) { &$_sig_name_init; &sig2num }
1448sub sig2name($) { &$_sig_name_init; &sig2name }
1449
1065sub signal { 1450sub signal {
1066 my (undef, %arg) = @_; 1451 eval q{ # poor man's autoloading {}
1452 # probe for availability of Async::Interrupt
1453 if (_have_async_interrupt) {
1454 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1067 1455
1068 unless ($SIGPIPE_R) { 1456 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1069 if (AnyEvent::WIN32) { 1457 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1070 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1458
1071 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1072 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1073 } else { 1459 } else {
1074 pipe $SIGPIPE_R, $SIGPIPE_W; 1460 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1461
1075 require Fcntl; 1462 require Fcntl;
1463
1464 if (AnyEvent::WIN32) {
1465 require AnyEvent::Util;
1466
1467 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1468 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1469 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1470 } else {
1471 pipe $SIGPIPE_R, $SIGPIPE_W;
1076 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; 1472 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1077 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case 1473 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1474
1475 # not strictly required, as $^F is normally 2, but let's make sure...
1476 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1477 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1478 }
1479
1480 $SIGPIPE_R
1481 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1482
1483 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1078 } 1484 }
1079 1485
1080 $SIGPIPE_R 1486 *signal = sub {
1081 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1487 my (undef, %arg) = @_;
1082 1488
1083 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1084 }
1085
1086 my $signal = uc $arg{signal} 1489 my $signal = uc $arg{signal}
1087 or Carp::croak "required option 'signal' is missing"; 1490 or Carp::croak "required option 'signal' is missing";
1088 1491
1492 if ($HAVE_ASYNC_INTERRUPT) {
1493 # async::interrupt
1494
1495 $signal = sig2num $signal;
1089 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1496 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1497
1498 $SIG_ASY{$signal} ||= new Async::Interrupt
1499 cb => sub { undef $SIG_EV{$signal} },
1500 signal => $signal,
1501 pipe => [$SIGPIPE_R->filenos],
1502 pipe_autodrain => 0,
1503 ;
1504
1505 } else {
1506 # pure perl
1507
1508 # AE::Util has been loaded in signal
1509 $signal = sig2name $signal;
1510 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1511
1090 $SIG{$signal} ||= sub { 1512 $SIG{$signal} ||= sub {
1513 local $!;
1091 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1514 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1092 undef $SIG_EV{$signal}; 1515 undef $SIG_EV{$signal};
1516 };
1517
1518 # can't do signal processing without introducing races in pure perl,
1519 # so limit the signal latency.
1520 _sig_add;
1521 }
1522
1523 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1524 };
1525
1526 *AnyEvent::Base::signal::DESTROY = sub {
1527 my ($signal, $cb) = @{$_[0]};
1528
1529 _sig_del;
1530
1531 delete $SIG_CB{$signal}{$cb};
1532
1533 $HAVE_ASYNC_INTERRUPT
1534 ? delete $SIG_ASY{$signal}
1535 : # delete doesn't work with older perls - they then
1536 # print weird messages, or just unconditionally exit
1537 # instead of getting the default action.
1538 undef $SIG{$signal}
1539 unless keys %{ $SIG_CB{$signal} };
1540 };
1093 }; 1541 };
1094 1542 die if $@;
1095 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1543 &signal
1096}
1097
1098sub AnyEvent::Base::Signal::DESTROY {
1099 my ($signal, $cb) = @{$_[0]};
1100
1101 delete $SIG_CB{$signal}{$cb};
1102
1103 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1104} 1544}
1105 1545
1106# default implementation for ->child 1546# default implementation for ->child
1107 1547
1108our %PID_CB; 1548our %PID_CB;
1109our $CHLD_W; 1549our $CHLD_W;
1110our $CHLD_DELAY_W; 1550our $CHLD_DELAY_W;
1111our $PID_IDLE;
1112our $WNOHANG; 1551our $WNOHANG;
1113 1552
1114sub _child_wait { 1553sub _emit_childstatus($$) {
1115 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1554 my (undef, $rpid, $rstatus) = @_;
1555
1556 $_->($rpid, $rstatus)
1116 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1557 for values %{ $PID_CB{$rpid} || {} },
1117 (values %{ $PID_CB{0} || {} }); 1558 values %{ $PID_CB{0} || {} };
1118 }
1119
1120 undef $PID_IDLE;
1121} 1559}
1122 1560
1123sub _sigchld { 1561sub _sigchld {
1124 # make sure we deliver these changes "synchronous" with the event loop. 1562 my $pid;
1125 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub { 1563
1126 undef $CHLD_DELAY_W; 1564 AnyEvent->_emit_childstatus ($pid, $?)
1127 &_child_wait; 1565 while ($pid = waitpid -1, $WNOHANG) > 0;
1128 });
1129} 1566}
1130 1567
1131sub child { 1568sub child {
1132 my (undef, %arg) = @_; 1569 my (undef, %arg) = @_;
1133 1570
1134 defined (my $pid = $arg{pid} + 0) 1571 defined (my $pid = $arg{pid} + 0)
1135 or Carp::croak "required option 'pid' is missing"; 1572 or Carp::croak "required option 'pid' is missing";
1136 1573
1137 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1574 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1138 1575
1139 unless ($WNOHANG) { 1576 # WNOHANG is almost cetrainly 1 everywhere
1577 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1578 ? 1
1140 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1579 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1141 }
1142 1580
1143 unless ($CHLD_W) { 1581 unless ($CHLD_W) {
1144 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1582 $CHLD_W = AE::signal CHLD => \&_sigchld;
1145 # child could be a zombie already, so make at least one round 1583 # child could be a zombie already, so make at least one round
1146 &_sigchld; 1584 &_sigchld;
1147 } 1585 }
1148 1586
1149 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1587 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1150} 1588}
1151 1589
1152sub AnyEvent::Base::Child::DESTROY { 1590sub AnyEvent::Base::child::DESTROY {
1153 my ($pid, $cb) = @{$_[0]}; 1591 my ($pid, $cb) = @{$_[0]};
1154 1592
1155 delete $PID_CB{$pid}{$cb}; 1593 delete $PID_CB{$pid}{$cb};
1156 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1594 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1157 1595
1158 undef $CHLD_W unless keys %PID_CB; 1596 undef $CHLD_W unless keys %PID_CB;
1159} 1597}
1160 1598
1599# idle emulation is done by simply using a timer, regardless
1600# of whether the process is idle or not, and not letting
1601# the callback use more than 50% of the time.
1602sub idle {
1603 my (undef, %arg) = @_;
1604
1605 my ($cb, $w, $rcb) = $arg{cb};
1606
1607 $rcb = sub {
1608 if ($cb) {
1609 $w = _time;
1610 &$cb;
1611 $w = _time - $w;
1612
1613 # never use more then 50% of the time for the idle watcher,
1614 # within some limits
1615 $w = 0.0001 if $w < 0.0001;
1616 $w = 5 if $w > 5;
1617
1618 $w = AE::timer $w, 0, $rcb;
1619 } else {
1620 # clean up...
1621 undef $w;
1622 undef $rcb;
1623 }
1624 };
1625
1626 $w = AE::timer 0.05, 0, $rcb;
1627
1628 bless \\$cb, "AnyEvent::Base::idle"
1629}
1630
1631sub AnyEvent::Base::idle::DESTROY {
1632 undef $${$_[0]};
1633}
1634
1161package AnyEvent::CondVar; 1635package AnyEvent::CondVar;
1162 1636
1163our @ISA = AnyEvent::CondVar::Base::; 1637our @ISA = AnyEvent::CondVar::Base::;
1164 1638
1165package AnyEvent::CondVar::Base; 1639package AnyEvent::CondVar::Base;
1166 1640
1167use overload 1641#use overload
1168 '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1642# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1169 fallback => 1; 1643# fallback => 1;
1644
1645# save 300+ kilobytes by dirtily hardcoding overloading
1646${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
1647*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
1648*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
1649${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1650
1651our $WAITING;
1170 1652
1171sub _send { 1653sub _send {
1172 # nop 1654 # nop
1173} 1655}
1174 1656
1187sub ready { 1669sub ready {
1188 $_[0]{_ae_sent} 1670 $_[0]{_ae_sent}
1189} 1671}
1190 1672
1191sub _wait { 1673sub _wait {
1674 $WAITING
1675 and !$_[0]{_ae_sent}
1676 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1677
1678 local $WAITING = 1;
1192 AnyEvent->one_event while !$_[0]{_ae_sent}; 1679 AnyEvent->one_event while !$_[0]{_ae_sent};
1193} 1680}
1194 1681
1195sub recv { 1682sub recv {
1196 $_[0]->_wait; 1683 $_[0]->_wait;
1198 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1685 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1199 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1686 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1200} 1687}
1201 1688
1202sub cb { 1689sub cb {
1203 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1690 my $cv = shift;
1691
1692 @_
1693 and $cv->{_ae_cb} = shift
1694 and $cv->{_ae_sent}
1695 and (delete $cv->{_ae_cb})->($cv);
1696
1204 $_[0]{_ae_cb} 1697 $cv->{_ae_cb}
1205} 1698}
1206 1699
1207sub begin { 1700sub begin {
1208 ++$_[0]{_ae_counter}; 1701 ++$_[0]{_ae_counter};
1209 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1702 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1237so on. 1730so on.
1238 1731
1239=head1 ENVIRONMENT VARIABLES 1732=head1 ENVIRONMENT VARIABLES
1240 1733
1241The following environment variables are used by this module or its 1734The following environment variables are used by this module or its
1242submodules: 1735submodules.
1736
1737Note that AnyEvent will remove I<all> environment variables starting with
1738C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
1739enabled.
1243 1740
1244=over 4 1741=over 4
1245 1742
1246=item C<PERL_ANYEVENT_VERBOSE> 1743=item C<PERL_ANYEVENT_VERBOSE>
1247 1744
1254C<PERL_ANYEVENT_MODEL>. 1751C<PERL_ANYEVENT_MODEL>.
1255 1752
1256When set to C<2> or higher, cause AnyEvent to report to STDERR which event 1753When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1257model it chooses. 1754model it chooses.
1258 1755
1756When set to C<8> or higher, then AnyEvent will report extra information on
1757which optional modules it loads and how it implements certain features.
1758
1259=item C<PERL_ANYEVENT_STRICT> 1759=item C<PERL_ANYEVENT_STRICT>
1260 1760
1261AnyEvent does not do much argument checking by default, as thorough 1761AnyEvent does not do much argument checking by default, as thorough
1262argument checking is very costly. Setting this variable to a true value 1762argument checking is very costly. Setting this variable to a true value
1263will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly 1763will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1264check the arguments passed to most method calls. If it finds any problems 1764check the arguments passed to most method calls. If it finds any problems,
1265it will croak. 1765it will croak.
1266 1766
1267In other words, enables "strict" mode. 1767In other words, enables "strict" mode.
1268 1768
1269Unlike C<use strict>, it is definitely recommended ot keep it off in 1769Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1270production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while 1770>>, it is definitely recommended to keep it off in production. Keeping
1271developing programs can be very useful, however. 1771C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1772can be very useful, however.
1272 1773
1273=item C<PERL_ANYEVENT_MODEL> 1774=item C<PERL_ANYEVENT_MODEL>
1274 1775
1275This can be used to specify the event model to be used by AnyEvent, before 1776This can be used to specify the event model to be used by AnyEvent, before
1276auto detection and -probing kicks in. It must be a string consisting 1777auto detection and -probing kicks in. It must be a string consisting
1319 1820
1320=item C<PERL_ANYEVENT_MAX_FORKS> 1821=item C<PERL_ANYEVENT_MAX_FORKS>
1321 1822
1322The maximum number of child processes that C<AnyEvent::Util::fork_call> 1823The maximum number of child processes that C<AnyEvent::Util::fork_call>
1323will create in parallel. 1824will create in parallel.
1825
1826=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1827
1828The default value for the C<max_outstanding> parameter for the default DNS
1829resolver - this is the maximum number of parallel DNS requests that are
1830sent to the DNS server.
1831
1832=item C<PERL_ANYEVENT_RESOLV_CONF>
1833
1834The file to use instead of F</etc/resolv.conf> (or OS-specific
1835configuration) in the default resolver. When set to the empty string, no
1836default config will be used.
1837
1838=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1839
1840When neither C<ca_file> nor C<ca_path> was specified during
1841L<AnyEvent::TLS> context creation, and either of these environment
1842variables exist, they will be used to specify CA certificate locations
1843instead of a system-dependent default.
1844
1845=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1846
1847When these are set to C<1>, then the respective modules are not
1848loaded. Mostly good for testing AnyEvent itself.
1324 1849
1325=back 1850=back
1326 1851
1327=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1852=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1328 1853
1536through AnyEvent. The benchmark creates a lot of timers (with a zero 2061through AnyEvent. The benchmark creates a lot of timers (with a zero
1537timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2062timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1538which it is), lets them fire exactly once and destroys them again. 2063which it is), lets them fire exactly once and destroys them again.
1539 2064
1540Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2065Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1541distribution. 2066distribution. It uses the L<AE> interface, which makes a real difference
2067for the EV and Perl backends only.
1542 2068
1543=head3 Explanation of the columns 2069=head3 Explanation of the columns
1544 2070
1545I<watcher> is the number of event watchers created/destroyed. Since 2071I<watcher> is the number of event watchers created/destroyed. Since
1546different event models feature vastly different performances, each event 2072different event models feature vastly different performances, each event
1567watcher. 2093watcher.
1568 2094
1569=head3 Results 2095=head3 Results
1570 2096
1571 name watchers bytes create invoke destroy comment 2097 name watchers bytes create invoke destroy comment
1572 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2098 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1573 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2099 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1574 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2100 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1575 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2101 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1576 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2102 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1577 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2103 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2104 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2105 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1578 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2106 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1579 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2107 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1580 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2108 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1581 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2109 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1582 2110
1583=head3 Discussion 2111=head3 Discussion
1584 2112
1585The benchmark does I<not> measure scalability of the event loop very 2113The benchmark does I<not> measure scalability of the event loop very
1586well. For example, a select-based event loop (such as the pure perl one) 2114well. For example, a select-based event loop (such as the pure perl one)
1598benchmark machine, handling an event takes roughly 1600 CPU cycles with 2126benchmark machine, handling an event takes roughly 1600 CPU cycles with
1599EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2127EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1600cycles with POE. 2128cycles with POE.
1601 2129
1602C<EV> is the sole leader regarding speed and memory use, which are both 2130C<EV> is the sole leader regarding speed and memory use, which are both
1603maximal/minimal, respectively. Even when going through AnyEvent, it uses 2131maximal/minimal, respectively. When using the L<AE> API there is zero
2132overhead (when going through the AnyEvent API create is about 5-6 times
2133slower, with other times being equal, so still uses far less memory than
1604far less memory than any other event loop and is still faster than Event 2134any other event loop and is still faster than Event natively).
1605natively.
1606 2135
1607The pure perl implementation is hit in a few sweet spots (both the 2136The pure perl implementation is hit in a few sweet spots (both the
1608constant timeout and the use of a single fd hit optimisations in the perl 2137constant timeout and the use of a single fd hit optimisations in the perl
1609interpreter and the backend itself). Nevertheless this shows that it 2138interpreter and the backend itself). Nevertheless this shows that it
1610adds very little overhead in itself. Like any select-based backend its 2139adds very little overhead in itself. Like any select-based backend its
1611performance becomes really bad with lots of file descriptors (and few of 2140performance becomes really bad with lots of file descriptors (and few of
1612them active), of course, but this was not subject of this benchmark. 2141them active), of course, but this was not subject of this benchmark.
1613 2142
1614The C<Event> module has a relatively high setup and callback invocation 2143The C<Event> module has a relatively high setup and callback invocation
1615cost, but overall scores in on the third place. 2144cost, but overall scores in on the third place.
2145
2146C<IO::Async> performs admirably well, about on par with C<Event>, even
2147when using its pure perl backend.
1616 2148
1617C<Glib>'s memory usage is quite a bit higher, but it features a 2149C<Glib>'s memory usage is quite a bit higher, but it features a
1618faster callback invocation and overall ends up in the same class as 2150faster callback invocation and overall ends up in the same class as
1619C<Event>. However, Glib scales extremely badly, doubling the number of 2151C<Event>. However, Glib scales extremely badly, doubling the number of
1620watchers increases the processing time by more than a factor of four, 2152watchers increases the processing time by more than a factor of four,
1681In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2213In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1682(1%) are active. This mirrors the activity of large servers with many 2214(1%) are active. This mirrors the activity of large servers with many
1683connections, most of which are idle at any one point in time. 2215connections, most of which are idle at any one point in time.
1684 2216
1685Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2217Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1686distribution. 2218distribution. It uses the L<AE> interface, which makes a real difference
2219for the EV and Perl backends only.
1687 2220
1688=head3 Explanation of the columns 2221=head3 Explanation of the columns
1689 2222
1690I<sockets> is the number of sockets, and twice the number of "servers" (as 2223I<sockets> is the number of sockets, and twice the number of "servers" (as
1691each server has a read and write socket end). 2224each server has a read and write socket end).
1698it to another server. This includes deleting the old timeout and creating 2231it to another server. This includes deleting the old timeout and creating
1699a new one that moves the timeout into the future. 2232a new one that moves the timeout into the future.
1700 2233
1701=head3 Results 2234=head3 Results
1702 2235
1703 name sockets create request 2236 name sockets create request
1704 EV 20000 69.01 11.16 2237 EV 20000 62.66 7.99
1705 Perl 20000 73.32 35.87 2238 Perl 20000 68.32 32.64
1706 Event 20000 212.62 257.32 2239 IOAsync 20000 174.06 101.15 epoll
1707 Glib 20000 651.16 1896.30 2240 IOAsync 20000 174.67 610.84 poll
2241 Event 20000 202.69 242.91
2242 Glib 20000 557.01 1689.52
1708 POE 20000 349.67 12317.24 uses POE::Loop::Event 2243 POE 20000 341.54 12086.32 uses POE::Loop::Event
1709 2244
1710=head3 Discussion 2245=head3 Discussion
1711 2246
1712This benchmark I<does> measure scalability and overall performance of the 2247This benchmark I<does> measure scalability and overall performance of the
1713particular event loop. 2248particular event loop.
1715EV is again fastest. Since it is using epoll on my system, the setup time 2250EV is again fastest. Since it is using epoll on my system, the setup time
1716is relatively high, though. 2251is relatively high, though.
1717 2252
1718Perl surprisingly comes second. It is much faster than the C-based event 2253Perl surprisingly comes second. It is much faster than the C-based event
1719loops Event and Glib. 2254loops Event and Glib.
2255
2256IO::Async performs very well when using its epoll backend, and still quite
2257good compared to Glib when using its pure perl backend.
1720 2258
1721Event suffers from high setup time as well (look at its code and you will 2259Event suffers from high setup time as well (look at its code and you will
1722understand why). Callback invocation also has a high overhead compared to 2260understand why). Callback invocation also has a high overhead compared to
1723the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 2261the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1724uses select or poll in basically all documented configurations. 2262uses select or poll in basically all documented configurations.
1787=item * C-based event loops perform very well with small number of 2325=item * C-based event loops perform very well with small number of
1788watchers, as the management overhead dominates. 2326watchers, as the management overhead dominates.
1789 2327
1790=back 2328=back
1791 2329
2330=head2 THE IO::Lambda BENCHMARK
2331
2332Recently I was told about the benchmark in the IO::Lambda manpage, which
2333could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
2334simply compares IO::Lambda with POE, and IO::Lambda looks better (which
2335shouldn't come as a surprise to anybody). As such, the benchmark is
2336fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
2337very optimal. But how would AnyEvent compare when used without the extra
2338baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
2339
2340The benchmark itself creates an echo-server, and then, for 500 times,
2341connects to the echo server, sends a line, waits for the reply, and then
2342creates the next connection. This is a rather bad benchmark, as it doesn't
2343test the efficiency of the framework or much non-blocking I/O, but it is a
2344benchmark nevertheless.
2345
2346 name runtime
2347 Lambda/select 0.330 sec
2348 + optimized 0.122 sec
2349 Lambda/AnyEvent 0.327 sec
2350 + optimized 0.138 sec
2351 Raw sockets/select 0.077 sec
2352 POE/select, components 0.662 sec
2353 POE/select, raw sockets 0.226 sec
2354 POE/select, optimized 0.404 sec
2355
2356 AnyEvent/select/nb 0.085 sec
2357 AnyEvent/EV/nb 0.068 sec
2358 +state machine 0.134 sec
2359
2360The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
2361benchmarks actually make blocking connects and use 100% blocking I/O,
2362defeating the purpose of an event-based solution. All of the newly
2363written AnyEvent benchmarks use 100% non-blocking connects (using
2364AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
2365resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
2366generally require a lot more bookkeeping and event handling than blocking
2367connects (which involve a single syscall only).
2368
2369The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
2370offers similar expressive power as POE and IO::Lambda, using conventional
2371Perl syntax. This means that both the echo server and the client are 100%
2372non-blocking, further placing it at a disadvantage.
2373
2374As you can see, the AnyEvent + EV combination even beats the
2375hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2376backend easily beats IO::Lambda and POE.
2377
2378And even the 100% non-blocking version written using the high-level (and
2379slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
2380large margin, even though it does all of DNS, tcp-connect and socket I/O
2381in a non-blocking way.
2382
2383The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2384F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2385part of the IO::lambda distribution and were used without any changes.
2386
1792 2387
1793=head1 SIGNALS 2388=head1 SIGNALS
1794 2389
1795AnyEvent currently installs handlers for these signals: 2390AnyEvent currently installs handlers for these signals:
1796 2391
1799=item SIGCHLD 2394=item SIGCHLD
1800 2395
1801A handler for C<SIGCHLD> is installed by AnyEvent's child watcher 2396A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1802emulation for event loops that do not support them natively. Also, some 2397emulation for event loops that do not support them natively. Also, some
1803event loops install a similar handler. 2398event loops install a similar handler.
2399
2400Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2401AnyEvent will reset it to default, to avoid losing child exit statuses.
1804 2402
1805=item SIGPIPE 2403=item SIGPIPE
1806 2404
1807A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> 2405A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1808when AnyEvent gets loaded. 2406when AnyEvent gets loaded.
1820 2418
1821=back 2419=back
1822 2420
1823=cut 2421=cut
1824 2422
2423undef $SIG{CHLD}
2424 if $SIG{CHLD} eq 'IGNORE';
2425
1825$SIG{PIPE} = sub { } 2426$SIG{PIPE} = sub { }
1826 unless defined $SIG{PIPE}; 2427 unless defined $SIG{PIPE};
2428
2429=head1 RECOMMENDED/OPTIONAL MODULES
2430
2431One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2432it's built-in modules) are required to use it.
2433
2434That does not mean that AnyEvent won't take advantage of some additional
2435modules if they are installed.
2436
2437This section epxlains which additional modules will be used, and how they
2438affect AnyEvent's operetion.
2439
2440=over 4
2441
2442=item L<Async::Interrupt>
2443
2444This slightly arcane module is used to implement fast signal handling: To
2445my knowledge, there is no way to do completely race-free and quick
2446signal handling in pure perl. To ensure that signals still get
2447delivered, AnyEvent will start an interval timer to wake up perl (and
2448catch the signals) with some delay (default is 10 seconds, look for
2449C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2450
2451If this module is available, then it will be used to implement signal
2452catching, which means that signals will not be delayed, and the event loop
2453will not be interrupted regularly, which is more efficient (And good for
2454battery life on laptops).
2455
2456This affects not just the pure-perl event loop, but also other event loops
2457that have no signal handling on their own (e.g. Glib, Tk, Qt).
2458
2459Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
2460and either employ their own workarounds (POE) or use AnyEvent's workaround
2461(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
2462does nothing for those backends.
2463
2464=item L<EV>
2465
2466This module isn't really "optional", as it is simply one of the backend
2467event loops that AnyEvent can use. However, it is simply the best event
2468loop available in terms of features, speed and stability: It supports
2469the AnyEvent API optimally, implements all the watcher types in XS, does
2470automatic timer adjustments even when no monotonic clock is available,
2471can take avdantage of advanced kernel interfaces such as C<epoll> and
2472C<kqueue>, and is the fastest backend I<by far>. You can even embed
2473L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2474
2475=item L<Guard>
2476
2477The guard module, when used, will be used to implement
2478C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2479lot less memory), but otherwise doesn't affect guard operation much. It is
2480purely used for performance.
2481
2482=item L<JSON> and L<JSON::XS>
2483
2484This module is required when you want to read or write JSON data via
2485L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2486advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2487
2488In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2489installed.
2490
2491=item L<Net::SSLeay>
2492
2493Implementing TLS/SSL in Perl is certainly interesting, but not very
2494worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2495the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2496
2497=item L<Time::HiRes>
2498
2499This module is part of perl since release 5.008. It will be used when the
2500chosen event library does not come with a timing source on it's own. The
2501pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2502try to use a monotonic clock for timing stability.
2503
2504=back
1827 2505
1828 2506
1829=head1 FORK 2507=head1 FORK
1830 2508
1831Most event libraries are not fork-safe. The ones who are usually are 2509Most event libraries are not fork-safe. The ones who are usually are
1832because they rely on inefficient but fork-safe C<select> or C<poll> 2510because they rely on inefficient but fork-safe C<select> or C<poll>
1833calls. Only L<EV> is fully fork-aware. 2511calls. Only L<EV> is fully fork-aware.
1834 2512
1835If you have to fork, you must either do so I<before> creating your first 2513If you have to fork, you must either do so I<before> creating your first
1836watcher OR you must not use AnyEvent at all in the child. 2514watcher OR you must not use AnyEvent at all in the child OR you must do
2515something completely out of the scope of AnyEvent.
1837 2516
1838 2517
1839=head1 SECURITY CONSIDERATIONS 2518=head1 SECURITY CONSIDERATIONS
1840 2519
1841AnyEvent can be forced to load any event model via 2520AnyEvent can be forced to load any event model via
1853 use AnyEvent; 2532 use AnyEvent;
1854 2533
1855Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2534Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1856be used to probe what backend is used and gain other information (which is 2535be used to probe what backend is used and gain other information (which is
1857probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and 2536probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1858$ENV{PERL_ANYEGENT_STRICT}. 2537$ENV{PERL_ANYEVENT_STRICT}.
2538
2539Note that AnyEvent will remove I<all> environment variables starting with
2540C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2541enabled.
1859 2542
1860 2543
1861=head1 BUGS 2544=head1 BUGS
1862 2545
1863Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 2546Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1875L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2558L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1876 2559
1877Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2560Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1878L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2561L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1879L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2562L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1880L<AnyEvent::Impl::POE>. 2563L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
1881 2564
1882Non-blocking file handles, sockets, TCP clients and 2565Non-blocking file handles, sockets, TCP clients and
1883servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. 2566servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1884 2567
1885Asynchronous DNS: L<AnyEvent::DNS>. 2568Asynchronous DNS: L<AnyEvent::DNS>.
1886 2569
1887Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 2570Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
2571L<Coro::Event>,
1888 2572
1889Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 2573Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
2574L<AnyEvent::HTTP>.
1890 2575
1891 2576
1892=head1 AUTHOR 2577=head1 AUTHOR
1893 2578
1894 Marc Lehmann <schmorp@schmorp.de> 2579 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines