… | |
… | |
312 | C<cb>, which specifies a callback to be called when the condition variable |
312 | C<cb>, which specifies a callback to be called when the condition variable |
313 | becomes true. |
313 | becomes true. |
314 | |
314 | |
315 | After creation, the condition variable is "false" until it becomes "true" |
315 | After creation, the condition variable is "false" until it becomes "true" |
316 | by calling the C<send> method (or calling the condition variable as if it |
316 | by calling the C<send> method (or calling the condition variable as if it |
317 | were a callback). |
317 | were a callback, read about the caveats in the description for the C<< |
|
|
318 | ->send >> method). |
318 | |
319 | |
319 | Condition variables are similar to callbacks, except that you can |
320 | Condition variables are similar to callbacks, except that you can |
320 | optionally wait for them. They can also be called merge points - points |
321 | optionally wait for them. They can also be called merge points - points |
321 | in time where multiple outstanding events have been processed. And yet |
322 | in time where multiple outstanding events have been processed. And yet |
322 | another way to call them is transactions - each condition variable can be |
323 | another way to call them is transactions - each condition variable can be |
… | |
… | |
394 | immediately from within send. |
395 | immediately from within send. |
395 | |
396 | |
396 | Any arguments passed to the C<send> call will be returned by all |
397 | Any arguments passed to the C<send> call will be returned by all |
397 | future C<< ->recv >> calls. |
398 | future C<< ->recv >> calls. |
398 | |
399 | |
399 | Condition variables are overloaded so one can call them directly (as a |
400 | Condition variables are overloaded so one can call them directly |
400 | code reference). Calling them directly is the same as calling C<send>. |
401 | (as a code reference). Calling them directly is the same as calling |
|
|
402 | C<send>. Note, however, that many C-based event loops do not handle |
|
|
403 | overloading, so as tempting as it may be, passing a condition variable |
|
|
404 | instead of a callback does not work. Both the pure perl and EV loops |
|
|
405 | support overloading, however, as well as all functions that use perl to |
|
|
406 | invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for |
|
|
407 | example). |
401 | |
408 | |
402 | =item $cv->croak ($error) |
409 | =item $cv->croak ($error) |
403 | |
410 | |
404 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
411 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
405 | C<Carp::croak> with the given error message/object/scalar. |
412 | C<Carp::croak> with the given error message/object/scalar. |
… | |
… | |
519 | The callback will be called when the condition becomes "true", i.e. when |
526 | The callback will be called when the condition becomes "true", i.e. when |
520 | C<send> or C<croak> are called. Calling C<recv> inside the callback |
527 | C<send> or C<croak> are called. Calling C<recv> inside the callback |
521 | or at any later time is guaranteed not to block. |
528 | or at any later time is guaranteed not to block. |
522 | |
529 | |
523 | =back |
530 | =back |
524 | |
|
|
525 | =head3 MAINLOOP EMULATION |
|
|
526 | |
|
|
527 | Sometimes (often for short test scripts, or even standalone programs |
|
|
528 | who only want to use AnyEvent), you I<do> want your program to block |
|
|
529 | indefinitely in some event loop. |
|
|
530 | |
|
|
531 | In that case, you cna use a condition variable like this: |
|
|
532 | |
|
|
533 | AnyEvent->condvar->recv; |
|
|
534 | |
|
|
535 | This has the effect of entering the event loop and looping forever. |
|
|
536 | |
|
|
537 | Note that usually your program has some exit condition, in which case |
|
|
538 | it is better to use the "traditional" approach of storing a condition |
|
|
539 | variable, waiting for it, and sending it when the program should exit |
|
|
540 | cleanly. |
|
|
541 | |
|
|
542 | |
531 | |
543 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
532 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
544 | |
533 | |
545 | =over 4 |
534 | =over 4 |
546 | |
535 | |
… | |
… | |
630 | |
619 | |
631 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
620 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
632 | do anything special (it does not need to be event-based) and let AnyEvent |
621 | do anything special (it does not need to be event-based) and let AnyEvent |
633 | decide which implementation to chose if some module relies on it. |
622 | decide which implementation to chose if some module relies on it. |
634 | |
623 | |
635 | If the main program relies on a specific event model. For example, in |
624 | If the main program relies on a specific event model - for example, in |
636 | Gtk2 programs you have to rely on the Glib module. You should load the |
625 | Gtk2 programs you have to rely on the Glib module - you should load the |
637 | event module before loading AnyEvent or any module that uses it: generally |
626 | event module before loading AnyEvent or any module that uses it: generally |
638 | speaking, you should load it as early as possible. The reason is that |
627 | speaking, you should load it as early as possible. The reason is that |
639 | modules might create watchers when they are loaded, and AnyEvent will |
628 | modules might create watchers when they are loaded, and AnyEvent will |
640 | decide on the event model to use as soon as it creates watchers, and it |
629 | decide on the event model to use as soon as it creates watchers, and it |
641 | might chose the wrong one unless you load the correct one yourself. |
630 | might chose the wrong one unless you load the correct one yourself. |
642 | |
631 | |
643 | You can chose to use a rather inefficient pure-perl implementation by |
632 | You can chose to use a pure-perl implementation by loading the |
644 | loading the C<AnyEvent::Impl::Perl> module, which gives you similar |
633 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
645 | behaviour everywhere, but letting AnyEvent chose is generally better. |
634 | everywhere, but letting AnyEvent chose the model is generally better. |
|
|
635 | |
|
|
636 | =head2 MAINLOOP EMULATION |
|
|
637 | |
|
|
638 | Sometimes (often for short test scripts, or even standalone programs who |
|
|
639 | only want to use AnyEvent), you do not want to run a specific event loop. |
|
|
640 | |
|
|
641 | In that case, you can use a condition variable like this: |
|
|
642 | |
|
|
643 | AnyEvent->condvar->recv; |
|
|
644 | |
|
|
645 | This has the effect of entering the event loop and looping forever. |
|
|
646 | |
|
|
647 | Note that usually your program has some exit condition, in which case |
|
|
648 | it is better to use the "traditional" approach of storing a condition |
|
|
649 | variable somewhere, waiting for it, and sending it when the program should |
|
|
650 | exit cleanly. |
|
|
651 | |
646 | |
652 | |
647 | =head1 OTHER MODULES |
653 | =head1 OTHER MODULES |
648 | |
654 | |
649 | The following is a non-exhaustive list of additional modules that use |
655 | The following is a non-exhaustive list of additional modules that use |
650 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
656 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
… | |
… | |
666 | |
672 | |
667 | Provides various utility functions for (internet protocol) sockets, |
673 | Provides various utility functions for (internet protocol) sockets, |
668 | addresses and name resolution. Also functions to create non-blocking tcp |
674 | addresses and name resolution. Also functions to create non-blocking tcp |
669 | connections or tcp servers, with IPv6 and SRV record support and more. |
675 | connections or tcp servers, with IPv6 and SRV record support and more. |
670 | |
676 | |
|
|
677 | =item L<AnyEvent::DNS> |
|
|
678 | |
|
|
679 | Provides rich asynchronous DNS resolver capabilities. |
|
|
680 | |
671 | =item L<AnyEvent::HTTPD> |
681 | =item L<AnyEvent::HTTPD> |
672 | |
682 | |
673 | Provides a simple web application server framework. |
683 | Provides a simple web application server framework. |
674 | |
|
|
675 | =item L<AnyEvent::DNS> |
|
|
676 | |
|
|
677 | Provides rich asynchronous DNS resolver capabilities. |
|
|
678 | |
684 | |
679 | =item L<AnyEvent::FastPing> |
685 | =item L<AnyEvent::FastPing> |
680 | |
686 | |
681 | The fastest ping in the west. |
687 | The fastest ping in the west. |
682 | |
688 | |
… | |
… | |
731 | our $MODEL; |
737 | our $MODEL; |
732 | |
738 | |
733 | our $AUTOLOAD; |
739 | our $AUTOLOAD; |
734 | our @ISA; |
740 | our @ISA; |
735 | |
741 | |
|
|
742 | our @REGISTRY; |
|
|
743 | |
736 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
744 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
737 | |
745 | |
738 | our @REGISTRY; |
746 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
739 | |
|
|
740 | our %PROTOCOL; # (ipv4|ipv6) => (1|2) |
|
|
741 | |
747 | |
742 | { |
748 | { |
743 | my $idx; |
749 | my $idx; |
744 | $PROTOCOL{$_} = ++$idx |
750 | $PROTOCOL{$_} = ++$idx |
|
|
751 | for reverse split /\s*,\s*/, |
745 | for split /\s*,\s*/, $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
752 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
746 | } |
753 | } |
747 | |
754 | |
748 | my @models = ( |
755 | my @models = ( |
749 | [EV:: => AnyEvent::Impl::EV::], |
756 | [EV:: => AnyEvent::Impl::EV::], |
750 | [Event:: => AnyEvent::Impl::Event::], |
757 | [Event:: => AnyEvent::Impl::Event::], |
751 | [Tk:: => AnyEvent::Impl::Tk::], |
|
|
752 | [Wx:: => AnyEvent::Impl::POE::], |
|
|
753 | [Prima:: => AnyEvent::Impl::POE::], |
|
|
754 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
758 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
755 | # everything below here will not be autoprobed as the pureperl backend should work everywhere |
759 | # everything below here will not be autoprobed |
756 | [Glib:: => AnyEvent::Impl::Glib::], |
760 | # as the pureperl backend should work everywhere |
|
|
761 | # and is usually faster |
|
|
762 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
|
|
763 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
757 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
764 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
758 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
765 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
759 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
766 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
|
|
767 | [Wx:: => AnyEvent::Impl::POE::], |
|
|
768 | [Prima:: => AnyEvent::Impl::POE::], |
760 | ); |
769 | ); |
761 | |
770 | |
762 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
771 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
763 | |
772 | |
764 | our @post_detect; |
773 | our @post_detect; |