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 |
… | |
… | |
207 | |
208 | |
208 | There are two ways to handle timers: based on real time (relative, "fire |
209 | There are two ways to handle timers: based on real time (relative, "fire |
209 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
210 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
210 | o'clock"). |
211 | o'clock"). |
211 | |
212 | |
212 | While most event loops expect timers to specified in a relative way, they use |
213 | While most event loops expect timers to specified in a relative way, they |
213 | absolute time internally. This makes a difference when your clock "jumps", |
214 | use absolute time internally. This makes a difference when your clock |
214 | for example, when ntp decides to set your clock backwards from the wrong 2014-01-01 to |
215 | "jumps", for example, when ntp decides to set your clock backwards from |
215 | 2008-01-01, a watcher that you created to fire "after" a second might actually take |
216 | the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to |
216 | six years to finally fire. |
217 | fire "after" a second might actually take six years to finally fire. |
217 | |
218 | |
218 | AnyEvent cannot compensate for this. The only event loop that is conscious |
219 | AnyEvent cannot compensate for this. The only event loop that is conscious |
219 | about these issues is L<EV>, which offers both relative (ev_timer) and |
220 | about these issues is L<EV>, which offers both relative (ev_timer, based |
220 | absolute (ev_periodic) timers. |
221 | on true relative time) and absolute (ev_periodic, based on wallclock time) |
|
|
222 | timers. |
221 | |
223 | |
222 | AnyEvent always prefers relative timers, if available, matching the |
224 | AnyEvent always prefers relative timers, if available, matching the |
223 | AnyEvent API. |
225 | AnyEvent API. |
224 | |
226 | |
225 | =head2 SIGNAL WATCHERS |
227 | =head2 SIGNAL WATCHERS |
226 | |
228 | |
227 | You can watch for signals using a signal watcher, C<signal> is the signal |
229 | You can watch for signals using a signal watcher, C<signal> is the signal |
228 | I<name> without any C<SIG> prefix, C<cb> is the Perl callback to |
230 | I<name> without any C<SIG> prefix, C<cb> is the Perl callback to |
229 | be invoked whenever a signal occurs. |
231 | be invoked whenever a signal occurs. |
230 | |
232 | |
231 | Multiple signals occurances can be clumped together into one callback |
233 | Multiple signal occurances can be clumped together into one callback |
232 | invocation, and callback invocation will be synchronous. synchronous means |
234 | invocation, and callback invocation will be synchronous. synchronous means |
233 | that it might take a while until the signal gets handled by the process, |
235 | that it might take a while until the signal gets handled by the process, |
234 | but it is guarenteed not to interrupt any other callbacks. |
236 | but it is guarenteed not to interrupt any other callbacks. |
235 | |
237 | |
236 | The main advantage of using these watchers is that you can share a signal |
238 | The main advantage of using these watchers is that you can share a signal |
… | |
… | |
361 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
363 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
362 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
364 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
363 | AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable. |
365 | AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable. |
364 | 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). |
365 | 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. |
366 | |
376 | |
367 | =item AnyEvent::detect |
377 | =item AnyEvent::detect |
368 | |
378 | |
369 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
379 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
370 | 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 |
… | |
… | |
421 | no warnings; |
431 | no warnings; |
422 | use strict; |
432 | use strict; |
423 | |
433 | |
424 | use Carp; |
434 | use Carp; |
425 | |
435 | |
426 | our $VERSION = '3.12'; |
436 | our $VERSION = '3.2'; |
427 | our $MODEL; |
437 | our $MODEL; |
428 | |
438 | |
429 | our $AUTOLOAD; |
439 | our $AUTOLOAD; |
430 | our @ISA; |
440 | our @ISA; |
431 | |
441 | |
… | |
… | |
439 | [EV:: => AnyEvent::Impl::EV::], |
449 | [EV:: => AnyEvent::Impl::EV::], |
440 | [Event:: => AnyEvent::Impl::Event::], |
450 | [Event:: => AnyEvent::Impl::Event::], |
441 | [Glib:: => AnyEvent::Impl::Glib::], |
451 | [Glib:: => AnyEvent::Impl::Glib::], |
442 | [Tk:: => AnyEvent::Impl::Tk::], |
452 | [Tk:: => AnyEvent::Impl::Tk::], |
443 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
453 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
444 | ); |
454 | # everything below here will not be autoprobed as the pureperl backend should work everywhere |
445 | my @models_detect = ( |
455 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
446 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
456 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
447 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
457 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
448 | ); |
458 | ); |
449 | |
459 | |
450 | 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); |
451 | |
461 | |
452 | sub detect() { |
462 | sub detect() { |
… | |
… | |
456 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
466 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
457 | my $model = "AnyEvent::Impl::$1"; |
467 | my $model = "AnyEvent::Impl::$1"; |
458 | if (eval "require $model") { |
468 | if (eval "require $model") { |
459 | $MODEL = $model; |
469 | $MODEL = $model; |
460 | warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; |
470 | warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; |
|
|
471 | } else { |
|
|
472 | warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; |
461 | } |
473 | } |
462 | } |
474 | } |
463 | |
475 | |
464 | # check for already loaded models |
476 | # check for already loaded models |
465 | unless ($MODEL) { |
477 | unless ($MODEL) { |
466 | for (@REGISTRY, @models, @models_detect) { |
478 | for (@REGISTRY, @models) { |
467 | my ($package, $model) = @$_; |
479 | my ($package, $model) = @$_; |
468 | if (${"$package\::VERSION"} > 0) { |
480 | if (${"$package\::VERSION"} > 0) { |
469 | if (eval "require $model") { |
481 | if (eval "require $model") { |
470 | $MODEL = $model; |
482 | $MODEL = $model; |
471 | warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; |
483 | warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; |
… | |
… | |
658 | |
670 | |
659 | =over 4 |
671 | =over 4 |
660 | |
672 | |
661 | =item C<PERL_ANYEVENT_VERBOSE> |
673 | =item C<PERL_ANYEVENT_VERBOSE> |
662 | |
674 | |
|
|
675 | By default, AnyEvent will be completely silent except in fatal |
|
|
676 | conditions. You can set this environment variable to make AnyEvent more |
|
|
677 | talkative. |
|
|
678 | |
|
|
679 | When set to C<1> or higher, causes AnyEvent to warn about unexpected |
|
|
680 | conditions, such as not being able to load the event model specified by |
|
|
681 | C<PERL_ANYEVENT_MODEL>. |
|
|
682 | |
663 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
683 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
664 | model it chooses. |
684 | model it chooses. |
665 | |
685 | |
666 | =item C<PERL_ANYEVENT_MODEL> |
686 | =item C<PERL_ANYEVENT_MODEL> |
667 | |
687 | |
… | |
… | |
863 | |
883 | |
864 | =head1 SEE ALSO |
884 | =head1 SEE ALSO |
865 | |
885 | |
866 | 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>, |
867 | 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>, |
868 | L<Event::Lib>, L<Qt>. |
888 | L<Event::Lib>, L<Qt>, L<POE>. |
869 | |
889 | |
870 | Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>, |
890 | Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>, |
871 | 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>, |
872 | 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>, |
873 | L<AnyEvent::Impl::Qt>. |
893 | L<AnyEvent::Impl::Qt>, L<AnyEvent::Impl::POE>. |
874 | |
894 | |
875 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. |
895 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. |
876 | |
896 | |
877 | =head1 AUTHOR |
897 | =head1 AUTHOR |
878 | |
898 | |