… | |
… | |
176 | =head2 I/O WATCHERS |
176 | =head2 I/O WATCHERS |
177 | |
177 | |
178 | 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 |
179 | with the following mandatory key-value pairs as arguments: |
179 | with the following mandatory key-value pairs as arguments: |
180 | |
180 | |
181 | 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 |
182 | 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 |
183 | handle). Note that only file handles pointing to things for which |
183 | handle). Note that only file handles pointing to things for which |
184 | non-blocking operation makes sense are allowed. This includes sockets, |
184 | non-blocking operation makes sense are allowed. This includes sockets, |
185 | 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 |
186 | or block devices. |
186 | or block devices. |
… | |
… | |
361 | invocation, and callback invocation will be synchronous. Synchronous means |
361 | invocation, and callback invocation will be synchronous. Synchronous means |
362 | that it might take a while until the signal gets handled by the process, |
362 | that it might take a while until the signal gets handled by the process, |
363 | but it is guaranteed not to interrupt any other callbacks. |
363 | but it is guaranteed not to interrupt any other callbacks. |
364 | |
364 | |
365 | The main advantage of using these watchers is that you can share a signal |
365 | The main advantage of using these watchers is that you can share a signal |
366 | between multiple watchers. |
366 | between multiple watchers, and AnyEvent will ensure that signals will not |
|
|
367 | interrupt your program at bad times. |
367 | |
368 | |
368 | This watcher might use C<%SIG>, so programs overwriting those signals |
369 | This watcher might use C<%SIG> (depending on the event loop used), |
369 | directly will likely not work correctly. |
370 | so programs overwriting those signals directly will likely not work |
|
|
371 | correctly. |
|
|
372 | |
|
|
373 | Also note that many event loops (e.g. Glib, Tk, Qt, IO::Async) do not |
|
|
374 | support attaching callbacks to signals, which is a pity, as you cannot do |
|
|
375 | race-free signal handling in perl. AnyEvent will try to do it's best, but |
|
|
376 | in some cases, signals will be delayed. The maximum time a signal might |
|
|
377 | be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 |
|
|
378 | seconds). This variable can be changed only before the first signal |
|
|
379 | watcher is created, and should be left alone otherwise. Higher values |
|
|
380 | will cause fewer spurious wake-ups, which is better for power and CPU |
|
|
381 | saving. All these problems can be avoided by installing the optional |
|
|
382 | L<Async::Interrupt> module. |
370 | |
383 | |
371 | Example: exit on SIGINT |
384 | Example: exit on SIGINT |
372 | |
385 | |
373 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
386 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
374 | |
387 | |
… | |
… | |
403 | |
416 | |
404 | This means you cannot create a child watcher as the very first |
417 | This means you cannot create a child watcher as the very first |
405 | thing in an AnyEvent program, you I<have> to create at least one |
418 | thing in an AnyEvent program, you I<have> to create at least one |
406 | watcher before you C<fork> the child (alternatively, you can call |
419 | watcher before you C<fork> the child (alternatively, you can call |
407 | C<AnyEvent::detect>). |
420 | C<AnyEvent::detect>). |
|
|
421 | |
|
|
422 | As most event loops do not support waiting for child events, they will be |
|
|
423 | emulated by AnyEvent in most cases, in which the latency and race problems |
|
|
424 | mentioned in the description of signal watchers apply. |
408 | |
425 | |
409 | Example: fork a process and wait for it |
426 | Example: fork a process and wait for it |
410 | |
427 | |
411 | my $done = AnyEvent->condvar; |
428 | my $done = AnyEvent->condvar; |
412 | |
429 | |
… | |
… | |
463 | |
480 | |
464 | If you are familiar with some event loops you will know that all of them |
481 | If you are familiar with some event loops you will know that all of them |
465 | require you to run some blocking "loop", "run" or similar function that |
482 | require you to run some blocking "loop", "run" or similar function that |
466 | will actively watch for new events and call your callbacks. |
483 | will actively watch for new events and call your callbacks. |
467 | |
484 | |
468 | AnyEvent is different, it expects somebody else to run the event loop and |
485 | AnyEvent is slightly different: it expects somebody else to run the event |
469 | will only block when necessary (usually when told by the user). |
486 | loop and will only block when necessary (usually when told by the user). |
470 | |
487 | |
471 | The instrument to do that is called a "condition variable", so called |
488 | The instrument to do that is called a "condition variable", so called |
472 | because they represent a condition that must become true. |
489 | because they represent a condition that must become true. |
473 | |
490 | |
|
|
491 | Now is probably a good time to look at the examples further below. |
|
|
492 | |
474 | Condition variables can be created by calling the C<< AnyEvent->condvar |
493 | Condition variables can be created by calling the C<< AnyEvent->condvar |
475 | >> method, usually without arguments. The only argument pair allowed is |
494 | >> method, usually without arguments. The only argument pair allowed is |
476 | |
|
|
477 | C<cb>, which specifies a callback to be called when the condition variable |
495 | C<cb>, which specifies a callback to be called when the condition variable |
478 | becomes true, with the condition variable as the first argument (but not |
496 | becomes true, with the condition variable as the first argument (but not |
479 | the results). |
497 | the results). |
480 | |
498 | |
481 | After creation, the condition variable is "false" until it becomes "true" |
499 | After creation, the condition variable is "false" until it becomes "true" |
… | |
… | |
530 | after => 1, |
548 | after => 1, |
531 | cb => sub { $result_ready->send }, |
549 | cb => sub { $result_ready->send }, |
532 | ); |
550 | ); |
533 | |
551 | |
534 | # this "blocks" (while handling events) till the callback |
552 | # this "blocks" (while handling events) till the callback |
535 | # calls send |
553 | # calls -<send |
536 | $result_ready->recv; |
554 | $result_ready->recv; |
537 | |
555 | |
538 | Example: wait for a timer, but take advantage of the fact that |
556 | Example: wait for a timer, but take advantage of the fact that condition |
539 | condition variables are also code references. |
557 | variables are also callable directly. |
540 | |
558 | |
541 | my $done = AnyEvent->condvar; |
559 | my $done = AnyEvent->condvar; |
542 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
560 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
543 | $done->recv; |
561 | $done->recv; |
544 | |
562 | |
… | |
… | |
550 | |
568 | |
551 | ... |
569 | ... |
552 | |
570 | |
553 | my @info = $couchdb->info->recv; |
571 | my @info = $couchdb->info->recv; |
554 | |
572 | |
555 | And this is how you would just ste a callback to be called whenever the |
573 | And this is how you would just set a callback to be called whenever the |
556 | results are available: |
574 | results are available: |
557 | |
575 | |
558 | $couchdb->info->cb (sub { |
576 | $couchdb->info->cb (sub { |
559 | my @info = $_[0]->recv; |
577 | my @info = $_[0]->recv; |
560 | }); |
578 | }); |
… | |
… | |
578 | immediately from within send. |
596 | immediately from within send. |
579 | |
597 | |
580 | Any arguments passed to the C<send> call will be returned by all |
598 | Any arguments passed to the C<send> call will be returned by all |
581 | future C<< ->recv >> calls. |
599 | future C<< ->recv >> calls. |
582 | |
600 | |
583 | Condition variables are overloaded so one can call them directly |
601 | Condition variables are overloaded so one can call them directly (as if |
584 | (as a code reference). Calling them directly is the same as calling |
602 | they were a code reference). Calling them directly is the same as calling |
585 | C<send>. Note, however, that many C-based event loops do not handle |
603 | C<send>. |
586 | overloading, so as tempting as it may be, passing a condition variable |
|
|
587 | instead of a callback does not work. Both the pure perl and EV loops |
|
|
588 | support overloading, however, as well as all functions that use perl to |
|
|
589 | invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for |
|
|
590 | example). |
|
|
591 | |
604 | |
592 | =item $cv->croak ($error) |
605 | =item $cv->croak ($error) |
593 | |
606 | |
594 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
607 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
595 | C<Carp::croak> with the given error message/object/scalar. |
608 | C<Carp::croak> with the given error message/object/scalar. |
596 | |
609 | |
597 | This can be used to signal any errors to the condition variable |
610 | This can be used to signal any errors to the condition variable |
598 | user/consumer. |
611 | user/consumer. Doing it this way instead of calling C<croak> directly |
|
|
612 | delays the error detetcion, but has the overwhelmign advantage that it |
|
|
613 | diagnoses the error at the place where the result is expected, and not |
|
|
614 | deep in some event clalback without connection to the actual code causing |
|
|
615 | the problem. |
599 | |
616 | |
600 | =item $cv->begin ([group callback]) |
617 | =item $cv->begin ([group callback]) |
601 | |
618 | |
602 | =item $cv->end |
619 | =item $cv->end |
603 | |
620 | |
… | |
… | |
699 | function will call C<croak>. |
716 | function will call C<croak>. |
700 | |
717 | |
701 | In list context, all parameters passed to C<send> will be returned, |
718 | In list context, all parameters passed to C<send> will be returned, |
702 | in scalar context only the first one will be returned. |
719 | in scalar context only the first one will be returned. |
703 | |
720 | |
|
|
721 | Note that doing a blocking wait in a callback is not supported by any |
|
|
722 | event loop, that is, recursive invocation of a blocking C<< ->recv |
|
|
723 | >> is not allowed, and the C<recv> call will C<croak> if such a |
|
|
724 | condition is detected. This condition can be slightly loosened by using |
|
|
725 | L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from |
|
|
726 | any thread that doesn't run the event loop itself. |
|
|
727 | |
704 | Not all event models support a blocking wait - some die in that case |
728 | Not all event models support a blocking wait - some die in that case |
705 | (programs might want to do that to stay interactive), so I<if you are |
729 | (programs might want to do that to stay interactive), so I<if you are |
706 | using this from a module, never require a blocking wait>, but let the |
730 | using this from a module, never require a blocking wait>. Instead, let the |
707 | caller decide whether the call will block or not (for example, by coupling |
731 | caller decide whether the call will block or not (for example, by coupling |
708 | condition variables with some kind of request results and supporting |
732 | condition variables with some kind of request results and supporting |
709 | callbacks so the caller knows that getting the result will not block, |
733 | callbacks so the caller knows that getting the result will not block, |
710 | while still supporting blocking waits if the caller so desires). |
734 | while still supporting blocking waits if the caller so desires). |
711 | |
735 | |
712 | Another reason I<never> to C<< ->recv >> in a module is that you cannot |
|
|
713 | sensibly have two C<< ->recv >>'s in parallel, as that would require |
|
|
714 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
|
|
715 | can supply. |
|
|
716 | |
|
|
717 | The L<Coro> module, however, I<can> and I<does> supply coroutines and, in |
|
|
718 | fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe |
|
|
719 | versions and also integrates coroutines into AnyEvent, making blocking |
|
|
720 | C<< ->recv >> calls perfectly safe as long as they are done from another |
|
|
721 | coroutine (one that doesn't run the event loop). |
|
|
722 | |
|
|
723 | You can ensure that C<< -recv >> never blocks by setting a callback and |
736 | You can ensure that C<< -recv >> never blocks by setting a callback and |
724 | only calling C<< ->recv >> from within that callback (or at a later |
737 | only calling C<< ->recv >> from within that callback (or at a later |
725 | time). This will work even when the event loop does not support blocking |
738 | time). This will work even when the event loop does not support blocking |
726 | waits otherwise. |
739 | waits otherwise. |
727 | |
740 | |
… | |
… | |
740 | variable itself. Calling C<recv> inside the callback or at any later time |
753 | variable itself. Calling C<recv> inside the callback or at any later time |
741 | is guaranteed not to block. |
754 | is guaranteed not to block. |
742 | |
755 | |
743 | =back |
756 | =back |
744 | |
757 | |
|
|
758 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
|
|
759 | |
|
|
760 | The available backend classes are (every class has its own manpage): |
|
|
761 | |
|
|
762 | =over 4 |
|
|
763 | |
|
|
764 | =item Backends that are autoprobed when no other event loop can be found. |
|
|
765 | |
|
|
766 | EV is the preferred backend when no other event loop seems to be in |
|
|
767 | use. If EV is not installed, then AnyEvent will try Event, and, failing |
|
|
768 | that, will fall back to its own pure-perl implementation, which is |
|
|
769 | available everywhere as it comes with AnyEvent itself. |
|
|
770 | |
|
|
771 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
|
|
772 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
|
|
773 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
|
|
774 | |
|
|
775 | =item Backends that are transparently being picked up when they are used. |
|
|
776 | |
|
|
777 | These will be used when they are currently loaded when the first watcher |
|
|
778 | is created, in which case it is assumed that the application is using |
|
|
779 | them. This means that AnyEvent will automatically pick the right backend |
|
|
780 | when the main program loads an event module before anything starts to |
|
|
781 | create watchers. Nothing special needs to be done by the main program. |
|
|
782 | |
|
|
783 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
|
|
784 | AnyEvent::Impl::Tk based on Tk, very broken. |
|
|
785 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
|
|
786 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
|
|
787 | |
|
|
788 | =item Backends with special needs. |
|
|
789 | |
|
|
790 | Qt requires the Qt::Application to be instantiated first, but will |
|
|
791 | otherwise be picked up automatically. As long as the main program |
|
|
792 | instantiates the application before any AnyEvent watchers are created, |
|
|
793 | everything should just work. |
|
|
794 | |
|
|
795 | AnyEvent::Impl::Qt based on Qt. |
|
|
796 | |
|
|
797 | Support for IO::Async can only be partial, as it is too broken and |
|
|
798 | architecturally limited to even support the AnyEvent API. It also |
|
|
799 | is the only event loop that needs the loop to be set explicitly, so |
|
|
800 | it can only be used by a main program knowing about AnyEvent. See |
|
|
801 | L<AnyEvent::Impl::Async> for the gory details. |
|
|
802 | |
|
|
803 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed. |
|
|
804 | |
|
|
805 | =item Event loops that are indirectly supported via other backends. |
|
|
806 | |
|
|
807 | Some event loops can be supported via other modules: |
|
|
808 | |
|
|
809 | There is no direct support for WxWidgets (L<Wx>) or L<Prima>. |
|
|
810 | |
|
|
811 | B<WxWidgets> has no support for watching file handles. However, you can |
|
|
812 | use WxWidgets through the POE adaptor, as POE has a Wx backend that simply |
|
|
813 | polls 20 times per second, which was considered to be too horrible to even |
|
|
814 | consider for AnyEvent. |
|
|
815 | |
|
|
816 | B<Prima> is not supported as nobody seems to be using it, but it has a POE |
|
|
817 | backend, so it can be supported through POE. |
|
|
818 | |
|
|
819 | AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to |
|
|
820 | load L<POE> when detecting them, in the hope that POE will pick them up, |
|
|
821 | in which case everything will be automatic. |
|
|
822 | |
|
|
823 | =back |
|
|
824 | |
745 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
825 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
746 | |
826 | |
|
|
827 | These are not normally required to use AnyEvent, but can be useful to |
|
|
828 | write AnyEvent extension modules. |
|
|
829 | |
747 | =over 4 |
830 | =over 4 |
748 | |
831 | |
749 | =item $AnyEvent::MODEL |
832 | =item $AnyEvent::MODEL |
750 | |
833 | |
751 | Contains C<undef> until the first watcher is being created. Then it |
834 | Contains C<undef> until the first watcher is being created, before the |
|
|
835 | backend has been autodetected. |
|
|
836 | |
752 | contains the event model that is being used, which is the name of the |
837 | Afterwards it contains the event model that is being used, which is the |
753 | Perl class implementing the model. This class is usually one of the |
838 | name of the Perl class implementing the model. This class is usually one |
754 | C<AnyEvent::Impl:xxx> modules, but can be any other class in the case |
839 | of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the |
755 | AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). |
840 | case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it |
756 | |
841 | will be C<urxvt::anyevent>). |
757 | The known classes so far are: |
|
|
758 | |
|
|
759 | AnyEvent::Impl::EV based on EV (an interface to libev, best choice). |
|
|
760 | AnyEvent::Impl::Event based on Event, second best choice. |
|
|
761 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
|
|
762 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
|
|
763 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
|
|
764 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
|
|
765 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
|
|
766 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
|
|
767 | |
|
|
768 | # warning, support for IO::Async is only partial, as it is too broken |
|
|
769 | # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async. |
|
|
770 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs). |
|
|
771 | |
|
|
772 | There is no support for WxWidgets, as WxWidgets has no support for |
|
|
773 | watching file handles. However, you can use WxWidgets through the |
|
|
774 | POE Adaptor, as POE has a Wx backend that simply polls 20 times per |
|
|
775 | second, which was considered to be too horrible to even consider for |
|
|
776 | AnyEvent. Likewise, other POE backends can be used by AnyEvent by using |
|
|
777 | it's adaptor. |
|
|
778 | |
|
|
779 | AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when |
|
|
780 | autodetecting them. |
|
|
781 | |
842 | |
782 | =item AnyEvent::detect |
843 | =item AnyEvent::detect |
783 | |
844 | |
784 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
845 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
785 | if necessary. You should only call this function right before you would |
846 | if necessary. You should only call this function right before you would |
786 | have created an AnyEvent watcher anyway, that is, as late as possible at |
847 | have created an AnyEvent watcher anyway, that is, as late as possible at |
787 | runtime. |
848 | runtime, and not e.g. while initialising of your module. |
|
|
849 | |
|
|
850 | If you need to do some initialisation before AnyEvent watchers are |
|
|
851 | created, use C<post_detect>. |
788 | |
852 | |
789 | =item $guard = AnyEvent::post_detect { BLOCK } |
853 | =item $guard = AnyEvent::post_detect { BLOCK } |
790 | |
854 | |
791 | Arranges for the code block to be executed as soon as the event model is |
855 | Arranges for the code block to be executed as soon as the event model is |
792 | autodetected (or immediately if this has already happened). |
856 | autodetected (or immediately if this has already happened). |
|
|
857 | |
|
|
858 | The block will be executed I<after> the actual backend has been detected |
|
|
859 | (C<$AnyEvent::MODEL> is set), but I<before> any watchers have been |
|
|
860 | created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do |
|
|
861 | other initialisations - see the sources of L<AnyEvent::Strict> or |
|
|
862 | L<AnyEvent::AIO> to see how this is used. |
|
|
863 | |
|
|
864 | The most common usage is to create some global watchers, without forcing |
|
|
865 | event module detection too early, for example, L<AnyEvent::AIO> creates |
|
|
866 | and installs the global L<IO::AIO> watcher in a C<post_detect> block to |
|
|
867 | avoid autodetecting the event module at load time. |
793 | |
868 | |
794 | If called in scalar or list context, then it creates and returns an object |
869 | If called in scalar or list context, then it creates and returns an object |
795 | that automatically removes the callback again when it is destroyed. See |
870 | that automatically removes the callback again when it is destroyed. See |
796 | L<Coro::BDB> for a case where this is useful. |
871 | L<Coro::BDB> for a case where this is useful. |
797 | |
872 | |
… | |
… | |
800 | If there are any code references in this array (you can C<push> to it |
875 | If there are any code references in this array (you can C<push> to it |
801 | before or after loading AnyEvent), then they will called directly after |
876 | before or after loading AnyEvent), then they will called directly after |
802 | the event loop has been chosen. |
877 | the event loop has been chosen. |
803 | |
878 | |
804 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
879 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
805 | if it contains a true value then the event loop has already been detected, |
880 | if it is defined then the event loop has already been detected, and the |
806 | and the array will be ignored. |
881 | array will be ignored. |
807 | |
882 | |
808 | Best use C<AnyEvent::post_detect { BLOCK }> instead. |
883 | Best use C<AnyEvent::post_detect { BLOCK }> when your application allows |
|
|
884 | it,as it takes care of these details. |
|
|
885 | |
|
|
886 | This variable is mainly useful for modules that can do something useful |
|
|
887 | when AnyEvent is used and thus want to know when it is initialised, but do |
|
|
888 | not need to even load it by default. This array provides the means to hook |
|
|
889 | into AnyEvent passively, without loading it. |
809 | |
890 | |
810 | =back |
891 | =back |
811 | |
892 | |
812 | =head1 WHAT TO DO IN A MODULE |
893 | =head1 WHAT TO DO IN A MODULE |
813 | |
894 | |
… | |
… | |
868 | |
949 | |
869 | |
950 | |
870 | =head1 OTHER MODULES |
951 | =head1 OTHER MODULES |
871 | |
952 | |
872 | The following is a non-exhaustive list of additional modules that use |
953 | The following is a non-exhaustive list of additional modules that use |
873 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
954 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
874 | in the same program. Some of the modules come with AnyEvent, some are |
955 | modules and other event loops in the same program. Some of the modules |
875 | available via CPAN. |
956 | come with AnyEvent, most are available via CPAN. |
876 | |
957 | |
877 | =over 4 |
958 | =over 4 |
878 | |
959 | |
879 | =item L<AnyEvent::Util> |
960 | =item L<AnyEvent::Util> |
880 | |
961 | |
… | |
… | |
889 | |
970 | |
890 | =item L<AnyEvent::Handle> |
971 | =item L<AnyEvent::Handle> |
891 | |
972 | |
892 | Provide read and write buffers, manages watchers for reads and writes, |
973 | Provide read and write buffers, manages watchers for reads and writes, |
893 | supports raw and formatted I/O, I/O queued and fully transparent and |
974 | supports raw and formatted I/O, I/O queued and fully transparent and |
894 | non-blocking SSL/TLS. |
975 | non-blocking SSL/TLS (via L<AnyEvent::TLS>. |
895 | |
976 | |
896 | =item L<AnyEvent::DNS> |
977 | =item L<AnyEvent::DNS> |
897 | |
978 | |
898 | Provides rich asynchronous DNS resolver capabilities. |
979 | Provides rich asynchronous DNS resolver capabilities. |
899 | |
980 | |
… | |
… | |
927 | |
1008 | |
928 | =item L<AnyEvent::GPSD> |
1009 | =item L<AnyEvent::GPSD> |
929 | |
1010 | |
930 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
1011 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
931 | |
1012 | |
|
|
1013 | =item L<AnyEvent::IRC> |
|
|
1014 | |
|
|
1015 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
|
|
1016 | |
|
|
1017 | =item L<AnyEvent::XMPP> |
|
|
1018 | |
|
|
1019 | AnyEvent based XMPP (Jabber protocol) module family (replacing the older |
|
|
1020 | Net::XMPP2>. |
|
|
1021 | |
932 | =item L<AnyEvent::IGS> |
1022 | =item L<AnyEvent::IGS> |
933 | |
1023 | |
934 | A non-blocking interface to the Internet Go Server protocol (used by |
1024 | A non-blocking interface to the Internet Go Server protocol (used by |
935 | L<App::IGS>). |
1025 | L<App::IGS>). |
936 | |
1026 | |
937 | =item L<AnyEvent::IRC> |
|
|
938 | |
|
|
939 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
|
|
940 | |
|
|
941 | =item L<Net::XMPP2> |
|
|
942 | |
|
|
943 | AnyEvent based XMPP (Jabber protocol) module family. |
|
|
944 | |
|
|
945 | =item L<Net::FCP> |
1027 | =item L<Net::FCP> |
946 | |
1028 | |
947 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
1029 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
948 | of AnyEvent. |
1030 | of AnyEvent. |
949 | |
1031 | |
… | |
… | |
953 | |
1035 | |
954 | =item L<Coro> |
1036 | =item L<Coro> |
955 | |
1037 | |
956 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
1038 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
957 | |
1039 | |
958 | =item L<IO::Lambda> |
|
|
959 | |
|
|
960 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
|
|
961 | |
|
|
962 | =back |
1040 | =back |
963 | |
1041 | |
964 | =cut |
1042 | =cut |
965 | |
1043 | |
966 | package AnyEvent; |
1044 | package AnyEvent; |
967 | |
1045 | |
|
|
1046 | # basically a tuned-down version of common::sense |
|
|
1047 | sub common_sense { |
968 | no warnings; |
1048 | # no warnings |
|
|
1049 | ${^WARNING_BITS} ^= ${^WARNING_BITS}; |
969 | use strict qw(vars subs); |
1050 | # use strict vars subs |
|
|
1051 | $^H |= 0x00000600; |
|
|
1052 | } |
970 | |
1053 | |
|
|
1054 | BEGIN { AnyEvent::common_sense } |
|
|
1055 | |
971 | use Carp; |
1056 | use Carp (); |
972 | |
1057 | |
973 | our $VERSION = 4.45; |
1058 | our $VERSION = 4.83; |
974 | our $MODEL; |
1059 | our $MODEL; |
975 | |
1060 | |
976 | our $AUTOLOAD; |
1061 | our $AUTOLOAD; |
977 | our @ISA; |
1062 | our @ISA; |
978 | |
1063 | |
979 | our @REGISTRY; |
1064 | our @REGISTRY; |
980 | |
1065 | |
981 | our $WIN32; |
1066 | our $WIN32; |
|
|
1067 | |
|
|
1068 | our $VERBOSE; |
982 | |
1069 | |
983 | BEGIN { |
1070 | BEGIN { |
984 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
1071 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
985 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
1072 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
986 | |
1073 | |
987 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1074 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
988 | if ${^TAINT}; |
1075 | if ${^TAINT}; |
989 | } |
|
|
990 | |
1076 | |
991 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1077 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
|
|
1078 | |
|
|
1079 | } |
|
|
1080 | |
|
|
1081 | our $MAX_SIGNAL_LATENCY = 10; |
992 | |
1082 | |
993 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1083 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
994 | |
1084 | |
995 | { |
1085 | { |
996 | my $idx; |
1086 | my $idx; |
… | |
… | |
1004 | [Event:: => AnyEvent::Impl::Event::], |
1094 | [Event:: => AnyEvent::Impl::Event::], |
1005 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
1095 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
1006 | # everything below here will not be autoprobed |
1096 | # everything below here will not be autoprobed |
1007 | # as the pureperl backend should work everywhere |
1097 | # as the pureperl backend should work everywhere |
1008 | # and is usually faster |
1098 | # and is usually faster |
1009 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
|
|
1010 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
1099 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
1011 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1100 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
|
|
1101 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1012 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1102 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1013 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1103 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1014 | [Wx:: => AnyEvent::Impl::POE::], |
1104 | [Wx:: => AnyEvent::Impl::POE::], |
1015 | [Prima:: => AnyEvent::Impl::POE::], |
1105 | [Prima:: => AnyEvent::Impl::POE::], |
1016 | # IO::Async is just too broken - we would need workaorunds for its |
1106 | # IO::Async is just too broken - we would need workarounds for its |
1017 | # byzantine signal and broken child handling, among others. |
1107 | # byzantine signal and broken child handling, among others. |
1018 | # IO::Async is rather hard to detect, as it doesn't have any |
1108 | # IO::Async is rather hard to detect, as it doesn't have any |
1019 | # obvious default class. |
1109 | # obvious default class. |
1020 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1110 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1021 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1111 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
… | |
… | |
1047 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1137 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1048 | } |
1138 | } |
1049 | |
1139 | |
1050 | sub detect() { |
1140 | sub detect() { |
1051 | unless ($MODEL) { |
1141 | unless ($MODEL) { |
1052 | no strict 'refs'; |
|
|
1053 | local $SIG{__DIE__}; |
1142 | local $SIG{__DIE__}; |
1054 | |
1143 | |
1055 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1144 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1056 | my $model = "AnyEvent::Impl::$1"; |
1145 | my $model = "AnyEvent::Impl::$1"; |
1057 | if (eval "require $model") { |
1146 | if (eval "require $model") { |
1058 | $MODEL = $model; |
1147 | $MODEL = $model; |
1059 | warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; |
1148 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
1060 | } else { |
1149 | } else { |
1061 | warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; |
1150 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
1062 | } |
1151 | } |
1063 | } |
1152 | } |
1064 | |
1153 | |
1065 | # check for already loaded models |
1154 | # check for already loaded models |
1066 | unless ($MODEL) { |
1155 | unless ($MODEL) { |
1067 | for (@REGISTRY, @models) { |
1156 | for (@REGISTRY, @models) { |
1068 | my ($package, $model) = @$_; |
1157 | my ($package, $model) = @$_; |
1069 | if (${"$package\::VERSION"} > 0) { |
1158 | if (${"$package\::VERSION"} > 0) { |
1070 | if (eval "require $model") { |
1159 | if (eval "require $model") { |
1071 | $MODEL = $model; |
1160 | $MODEL = $model; |
1072 | warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; |
1161 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
1073 | last; |
1162 | last; |
1074 | } |
1163 | } |
1075 | } |
1164 | } |
1076 | } |
1165 | } |
1077 | |
1166 | |
… | |
… | |
1082 | my ($package, $model) = @$_; |
1171 | my ($package, $model) = @$_; |
1083 | if (eval "require $package" |
1172 | if (eval "require $package" |
1084 | and ${"$package\::VERSION"} > 0 |
1173 | and ${"$package\::VERSION"} > 0 |
1085 | and eval "require $model") { |
1174 | and eval "require $model") { |
1086 | $MODEL = $model; |
1175 | $MODEL = $model; |
1087 | warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; |
1176 | warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; |
1088 | last; |
1177 | last; |
1089 | } |
1178 | } |
1090 | } |
1179 | } |
1091 | |
1180 | |
1092 | $MODEL |
1181 | $MODEL |
… | |
… | |
1108 | |
1197 | |
1109 | sub AUTOLOAD { |
1198 | sub AUTOLOAD { |
1110 | (my $func = $AUTOLOAD) =~ s/.*://; |
1199 | (my $func = $AUTOLOAD) =~ s/.*://; |
1111 | |
1200 | |
1112 | $method{$func} |
1201 | $method{$func} |
1113 | or croak "$func: not a valid method for AnyEvent objects"; |
1202 | or Carp::croak "$func: not a valid method for AnyEvent objects"; |
1114 | |
1203 | |
1115 | detect unless $MODEL; |
1204 | detect unless $MODEL; |
1116 | |
1205 | |
1117 | my $class = shift; |
1206 | my $class = shift; |
1118 | $class->$func (@_); |
1207 | $class->$func (@_); |
… | |
… | |
1123 | # allow only one watcher per fd, so we dup it to get a different one). |
1212 | # allow only one watcher per fd, so we dup it to get a different one). |
1124 | sub _dupfh($$;$$) { |
1213 | sub _dupfh($$;$$) { |
1125 | my ($poll, $fh, $r, $w) = @_; |
1214 | my ($poll, $fh, $r, $w) = @_; |
1126 | |
1215 | |
1127 | # cygwin requires the fh mode to be matching, unix doesn't |
1216 | # cygwin requires the fh mode to be matching, unix doesn't |
1128 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
1217 | my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&"); |
1129 | : $poll eq "w" ? ($w, ">") |
|
|
1130 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
|
|
1131 | |
1218 | |
1132 | open my $fh2, "$mode&" . fileno $fh |
1219 | open my $fh2, $mode, $fh |
1133 | or die "cannot dup() filehandle: $!,"; |
1220 | or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,"; |
1134 | |
1221 | |
1135 | # we assume CLOEXEC is already set by perl in all important cases |
1222 | # we assume CLOEXEC is already set by perl in all important cases |
1136 | |
1223 | |
1137 | ($fh2, $rw) |
1224 | ($fh2, $rw) |
1138 | } |
1225 | } |
1139 | |
1226 | |
1140 | package AnyEvent::Base; |
1227 | package AnyEvent::Base; |
1141 | |
1228 | |
1142 | # default implementations for many methods |
1229 | # default implementations for many methods |
1143 | |
1230 | |
1144 | BEGIN { |
1231 | sub _time { |
|
|
1232 | # probe for availability of Time::HiRes |
1145 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1233 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
|
|
1234 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1146 | *_time = \&Time::HiRes::time; |
1235 | *_time = \&Time::HiRes::time; |
1147 | # if (eval "use POSIX (); (POSIX::times())... |
1236 | # if (eval "use POSIX (); (POSIX::times())... |
1148 | } else { |
1237 | } else { |
|
|
1238 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1149 | *_time = sub { time }; # epic fail |
1239 | *_time = sub { time }; # epic fail |
1150 | } |
1240 | } |
|
|
1241 | |
|
|
1242 | &_time |
1151 | } |
1243 | } |
1152 | |
1244 | |
1153 | sub time { _time } |
1245 | sub time { _time } |
1154 | sub now { _time } |
1246 | sub now { _time } |
1155 | sub now_update { } |
1247 | sub now_update { } |
… | |
… | |
1160 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1252 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1161 | } |
1253 | } |
1162 | |
1254 | |
1163 | # default implementation for ->signal |
1255 | # default implementation for ->signal |
1164 | |
1256 | |
|
|
1257 | our $HAVE_ASYNC_INTERRUPT; |
1165 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1258 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
|
|
1259 | our (%SIG_ASY, %SIG_ASY_W); |
|
|
1260 | our ($SIG_COUNT, $SIG_TW); |
1166 | |
1261 | |
1167 | sub _signal_exec { |
1262 | sub _signal_exec { |
|
|
1263 | $HAVE_ASYNC_INTERRUPT |
|
|
1264 | ? $SIGPIPE_R->drain |
1168 | sysread $SIGPIPE_R, my $dummy, 4; |
1265 | : sysread $SIGPIPE_R, my $dummy, 9; |
1169 | |
1266 | |
1170 | while (%SIG_EV) { |
1267 | while (%SIG_EV) { |
1171 | for (keys %SIG_EV) { |
1268 | for (keys %SIG_EV) { |
1172 | delete $SIG_EV{$_}; |
1269 | delete $SIG_EV{$_}; |
1173 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1270 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1174 | } |
1271 | } |
1175 | } |
1272 | } |
1176 | } |
1273 | } |
1177 | |
1274 | |
|
|
1275 | sub _signal { |
|
|
1276 | my (undef, %arg) = @_; |
|
|
1277 | |
|
|
1278 | my $signal = uc $arg{signal} |
|
|
1279 | or Carp::croak "required option 'signal' is missing"; |
|
|
1280 | |
|
|
1281 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1282 | |
|
|
1283 | if ($HAVE_ASYNC_INTERRUPT) { |
|
|
1284 | # async::interrupt |
|
|
1285 | |
|
|
1286 | $SIG_ASY{$signal} ||= do { |
|
|
1287 | my $asy = new Async::Interrupt |
|
|
1288 | cb => sub { undef $SIG_EV{$signal} }, |
|
|
1289 | signal => $signal, |
|
|
1290 | pipe => [$SIGPIPE_R->filenos], |
|
|
1291 | ; |
|
|
1292 | $asy->pipe_autodrain (0); |
|
|
1293 | |
|
|
1294 | $asy |
|
|
1295 | }; |
|
|
1296 | |
|
|
1297 | } else { |
|
|
1298 | # pure perl |
|
|
1299 | |
|
|
1300 | $SIG{$signal} ||= sub { |
|
|
1301 | local $!; |
|
|
1302 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
|
|
1303 | undef $SIG_EV{$signal}; |
|
|
1304 | }; |
|
|
1305 | |
|
|
1306 | # can't do signal processing without introducing races in pure perl, |
|
|
1307 | # so limit the signal latency. |
|
|
1308 | ++$SIG_COUNT; |
|
|
1309 | $SIG_TW ||= AnyEvent->timer ( |
|
|
1310 | after => $MAX_SIGNAL_LATENCY, |
|
|
1311 | interval => $MAX_SIGNAL_LATENCY, |
|
|
1312 | cb => sub { }, # just for the PERL_ASYNC_CHECK |
|
|
1313 | ); |
|
|
1314 | } |
|
|
1315 | |
|
|
1316 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1317 | } |
|
|
1318 | |
1178 | sub signal { |
1319 | sub signal { |
1179 | my (undef, %arg) = @_; |
1320 | # probe for availability of Async::Interrupt |
|
|
1321 | if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") { |
|
|
1322 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
1180 | |
1323 | |
1181 | unless ($SIGPIPE_R) { |
1324 | $HAVE_ASYNC_INTERRUPT = 1; |
|
|
1325 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
|
|
1326 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); |
|
|
1327 | |
|
|
1328 | } else { |
|
|
1329 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
|
|
1330 | |
1182 | require Fcntl; |
1331 | require Fcntl; |
1183 | |
1332 | |
1184 | if (AnyEvent::WIN32) { |
1333 | if (AnyEvent::WIN32) { |
1185 | require AnyEvent::Util; |
1334 | require AnyEvent::Util; |
1186 | |
1335 | |
… | |
… | |
1201 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
1350 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
1202 | |
1351 | |
1203 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
1352 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
1204 | } |
1353 | } |
1205 | |
1354 | |
1206 | my $signal = uc $arg{signal} |
1355 | *signal = \&_signal; |
1207 | or Carp::croak "required option 'signal' is missing"; |
1356 | &signal |
1208 | |
|
|
1209 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1210 | $SIG{$signal} ||= sub { |
|
|
1211 | local $!; |
|
|
1212 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
|
|
1213 | undef $SIG_EV{$signal}; |
|
|
1214 | }; |
|
|
1215 | |
|
|
1216 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1217 | } |
1357 | } |
1218 | |
1358 | |
1219 | sub AnyEvent::Base::signal::DESTROY { |
1359 | sub AnyEvent::Base::signal::DESTROY { |
1220 | my ($signal, $cb) = @{$_[0]}; |
1360 | my ($signal, $cb) = @{$_[0]}; |
|
|
1361 | |
|
|
1362 | undef $SIG_TW |
|
|
1363 | unless --$SIG_COUNT; |
1221 | |
1364 | |
1222 | delete $SIG_CB{$signal}{$cb}; |
1365 | delete $SIG_CB{$signal}{$cb}; |
1223 | |
1366 | |
1224 | # delete doesn't work with older perls - they then |
1367 | # delete doesn't work with older perls - they then |
1225 | # print weird messages, or just unconditionally exit |
1368 | # print weird messages, or just unconditionally exit |
1226 | # instead of getting the default action. |
1369 | # instead of getting the default action. |
|
|
1370 | undef $SIG{$signal} |
1227 | undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
1371 | unless keys %{ $SIG_CB{$signal} }; |
1228 | } |
1372 | } |
1229 | |
1373 | |
1230 | # default implementation for ->child |
1374 | # default implementation for ->child |
1231 | |
1375 | |
1232 | our %PID_CB; |
1376 | our %PID_CB; |
… | |
… | |
1234 | our $CHLD_DELAY_W; |
1378 | our $CHLD_DELAY_W; |
1235 | our $WNOHANG; |
1379 | our $WNOHANG; |
1236 | |
1380 | |
1237 | sub _sigchld { |
1381 | sub _sigchld { |
1238 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1382 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
|
|
1383 | $_->($pid, $?) |
1239 | $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), |
1384 | for values %{ $PID_CB{$pid} || {} }, |
1240 | (values %{ $PID_CB{0} || {} }); |
1385 | values %{ $PID_CB{0} || {} }; |
1241 | } |
1386 | } |
1242 | } |
1387 | } |
1243 | |
1388 | |
1244 | sub child { |
1389 | sub child { |
1245 | my (undef, %arg) = @_; |
1390 | my (undef, %arg) = @_; |
… | |
… | |
1247 | defined (my $pid = $arg{pid} + 0) |
1392 | defined (my $pid = $arg{pid} + 0) |
1248 | or Carp::croak "required option 'pid' is missing"; |
1393 | or Carp::croak "required option 'pid' is missing"; |
1249 | |
1394 | |
1250 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1395 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1251 | |
1396 | |
|
|
1397 | # WNOHANG is almost cetrainly 1 everywhere |
|
|
1398 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
|
|
1399 | ? 1 |
1252 | $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1400 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1253 | |
1401 | |
1254 | unless ($CHLD_W) { |
1402 | unless ($CHLD_W) { |
1255 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1403 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1256 | # child could be a zombie already, so make at least one round |
1404 | # child could be a zombie already, so make at least one round |
1257 | &_sigchld; |
1405 | &_sigchld; |
… | |
… | |
1309 | |
1457 | |
1310 | our @ISA = AnyEvent::CondVar::Base::; |
1458 | our @ISA = AnyEvent::CondVar::Base::; |
1311 | |
1459 | |
1312 | package AnyEvent::CondVar::Base; |
1460 | package AnyEvent::CondVar::Base; |
1313 | |
1461 | |
1314 | use overload |
1462 | #use overload |
1315 | '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
1463 | # '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
1316 | fallback => 1; |
1464 | # fallback => 1; |
|
|
1465 | |
|
|
1466 | # save 300+ kilobytes by dirtily hardcoding overloading |
|
|
1467 | ${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching. |
|
|
1468 | *{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod." |
|
|
1469 | *{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{} |
|
|
1470 | ${'AnyEvent::CondVar::Base::()'} = 1; # fallback |
|
|
1471 | |
|
|
1472 | our $WAITING; |
1317 | |
1473 | |
1318 | sub _send { |
1474 | sub _send { |
1319 | # nop |
1475 | # nop |
1320 | } |
1476 | } |
1321 | |
1477 | |
… | |
… | |
1334 | sub ready { |
1490 | sub ready { |
1335 | $_[0]{_ae_sent} |
1491 | $_[0]{_ae_sent} |
1336 | } |
1492 | } |
1337 | |
1493 | |
1338 | sub _wait { |
1494 | sub _wait { |
|
|
1495 | $WAITING |
|
|
1496 | and !$_[0]{_ae_sent} |
|
|
1497 | and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected"; |
|
|
1498 | |
|
|
1499 | local $WAITING = 1; |
1339 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
1500 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
1340 | } |
1501 | } |
1341 | |
1502 | |
1342 | sub recv { |
1503 | sub recv { |
1343 | $_[0]->_wait; |
1504 | $_[0]->_wait; |
… | |
… | |
1415 | check the arguments passed to most method calls. If it finds any problems, |
1576 | check the arguments passed to most method calls. If it finds any problems, |
1416 | it will croak. |
1577 | it will croak. |
1417 | |
1578 | |
1418 | In other words, enables "strict" mode. |
1579 | In other words, enables "strict" mode. |
1419 | |
1580 | |
1420 | Unlike C<use strict>, it is definitely recommended to keep it off in |
1581 | Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense> |
1421 | production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while |
1582 | >>, it is definitely recommended to keep it off in production. Keeping |
1422 | developing programs can be very useful, however. |
1583 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
|
|
1584 | can be very useful, however. |
1423 | |
1585 | |
1424 | =item C<PERL_ANYEVENT_MODEL> |
1586 | =item C<PERL_ANYEVENT_MODEL> |
1425 | |
1587 | |
1426 | This can be used to specify the event model to be used by AnyEvent, before |
1588 | This can be used to specify the event model to be used by AnyEvent, before |
1427 | auto detection and -probing kicks in. It must be a string consisting |
1589 | auto detection and -probing kicks in. It must be a string consisting |
… | |
… | |
1470 | |
1632 | |
1471 | =item C<PERL_ANYEVENT_MAX_FORKS> |
1633 | =item C<PERL_ANYEVENT_MAX_FORKS> |
1472 | |
1634 | |
1473 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
1635 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
1474 | will create in parallel. |
1636 | will create in parallel. |
|
|
1637 | |
|
|
1638 | =item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS> |
|
|
1639 | |
|
|
1640 | The default value for the C<max_outstanding> parameter for the default DNS |
|
|
1641 | resolver - this is the maximum number of parallel DNS requests that are |
|
|
1642 | sent to the DNS server. |
|
|
1643 | |
|
|
1644 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
|
|
1645 | |
|
|
1646 | The file to use instead of F</etc/resolv.conf> (or OS-specific |
|
|
1647 | configuration) in the default resolver. When set to the empty string, no |
|
|
1648 | default config will be used. |
|
|
1649 | |
|
|
1650 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
|
|
1651 | |
|
|
1652 | When neither C<ca_file> nor C<ca_path> was specified during |
|
|
1653 | L<AnyEvent::TLS> context creation, and either of these environment |
|
|
1654 | variables exist, they will be used to specify CA certificate locations |
|
|
1655 | instead of a system-dependent default. |
1475 | |
1656 | |
1476 | =back |
1657 | =back |
1477 | |
1658 | |
1478 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1659 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1479 | |
1660 | |
… | |
… | |
2018 | |
2199 | |
2019 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
2200 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
2020 | emulation for event loops that do not support them natively. Also, some |
2201 | emulation for event loops that do not support them natively. Also, some |
2021 | event loops install a similar handler. |
2202 | event loops install a similar handler. |
2022 | |
2203 | |
2023 | If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will |
2204 | Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then |
2024 | reset it to default, to avoid losing child exit statuses. |
2205 | AnyEvent will reset it to default, to avoid losing child exit statuses. |
2025 | |
2206 | |
2026 | =item SIGPIPE |
2207 | =item SIGPIPE |
2027 | |
2208 | |
2028 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
2209 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
2029 | when AnyEvent gets loaded. |
2210 | when AnyEvent gets loaded. |
… | |
… | |
2047 | if $SIG{CHLD} eq 'IGNORE'; |
2228 | if $SIG{CHLD} eq 'IGNORE'; |
2048 | |
2229 | |
2049 | $SIG{PIPE} = sub { } |
2230 | $SIG{PIPE} = sub { } |
2050 | unless defined $SIG{PIPE}; |
2231 | unless defined $SIG{PIPE}; |
2051 | |
2232 | |
|
|
2233 | =head1 RECOMMENDED/OPTIONAL MODULES |
|
|
2234 | |
|
|
2235 | One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and |
|
|
2236 | it's built-in modules) are required to use it. |
|
|
2237 | |
|
|
2238 | That does not mean that AnyEvent won't take advantage of some additional |
|
|
2239 | modules if they are installed. |
|
|
2240 | |
|
|
2241 | This section epxlains which additional modules will be used, and how they |
|
|
2242 | affect AnyEvent's operetion. |
|
|
2243 | |
|
|
2244 | =over 4 |
|
|
2245 | |
|
|
2246 | =item L<Async::Interrupt> |
|
|
2247 | |
|
|
2248 | This slightly arcane module is used to implement fast signal handling: To |
|
|
2249 | my knowledge, there is no way to do completely race-free and quick |
|
|
2250 | signal handling in pure perl. To ensure that signals still get |
|
|
2251 | delivered, AnyEvent will start an interval timer to wake up perl (and |
|
|
2252 | catch the signals) with soemd elay (default is 10 seconds, look for |
|
|
2253 | C<$AnyEvent::MAX_SIGNAL_LATENCY>). |
|
|
2254 | |
|
|
2255 | If this module is available, then it will be used to implement signal |
|
|
2256 | catching, which means that signals will not be delayed, and the event loop |
|
|
2257 | will not be interrupted regularly, which is more efficient (And good for |
|
|
2258 | battery life on laptops). |
|
|
2259 | |
|
|
2260 | This affects not just the pure-perl event loop, but also other event loops |
|
|
2261 | that have no signal handling on their own (e.g. Glib, Tk, Qt). |
|
|
2262 | |
|
|
2263 | =item L<EV> |
|
|
2264 | |
|
|
2265 | This module isn't really "optional", as it is simply one of the backend |
|
|
2266 | event loops that AnyEvent can use. However, it is simply the best event |
|
|
2267 | loop available in terms of features, speed and stability: It supports |
|
|
2268 | the AnyEvent API optimally, implements all the watcher types in XS, does |
|
|
2269 | automatic timer adjustments even when no monotonic clock is available, |
|
|
2270 | can take avdantage of advanced kernel interfaces such as C<epoll> and |
|
|
2271 | C<kqueue>, and is the fastest backend I<by far>. You can even embed |
|
|
2272 | L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). |
|
|
2273 | |
|
|
2274 | =item L<Guard> |
|
|
2275 | |
|
|
2276 | The guard module, when used, will be used to implement |
|
|
2277 | C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a |
|
|
2278 | lot less memory), but otherwise doesn't affect guard operation much. It is |
|
|
2279 | purely used for performance. |
|
|
2280 | |
|
|
2281 | =item L<JSON> and L<JSON::XS> |
|
|
2282 | |
|
|
2283 | This module is required when you want to read or write JSON data via |
|
|
2284 | L<AnyEvent::Handle>. It is also written in pure-perl, but can take |
|
|
2285 | advantage of the ulta-high-speed L<JSON::XS> module when it is installed. |
|
|
2286 | |
|
|
2287 | In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is |
|
|
2288 | installed. |
|
|
2289 | |
|
|
2290 | =item L<Net::SSLeay> |
|
|
2291 | |
|
|
2292 | Implementing TLS/SSL in Perl is certainly interesting, but not very |
|
|
2293 | worthwhile: If this module is installed, then L<AnyEvent::Handle> (with |
|
|
2294 | the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. |
|
|
2295 | |
|
|
2296 | =item L<Time::HiRes> |
|
|
2297 | |
|
|
2298 | This module is part of perl since release 5.008. It will be used when the |
|
|
2299 | chosen event library does not come with a timing source on it's own. The |
|
|
2300 | pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to |
|
|
2301 | try to use a monotonic clock for timing stability. |
|
|
2302 | |
|
|
2303 | =back |
|
|
2304 | |
|
|
2305 | |
2052 | =head1 FORK |
2306 | =head1 FORK |
2053 | |
2307 | |
2054 | Most event libraries are not fork-safe. The ones who are usually are |
2308 | Most event libraries are not fork-safe. The ones who are usually are |
2055 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2309 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2056 | calls. Only L<EV> is fully fork-aware. |
2310 | calls. Only L<EV> is fully fork-aware. |
2057 | |
2311 | |
2058 | If you have to fork, you must either do so I<before> creating your first |
2312 | If you have to fork, you must either do so I<before> creating your first |
2059 | watcher OR you must not use AnyEvent at all in the child. |
2313 | watcher OR you must not use AnyEvent at all in the child OR you must do |
|
|
2314 | something completely out of the scope of AnyEvent. |
2060 | |
2315 | |
2061 | |
2316 | |
2062 | =head1 SECURITY CONSIDERATIONS |
2317 | =head1 SECURITY CONSIDERATIONS |
2063 | |
2318 | |
2064 | AnyEvent can be forced to load any event model via |
2319 | AnyEvent can be forced to load any event model via |
… | |
… | |
2102 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2357 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2103 | |
2358 | |
2104 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2359 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2105 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2360 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2106 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2361 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2107 | L<AnyEvent::Impl::POE>. |
2362 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. |
2108 | |
2363 | |
2109 | Non-blocking file handles, sockets, TCP clients and |
2364 | Non-blocking file handles, sockets, TCP clients and |
2110 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. |
2365 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2111 | |
2366 | |
2112 | Asynchronous DNS: L<AnyEvent::DNS>. |
2367 | Asynchronous DNS: L<AnyEvent::DNS>. |
2113 | |
2368 | |
2114 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, |
2369 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, |
|
|
2370 | L<Coro::Event>, |
2115 | |
2371 | |
2116 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
2372 | Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, |
|
|
2373 | L<AnyEvent::HTTP>. |
2117 | |
2374 | |
2118 | |
2375 | |
2119 | =head1 AUTHOR |
2376 | =head1 AUTHOR |
2120 | |
2377 | |
2121 | Marc Lehmann <schmorp@schmorp.de> |
2378 | Marc Lehmann <schmorp@schmorp.de> |