1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - provide framework for multiple event loops |
3 | AnyEvent - provide framework for multiple event loops |
4 | |
4 | |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported |
|
|
6 | event loops. |
6 | |
7 | |
7 | =head1 SYNOPSIS |
8 | =head1 SYNOPSIS |
8 | |
9 | |
9 | use AnyEvent; |
10 | use AnyEvent; |
10 | |
11 | |
|
|
12 | # file descriptor readable |
11 | my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { ... }); |
13 | my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); |
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: |
… | |
… | |
168 | =head2 I/O WATCHERS |
176 | =head2 I/O WATCHERS |
169 | |
177 | |
170 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
178 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
171 | with the following mandatory key-value pairs as arguments: |
179 | with the following mandatory key-value pairs as arguments: |
172 | |
180 | |
173 | C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch |
181 | C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch |
174 | for events (AnyEvent might or might not keep a reference to this file |
182 | for events (AnyEvent might or might not keep a reference to this file |
175 | handle). Note that only file handles pointing to things for which |
183 | handle). Note that only file handles pointing to things for which |
176 | non-blocking operation makes sense are allowed. This includes sockets, |
184 | non-blocking operation makes sense are allowed. This includes sockets, |
177 | most character devices, pipes, fifos and so on, but not for example files |
185 | most character devices, pipes, fifos and so on, but not for example files |
178 | or block devices. |
186 | or block devices. |
… | |
… | |
320 | In either case, if you care (and in most cases, you don't), then you |
328 | In either case, if you care (and in most cases, you don't), then you |
321 | can get whatever behaviour you want with any event loop, by taking the |
329 | can get whatever behaviour you want with any event loop, by taking the |
322 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
330 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
323 | account. |
331 | account. |
324 | |
332 | |
|
|
333 | =item AnyEvent->now_update |
|
|
334 | |
|
|
335 | Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache |
|
|
336 | the current time for each loop iteration (see the discussion of L<< |
|
|
337 | AnyEvent->now >>, above). |
|
|
338 | |
|
|
339 | When a callback runs for a long time (or when the process sleeps), then |
|
|
340 | this "current" time will differ substantially from the real time, which |
|
|
341 | might affect timers and time-outs. |
|
|
342 | |
|
|
343 | When this is the case, you can call this method, which will update the |
|
|
344 | event loop's idea of "current time". |
|
|
345 | |
|
|
346 | Note that updating the time I<might> cause some events to be handled. |
|
|
347 | |
325 | =back |
348 | =back |
326 | |
349 | |
327 | =head2 SIGNAL WATCHERS |
350 | =head2 SIGNAL WATCHERS |
328 | |
351 | |
329 | You can watch for signals using a signal watcher, C<signal> is the signal |
352 | You can watch for signals using a signal watcher, C<signal> is the signal |
… | |
… | |
369 | |
392 | |
370 | There is a slight catch to child watchers, however: you usually start them |
393 | There is a slight catch to child watchers, however: you usually start them |
371 | I<after> the child process was created, and this means the process could |
394 | I<after> the child process was created, and this means the process could |
372 | have exited already (and no SIGCHLD will be sent anymore). |
395 | have exited already (and no SIGCHLD will be sent anymore). |
373 | |
396 | |
374 | Not all event models handle this correctly (POE doesn't), but even for |
397 | Not all event models handle this correctly (neither POE nor IO::Async do, |
|
|
398 | see their AnyEvent::Impl manpages for details), but even for event models |
375 | event models that I<do> handle this correctly, they usually need to be |
399 | that I<do> handle this correctly, they usually need to be loaded before |
376 | loaded before the process exits (i.e. before you fork in the first place). |
400 | the process exits (i.e. before you fork in the first place). AnyEvent's |
|
|
401 | pure perl event loop handles all cases correctly regardless of when you |
|
|
402 | start the watcher. |
377 | |
403 | |
378 | This means you cannot create a child watcher as the very first thing in an |
404 | This means you cannot create a child watcher as the very first |
379 | AnyEvent program, you I<have> to create at least one watcher before you |
405 | thing in an AnyEvent program, you I<have> to create at least one |
380 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
406 | watcher before you C<fork> the child (alternatively, you can call |
|
|
407 | C<AnyEvent::detect>). |
381 | |
408 | |
382 | Example: fork a process and wait for it |
409 | Example: fork a process and wait for it |
383 | |
410 | |
384 | my $done = AnyEvent->condvar; |
411 | my $done = AnyEvent->condvar; |
385 | |
412 | |
… | |
… | |
395 | ); |
422 | ); |
396 | |
423 | |
397 | # do something else, then wait for process exit |
424 | # do something else, then wait for process exit |
398 | $done->recv; |
425 | $done->recv; |
399 | |
426 | |
|
|
427 | =head2 IDLE WATCHERS |
|
|
428 | |
|
|
429 | Sometimes there is a need to do something, but it is not so important |
|
|
430 | to do it instantly, but only when there is nothing better to do. This |
|
|
431 | "nothing better to do" is usually defined to be "no other events need |
|
|
432 | attention by the event loop". |
|
|
433 | |
|
|
434 | Idle watchers ideally get invoked when the event loop has nothing |
|
|
435 | better to do, just before it would block the process to wait for new |
|
|
436 | events. Instead of blocking, the idle watcher is invoked. |
|
|
437 | |
|
|
438 | Most event loops unfortunately do not really support idle watchers (only |
|
|
439 | EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent |
|
|
440 | will simply call the callback "from time to time". |
|
|
441 | |
|
|
442 | Example: read lines from STDIN, but only process them when the |
|
|
443 | program is otherwise idle: |
|
|
444 | |
|
|
445 | my @lines; # read data |
|
|
446 | my $idle_w; |
|
|
447 | my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
|
|
448 | push @lines, scalar <STDIN>; |
|
|
449 | |
|
|
450 | # start an idle watcher, if not already done |
|
|
451 | $idle_w ||= AnyEvent->idle (cb => sub { |
|
|
452 | # handle only one line, when there are lines left |
|
|
453 | if (my $line = shift @lines) { |
|
|
454 | print "handled when idle: $line"; |
|
|
455 | } else { |
|
|
456 | # otherwise disable the idle watcher again |
|
|
457 | undef $idle_w; |
|
|
458 | } |
|
|
459 | }); |
|
|
460 | }); |
|
|
461 | |
400 | =head2 CONDITION VARIABLES |
462 | =head2 CONDITION VARIABLES |
401 | |
463 | |
402 | If you are familiar with some event loops you will know that all of them |
464 | If you are familiar with some event loops you will know that all of them |
403 | require you to run some blocking "loop", "run" or similar function that |
465 | require you to run some blocking "loop", "run" or similar function that |
404 | will actively watch for new events and call your callbacks. |
466 | will actively watch for new events and call your callbacks. |
… | |
… | |
537 | |
599 | |
538 | =item $cv->begin ([group callback]) |
600 | =item $cv->begin ([group callback]) |
539 | |
601 | |
540 | =item $cv->end |
602 | =item $cv->end |
541 | |
603 | |
542 | These two methods are EXPERIMENTAL and MIGHT CHANGE. |
|
|
543 | |
|
|
544 | These two methods can be used to combine many transactions/events into |
604 | These two methods can be used to combine many transactions/events into |
545 | one. For example, a function that pings many hosts in parallel might want |
605 | one. For example, a function that pings many hosts in parallel might want |
546 | to use a condition variable for the whole process. |
606 | to use a condition variable for the whole process. |
547 | |
607 | |
548 | Every call to C<< ->begin >> will increment a counter, and every call to |
608 | Every call to C<< ->begin >> will increment a counter, and every call to |
549 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
609 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
550 | >>, the (last) callback passed to C<begin> will be executed. That callback |
610 | >>, the (last) callback passed to C<begin> will be executed. That callback |
551 | is I<supposed> to call C<< ->send >>, but that is not required. If no |
611 | is I<supposed> to call C<< ->send >>, but that is not required. If no |
552 | callback was set, C<send> will be called without any arguments. |
612 | callback was set, C<send> will be called without any arguments. |
553 | |
613 | |
554 | Let's clarify this with the ping example: |
614 | You can think of C<< $cv->send >> giving you an OR condition (one call |
|
|
615 | sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND |
|
|
616 | condition (all C<begin> calls must be C<end>'ed before the condvar sends). |
|
|
617 | |
|
|
618 | Let's start with a simple example: you have two I/O watchers (for example, |
|
|
619 | STDOUT and STDERR for a program), and you want to wait for both streams to |
|
|
620 | close before activating a condvar: |
|
|
621 | |
|
|
622 | my $cv = AnyEvent->condvar; |
|
|
623 | |
|
|
624 | $cv->begin; # first watcher |
|
|
625 | my $w1 = AnyEvent->io (fh => $fh1, cb => sub { |
|
|
626 | defined sysread $fh1, my $buf, 4096 |
|
|
627 | or $cv->end; |
|
|
628 | }); |
|
|
629 | |
|
|
630 | $cv->begin; # second watcher |
|
|
631 | my $w2 = AnyEvent->io (fh => $fh2, cb => sub { |
|
|
632 | defined sysread $fh2, my $buf, 4096 |
|
|
633 | or $cv->end; |
|
|
634 | }); |
|
|
635 | |
|
|
636 | $cv->recv; |
|
|
637 | |
|
|
638 | This works because for every event source (EOF on file handle), there is |
|
|
639 | one call to C<begin>, so the condvar waits for all calls to C<end> before |
|
|
640 | sending. |
|
|
641 | |
|
|
642 | The ping example mentioned above is slightly more complicated, as the |
|
|
643 | there are results to be passwd back, and the number of tasks that are |
|
|
644 | begung can potentially be zero: |
555 | |
645 | |
556 | my $cv = AnyEvent->condvar; |
646 | my $cv = AnyEvent->condvar; |
557 | |
647 | |
558 | my %result; |
648 | my %result; |
559 | $cv->begin (sub { $cv->send (\%result) }); |
649 | $cv->begin (sub { $cv->send (\%result) }); |
… | |
… | |
579 | loop, which serves two important purposes: first, it sets the callback |
669 | loop, which serves two important purposes: first, it sets the callback |
580 | to be called once the counter reaches C<0>, and second, it ensures that |
670 | to be called once the counter reaches C<0>, and second, it ensures that |
581 | C<send> is called even when C<no> hosts are being pinged (the loop |
671 | C<send> is called even when C<no> hosts are being pinged (the loop |
582 | doesn't execute once). |
672 | doesn't execute once). |
583 | |
673 | |
584 | This is the general pattern when you "fan out" into multiple subrequests: |
674 | This is the general pattern when you "fan out" into multiple (but |
585 | use an outer C<begin>/C<end> pair to set the callback and ensure C<end> |
675 | potentially none) subrequests: use an outer C<begin>/C<end> pair to set |
586 | is called at least once, and then, for each subrequest you start, call |
676 | the callback and ensure C<end> is called at least once, and then, for each |
587 | C<begin> and for each subrequest you finish, call C<end>. |
677 | subrequest you start, call C<begin> and for each subrequest you finish, |
|
|
678 | call C<end>. |
588 | |
679 | |
589 | =back |
680 | =back |
590 | |
681 | |
591 | =head3 METHODS FOR CONSUMERS |
682 | =head3 METHODS FOR CONSUMERS |
592 | |
683 | |
… | |
… | |
649 | variable itself. Calling C<recv> inside the callback or at any later time |
740 | variable itself. Calling C<recv> inside the callback or at any later time |
650 | is guaranteed not to block. |
741 | is guaranteed not to block. |
651 | |
742 | |
652 | =back |
743 | =back |
653 | |
744 | |
|
|
745 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
|
|
746 | |
|
|
747 | The available backend classes are (every class has its own manpage): |
|
|
748 | |
|
|
749 | =over 4 |
|
|
750 | |
|
|
751 | =item Backends that are autoprobed when no other event loop can be found. |
|
|
752 | |
|
|
753 | EV is the preferred backend when no other event loop seems to be in |
|
|
754 | use. If EV is not installed, then AnyEvent will try Event, and, failing |
|
|
755 | that, will fall back to its own pure-perl implementation, which is |
|
|
756 | available everywhere as it comes with AnyEvent itself. |
|
|
757 | |
|
|
758 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
|
|
759 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
|
|
760 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
|
|
761 | |
|
|
762 | =item Backends that are transparently being picked up when they are used. |
|
|
763 | |
|
|
764 | These will be used when they are currently loaded when the first watcher |
|
|
765 | is created, in which case it is assumed that the application is using |
|
|
766 | them. This means that AnyEvent will automatically pick the right backend |
|
|
767 | when the main program loads an event module before anything starts to |
|
|
768 | create watchers. Nothing special needs to be done by the main program. |
|
|
769 | |
|
|
770 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
|
|
771 | AnyEvent::Impl::Tk based on Tk, very broken. |
|
|
772 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
|
|
773 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
|
|
774 | |
|
|
775 | =item Backends with special needs. |
|
|
776 | |
|
|
777 | Qt requires the Qt::Application to be instantiated first, but will |
|
|
778 | otherwise be picked up automatically. As long as the main program |
|
|
779 | instantiates the application before any AnyEvent watchers are created, |
|
|
780 | everything should just work. |
|
|
781 | |
|
|
782 | AnyEvent::Impl::Qt based on Qt. |
|
|
783 | |
|
|
784 | Support for IO::Async can only be partial, as it is too broken and |
|
|
785 | architecturally limited to even support the AnyEvent API. It also |
|
|
786 | is the only event loop that needs the loop to be set explicitly, so |
|
|
787 | it can only be used by a main program knowing about AnyEvent. See |
|
|
788 | L<AnyEvent::Impl::Async> for the gory details. |
|
|
789 | |
|
|
790 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed. |
|
|
791 | |
|
|
792 | =item Event loops that are indirectly supported via other backends. |
|
|
793 | |
|
|
794 | Some event loops can be supported via other modules: |
|
|
795 | |
|
|
796 | There is no direct support for WxWidgets (L<Wx>) or L<Prima>. |
|
|
797 | |
|
|
798 | B<WxWidgets> has no support for watching file handles. However, you can |
|
|
799 | use WxWidgets through the POE adaptor, as POE has a Wx backend that simply |
|
|
800 | polls 20 times per second, which was considered to be too horrible to even |
|
|
801 | consider for AnyEvent. |
|
|
802 | |
|
|
803 | B<Prima> is not supported as nobody seems to be using it, but it has a POE |
|
|
804 | backend, so it can be supported through POE. |
|
|
805 | |
|
|
806 | AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to |
|
|
807 | load L<POE> when detecting them, in the hope that POE will pick them up, |
|
|
808 | in which case everything will be automatic. |
|
|
809 | |
|
|
810 | =back |
|
|
811 | |
654 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
812 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
655 | |
813 | |
656 | =over 4 |
814 | =over 4 |
657 | |
815 | |
658 | =item $AnyEvent::MODEL |
816 | =item $AnyEvent::MODEL |
… | |
… | |
660 | Contains C<undef> until the first watcher is being created. Then it |
818 | Contains C<undef> until the first watcher is being created. Then it |
661 | contains the event model that is being used, which is the name of the |
819 | contains the event model that is being used, which is the name of the |
662 | Perl class implementing the model. This class is usually one of the |
820 | Perl class implementing the model. This class is usually one of the |
663 | C<AnyEvent::Impl:xxx> modules, but can be any other class in the case |
821 | C<AnyEvent::Impl:xxx> modules, but can be any other class in the case |
664 | AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). |
822 | AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). |
665 | |
|
|
666 | The known classes so far are: |
|
|
667 | |
|
|
668 | AnyEvent::Impl::EV based on EV (an interface to libev, best choice). |
|
|
669 | AnyEvent::Impl::Event based on Event, second best choice. |
|
|
670 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
|
|
671 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
|
|
672 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
|
|
673 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
|
|
674 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
|
|
675 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
|
|
676 | |
|
|
677 | There is no support for WxWidgets, as WxWidgets has no support for |
|
|
678 | watching file handles. However, you can use WxWidgets through the |
|
|
679 | POE Adaptor, as POE has a Wx backend that simply polls 20 times per |
|
|
680 | second, which was considered to be too horrible to even consider for |
|
|
681 | AnyEvent. Likewise, other POE backends can be used by AnyEvent by using |
|
|
682 | it's adaptor. |
|
|
683 | |
|
|
684 | AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when |
|
|
685 | autodetecting them. |
|
|
686 | |
823 | |
687 | =item AnyEvent::detect |
824 | =item AnyEvent::detect |
688 | |
825 | |
689 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
826 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
690 | if necessary. You should only call this function right before you would |
827 | if necessary. You should only call this function right before you would |
… | |
… | |
773 | |
910 | |
774 | |
911 | |
775 | =head1 OTHER MODULES |
912 | =head1 OTHER MODULES |
776 | |
913 | |
777 | The following is a non-exhaustive list of additional modules that use |
914 | The following is a non-exhaustive list of additional modules that use |
778 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
915 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
779 | in the same program. Some of the modules come with AnyEvent, some are |
916 | modules and other event loops in the same program. Some of the modules |
780 | available via CPAN. |
917 | come with AnyEvent, most are available via CPAN. |
781 | |
918 | |
782 | =over 4 |
919 | =over 4 |
783 | |
920 | |
784 | =item L<AnyEvent::Util> |
921 | =item L<AnyEvent::Util> |
785 | |
922 | |
… | |
… | |
794 | |
931 | |
795 | =item L<AnyEvent::Handle> |
932 | =item L<AnyEvent::Handle> |
796 | |
933 | |
797 | Provide read and write buffers, manages watchers for reads and writes, |
934 | Provide read and write buffers, manages watchers for reads and writes, |
798 | supports raw and formatted I/O, I/O queued and fully transparent and |
935 | supports raw and formatted I/O, I/O queued and fully transparent and |
799 | non-blocking SSL/TLS. |
936 | non-blocking SSL/TLS (via L<AnyEvent::TLS>. |
800 | |
937 | |
801 | =item L<AnyEvent::DNS> |
938 | =item L<AnyEvent::DNS> |
802 | |
939 | |
803 | Provides rich asynchronous DNS resolver capabilities. |
940 | Provides rich asynchronous DNS resolver capabilities. |
804 | |
941 | |
… | |
… | |
832 | |
969 | |
833 | =item L<AnyEvent::GPSD> |
970 | =item L<AnyEvent::GPSD> |
834 | |
971 | |
835 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
972 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
836 | |
973 | |
|
|
974 | =item L<AnyEvent::IRC> |
|
|
975 | |
|
|
976 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
|
|
977 | |
|
|
978 | =item L<AnyEvent::XMPP> |
|
|
979 | |
|
|
980 | AnyEvent based XMPP (Jabber protocol) module family (replacing the older |
|
|
981 | Net::XMPP2>. |
|
|
982 | |
837 | =item L<AnyEvent::IGS> |
983 | =item L<AnyEvent::IGS> |
838 | |
984 | |
839 | A non-blocking interface to the Internet Go Server protocol (used by |
985 | A non-blocking interface to the Internet Go Server protocol (used by |
840 | L<App::IGS>). |
986 | L<App::IGS>). |
841 | |
987 | |
842 | =item L<AnyEvent::IRC> |
|
|
843 | |
|
|
844 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
|
|
845 | |
|
|
846 | =item L<Net::XMPP2> |
|
|
847 | |
|
|
848 | AnyEvent based XMPP (Jabber protocol) module family. |
|
|
849 | |
|
|
850 | =item L<Net::FCP> |
988 | =item L<Net::FCP> |
851 | |
989 | |
852 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
990 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
853 | of AnyEvent. |
991 | of AnyEvent. |
854 | |
992 | |
… | |
… | |
858 | |
996 | |
859 | =item L<Coro> |
997 | =item L<Coro> |
860 | |
998 | |
861 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
999 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
862 | |
1000 | |
863 | =item L<IO::Lambda> |
|
|
864 | |
|
|
865 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
|
|
866 | |
|
|
867 | =back |
1001 | =back |
868 | |
1002 | |
869 | =cut |
1003 | =cut |
870 | |
1004 | |
871 | package AnyEvent; |
1005 | package AnyEvent; |
… | |
… | |
873 | no warnings; |
1007 | no warnings; |
874 | use strict qw(vars subs); |
1008 | use strict qw(vars subs); |
875 | |
1009 | |
876 | use Carp; |
1010 | use Carp; |
877 | |
1011 | |
878 | our $VERSION = 4.35; |
1012 | our $VERSION = 4.801; |
879 | our $MODEL; |
1013 | our $MODEL; |
880 | |
1014 | |
881 | our $AUTOLOAD; |
1015 | our $AUTOLOAD; |
882 | our @ISA; |
1016 | our @ISA; |
883 | |
1017 | |
884 | our @REGISTRY; |
1018 | our @REGISTRY; |
885 | |
1019 | |
886 | our $WIN32; |
1020 | our $WIN32; |
887 | |
1021 | |
888 | BEGIN { |
1022 | BEGIN { |
889 | my $win32 = ! ! ($^O =~ /mswin32/i); |
1023 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
890 | eval "sub WIN32(){ $win32 }"; |
1024 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
|
|
1025 | |
|
|
1026 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
|
|
1027 | if ${^TAINT}; |
891 | } |
1028 | } |
892 | |
1029 | |
893 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1030 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
894 | |
1031 | |
895 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1032 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
… | |
… | |
906 | [Event:: => AnyEvent::Impl::Event::], |
1043 | [Event:: => AnyEvent::Impl::Event::], |
907 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
1044 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
908 | # everything below here will not be autoprobed |
1045 | # everything below here will not be autoprobed |
909 | # as the pureperl backend should work everywhere |
1046 | # as the pureperl backend should work everywhere |
910 | # and is usually faster |
1047 | # and is usually faster |
911 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
|
|
912 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
1048 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
913 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1049 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
|
|
1050 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
|
|
1051 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
914 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1052 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
915 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
|
|
916 | [Wx:: => AnyEvent::Impl::POE::], |
1053 | [Wx:: => AnyEvent::Impl::POE::], |
917 | [Prima:: => AnyEvent::Impl::POE::], |
1054 | [Prima:: => AnyEvent::Impl::POE::], |
|
|
1055 | # IO::Async is just too broken - we would need workarounds for its |
|
|
1056 | # byzantine signal and broken child handling, among others. |
|
|
1057 | # IO::Async is rather hard to detect, as it doesn't have any |
|
|
1058 | # obvious default class. |
|
|
1059 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1060 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1061 | # [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
918 | ); |
1062 | ); |
919 | |
1063 | |
920 | our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); |
1064 | our %method = map +($_ => 1), |
|
|
1065 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
921 | |
1066 | |
922 | our @post_detect; |
1067 | our @post_detect; |
923 | |
1068 | |
924 | sub post_detect(&) { |
1069 | sub post_detect(&) { |
925 | my ($cb) = @_; |
1070 | my ($cb) = @_; |
… | |
… | |
930 | 1 |
1075 | 1 |
931 | } else { |
1076 | } else { |
932 | push @post_detect, $cb; |
1077 | push @post_detect, $cb; |
933 | |
1078 | |
934 | defined wantarray |
1079 | defined wantarray |
935 | ? bless \$cb, "AnyEvent::Util::PostDetect" |
1080 | ? bless \$cb, "AnyEvent::Util::postdetect" |
936 | : () |
1081 | : () |
937 | } |
1082 | } |
938 | } |
1083 | } |
939 | |
1084 | |
940 | sub AnyEvent::Util::PostDetect::DESTROY { |
1085 | sub AnyEvent::Util::postdetect::DESTROY { |
941 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1086 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
942 | } |
1087 | } |
943 | |
1088 | |
944 | sub detect() { |
1089 | sub detect() { |
945 | unless ($MODEL) { |
1090 | unless ($MODEL) { |
… | |
… | |
982 | last; |
1127 | last; |
983 | } |
1128 | } |
984 | } |
1129 | } |
985 | |
1130 | |
986 | $MODEL |
1131 | $MODEL |
987 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; |
1132 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
988 | } |
1133 | } |
989 | } |
1134 | } |
990 | |
1135 | |
991 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1136 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
992 | |
1137 | |
… | |
… | |
1013 | } |
1158 | } |
1014 | |
1159 | |
1015 | # utility function to dup a filehandle. this is used by many backends |
1160 | # utility function to dup a filehandle. this is used by many backends |
1016 | # to support binding more than one watcher per filehandle (they usually |
1161 | # to support binding more than one watcher per filehandle (they usually |
1017 | # allow only one watcher per fd, so we dup it to get a different one). |
1162 | # allow only one watcher per fd, so we dup it to get a different one). |
1018 | sub _dupfh($$$$) { |
1163 | sub _dupfh($$;$$) { |
1019 | my ($poll, $fh, $r, $w) = @_; |
1164 | my ($poll, $fh, $r, $w) = @_; |
1020 | |
1165 | |
1021 | # cygwin requires the fh mode to be matching, unix doesn't |
1166 | # cygwin requires the fh mode to be matching, unix doesn't |
1022 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
1167 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") : ($w, ">"); |
1023 | : $poll eq "w" ? ($w, ">") |
|
|
1024 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
|
|
1025 | |
1168 | |
1026 | open my $fh2, "$mode&" . fileno $fh |
1169 | open my $fh2, "$mode&", $fh |
1027 | or die "cannot dup() filehandle: $!"; |
1170 | or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,"; |
1028 | |
1171 | |
1029 | # we assume CLOEXEC is already set by perl in all important cases |
1172 | # we assume CLOEXEC is already set by perl in all important cases |
1030 | |
1173 | |
1031 | ($fh2, $rw) |
1174 | ($fh2, $rw) |
1032 | } |
1175 | } |
1033 | |
1176 | |
1034 | package AnyEvent::Base; |
1177 | package AnyEvent::Base; |
1035 | |
1178 | |
1036 | # default implementation for now and time |
1179 | # default implementations for many methods |
1037 | |
1180 | |
1038 | BEGIN { |
1181 | BEGIN { |
1039 | if (eval "use Time::HiRes (); time (); 1") { |
1182 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1040 | *_time = \&Time::HiRes::time; |
1183 | *_time = \&Time::HiRes::time; |
1041 | # if (eval "use POSIX (); (POSIX::times())... |
1184 | # if (eval "use POSIX (); (POSIX::times())... |
1042 | } else { |
1185 | } else { |
1043 | *_time = sub { time }; # epic fail |
1186 | *_time = sub { time }; # epic fail |
1044 | } |
1187 | } |
1045 | } |
1188 | } |
1046 | |
1189 | |
1047 | sub time { _time } |
1190 | sub time { _time } |
1048 | sub now { _time } |
1191 | sub now { _time } |
|
|
1192 | sub now_update { } |
1049 | |
1193 | |
1050 | # default implementation for ->condvar |
1194 | # default implementation for ->condvar |
1051 | |
1195 | |
1052 | sub condvar { |
1196 | sub condvar { |
1053 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
1197 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1054 | } |
1198 | } |
1055 | |
1199 | |
1056 | # default implementation for ->signal |
1200 | # default implementation for ->signal |
1057 | |
1201 | |
1058 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1202 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
… | |
… | |
1082 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
1226 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
1083 | } else { |
1227 | } else { |
1084 | pipe $SIGPIPE_R, $SIGPIPE_W; |
1228 | pipe $SIGPIPE_R, $SIGPIPE_W; |
1085 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
1229 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
1086 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
1230 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1231 | |
|
|
1232 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1233 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1234 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
1087 | } |
1235 | } |
1088 | |
1236 | |
1089 | $SIGPIPE_R |
1237 | $SIGPIPE_R |
1090 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
1238 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
1091 | |
1239 | |
1092 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1093 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1094 | |
|
|
1095 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
1240 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
1096 | } |
1241 | } |
1097 | |
1242 | |
1098 | my $signal = uc $arg{signal} |
1243 | my $signal = uc $arg{signal} |
1099 | or Carp::croak "required option 'signal' is missing"; |
1244 | or Carp::croak "required option 'signal' is missing"; |
1100 | |
1245 | |
1101 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1246 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1102 | $SIG{$signal} ||= sub { |
1247 | $SIG{$signal} ||= sub { |
|
|
1248 | local $!; |
1103 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1249 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1104 | undef $SIG_EV{$signal}; |
1250 | undef $SIG_EV{$signal}; |
1105 | }; |
1251 | }; |
1106 | |
1252 | |
1107 | bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" |
1253 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
1108 | } |
1254 | } |
1109 | |
1255 | |
1110 | sub AnyEvent::Base::Signal::DESTROY { |
1256 | sub AnyEvent::Base::signal::DESTROY { |
1111 | my ($signal, $cb) = @{$_[0]}; |
1257 | my ($signal, $cb) = @{$_[0]}; |
1112 | |
1258 | |
1113 | delete $SIG_CB{$signal}{$cb}; |
1259 | delete $SIG_CB{$signal}{$cb}; |
1114 | |
1260 | |
|
|
1261 | # delete doesn't work with older perls - they then |
|
|
1262 | # print weird messages, or just unconditionally exit |
|
|
1263 | # instead of getting the default action. |
1115 | delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
1264 | undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
1116 | } |
1265 | } |
1117 | |
1266 | |
1118 | # default implementation for ->child |
1267 | # default implementation for ->child |
1119 | |
1268 | |
1120 | our %PID_CB; |
1269 | our %PID_CB; |
1121 | our $CHLD_W; |
1270 | our $CHLD_W; |
1122 | our $CHLD_DELAY_W; |
1271 | our $CHLD_DELAY_W; |
1123 | our $PID_IDLE; |
|
|
1124 | our $WNOHANG; |
1272 | our $WNOHANG; |
1125 | |
1273 | |
1126 | sub _child_wait { |
1274 | sub _sigchld { |
1127 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1275 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1128 | $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), |
1276 | $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), |
1129 | (values %{ $PID_CB{0} || {} }); |
1277 | (values %{ $PID_CB{0} || {} }); |
1130 | } |
1278 | } |
1131 | |
|
|
1132 | undef $PID_IDLE; |
|
|
1133 | } |
|
|
1134 | |
|
|
1135 | sub _sigchld { |
|
|
1136 | # make sure we deliver these changes "synchronous" with the event loop. |
|
|
1137 | $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub { |
|
|
1138 | undef $CHLD_DELAY_W; |
|
|
1139 | &_child_wait; |
|
|
1140 | }); |
|
|
1141 | } |
1279 | } |
1142 | |
1280 | |
1143 | sub child { |
1281 | sub child { |
1144 | my (undef, %arg) = @_; |
1282 | my (undef, %arg) = @_; |
1145 | |
1283 | |
1146 | defined (my $pid = $arg{pid} + 0) |
1284 | defined (my $pid = $arg{pid} + 0) |
1147 | or Carp::croak "required option 'pid' is missing"; |
1285 | or Carp::croak "required option 'pid' is missing"; |
1148 | |
1286 | |
1149 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1287 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1150 | |
1288 | |
1151 | unless ($WNOHANG) { |
|
|
1152 | $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1289 | $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1153 | } |
|
|
1154 | |
1290 | |
1155 | unless ($CHLD_W) { |
1291 | unless ($CHLD_W) { |
1156 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1292 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1157 | # child could be a zombie already, so make at least one round |
1293 | # child could be a zombie already, so make at least one round |
1158 | &_sigchld; |
1294 | &_sigchld; |
1159 | } |
1295 | } |
1160 | |
1296 | |
1161 | bless [$pid, $arg{cb}], "AnyEvent::Base::Child" |
1297 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
1162 | } |
1298 | } |
1163 | |
1299 | |
1164 | sub AnyEvent::Base::Child::DESTROY { |
1300 | sub AnyEvent::Base::child::DESTROY { |
1165 | my ($pid, $cb) = @{$_[0]}; |
1301 | my ($pid, $cb) = @{$_[0]}; |
1166 | |
1302 | |
1167 | delete $PID_CB{$pid}{$cb}; |
1303 | delete $PID_CB{$pid}{$cb}; |
1168 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1304 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1169 | |
1305 | |
1170 | undef $CHLD_W unless keys %PID_CB; |
1306 | undef $CHLD_W unless keys %PID_CB; |
|
|
1307 | } |
|
|
1308 | |
|
|
1309 | # idle emulation is done by simply using a timer, regardless |
|
|
1310 | # of whether the process is idle or not, and not letting |
|
|
1311 | # the callback use more than 50% of the time. |
|
|
1312 | sub idle { |
|
|
1313 | my (undef, %arg) = @_; |
|
|
1314 | |
|
|
1315 | my ($cb, $w, $rcb) = $arg{cb}; |
|
|
1316 | |
|
|
1317 | $rcb = sub { |
|
|
1318 | if ($cb) { |
|
|
1319 | $w = _time; |
|
|
1320 | &$cb; |
|
|
1321 | $w = _time - $w; |
|
|
1322 | |
|
|
1323 | # never use more then 50% of the time for the idle watcher, |
|
|
1324 | # within some limits |
|
|
1325 | $w = 0.0001 if $w < 0.0001; |
|
|
1326 | $w = 5 if $w > 5; |
|
|
1327 | |
|
|
1328 | $w = AnyEvent->timer (after => $w, cb => $rcb); |
|
|
1329 | } else { |
|
|
1330 | # clean up... |
|
|
1331 | undef $w; |
|
|
1332 | undef $rcb; |
|
|
1333 | } |
|
|
1334 | }; |
|
|
1335 | |
|
|
1336 | $w = AnyEvent->timer (after => 0.05, cb => $rcb); |
|
|
1337 | |
|
|
1338 | bless \\$cb, "AnyEvent::Base::idle" |
|
|
1339 | } |
|
|
1340 | |
|
|
1341 | sub AnyEvent::Base::idle::DESTROY { |
|
|
1342 | undef $${$_[0]}; |
1171 | } |
1343 | } |
1172 | |
1344 | |
1173 | package AnyEvent::CondVar; |
1345 | package AnyEvent::CondVar; |
1174 | |
1346 | |
1175 | our @ISA = AnyEvent::CondVar::Base::; |
1347 | our @ISA = AnyEvent::CondVar::Base::; |
… | |
… | |
1249 | so on. |
1421 | so on. |
1250 | |
1422 | |
1251 | =head1 ENVIRONMENT VARIABLES |
1423 | =head1 ENVIRONMENT VARIABLES |
1252 | |
1424 | |
1253 | The following environment variables are used by this module or its |
1425 | The following environment variables are used by this module or its |
1254 | submodules: |
1426 | submodules. |
|
|
1427 | |
|
|
1428 | Note that AnyEvent will remove I<all> environment variables starting with |
|
|
1429 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
|
|
1430 | enabled. |
1255 | |
1431 | |
1256 | =over 4 |
1432 | =over 4 |
1257 | |
1433 | |
1258 | =item C<PERL_ANYEVENT_VERBOSE> |
1434 | =item C<PERL_ANYEVENT_VERBOSE> |
1259 | |
1435 | |
… | |
… | |
1271 | =item C<PERL_ANYEVENT_STRICT> |
1447 | =item C<PERL_ANYEVENT_STRICT> |
1272 | |
1448 | |
1273 | AnyEvent does not do much argument checking by default, as thorough |
1449 | AnyEvent does not do much argument checking by default, as thorough |
1274 | argument checking is very costly. Setting this variable to a true value |
1450 | argument checking is very costly. Setting this variable to a true value |
1275 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
1451 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
1276 | check the arguments passed to most method calls. If it finds any problems |
1452 | check the arguments passed to most method calls. If it finds any problems, |
1277 | it will croak. |
1453 | it will croak. |
1278 | |
1454 | |
1279 | In other words, enables "strict" mode. |
1455 | In other words, enables "strict" mode. |
1280 | |
1456 | |
1281 | Unlike C<use strict>, it is definitely recommended ot keep it off in |
1457 | Unlike C<use strict>, it is definitely recommended to keep it off in |
1282 | production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while |
1458 | production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while |
1283 | developing programs can be very useful, however. |
1459 | developing programs can be very useful, however. |
1284 | |
1460 | |
1285 | =item C<PERL_ANYEVENT_MODEL> |
1461 | =item C<PERL_ANYEVENT_MODEL> |
1286 | |
1462 | |
… | |
… | |
1331 | |
1507 | |
1332 | =item C<PERL_ANYEVENT_MAX_FORKS> |
1508 | =item C<PERL_ANYEVENT_MAX_FORKS> |
1333 | |
1509 | |
1334 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
1510 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
1335 | will create in parallel. |
1511 | will create in parallel. |
|
|
1512 | |
|
|
1513 | =item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS> |
|
|
1514 | |
|
|
1515 | The default value for the C<max_outstanding> parameter for the default DNS |
|
|
1516 | resolver - this is the maximum number of parallel DNS requests that are |
|
|
1517 | sent to the DNS server. |
|
|
1518 | |
|
|
1519 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
|
|
1520 | |
|
|
1521 | The file to use instead of F</etc/resolv.conf> (or OS-specific |
|
|
1522 | configuration) in the default resolver. When set to the empty string, no |
|
|
1523 | default config will be used. |
|
|
1524 | |
|
|
1525 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
|
|
1526 | |
|
|
1527 | When neither C<ca_file> nor C<ca_path> was specified during |
|
|
1528 | L<AnyEvent::TLS> context creation, and either of these environment |
|
|
1529 | variables exist, they will be used to specify CA certificate locations |
|
|
1530 | instead of a system-dependent default. |
1336 | |
1531 | |
1337 | =back |
1532 | =back |
1338 | |
1533 | |
1339 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1534 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1340 | |
1535 | |
… | |
… | |
1585 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
1780 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
1586 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
1781 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
1587 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
1782 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
1588 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
1783 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
1589 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
1784 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
|
|
1785 | IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll |
|
|
1786 | IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll |
1590 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
1787 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
1591 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
1788 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
1592 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
1789 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
1593 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
1790 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
1594 | |
1791 | |
… | |
… | |
1623 | performance becomes really bad with lots of file descriptors (and few of |
1820 | performance becomes really bad with lots of file descriptors (and few of |
1624 | them active), of course, but this was not subject of this benchmark. |
1821 | them active), of course, but this was not subject of this benchmark. |
1625 | |
1822 | |
1626 | The C<Event> module has a relatively high setup and callback invocation |
1823 | The C<Event> module has a relatively high setup and callback invocation |
1627 | cost, but overall scores in on the third place. |
1824 | cost, but overall scores in on the third place. |
|
|
1825 | |
|
|
1826 | C<IO::Async> performs admirably well, about on par with C<Event>, even |
|
|
1827 | when using its pure perl backend. |
1628 | |
1828 | |
1629 | C<Glib>'s memory usage is quite a bit higher, but it features a |
1829 | C<Glib>'s memory usage is quite a bit higher, but it features a |
1630 | faster callback invocation and overall ends up in the same class as |
1830 | faster callback invocation and overall ends up in the same class as |
1631 | C<Event>. However, Glib scales extremely badly, doubling the number of |
1831 | C<Event>. However, Glib scales extremely badly, doubling the number of |
1632 | watchers increases the processing time by more than a factor of four, |
1832 | watchers increases the processing time by more than a factor of four, |
… | |
… | |
1710 | it to another server. This includes deleting the old timeout and creating |
1910 | it to another server. This includes deleting the old timeout and creating |
1711 | a new one that moves the timeout into the future. |
1911 | a new one that moves the timeout into the future. |
1712 | |
1912 | |
1713 | =head3 Results |
1913 | =head3 Results |
1714 | |
1914 | |
1715 | name sockets create request |
1915 | name sockets create request |
1716 | EV 20000 69.01 11.16 |
1916 | EV 20000 69.01 11.16 |
1717 | Perl 20000 73.32 35.87 |
1917 | Perl 20000 73.32 35.87 |
|
|
1918 | IOAsync 20000 157.00 98.14 epoll |
|
|
1919 | IOAsync 20000 159.31 616.06 poll |
1718 | Event 20000 212.62 257.32 |
1920 | Event 20000 212.62 257.32 |
1719 | Glib 20000 651.16 1896.30 |
1921 | Glib 20000 651.16 1896.30 |
1720 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
1922 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
1721 | |
1923 | |
1722 | =head3 Discussion |
1924 | =head3 Discussion |
1723 | |
1925 | |
1724 | This benchmark I<does> measure scalability and overall performance of the |
1926 | This benchmark I<does> measure scalability and overall performance of the |
1725 | particular event loop. |
1927 | particular event loop. |
… | |
… | |
1727 | EV is again fastest. Since it is using epoll on my system, the setup time |
1929 | EV is again fastest. Since it is using epoll on my system, the setup time |
1728 | is relatively high, though. |
1930 | is relatively high, though. |
1729 | |
1931 | |
1730 | Perl surprisingly comes second. It is much faster than the C-based event |
1932 | Perl surprisingly comes second. It is much faster than the C-based event |
1731 | loops Event and Glib. |
1933 | loops Event and Glib. |
|
|
1934 | |
|
|
1935 | IO::Async performs very well when using its epoll backend, and still quite |
|
|
1936 | good compared to Glib when using its pure perl backend. |
1732 | |
1937 | |
1733 | Event suffers from high setup time as well (look at its code and you will |
1938 | Event suffers from high setup time as well (look at its code and you will |
1734 | understand why). Callback invocation also has a high overhead compared to |
1939 | understand why). Callback invocation also has a high overhead compared to |
1735 | the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event |
1940 | the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event |
1736 | uses select or poll in basically all documented configurations. |
1941 | uses select or poll in basically all documented configurations. |
… | |
… | |
1799 | =item * C-based event loops perform very well with small number of |
2004 | =item * C-based event loops perform very well with small number of |
1800 | watchers, as the management overhead dominates. |
2005 | watchers, as the management overhead dominates. |
1801 | |
2006 | |
1802 | =back |
2007 | =back |
1803 | |
2008 | |
|
|
2009 | =head2 THE IO::Lambda BENCHMARK |
|
|
2010 | |
|
|
2011 | Recently I was told about the benchmark in the IO::Lambda manpage, which |
|
|
2012 | could be misinterpreted to make AnyEvent look bad. In fact, the benchmark |
|
|
2013 | simply compares IO::Lambda with POE, and IO::Lambda looks better (which |
|
|
2014 | shouldn't come as a surprise to anybody). As such, the benchmark is |
|
|
2015 | fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't |
|
|
2016 | very optimal. But how would AnyEvent compare when used without the extra |
|
|
2017 | baggage? To explore this, I wrote the equivalent benchmark for AnyEvent. |
|
|
2018 | |
|
|
2019 | The benchmark itself creates an echo-server, and then, for 500 times, |
|
|
2020 | connects to the echo server, sends a line, waits for the reply, and then |
|
|
2021 | creates the next connection. This is a rather bad benchmark, as it doesn't |
|
|
2022 | test the efficiency of the framework or much non-blocking I/O, but it is a |
|
|
2023 | benchmark nevertheless. |
|
|
2024 | |
|
|
2025 | name runtime |
|
|
2026 | Lambda/select 0.330 sec |
|
|
2027 | + optimized 0.122 sec |
|
|
2028 | Lambda/AnyEvent 0.327 sec |
|
|
2029 | + optimized 0.138 sec |
|
|
2030 | Raw sockets/select 0.077 sec |
|
|
2031 | POE/select, components 0.662 sec |
|
|
2032 | POE/select, raw sockets 0.226 sec |
|
|
2033 | POE/select, optimized 0.404 sec |
|
|
2034 | |
|
|
2035 | AnyEvent/select/nb 0.085 sec |
|
|
2036 | AnyEvent/EV/nb 0.068 sec |
|
|
2037 | +state machine 0.134 sec |
|
|
2038 | |
|
|
2039 | The benchmark is also a bit unfair (my fault): the IO::Lambda/POE |
|
|
2040 | benchmarks actually make blocking connects and use 100% blocking I/O, |
|
|
2041 | defeating the purpose of an event-based solution. All of the newly |
|
|
2042 | written AnyEvent benchmarks use 100% non-blocking connects (using |
|
|
2043 | AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS |
|
|
2044 | resolver), so AnyEvent is at a disadvantage here, as non-blocking connects |
|
|
2045 | generally require a lot more bookkeeping and event handling than blocking |
|
|
2046 | connects (which involve a single syscall only). |
|
|
2047 | |
|
|
2048 | The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which |
|
|
2049 | offers similar expressive power as POE and IO::Lambda, using conventional |
|
|
2050 | Perl syntax. This means that both the echo server and the client are 100% |
|
|
2051 | non-blocking, further placing it at a disadvantage. |
|
|
2052 | |
|
|
2053 | As you can see, the AnyEvent + EV combination even beats the |
|
|
2054 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
|
|
2055 | backend easily beats IO::Lambda and POE. |
|
|
2056 | |
|
|
2057 | And even the 100% non-blocking version written using the high-level (and |
|
|
2058 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a |
|
|
2059 | large margin, even though it does all of DNS, tcp-connect and socket I/O |
|
|
2060 | in a non-blocking way. |
|
|
2061 | |
|
|
2062 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
|
|
2063 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
|
|
2064 | part of the IO::lambda distribution and were used without any changes. |
|
|
2065 | |
1804 | |
2066 | |
1805 | =head1 SIGNALS |
2067 | =head1 SIGNALS |
1806 | |
2068 | |
1807 | AnyEvent currently installs handlers for these signals: |
2069 | AnyEvent currently installs handlers for these signals: |
1808 | |
2070 | |
… | |
… | |
1811 | =item SIGCHLD |
2073 | =item SIGCHLD |
1812 | |
2074 | |
1813 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
2075 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
1814 | emulation for event loops that do not support them natively. Also, some |
2076 | emulation for event loops that do not support them natively. Also, some |
1815 | event loops install a similar handler. |
2077 | event loops install a similar handler. |
|
|
2078 | |
|
|
2079 | If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will |
|
|
2080 | reset it to default, to avoid losing child exit statuses. |
1816 | |
2081 | |
1817 | =item SIGPIPE |
2082 | =item SIGPIPE |
1818 | |
2083 | |
1819 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
2084 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
1820 | when AnyEvent gets loaded. |
2085 | when AnyEvent gets loaded. |
… | |
… | |
1832 | |
2097 | |
1833 | =back |
2098 | =back |
1834 | |
2099 | |
1835 | =cut |
2100 | =cut |
1836 | |
2101 | |
|
|
2102 | undef $SIG{CHLD} |
|
|
2103 | if $SIG{CHLD} eq 'IGNORE'; |
|
|
2104 | |
1837 | $SIG{PIPE} = sub { } |
2105 | $SIG{PIPE} = sub { } |
1838 | unless defined $SIG{PIPE}; |
2106 | unless defined $SIG{PIPE}; |
1839 | |
|
|
1840 | |
2107 | |
1841 | =head1 FORK |
2108 | =head1 FORK |
1842 | |
2109 | |
1843 | Most event libraries are not fork-safe. The ones who are usually are |
2110 | Most event libraries are not fork-safe. The ones who are usually are |
1844 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2111 | because they rely on inefficient but fork-safe C<select> or C<poll> |
… | |
… | |
1865 | use AnyEvent; |
2132 | use AnyEvent; |
1866 | |
2133 | |
1867 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
2134 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1868 | be used to probe what backend is used and gain other information (which is |
2135 | be used to probe what backend is used and gain other information (which is |
1869 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and |
2136 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and |
1870 | $ENV{PERL_ANYEGENT_STRICT}. |
2137 | $ENV{PERL_ANYEVENT_STRICT}. |
|
|
2138 | |
|
|
2139 | Note that AnyEvent will remove I<all> environment variables starting with |
|
|
2140 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
|
|
2141 | enabled. |
1871 | |
2142 | |
1872 | |
2143 | |
1873 | =head1 BUGS |
2144 | =head1 BUGS |
1874 | |
2145 | |
1875 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
2146 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
… | |
… | |
1887 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2158 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
1888 | |
2159 | |
1889 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2160 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
1890 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2161 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
1891 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2162 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
1892 | L<AnyEvent::Impl::POE>. |
2163 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. |
1893 | |
2164 | |
1894 | Non-blocking file handles, sockets, TCP clients and |
2165 | Non-blocking file handles, sockets, TCP clients and |
1895 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. |
2166 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
1896 | |
2167 | |
1897 | Asynchronous DNS: L<AnyEvent::DNS>. |
2168 | Asynchronous DNS: L<AnyEvent::DNS>. |
1898 | |
2169 | |
1899 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, |
2170 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, |
|
|
2171 | L<Coro::Event>, |
1900 | |
2172 | |
1901 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
2173 | Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, |
|
|
2174 | L<AnyEvent::HTTP>. |
1902 | |
2175 | |
1903 | |
2176 | |
1904 | =head1 AUTHOR |
2177 | =head1 AUTHOR |
1905 | |
2178 | |
1906 | Marc Lehmann <schmorp@schmorp.de> |
2179 | Marc Lehmann <schmorp@schmorp.de> |