… | |
… | |
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, see below) to |
181 | C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch |
182 | watch for events (AnyEvent might or might not keep a reference to this |
182 | for events (AnyEvent might or might not keep a reference to this file |
183 | file 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. |
187 | |
187 | |
188 | C<poll> must be a string that is either C<r> or C<w>, which creates a |
188 | C<poll> must be a string that is either C<r> or C<w>, which creates a |
… | |
… | |
209 | chomp (my $input = <STDIN>); |
209 | chomp (my $input = <STDIN>); |
210 | warn "read: $input\n"; |
210 | warn "read: $input\n"; |
211 | undef $w; |
211 | undef $w; |
212 | }); |
212 | }); |
213 | |
213 | |
214 | =head3 GETTING A FILE HANDLE FROM A FILE DESCRIPTOR |
|
|
215 | |
|
|
216 | It is not uncommon to only have a file descriptor, while AnyEvent requires |
|
|
217 | a Perl file handle. |
|
|
218 | |
|
|
219 | There are basically two methods to convert a file descriptor into a file handle. If you own |
|
|
220 | the file descriptor, you can open it with C<&=>, as in: |
|
|
221 | |
|
|
222 | open my $fh, "<&=$fileno" or die "xxx: ยง!"; |
|
|
223 | |
|
|
224 | This will "own" the file descriptor, meaning that when C<$fh> is |
|
|
225 | destroyed, it will automatically close the C<$fileno>. Also, note that |
|
|
226 | the open mode (read, write, read/write) must correspond with how the |
|
|
227 | underlying file descriptor was opened. |
|
|
228 | |
|
|
229 | In many cases, taking over the file descriptor is now what you want, in |
|
|
230 | which case the only alternative is to dup the file descriptor: |
|
|
231 | |
|
|
232 | open my $fh, "<&$fileno" or die "xxx: $!"; |
|
|
233 | |
|
|
234 | This has the advantage of not closing the file descriptor and the |
|
|
235 | disadvantage of making a slow copy. |
|
|
236 | |
|
|
237 | =head2 TIME WATCHERS |
214 | =head2 TIME WATCHERS |
238 | |
215 | |
239 | You can create a time watcher by calling the C<< AnyEvent->timer >> |
216 | You can create a time watcher by calling the C<< AnyEvent->timer >> |
240 | method with the following mandatory arguments: |
217 | method with the following mandatory arguments: |
241 | |
218 | |
… | |
… | |
384 | invocation, and callback invocation will be synchronous. Synchronous means |
361 | invocation, and callback invocation will be synchronous. Synchronous means |
385 | 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, |
386 | but it is guaranteed not to interrupt any other callbacks. |
363 | but it is guaranteed not to interrupt any other callbacks. |
387 | |
364 | |
388 | 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 |
389 | between multiple watchers. |
366 | between multiple watchers, and AnyEvent will ensure that signals will not |
|
|
367 | interrupt your program at bad times. |
390 | |
368 | |
391 | This watcher might use C<%SIG>, so programs overwriting those signals |
369 | This watcher might use C<%SIG> (depending on the event loop used), |
392 | 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. |
393 | |
383 | |
394 | Example: exit on SIGINT |
384 | Example: exit on SIGINT |
395 | |
385 | |
396 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
386 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
397 | |
387 | |
… | |
… | |
426 | |
416 | |
427 | 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 |
428 | 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 |
429 | watcher before you C<fork> the child (alternatively, you can call |
419 | watcher before you C<fork> the child (alternatively, you can call |
430 | 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. |
431 | |
425 | |
432 | Example: fork a process and wait for it |
426 | Example: fork a process and wait for it |
433 | |
427 | |
434 | my $done = AnyEvent->condvar; |
428 | my $done = AnyEvent->condvar; |
435 | |
429 | |
… | |
… | |
486 | |
480 | |
487 | 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 |
488 | 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 |
489 | will actively watch for new events and call your callbacks. |
483 | will actively watch for new events and call your callbacks. |
490 | |
484 | |
491 | 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 |
492 | 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). |
493 | |
487 | |
494 | 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 |
495 | because they represent a condition that must become true. |
489 | because they represent a condition that must become true. |
496 | |
490 | |
|
|
491 | Now is probably a good time to look at the examples further below. |
|
|
492 | |
497 | Condition variables can be created by calling the C<< AnyEvent->condvar |
493 | Condition variables can be created by calling the C<< AnyEvent->condvar |
498 | >> method, usually without arguments. The only argument pair allowed is |
494 | >> method, usually without arguments. The only argument pair allowed is |
499 | |
|
|
500 | 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 |
501 | 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 |
502 | the results). |
497 | the results). |
503 | |
498 | |
504 | After creation, the condition variable is "false" until it becomes "true" |
499 | After creation, the condition variable is "false" until it becomes "true" |
… | |
… | |
553 | after => 1, |
548 | after => 1, |
554 | cb => sub { $result_ready->send }, |
549 | cb => sub { $result_ready->send }, |
555 | ); |
550 | ); |
556 | |
551 | |
557 | # this "blocks" (while handling events) till the callback |
552 | # this "blocks" (while handling events) till the callback |
558 | # calls send |
553 | # calls -<send |
559 | $result_ready->recv; |
554 | $result_ready->recv; |
560 | |
555 | |
561 | 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 |
562 | condition variables are also code references. |
557 | variables are also callable directly. |
563 | |
558 | |
564 | my $done = AnyEvent->condvar; |
559 | my $done = AnyEvent->condvar; |
565 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
560 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
566 | $done->recv; |
561 | $done->recv; |
567 | |
562 | |
… | |
… | |
573 | |
568 | |
574 | ... |
569 | ... |
575 | |
570 | |
576 | my @info = $couchdb->info->recv; |
571 | my @info = $couchdb->info->recv; |
577 | |
572 | |
578 | 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 |
579 | results are available: |
574 | results are available: |
580 | |
575 | |
581 | $couchdb->info->cb (sub { |
576 | $couchdb->info->cb (sub { |
582 | my @info = $_[0]->recv; |
577 | my @info = $_[0]->recv; |
583 | }); |
578 | }); |
… | |
… | |
601 | immediately from within send. |
596 | immediately from within send. |
602 | |
597 | |
603 | 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 |
604 | future C<< ->recv >> calls. |
599 | future C<< ->recv >> calls. |
605 | |
600 | |
606 | Condition variables are overloaded so one can call them directly |
601 | Condition variables are overloaded so one can call them directly (as if |
607 | (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 |
608 | C<send>. Note, however, that many C-based event loops do not handle |
603 | C<send>. |
609 | overloading, so as tempting as it may be, passing a condition variable |
|
|
610 | instead of a callback does not work. Both the pure perl and EV loops |
|
|
611 | support overloading, however, as well as all functions that use perl to |
|
|
612 | invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for |
|
|
613 | example). |
|
|
614 | |
604 | |
615 | =item $cv->croak ($error) |
605 | =item $cv->croak ($error) |
616 | |
606 | |
617 | 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 |
618 | C<Carp::croak> with the given error message/object/scalar. |
608 | C<Carp::croak> with the given error message/object/scalar. |
619 | |
609 | |
620 | 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 |
621 | 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. |
622 | |
616 | |
623 | =item $cv->begin ([group callback]) |
617 | =item $cv->begin ([group callback]) |
624 | |
618 | |
625 | =item $cv->end |
619 | =item $cv->end |
626 | |
620 | |
… | |
… | |
722 | function will call C<croak>. |
716 | function will call C<croak>. |
723 | |
717 | |
724 | 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, |
725 | in scalar context only the first one will be returned. |
719 | in scalar context only the first one will be returned. |
726 | |
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 | |
727 | 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 |
728 | (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 |
729 | 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 |
730 | 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 |
731 | condition variables with some kind of request results and supporting |
732 | condition variables with some kind of request results and supporting |
732 | 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, |
733 | while still supporting blocking waits if the caller so desires). |
734 | while still supporting blocking waits if the caller so desires). |
734 | |
735 | |
735 | Another reason I<never> to C<< ->recv >> in a module is that you cannot |
|
|
736 | sensibly have two C<< ->recv >>'s in parallel, as that would require |
|
|
737 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
|
|
738 | can supply. |
|
|
739 | |
|
|
740 | The L<Coro> module, however, I<can> and I<does> supply coroutines and, in |
|
|
741 | fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe |
|
|
742 | versions and also integrates coroutines into AnyEvent, making blocking |
|
|
743 | C<< ->recv >> calls perfectly safe as long as they are done from another |
|
|
744 | coroutine (one that doesn't run the event loop). |
|
|
745 | |
|
|
746 | 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 |
747 | 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 |
748 | 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 |
749 | waits otherwise. |
739 | waits otherwise. |
750 | |
740 | |
… | |
… | |
763 | 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 |
764 | is guaranteed not to block. |
754 | is guaranteed not to block. |
765 | |
755 | |
766 | =back |
756 | =back |
767 | |
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 | |
768 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
825 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
769 | |
826 | |
|
|
827 | These are not normally required to use AnyEvent, but can be useful to |
|
|
828 | write AnyEvent extension modules. |
|
|
829 | |
770 | =over 4 |
830 | =over 4 |
771 | |
831 | |
772 | =item $AnyEvent::MODEL |
832 | =item $AnyEvent::MODEL |
773 | |
833 | |
774 | 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 | |
775 | 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 |
776 | 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 |
777 | 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 |
778 | 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 |
779 | |
841 | will be C<urxvt::anyevent>). |
780 | The known classes so far are: |
|
|
781 | |
|
|
782 | AnyEvent::Impl::EV based on EV (an interface to libev, best choice). |
|
|
783 | AnyEvent::Impl::Event based on Event, second best choice. |
|
|
784 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
|
|
785 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
|
|
786 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
|
|
787 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
|
|
788 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
|
|
789 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
|
|
790 | |
|
|
791 | # warning, support for IO::Async is only partial, as it is too broken |
|
|
792 | # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async. |
|
|
793 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs). |
|
|
794 | |
|
|
795 | There is no support for WxWidgets, as WxWidgets has no support for |
|
|
796 | watching file handles. However, you can use WxWidgets through the |
|
|
797 | POE Adaptor, as POE has a Wx backend that simply polls 20 times per |
|
|
798 | second, which was considered to be too horrible to even consider for |
|
|
799 | AnyEvent. Likewise, other POE backends can be used by AnyEvent by using |
|
|
800 | it's adaptor. |
|
|
801 | |
|
|
802 | AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when |
|
|
803 | autodetecting them. |
|
|
804 | |
842 | |
805 | =item AnyEvent::detect |
843 | =item AnyEvent::detect |
806 | |
844 | |
807 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
845 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
808 | 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 |
809 | 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 |
810 | 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>. |
811 | |
852 | |
812 | =item $guard = AnyEvent::post_detect { BLOCK } |
853 | =item $guard = AnyEvent::post_detect { BLOCK } |
813 | |
854 | |
814 | 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 |
815 | 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. |
816 | |
868 | |
817 | 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 |
818 | that automatically removes the callback again when it is destroyed. See |
870 | that automatically removes the callback again when it is destroyed. See |
819 | L<Coro::BDB> for a case where this is useful. |
871 | L<Coro::BDB> for a case where this is useful. |
820 | |
872 | |
… | |
… | |
823 | 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 |
824 | before or after loading AnyEvent), then they will called directly after |
876 | before or after loading AnyEvent), then they will called directly after |
825 | the event loop has been chosen. |
877 | the event loop has been chosen. |
826 | |
878 | |
827 | 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: |
828 | 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 |
829 | and the array will be ignored. |
881 | array will be ignored. |
830 | |
882 | |
831 | 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. |
832 | |
890 | |
833 | =back |
891 | =back |
834 | |
892 | |
835 | =head1 WHAT TO DO IN A MODULE |
893 | =head1 WHAT TO DO IN A MODULE |
836 | |
894 | |
… | |
… | |
891 | |
949 | |
892 | |
950 | |
893 | =head1 OTHER MODULES |
951 | =head1 OTHER MODULES |
894 | |
952 | |
895 | 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 |
896 | 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 |
897 | 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 |
898 | available via CPAN. |
956 | come with AnyEvent, most are available via CPAN. |
899 | |
957 | |
900 | =over 4 |
958 | =over 4 |
901 | |
959 | |
902 | =item L<AnyEvent::Util> |
960 | =item L<AnyEvent::Util> |
903 | |
961 | |
… | |
… | |
912 | |
970 | |
913 | =item L<AnyEvent::Handle> |
971 | =item L<AnyEvent::Handle> |
914 | |
972 | |
915 | Provide read and write buffers, manages watchers for reads and writes, |
973 | Provide read and write buffers, manages watchers for reads and writes, |
916 | 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 |
917 | non-blocking SSL/TLS. |
975 | non-blocking SSL/TLS (via L<AnyEvent::TLS>. |
918 | |
976 | |
919 | =item L<AnyEvent::DNS> |
977 | =item L<AnyEvent::DNS> |
920 | |
978 | |
921 | Provides rich asynchronous DNS resolver capabilities. |
979 | Provides rich asynchronous DNS resolver capabilities. |
922 | |
980 | |
… | |
… | |
950 | |
1008 | |
951 | =item L<AnyEvent::GPSD> |
1009 | =item L<AnyEvent::GPSD> |
952 | |
1010 | |
953 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
1011 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
954 | |
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 | |
955 | =item L<AnyEvent::IGS> |
1022 | =item L<AnyEvent::IGS> |
956 | |
1023 | |
957 | 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 |
958 | L<App::IGS>). |
1025 | L<App::IGS>). |
959 | |
1026 | |
960 | =item L<AnyEvent::IRC> |
|
|
961 | |
|
|
962 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
|
|
963 | |
|
|
964 | =item L<Net::XMPP2> |
|
|
965 | |
|
|
966 | AnyEvent based XMPP (Jabber protocol) module family. |
|
|
967 | |
|
|
968 | =item L<Net::FCP> |
1027 | =item L<Net::FCP> |
969 | |
1028 | |
970 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
1029 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
971 | of AnyEvent. |
1030 | of AnyEvent. |
972 | |
1031 | |
… | |
… | |
976 | |
1035 | |
977 | =item L<Coro> |
1036 | =item L<Coro> |
978 | |
1037 | |
979 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
1038 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
980 | |
1039 | |
981 | =item L<IO::Lambda> |
|
|
982 | |
|
|
983 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
|
|
984 | |
|
|
985 | =back |
1040 | =back |
986 | |
1041 | |
987 | =cut |
1042 | =cut |
988 | |
1043 | |
989 | package AnyEvent; |
1044 | package AnyEvent; |
990 | |
1045 | |
|
|
1046 | # basically a tuned-down version of common::sense |
|
|
1047 | sub common_sense { |
991 | no warnings; |
1048 | # no warnings |
|
|
1049 | ${^WARNING_BITS} ^= ${^WARNING_BITS}; |
992 | use strict qw(vars subs); |
1050 | # use strict vars subs |
|
|
1051 | $^H |= 0x00000600; |
|
|
1052 | } |
993 | |
1053 | |
|
|
1054 | BEGIN { AnyEvent::common_sense } |
|
|
1055 | |
994 | use Carp; |
1056 | use Carp (); |
995 | |
1057 | |
996 | our $VERSION = 4.8; |
1058 | our $VERSION = 4.85; |
997 | our $MODEL; |
1059 | our $MODEL; |
998 | |
1060 | |
999 | our $AUTOLOAD; |
1061 | our $AUTOLOAD; |
1000 | our @ISA; |
1062 | our @ISA; |
1001 | |
1063 | |
1002 | our @REGISTRY; |
1064 | our @REGISTRY; |
1003 | |
1065 | |
1004 | our $WIN32; |
1066 | our $WIN32; |
|
|
1067 | |
|
|
1068 | our $VERBOSE; |
1005 | |
1069 | |
1006 | BEGIN { |
1070 | BEGIN { |
1007 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
1071 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
1008 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
1072 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
1009 | |
1073 | |
1010 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1074 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1011 | if ${^TAINT}; |
1075 | if ${^TAINT}; |
1012 | } |
|
|
1013 | |
1076 | |
1014 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1077 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
|
|
1078 | |
|
|
1079 | } |
|
|
1080 | |
|
|
1081 | our $MAX_SIGNAL_LATENCY = 10; |
1015 | |
1082 | |
1016 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1083 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1017 | |
1084 | |
1018 | { |
1085 | { |
1019 | my $idx; |
1086 | my $idx; |
… | |
… | |
1027 | [Event:: => AnyEvent::Impl::Event::], |
1094 | [Event:: => AnyEvent::Impl::Event::], |
1028 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
1095 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
1029 | # everything below here will not be autoprobed |
1096 | # everything below here will not be autoprobed |
1030 | # as the pureperl backend should work everywhere |
1097 | # as the pureperl backend should work everywhere |
1031 | # and is usually faster |
1098 | # and is usually faster |
1032 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
|
|
1033 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
1099 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
1034 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1100 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
|
|
1101 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1035 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1102 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1036 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1103 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1037 | [Wx:: => AnyEvent::Impl::POE::], |
1104 | [Wx:: => AnyEvent::Impl::POE::], |
1038 | [Prima:: => AnyEvent::Impl::POE::], |
1105 | [Prima:: => AnyEvent::Impl::POE::], |
1039 | # 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 |
1040 | # byzantine signal and broken child handling, among others. |
1107 | # byzantine signal and broken child handling, among others. |
1041 | # 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 |
1042 | # obvious default class. |
1109 | # obvious default class. |
1043 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1110 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1044 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1111 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
… | |
… | |
1070 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1137 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1071 | } |
1138 | } |
1072 | |
1139 | |
1073 | sub detect() { |
1140 | sub detect() { |
1074 | unless ($MODEL) { |
1141 | unless ($MODEL) { |
1075 | no strict 'refs'; |
|
|
1076 | local $SIG{__DIE__}; |
1142 | local $SIG{__DIE__}; |
1077 | |
1143 | |
1078 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1144 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1079 | my $model = "AnyEvent::Impl::$1"; |
1145 | my $model = "AnyEvent::Impl::$1"; |
1080 | if (eval "require $model") { |
1146 | if (eval "require $model") { |
1081 | $MODEL = $model; |
1147 | $MODEL = $model; |
1082 | 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; |
1083 | } else { |
1149 | } else { |
1084 | 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; |
1085 | } |
1151 | } |
1086 | } |
1152 | } |
1087 | |
1153 | |
1088 | # check for already loaded models |
1154 | # check for already loaded models |
1089 | unless ($MODEL) { |
1155 | unless ($MODEL) { |
1090 | for (@REGISTRY, @models) { |
1156 | for (@REGISTRY, @models) { |
1091 | my ($package, $model) = @$_; |
1157 | my ($package, $model) = @$_; |
1092 | if (${"$package\::VERSION"} > 0) { |
1158 | if (${"$package\::VERSION"} > 0) { |
1093 | if (eval "require $model") { |
1159 | if (eval "require $model") { |
1094 | $MODEL = $model; |
1160 | $MODEL = $model; |
1095 | warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; |
1161 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
1096 | last; |
1162 | last; |
1097 | } |
1163 | } |
1098 | } |
1164 | } |
1099 | } |
1165 | } |
1100 | |
1166 | |
… | |
… | |
1105 | my ($package, $model) = @$_; |
1171 | my ($package, $model) = @$_; |
1106 | if (eval "require $package" |
1172 | if (eval "require $package" |
1107 | and ${"$package\::VERSION"} > 0 |
1173 | and ${"$package\::VERSION"} > 0 |
1108 | and eval "require $model") { |
1174 | and eval "require $model") { |
1109 | $MODEL = $model; |
1175 | $MODEL = $model; |
1110 | warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; |
1176 | warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; |
1111 | last; |
1177 | last; |
1112 | } |
1178 | } |
1113 | } |
1179 | } |
1114 | |
1180 | |
1115 | $MODEL |
1181 | $MODEL |
… | |
… | |
1131 | |
1197 | |
1132 | sub AUTOLOAD { |
1198 | sub AUTOLOAD { |
1133 | (my $func = $AUTOLOAD) =~ s/.*://; |
1199 | (my $func = $AUTOLOAD) =~ s/.*://; |
1134 | |
1200 | |
1135 | $method{$func} |
1201 | $method{$func} |
1136 | or croak "$func: not a valid method for AnyEvent objects"; |
1202 | or Carp::croak "$func: not a valid method for AnyEvent objects"; |
1137 | |
1203 | |
1138 | detect unless $MODEL; |
1204 | detect unless $MODEL; |
1139 | |
1205 | |
1140 | my $class = shift; |
1206 | my $class = shift; |
1141 | $class->$func (@_); |
1207 | $class->$func (@_); |
… | |
… | |
1146 | # 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). |
1147 | sub _dupfh($$;$$) { |
1213 | sub _dupfh($$;$$) { |
1148 | my ($poll, $fh, $r, $w) = @_; |
1214 | my ($poll, $fh, $r, $w) = @_; |
1149 | |
1215 | |
1150 | # cygwin requires the fh mode to be matching, unix doesn't |
1216 | # cygwin requires the fh mode to be matching, unix doesn't |
1151 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
1217 | my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&"); |
1152 | : $poll eq "w" ? ($w, ">") |
|
|
1153 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
|
|
1154 | |
1218 | |
1155 | open my $fh2, "$mode&" . fileno $fh |
1219 | open my $fh2, $mode, $fh |
1156 | or die "cannot dup() filehandle: $!,"; |
1220 | or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,"; |
1157 | |
1221 | |
1158 | # 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 |
1159 | |
1223 | |
1160 | ($fh2, $rw) |
1224 | ($fh2, $rw) |
1161 | } |
1225 | } |
1162 | |
1226 | |
1163 | package AnyEvent::Base; |
1227 | package AnyEvent::Base; |
1164 | |
1228 | |
1165 | # default implementations for many methods |
1229 | # default implementations for many methods |
1166 | |
1230 | |
1167 | BEGIN { |
1231 | sub _time { |
|
|
1232 | # probe for availability of Time::HiRes |
1168 | 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; |
1169 | *_time = \&Time::HiRes::time; |
1235 | *_time = \&Time::HiRes::time; |
1170 | # if (eval "use POSIX (); (POSIX::times())... |
1236 | # if (eval "use POSIX (); (POSIX::times())... |
1171 | } else { |
1237 | } else { |
|
|
1238 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1172 | *_time = sub { time }; # epic fail |
1239 | *_time = sub { time }; # epic fail |
1173 | } |
1240 | } |
|
|
1241 | |
|
|
1242 | &_time |
1174 | } |
1243 | } |
1175 | |
1244 | |
1176 | sub time { _time } |
1245 | sub time { _time } |
1177 | sub now { _time } |
1246 | sub now { _time } |
1178 | sub now_update { } |
1247 | sub now_update { } |
… | |
… | |
1183 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1252 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1184 | } |
1253 | } |
1185 | |
1254 | |
1186 | # default implementation for ->signal |
1255 | # default implementation for ->signal |
1187 | |
1256 | |
|
|
1257 | our $HAVE_ASYNC_INTERRUPT; |
1188 | 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); |
1189 | |
1261 | |
1190 | sub _signal_exec { |
1262 | sub _signal_exec { |
|
|
1263 | $HAVE_ASYNC_INTERRUPT |
|
|
1264 | ? $SIGPIPE_R->drain |
1191 | sysread $SIGPIPE_R, my $dummy, 4; |
1265 | : sysread $SIGPIPE_R, my $dummy, 9; |
1192 | |
1266 | |
1193 | while (%SIG_EV) { |
1267 | while (%SIG_EV) { |
1194 | for (keys %SIG_EV) { |
1268 | for (keys %SIG_EV) { |
1195 | delete $SIG_EV{$_}; |
1269 | delete $SIG_EV{$_}; |
1196 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1270 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1197 | } |
1271 | } |
1198 | } |
1272 | } |
1199 | } |
1273 | } |
1200 | |
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 | |
1201 | sub signal { |
1319 | sub signal { |
1202 | 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; |
1203 | |
1323 | |
1204 | 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 | |
1205 | require Fcntl; |
1331 | require Fcntl; |
1206 | |
1332 | |
1207 | if (AnyEvent::WIN32) { |
1333 | if (AnyEvent::WIN32) { |
1208 | require AnyEvent::Util; |
1334 | require AnyEvent::Util; |
1209 | |
1335 | |
… | |
… | |
1224 | 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"; |
1225 | |
1351 | |
1226 | $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); |
1227 | } |
1353 | } |
1228 | |
1354 | |
1229 | my $signal = uc $arg{signal} |
1355 | *signal = \&_signal; |
1230 | or Carp::croak "required option 'signal' is missing"; |
1356 | &signal |
1231 | |
|
|
1232 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1233 | $SIG{$signal} ||= sub { |
|
|
1234 | local $!; |
|
|
1235 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
|
|
1236 | undef $SIG_EV{$signal}; |
|
|
1237 | }; |
|
|
1238 | |
|
|
1239 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1240 | } |
1357 | } |
1241 | |
1358 | |
1242 | sub AnyEvent::Base::signal::DESTROY { |
1359 | sub AnyEvent::Base::signal::DESTROY { |
1243 | my ($signal, $cb) = @{$_[0]}; |
1360 | my ($signal, $cb) = @{$_[0]}; |
1244 | |
1361 | |
|
|
1362 | undef $SIG_TW |
|
|
1363 | unless --$SIG_COUNT; |
|
|
1364 | |
1245 | delete $SIG_CB{$signal}{$cb}; |
1365 | delete $SIG_CB{$signal}{$cb}; |
1246 | |
1366 | |
|
|
1367 | $HAVE_ASYNC_INTERRUPT |
|
|
1368 | ? delete $SIG_ASY{$signal} |
1247 | # delete doesn't work with older perls - they then |
1369 | : # delete doesn't work with older perls - they then |
1248 | # print weird messages, or just unconditionally exit |
1370 | # print weird messages, or just unconditionally exit |
1249 | # instead of getting the default action. |
1371 | # instead of getting the default action. |
|
|
1372 | undef $SIG{$signal} |
1250 | undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
1373 | unless keys %{ $SIG_CB{$signal} }; |
1251 | } |
1374 | } |
1252 | |
1375 | |
1253 | # default implementation for ->child |
1376 | # default implementation for ->child |
1254 | |
1377 | |
1255 | our %PID_CB; |
1378 | our %PID_CB; |
… | |
… | |
1257 | our $CHLD_DELAY_W; |
1380 | our $CHLD_DELAY_W; |
1258 | our $WNOHANG; |
1381 | our $WNOHANG; |
1259 | |
1382 | |
1260 | sub _sigchld { |
1383 | sub _sigchld { |
1261 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1384 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
|
|
1385 | $_->($pid, $?) |
1262 | $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), |
1386 | for values %{ $PID_CB{$pid} || {} }, |
1263 | (values %{ $PID_CB{0} || {} }); |
1387 | values %{ $PID_CB{0} || {} }; |
1264 | } |
1388 | } |
1265 | } |
1389 | } |
1266 | |
1390 | |
1267 | sub child { |
1391 | sub child { |
1268 | my (undef, %arg) = @_; |
1392 | my (undef, %arg) = @_; |
… | |
… | |
1270 | defined (my $pid = $arg{pid} + 0) |
1394 | defined (my $pid = $arg{pid} + 0) |
1271 | or Carp::croak "required option 'pid' is missing"; |
1395 | or Carp::croak "required option 'pid' is missing"; |
1272 | |
1396 | |
1273 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1397 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1274 | |
1398 | |
|
|
1399 | # WNOHANG is almost cetrainly 1 everywhere |
|
|
1400 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
|
|
1401 | ? 1 |
1275 | $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1402 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1276 | |
1403 | |
1277 | unless ($CHLD_W) { |
1404 | unless ($CHLD_W) { |
1278 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1405 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1279 | # child could be a zombie already, so make at least one round |
1406 | # child could be a zombie already, so make at least one round |
1280 | &_sigchld; |
1407 | &_sigchld; |
… | |
… | |
1332 | |
1459 | |
1333 | our @ISA = AnyEvent::CondVar::Base::; |
1460 | our @ISA = AnyEvent::CondVar::Base::; |
1334 | |
1461 | |
1335 | package AnyEvent::CondVar::Base; |
1462 | package AnyEvent::CondVar::Base; |
1336 | |
1463 | |
1337 | use overload |
1464 | #use overload |
1338 | '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
1465 | # '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
1339 | fallback => 1; |
1466 | # fallback => 1; |
|
|
1467 | |
|
|
1468 | # save 300+ kilobytes by dirtily hardcoding overloading |
|
|
1469 | ${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching. |
|
|
1470 | *{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod." |
|
|
1471 | *{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{} |
|
|
1472 | ${'AnyEvent::CondVar::Base::()'} = 1; # fallback |
|
|
1473 | |
|
|
1474 | our $WAITING; |
1340 | |
1475 | |
1341 | sub _send { |
1476 | sub _send { |
1342 | # nop |
1477 | # nop |
1343 | } |
1478 | } |
1344 | |
1479 | |
… | |
… | |
1357 | sub ready { |
1492 | sub ready { |
1358 | $_[0]{_ae_sent} |
1493 | $_[0]{_ae_sent} |
1359 | } |
1494 | } |
1360 | |
1495 | |
1361 | sub _wait { |
1496 | sub _wait { |
|
|
1497 | $WAITING |
|
|
1498 | and !$_[0]{_ae_sent} |
|
|
1499 | and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected"; |
|
|
1500 | |
|
|
1501 | local $WAITING = 1; |
1362 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
1502 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
1363 | } |
1503 | } |
1364 | |
1504 | |
1365 | sub recv { |
1505 | sub recv { |
1366 | $_[0]->_wait; |
1506 | $_[0]->_wait; |
… | |
… | |
1428 | C<PERL_ANYEVENT_MODEL>. |
1568 | C<PERL_ANYEVENT_MODEL>. |
1429 | |
1569 | |
1430 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
1570 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
1431 | model it chooses. |
1571 | model it chooses. |
1432 | |
1572 | |
|
|
1573 | When set to C<8> or higher, then AnyEvent will report extra information on |
|
|
1574 | which optional modules it loads and how it implements certain features. |
|
|
1575 | |
1433 | =item C<PERL_ANYEVENT_STRICT> |
1576 | =item C<PERL_ANYEVENT_STRICT> |
1434 | |
1577 | |
1435 | AnyEvent does not do much argument checking by default, as thorough |
1578 | AnyEvent does not do much argument checking by default, as thorough |
1436 | argument checking is very costly. Setting this variable to a true value |
1579 | argument checking is very costly. Setting this variable to a true value |
1437 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
1580 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
1438 | check the arguments passed to most method calls. If it finds any problems, |
1581 | check the arguments passed to most method calls. If it finds any problems, |
1439 | it will croak. |
1582 | it will croak. |
1440 | |
1583 | |
1441 | In other words, enables "strict" mode. |
1584 | In other words, enables "strict" mode. |
1442 | |
1585 | |
1443 | Unlike C<use strict>, it is definitely recommended to keep it off in |
1586 | Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense> |
1444 | production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while |
1587 | >>, it is definitely recommended to keep it off in production. Keeping |
1445 | developing programs can be very useful, however. |
1588 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
|
|
1589 | can be very useful, however. |
1446 | |
1590 | |
1447 | =item C<PERL_ANYEVENT_MODEL> |
1591 | =item C<PERL_ANYEVENT_MODEL> |
1448 | |
1592 | |
1449 | This can be used to specify the event model to be used by AnyEvent, before |
1593 | This can be used to specify the event model to be used by AnyEvent, before |
1450 | auto detection and -probing kicks in. It must be a string consisting |
1594 | auto detection and -probing kicks in. It must be a string consisting |
… | |
… | |
1512 | |
1656 | |
1513 | When neither C<ca_file> nor C<ca_path> was specified during |
1657 | When neither C<ca_file> nor C<ca_path> was specified during |
1514 | L<AnyEvent::TLS> context creation, and either of these environment |
1658 | L<AnyEvent::TLS> context creation, and either of these environment |
1515 | variables exist, they will be used to specify CA certificate locations |
1659 | variables exist, they will be used to specify CA certificate locations |
1516 | instead of a system-dependent default. |
1660 | instead of a system-dependent default. |
|
|
1661 | |
|
|
1662 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
|
|
1663 | |
|
|
1664 | When these are set to C<1>, then the respective modules are not |
|
|
1665 | loaded. Mostly good for testing AnyEvent itself. |
1517 | |
1666 | |
1518 | =back |
1667 | =back |
1519 | |
1668 | |
1520 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1669 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1521 | |
1670 | |
… | |
… | |
2060 | |
2209 | |
2061 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
2210 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
2062 | emulation for event loops that do not support them natively. Also, some |
2211 | emulation for event loops that do not support them natively. Also, some |
2063 | event loops install a similar handler. |
2212 | event loops install a similar handler. |
2064 | |
2213 | |
2065 | If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will |
2214 | Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then |
2066 | reset it to default, to avoid losing child exit statuses. |
2215 | AnyEvent will reset it to default, to avoid losing child exit statuses. |
2067 | |
2216 | |
2068 | =item SIGPIPE |
2217 | =item SIGPIPE |
2069 | |
2218 | |
2070 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
2219 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
2071 | when AnyEvent gets loaded. |
2220 | when AnyEvent gets loaded. |
… | |
… | |
2089 | if $SIG{CHLD} eq 'IGNORE'; |
2238 | if $SIG{CHLD} eq 'IGNORE'; |
2090 | |
2239 | |
2091 | $SIG{PIPE} = sub { } |
2240 | $SIG{PIPE} = sub { } |
2092 | unless defined $SIG{PIPE}; |
2241 | unless defined $SIG{PIPE}; |
2093 | |
2242 | |
|
|
2243 | =head1 RECOMMENDED/OPTIONAL MODULES |
|
|
2244 | |
|
|
2245 | One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and |
|
|
2246 | it's built-in modules) are required to use it. |
|
|
2247 | |
|
|
2248 | That does not mean that AnyEvent won't take advantage of some additional |
|
|
2249 | modules if they are installed. |
|
|
2250 | |
|
|
2251 | This section epxlains which additional modules will be used, and how they |
|
|
2252 | affect AnyEvent's operetion. |
|
|
2253 | |
|
|
2254 | =over 4 |
|
|
2255 | |
|
|
2256 | =item L<Async::Interrupt> |
|
|
2257 | |
|
|
2258 | This slightly arcane module is used to implement fast signal handling: To |
|
|
2259 | my knowledge, there is no way to do completely race-free and quick |
|
|
2260 | signal handling in pure perl. To ensure that signals still get |
|
|
2261 | delivered, AnyEvent will start an interval timer to wake up perl (and |
|
|
2262 | catch the signals) with soemd elay (default is 10 seconds, look for |
|
|
2263 | C<$AnyEvent::MAX_SIGNAL_LATENCY>). |
|
|
2264 | |
|
|
2265 | If this module is available, then it will be used to implement signal |
|
|
2266 | catching, which means that signals will not be delayed, and the event loop |
|
|
2267 | will not be interrupted regularly, which is more efficient (And good for |
|
|
2268 | battery life on laptops). |
|
|
2269 | |
|
|
2270 | This affects not just the pure-perl event loop, but also other event loops |
|
|
2271 | that have no signal handling on their own (e.g. Glib, Tk, Qt). |
|
|
2272 | |
|
|
2273 | =item L<EV> |
|
|
2274 | |
|
|
2275 | This module isn't really "optional", as it is simply one of the backend |
|
|
2276 | event loops that AnyEvent can use. However, it is simply the best event |
|
|
2277 | loop available in terms of features, speed and stability: It supports |
|
|
2278 | the AnyEvent API optimally, implements all the watcher types in XS, does |
|
|
2279 | automatic timer adjustments even when no monotonic clock is available, |
|
|
2280 | can take avdantage of advanced kernel interfaces such as C<epoll> and |
|
|
2281 | C<kqueue>, and is the fastest backend I<by far>. You can even embed |
|
|
2282 | L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). |
|
|
2283 | |
|
|
2284 | =item L<Guard> |
|
|
2285 | |
|
|
2286 | The guard module, when used, will be used to implement |
|
|
2287 | C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a |
|
|
2288 | lot less memory), but otherwise doesn't affect guard operation much. It is |
|
|
2289 | purely used for performance. |
|
|
2290 | |
|
|
2291 | =item L<JSON> and L<JSON::XS> |
|
|
2292 | |
|
|
2293 | This module is required when you want to read or write JSON data via |
|
|
2294 | L<AnyEvent::Handle>. It is also written in pure-perl, but can take |
|
|
2295 | advantage of the ulta-high-speed L<JSON::XS> module when it is installed. |
|
|
2296 | |
|
|
2297 | In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is |
|
|
2298 | installed. |
|
|
2299 | |
|
|
2300 | =item L<Net::SSLeay> |
|
|
2301 | |
|
|
2302 | Implementing TLS/SSL in Perl is certainly interesting, but not very |
|
|
2303 | worthwhile: If this module is installed, then L<AnyEvent::Handle> (with |
|
|
2304 | the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. |
|
|
2305 | |
|
|
2306 | =item L<Time::HiRes> |
|
|
2307 | |
|
|
2308 | This module is part of perl since release 5.008. It will be used when the |
|
|
2309 | chosen event library does not come with a timing source on it's own. The |
|
|
2310 | pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to |
|
|
2311 | try to use a monotonic clock for timing stability. |
|
|
2312 | |
|
|
2313 | =back |
|
|
2314 | |
|
|
2315 | |
2094 | =head1 FORK |
2316 | =head1 FORK |
2095 | |
2317 | |
2096 | Most event libraries are not fork-safe. The ones who are usually are |
2318 | Most event libraries are not fork-safe. The ones who are usually are |
2097 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2319 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2098 | calls. Only L<EV> is fully fork-aware. |
2320 | calls. Only L<EV> is fully fork-aware. |
2099 | |
2321 | |
2100 | If you have to fork, you must either do so I<before> creating your first |
2322 | If you have to fork, you must either do so I<before> creating your first |
2101 | watcher OR you must not use AnyEvent at all in the child. |
2323 | watcher OR you must not use AnyEvent at all in the child OR you must do |
|
|
2324 | something completely out of the scope of AnyEvent. |
2102 | |
2325 | |
2103 | |
2326 | |
2104 | =head1 SECURITY CONSIDERATIONS |
2327 | =head1 SECURITY CONSIDERATIONS |
2105 | |
2328 | |
2106 | AnyEvent can be forced to load any event model via |
2329 | AnyEvent can be forced to load any event model via |
… | |
… | |
2144 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2367 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2145 | |
2368 | |
2146 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2369 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2147 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2370 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2148 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2371 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2149 | L<AnyEvent::Impl::POE>. |
2372 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. |
2150 | |
2373 | |
2151 | Non-blocking file handles, sockets, TCP clients and |
2374 | Non-blocking file handles, sockets, TCP clients and |
2152 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. |
2375 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2153 | |
2376 | |
2154 | Asynchronous DNS: L<AnyEvent::DNS>. |
2377 | Asynchronous DNS: L<AnyEvent::DNS>. |
2155 | |
2378 | |
2156 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, |
2379 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, |
|
|
2380 | L<Coro::Event>, |
2157 | |
2381 | |
2158 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
2382 | Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, |
|
|
2383 | L<AnyEvent::HTTP>. |
2159 | |
2384 | |
2160 | |
2385 | |
2161 | =head1 AUTHOR |
2386 | =head1 AUTHOR |
2162 | |
2387 | |
2163 | Marc Lehmann <schmorp@schmorp.de> |
2388 | Marc Lehmann <schmorp@schmorp.de> |