1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - provide framework for multiple event loops |
3 | AnyEvent - provide framework for multiple event loops |
4 | |
4 | |
5 | EV, Event, Coro::EV, Coro::Event, Glib, Tk, Perl, Event::Lib, Qt - various supported event loops |
5 | EV, Event, Coro::EV, Coro::Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops |
6 | |
6 | |
7 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
8 | |
8 | |
9 | use AnyEvent; |
9 | use AnyEvent; |
10 | |
10 | |
… | |
… | |
78 | |
78 | |
79 | The interface itself is vaguely similar, but not identical to the L<Event> |
79 | The interface itself is vaguely similar, but not identical to the L<Event> |
80 | module. |
80 | module. |
81 | |
81 | |
82 | During the first call of any watcher-creation method, the module tries |
82 | During the first call of any watcher-creation method, the module tries |
83 | to detect the currently loaded event loop by probing whether one of |
83 | to detect the currently loaded event loop by probing whether one of the |
84 | the following modules is already loaded: L<Coro::EV>, L<Coro::Event>, |
84 | following modules is already loaded: L<Coro::EV>, L<Coro::Event>, L<EV>, |
85 | L<EV>, L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>. The first one |
85 | L<Event>, L<Glib>, L<Tk>, L<AnyEvent::Impl::Perl>, L<Event::Lib>, L<Qt>, |
86 | found is used. If none are found, the module tries to load these modules |
86 | L<POE>. The first one found is used. If none are found, the module tries |
87 | (excluding Event::Lib and Qt) in the order given. The first one that can |
87 | to load these modules (excluding Event::Lib, Qt and POE as the pure perl |
|
|
88 | adaptor should always succeed) in the order given. The first one that can |
88 | be successfully loaded will be used. If, after this, still none could be |
89 | be successfully loaded will be used. If, after this, still none could be |
89 | found, AnyEvent will fall back to a pure-perl event loop, which is not |
90 | found, AnyEvent will fall back to a pure-perl event loop, which is not |
90 | very efficient, but should work everywhere. |
91 | very efficient, but should work everywhere. |
91 | |
92 | |
92 | Because AnyEvent first checks for modules that are already loaded, loading |
93 | Because AnyEvent first checks for modules that are already loaded, loading |
… | |
… | |
362 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
363 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
363 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
364 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
364 | AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable. |
365 | AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable. |
365 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
366 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
366 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
367 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
|
|
368 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
|
|
369 | |
|
|
370 | There is no support for WxWidgets, as WxWidgets has no support for |
|
|
371 | watching file handles. However, you can use WxWidgets through the |
|
|
372 | POE Adaptor, as POE has a Wx backend that simply polls 20 times per |
|
|
373 | second, which was considered to be too horrible to even consider for |
|
|
374 | AnyEvent. Likewise, other POE backends can be used by Anyevent by using |
|
|
375 | it's adaptor. |
367 | |
376 | |
368 | =item AnyEvent::detect |
377 | =item AnyEvent::detect |
369 | |
378 | |
370 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
379 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
371 | if necessary. You should only call this function right before you would |
380 | if necessary. You should only call this function right before you would |
… | |
… | |
440 | [EV:: => AnyEvent::Impl::EV::], |
449 | [EV:: => AnyEvent::Impl::EV::], |
441 | [Event:: => AnyEvent::Impl::Event::], |
450 | [Event:: => AnyEvent::Impl::Event::], |
442 | [Glib:: => AnyEvent::Impl::Glib::], |
451 | [Glib:: => AnyEvent::Impl::Glib::], |
443 | [Tk:: => AnyEvent::Impl::Tk::], |
452 | [Tk:: => AnyEvent::Impl::Tk::], |
444 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
453 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
445 | ); |
454 | # everything below here will not be autoprobed as the pureperl backend should work everywhere |
446 | my @models_detect = ( |
455 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
447 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
456 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
448 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
457 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
449 | ); |
458 | ); |
450 | |
459 | |
451 | our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY); |
460 | our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY); |
452 | |
461 | |
453 | sub detect() { |
462 | sub detect() { |
… | |
… | |
464 | } |
473 | } |
465 | } |
474 | } |
466 | |
475 | |
467 | # check for already loaded models |
476 | # check for already loaded models |
468 | unless ($MODEL) { |
477 | unless ($MODEL) { |
469 | for (@REGISTRY, @models, @models_detect) { |
478 | for (@REGISTRY, @models) { |
470 | my ($package, $model) = @$_; |
479 | my ($package, $model) = @$_; |
471 | if (${"$package\::VERSION"} > 0) { |
480 | if (${"$package\::VERSION"} > 0) { |
472 | if (eval "require $model") { |
481 | if (eval "require $model") { |
473 | $MODEL = $model; |
482 | $MODEL = $model; |
474 | warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; |
483 | warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; |
… | |
… | |
874 | |
883 | |
875 | =head1 SEE ALSO |
884 | =head1 SEE ALSO |
876 | |
885 | |
877 | Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>, |
886 | Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>, |
878 | L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>, |
887 | L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>, |
879 | L<Event::Lib>, L<Qt>. |
888 | L<Event::Lib>, L<Qt>, L<POE>. |
880 | |
889 | |
881 | Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>, |
890 | Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>, |
882 | L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>, |
891 | L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>, |
883 | L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>, |
892 | L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>, |
884 | L<AnyEvent::Impl::Qt>. |
893 | L<AnyEvent::Impl::Qt>, L<AnyEvent::Impl::POE>. |
885 | |
894 | |
886 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. |
895 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. |
887 | |
896 | |
888 | =head1 AUTHOR |
897 | =head1 AUTHOR |
889 | |
898 | |