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.351 by root, Tue Aug 2 22:07:16 2011 UTC vs.
Revision 1.352 by root, Thu Aug 4 09:14:01 2011 UTC

… …
121The interface itself is vaguely similar, but not identical to the L<Event> 121The interface itself is vaguely similar, but not identical to the L<Event>
122module. 122module.
123 123
124During the first call of any watcher-creation method, the module tries 124During the first call of any watcher-creation method, the module tries
125to detect the currently loaded event loop by probing whether one of the 125to detect the currently loaded event loop by probing whether one of the
126following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>, 126following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
127L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one 127L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
128found is used. If none are detected, the module tries to load the first 128found is used. If none are detected, the module tries to load the first
129four modules in the order given; but note that if L<EV> is not 129four modules in the order given; but note that if L<EV> is not
130available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so 130available, the pure-perl L<AnyEvent::Loop> should always work, so
131the other two are not normally tried. 131the other two are not normally tried.
132 132
133Because AnyEvent first checks for modules that are already loaded, loading 133Because AnyEvent first checks for modules that are already loaded, loading
134an event model explicitly before first using AnyEvent will likely make 134an event model explicitly before first using AnyEvent will likely make
135that model the default. For example: 135that model the default. For example:
… …
142The I<likely> means that, if any module loads another event model and 142The I<likely> means that, if any module loads another event model and
143starts using it, all bets are off - this case should be very rare though, 143starts using it, all bets are off - this case should be very rare though,
144as very few modules hardcode event loops without announcing this very 144as very few modules hardcode event loops without announcing this very
145loudly. 145loudly.
146 146
147The pure-perl implementation of AnyEvent is called 147The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
148C<AnyEvent::Impl::Perl>. Like other event modules you can load it 148other event modules you can load it explicitly and enjoy the high
149explicitly and enjoy the high availability of that event loop :) 149availability of that event loop :)
150 150
151=head1 WATCHERS 151=head1 WATCHERS
152 152
153AnyEvent has the central concept of a I<watcher>, which is an object that 153AnyEvent has the central concept of a I<watcher>, which is an object that
154stores relevant data for each kind of event you are waiting for, such as 154stores relevant data for each kind of event you are waiting for, such as
… …
356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
357account. 357account.
358 358
359=item AnyEvent->now_update 359=item AnyEvent->now_update
360 360
361Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache 361Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current
362the current time for each loop iteration (see the discussion of L<< 362time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
363AnyEvent->now >>, above). 363above).
364 364
365When a callback runs for a long time (or when the process sleeps), then 365When a callback runs for a long time (or when the process sleeps), then
366this "current" time will differ substantially from the real time, which 366this "current" time will differ substantially from the real time, which
367might affect timers and time-outs. 367might affect timers and time-outs.
368 368
… …
860use. If EV is not installed, then AnyEvent will fall back to its own 860use. If EV is not installed, then AnyEvent will fall back to its own
861pure-perl implementation, which is available everywhere as it comes with 861pure-perl implementation, which is available everywhere as it comes with
862AnyEvent itself. 862AnyEvent itself.
863 863
864 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 864 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
865 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 865 AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
866 866
867=item Backends that are transparently being picked up when they are used. 867=item Backends that are transparently being picked up when they are used.
868 868
869These will be used if they are already loaded when the first watcher 869These will be used if they are already loaded when the first watcher
870is created, in which case it is assumed that the application is using 870is created, in which case it is assumed that the application is using
… …
1047modules might create watchers when they are loaded, and AnyEvent will 1047modules might create watchers when they are loaded, and AnyEvent will
1048decide on the event model to use as soon as it creates watchers, and it 1048decide on the event model to use as soon as it creates watchers, and it
1049might choose the wrong one unless you load the correct one yourself. 1049might choose the wrong one unless you load the correct one yourself.
1050 1050
1051You can chose to use a pure-perl implementation by loading the 1051You can chose to use a pure-perl implementation by loading the
1052C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1052C<AnyEvent::Loop> module, which gives you similar behaviour
1053everywhere, but letting AnyEvent chose the model is generally better. 1053everywhere, but letting AnyEvent chose the model is generally better.
1054 1054
1055=head2 MAINLOOP EMULATION 1055=head2 MAINLOOP EMULATION
1056 1056
1057Sometimes (often for short test scripts, or even standalone programs who 1057Sometimes (often for short test scripts, or even standalone programs who
… …
1197 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1197 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1198} 1198}
1199 1199
1200my @models = ( 1200my @models = (
1201 [EV:: => AnyEvent::Impl::EV:: , 1], 1201 [EV:: => AnyEvent::Impl::EV:: , 1],
1202 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1202 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1203 # everything below here will not (normally) be autoprobed 1203 # everything below here will not (normally) be autoprobed
1204 # as the pureperl backend should work everywhere 1204 # as the pure perl backend should work everywhere
1205 # and is usually faster 1205 # and is usually faster
1206 [Event:: => AnyEvent::Impl::Event::, 1], 1206 [Event:: => AnyEvent::Impl::Event::, 1],
1207 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1207 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1208 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1208 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1209 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1209 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
… …
1423 1423
1424*now = \&time; 1424*now = \&time;
1425 1425
1426sub now_update { } 1426sub now_update { }
1427 1427
1428sub _poll {
1429 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1430}
1431
1428# default implementation for ->condvar 1432# default implementation for ->condvar
1433# in fact,t he default should not be overwritten
1429 1434
1430sub condvar { 1435sub condvar {
1431 eval q{ # poor man's autoloading {} 1436 eval q{ # poor man's autoloading {}
1432 *condvar = sub { 1437 *condvar = sub {
1433 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1438 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
… …
1740sub _send { 1745sub _send {
1741 # nop 1746 # nop
1742} 1747}
1743 1748
1744sub _wait { 1749sub _wait {
1745 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; 1750 AnyEvent->_poll until $_[0]{_ae_sent};
1746} 1751}
1747 1752
1748sub send { 1753sub send {
1749 my $cv = shift; 1754 my $cv = shift;
1750 $cv->{_ae_sent} = [@_]; 1755 $cv->{_ae_sent} = [@_];
… …
1762} 1767}
1763 1768
1764sub recv { 1769sub recv {
1765 unless ($_[0]{_ae_sent}) { 1770 unless ($_[0]{_ae_sent}) {
1766 $WAITING 1771 $WAITING
1767 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected"; 1772 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1768 1773
1769 local $WAITING = 1; 1774 local $WAITING = 1;
1770 $_[0]->_wait; 1775 $_[0]->_wait;
1771 } 1776 }
1772 1777
… …
1872used as event model. If it fails to load AnyEvent will proceed with 1877used as event model. If it fails to load AnyEvent will proceed with
1873auto detection and -probing. 1878auto detection and -probing.
1874 1879
1875This functionality might change in future versions. 1880This functionality might change in future versions.
1876 1881
1877For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 1882For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1878could start your program like this: 1883could start your program like this:
1879 1884
1880 PERL_ANYEVENT_MODEL=Perl perl ... 1885 PERL_ANYEVENT_MODEL=Perl perl ...
1881 1886
1882=item C<PERL_ANYEVENT_PROTOCOLS> 1887=item C<PERL_ANYEVENT_PROTOCOLS>
… …
2581 2586
2582=item L<Time::HiRes> 2587=item L<Time::HiRes>
2583 2588
2584This module is part of perl since release 5.008. It will be used when the 2589This module is part of perl since release 5.008. It will be used when the
2585chosen event library does not come with a timing source of its own. The 2590chosen event library does not come with a timing source of its own. The
2586pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2591pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2587try to use a monotonic clock for timing stability. 2592try to use a monotonic clock for timing stability.
2588 2593
2589=back 2594=back
2590 2595
2591 2596
… …
2659 2664
2660FAQ: L<AnyEvent::FAQ>. 2665FAQ: L<AnyEvent::FAQ>.
2661 2666
2662Utility functions: L<AnyEvent::Util>. 2667Utility functions: L<AnyEvent::Util>.
2663 2668
2664Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2669Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,
2665L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2670L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2666 2671
2667Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2672Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2668L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2673L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2669L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2674L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2670L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2675L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.

Diff Legend

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