ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.58 by root, Thu Apr 24 03:24:07 2008 UTC vs.
Revision 1.61 by root, Fri Apr 25 01:55:25 2008 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - provide framework for multiple event loops
4 4
5EV, Event, Coro::EV, Coro::Event, Glib, Tk, Perl, Event::Lib, Qt - various supported event loops 5EV, 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
79The interface itself is vaguely similar, but not identical to the L<Event> 79The interface itself is vaguely similar, but not identical to the L<Event>
80module. 80module.
81 81
82During the first call of any watcher-creation method, the module tries 82During the first call of any watcher-creation method, the module tries
83to detect the currently loaded event loop by probing whether one of 83to detect the currently loaded event loop by probing whether one of the
84the following modules is already loaded: L<Coro::EV>, L<Coro::Event>, 84following modules is already loaded: L<Coro::EV>, L<Coro::Event>, L<EV>,
85L<EV>, L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>. The first one 85L<Event>, L<Glib>, L<Tk>, L<AnyEvent::Impl::Perl>, L<Event::Lib>, L<Qt>,
86found is used. If none are found, the module tries to load these modules 86L<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 87to load these modules (excluding Event::Lib, Qt and POE as the pure perl
88adaptor should always succeed) in the order given. The first one that can
88be successfully loaded will be used. If, after this, still none could be 89be successfully loaded will be used. If, after this, still none could be
89found, AnyEvent will fall back to a pure-perl event loop, which is not 90found, AnyEvent will fall back to a pure-perl event loop, which is not
90very efficient, but should work everywhere. 91very efficient, but should work everywhere.
91 92
92Because AnyEvent first checks for modules that are already loaded, loading 93Because 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
370There is no support for WxWidgets, as WxWidgets has no support for
371watching file handles. However, you can use WxWidgets through the
372POE Adaptor, as POE has a Wx backend that simply polls 20 times per
373second, which was considered to be too horrible to even consider for
374AnyEvent. Likewise, other POE backends can be used by Anyevent by using
375it's adaptor.
367 376
368=item AnyEvent::detect 377=item AnyEvent::detect
369 378
370Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 379Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
371if necessary. You should only call this function right before you would 380if necessary. You should only call this function right before you would
… …
422no warnings; 431no warnings;
423use strict; 432use strict;
424 433
425use Carp; 434use Carp;
426 435
427our $VERSION = '3.12'; 436our $VERSION = '3.2';
428our $MODEL; 437our $MODEL;
429 438
430our $AUTOLOAD; 439our $AUTOLOAD;
431our @ISA; 440our @ISA;
432 441
… …
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
446my @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
451our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY); 460our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY);
452 461
453sub detect() { 462sub detect() {
… …
457 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 466 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
458 my $model = "AnyEvent::Impl::$1"; 467 my $model = "AnyEvent::Impl::$1";
459 if (eval "require $model") { 468 if (eval "require $model") {
460 $MODEL = $model; 469 $MODEL = $model;
461 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;
462 } 473 }
463 } 474 }
464 475
465 # check for already loaded models 476 # check for already loaded models
466 unless ($MODEL) { 477 unless ($MODEL) {
467 for (@REGISTRY, @models, @models_detect) { 478 for (@REGISTRY, @models) {
468 my ($package, $model) = @$_; 479 my ($package, $model) = @$_;
469 if (${"$package\::VERSION"} > 0) { 480 if (${"$package\::VERSION"} > 0) {
470 if (eval "require $model") { 481 if (eval "require $model") {
471 $MODEL = $model; 482 $MODEL = $model;
472 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; 483 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;
… …
659 670
660=over 4 671=over 4
661 672
662=item C<PERL_ANYEVENT_VERBOSE> 673=item C<PERL_ANYEVENT_VERBOSE>
663 674
675By default, AnyEvent will be completely silent except in fatal
676conditions. You can set this environment variable to make AnyEvent more
677talkative.
678
679When set to C<1> or higher, causes AnyEvent to warn about unexpected
680conditions, such as not being able to load the event model specified by
681C<PERL_ANYEVENT_MODEL>.
682
664When set to C<2> or higher, cause AnyEvent to report to STDERR which event 683When set to C<2> or higher, cause AnyEvent to report to STDERR which event
665model it chooses. 684model it chooses.
666 685
667=item C<PERL_ANYEVENT_MODEL> 686=item C<PERL_ANYEVENT_MODEL>
668 687
… …
864 883
865=head1 SEE ALSO 884=head1 SEE ALSO
866 885
867Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>, 886Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>,
868L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>, 887L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>,
869L<Event::Lib>, L<Qt>. 888L<Event::Lib>, L<Qt>, L<POE>.
870 889
871Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>, 890Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>,
872L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>, 891L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>,
873L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>, 892L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>,
874L<AnyEvent::Impl::Qt>. 893L<AnyEvent::Impl::Qt>, L<AnyEvent::Impl::POE>.
875 894
876Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. 895Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>.
877 896
878=head1 AUTHOR 897=head1 AUTHOR
879 898

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines