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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines