… | |
… | |
121 | The interface itself is vaguely similar, but not identical to the L<Event> |
121 | The interface itself is vaguely similar, but not identical to the L<Event> |
122 | module. |
122 | module. |
123 | |
123 | |
124 | During the first call of any watcher-creation method, the module tries |
124 | During the first call of any watcher-creation method, the module tries |
125 | to detect the currently loaded event loop by probing whether one of the |
125 | to detect the currently loaded event loop by probing whether one of the |
126 | following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>, |
126 | following modules is already loaded: L<EV>, L<AnyEvent::Loop>, |
127 | L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one |
127 | L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one |
128 | found is used. If none are detected, the module tries to load the first |
128 | found is used. If none are detected, the module tries to load the first |
129 | four modules in the order given; but note that if L<EV> is not |
129 | four modules in the order given; but note that if L<EV> is not |
130 | available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so |
130 | available, the pure-perl L<AnyEvent::Loop> should always work, so |
131 | the other two are not normally tried. |
131 | the other two are not normally tried. |
132 | |
132 | |
133 | Because AnyEvent first checks for modules that are already loaded, loading |
133 | Because AnyEvent first checks for modules that are already loaded, loading |
134 | an event model explicitly before first using AnyEvent will likely make |
134 | an event model explicitly before first using AnyEvent will likely make |
135 | that model the default. For example: |
135 | that model the default. For example: |
… | |
… | |
142 | The I<likely> means that, if any module loads another event model and |
142 | The I<likely> means that, if any module loads another event model and |
143 | starts using it, all bets are off - this case should be very rare though, |
143 | starts using it, all bets are off - this case should be very rare though, |
144 | as very few modules hardcode event loops without announcing this very |
144 | as very few modules hardcode event loops without announcing this very |
145 | loudly. |
145 | loudly. |
146 | |
146 | |
147 | The pure-perl implementation of AnyEvent is called |
147 | The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like |
148 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
148 | other event modules you can load it explicitly and enjoy the high |
149 | explicitly and enjoy the high availability of that event loop :) |
149 | availability of that event loop :) |
150 | |
150 | |
151 | =head1 WATCHERS |
151 | =head1 WATCHERS |
152 | |
152 | |
153 | AnyEvent has the central concept of a I<watcher>, which is an object that |
153 | AnyEvent has the central concept of a I<watcher>, which is an object that |
154 | stores relevant data for each kind of event you are waiting for, such as |
154 | stores relevant data for each kind of event you are waiting for, such as |
… | |
… | |
356 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
356 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
357 | account. |
357 | account. |
358 | |
358 | |
359 | =item AnyEvent->now_update |
359 | =item AnyEvent->now_update |
360 | |
360 | |
361 | Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache |
361 | Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current |
362 | the current time for each loop iteration (see the discussion of L<< |
362 | time for each loop iteration (see the discussion of L<< AnyEvent->now >>, |
363 | AnyEvent->now >>, above). |
363 | above). |
364 | |
364 | |
365 | When a callback runs for a long time (or when the process sleeps), then |
365 | When a callback runs for a long time (or when the process sleeps), then |
366 | this "current" time will differ substantially from the real time, which |
366 | this "current" time will differ substantially from the real time, which |
367 | might affect timers and time-outs. |
367 | might affect timers and time-outs. |
368 | |
368 | |
… | |
… | |
482 | thing in an AnyEvent program, you I<have> to create at least one |
482 | thing in an AnyEvent program, you I<have> to create at least one |
483 | watcher before you C<fork> the child (alternatively, you can call |
483 | watcher before you C<fork> the child (alternatively, you can call |
484 | C<AnyEvent::detect>). |
484 | C<AnyEvent::detect>). |
485 | |
485 | |
486 | As most event loops do not support waiting for child events, they will be |
486 | As most event loops do not support waiting for child events, they will be |
487 | emulated by AnyEvent in most cases, in which the latency and race problems |
487 | emulated by AnyEvent in most cases, in which case the latency and race |
488 | mentioned in the description of signal watchers apply. |
488 | problems mentioned in the description of signal watchers apply. |
489 | |
489 | |
490 | Example: fork a process and wait for it |
490 | Example: fork a process and wait for it |
491 | |
491 | |
492 | my $done = AnyEvent->condvar; |
492 | my $done = AnyEvent->condvar; |
493 | |
493 | |
… | |
… | |
860 | use. If EV is not installed, then AnyEvent will fall back to its own |
860 | use. If EV is not installed, then AnyEvent will fall back to its own |
861 | pure-perl implementation, which is available everywhere as it comes with |
861 | pure-perl implementation, which is available everywhere as it comes with |
862 | AnyEvent itself. |
862 | AnyEvent 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 | |
869 | These will be used if they are already loaded when the first watcher |
869 | These will be used if they are already loaded when the first watcher |
870 | is created, in which case it is assumed that the application is using |
870 | is created, in which case it is assumed that the application is using |
… | |
… | |
877 | AnyEvent::Impl::Tk based on Tk, very broken. |
877 | AnyEvent::Impl::Tk based on Tk, very broken. |
878 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
878 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
879 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
879 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
880 | AnyEvent::Impl::Irssi used when running within irssi. |
880 | AnyEvent::Impl::Irssi used when running within irssi. |
881 | AnyEvent::Impl::IOAsync based on IO::Async. |
881 | AnyEvent::Impl::IOAsync based on IO::Async. |
|
|
882 | AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. |
|
|
883 | AnyEvent::Impl::FLTK based on FLTK. |
882 | |
884 | |
883 | =item Backends with special needs. |
885 | =item Backends with special needs. |
884 | |
886 | |
885 | Qt requires the Qt::Application to be instantiated first, but will |
887 | Qt requires the Qt::Application to be instantiated first, but will |
886 | otherwise be picked up automatically. As long as the main program |
888 | otherwise be picked up automatically. As long as the main program |
… | |
… | |
1045 | modules might create watchers when they are loaded, and AnyEvent will |
1047 | modules might create watchers when they are loaded, and AnyEvent will |
1046 | decide on the event model to use as soon as it creates watchers, and it |
1048 | decide on the event model to use as soon as it creates watchers, and it |
1047 | might choose the wrong one unless you load the correct one yourself. |
1049 | might choose the wrong one unless you load the correct one yourself. |
1048 | |
1050 | |
1049 | You can chose to use a pure-perl implementation by loading the |
1051 | You can chose to use a pure-perl implementation by loading the |
1050 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
1052 | C<AnyEvent::Loop> module, which gives you similar behaviour |
1051 | everywhere, but letting AnyEvent chose the model is generally better. |
1053 | everywhere, but letting AnyEvent chose the model is generally better. |
1052 | |
1054 | |
1053 | =head2 MAINLOOP EMULATION |
1055 | =head2 MAINLOOP EMULATION |
1054 | |
1056 | |
1055 | Sometimes (often for short test scripts, or even standalone programs who |
1057 | Sometimes (often for short test scripts, or even standalone programs who |
… | |
… | |
1150 | |
1152 | |
1151 | package AnyEvent; |
1153 | package AnyEvent; |
1152 | |
1154 | |
1153 | # basically a tuned-down version of common::sense |
1155 | # basically a tuned-down version of common::sense |
1154 | sub common_sense { |
1156 | sub common_sense { |
1155 | # from common:.sense 3.3 |
1157 | # from common:.sense 3.4 |
1156 | ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00"; |
1158 | ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00"; |
1157 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
1159 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
1158 | $^H |= 0x00000600; |
1160 | $^H |= 0x00000600; |
1159 | } |
1161 | } |
1160 | |
1162 | |
1161 | BEGIN { AnyEvent::common_sense } |
1163 | BEGIN { AnyEvent::common_sense } |
1162 | |
1164 | |
1163 | use Carp (); |
1165 | use Carp (); |
1164 | |
1166 | |
1165 | our $VERSION = '5.29'; |
1167 | our $VERSION = '5.34'; |
1166 | our $MODEL; |
1168 | our $MODEL; |
1167 | |
1169 | |
1168 | our $AUTOLOAD; |
1170 | our $AUTOLOAD; |
1169 | our @ISA; |
1171 | our @ISA; |
1170 | |
1172 | |
… | |
… | |
1195 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1197 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1196 | } |
1198 | } |
1197 | |
1199 | |
1198 | my @models = ( |
1200 | my @models = ( |
1199 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1201 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1200 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], |
1202 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], |
1201 | # everything below here will not (normally) be autoprobed |
1203 | # everything below here will not (normally) be autoprobed |
1202 | # as the pureperl backend should work everywhere |
1204 | # as the pure perl backend should work everywhere |
1203 | # and is usually faster |
1205 | # and is usually faster |
1204 | [Event:: => AnyEvent::Impl::Event::, 1], |
1206 | [Event:: => AnyEvent::Impl::Event::, 1], |
1205 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1207 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1206 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1208 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1207 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
1209 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
… | |
… | |
1209 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1211 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1210 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1212 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1211 | [Wx:: => AnyEvent::Impl::POE::], |
1213 | [Wx:: => AnyEvent::Impl::POE::], |
1212 | [Prima:: => AnyEvent::Impl::POE::], |
1214 | [Prima:: => AnyEvent::Impl::POE::], |
1213 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], |
1215 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], |
|
|
1216 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
|
|
1217 | [FLTK:: => AnyEvent::Impl::FLTK::], |
1214 | ); |
1218 | ); |
1215 | |
1219 | |
1216 | our %method = map +($_ => 1), |
1220 | our %method = map +($_ => 1), |
1217 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
1221 | qw(io timer time now now_update signal child idle condvar DESTROY); |
1218 | |
1222 | |
1219 | our @post_detect; |
1223 | our @post_detect; |
1220 | |
1224 | |
1221 | sub post_detect(&) { |
1225 | sub post_detect(&) { |
1222 | my ($cb) = @_; |
1226 | my ($cb) = @_; |
… | |
… | |
1419 | |
1423 | |
1420 | *now = \&time; |
1424 | *now = \&time; |
1421 | |
1425 | |
1422 | sub now_update { } |
1426 | sub now_update { } |
1423 | |
1427 | |
|
|
1428 | sub _poll { |
|
|
1429 | Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; |
|
|
1430 | } |
|
|
1431 | |
1424 | # default implementation for ->condvar |
1432 | # default implementation for ->condvar |
|
|
1433 | # in fact,t he default should not be overwritten |
1425 | |
1434 | |
1426 | sub condvar { |
1435 | sub condvar { |
1427 | eval q{ # poor man's autoloading {} |
1436 | eval q{ # poor man's autoloading {} |
1428 | *condvar = sub { |
1437 | *condvar = sub { |
1429 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1438 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
… | |
… | |
1636 | }; |
1645 | }; |
1637 | |
1646 | |
1638 | *child = sub { |
1647 | *child = sub { |
1639 | my (undef, %arg) = @_; |
1648 | my (undef, %arg) = @_; |
1640 | |
1649 | |
1641 | defined (my $pid = $arg{pid} + 0) |
1650 | my $pid = $arg{pid}; |
1642 | or Carp::croak "required option 'pid' is missing"; |
1651 | my $cb = $arg{cb}; |
1643 | |
1652 | |
1644 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1653 | $PID_CB{$pid}{$cb+0} = $cb; |
1645 | |
1654 | |
1646 | unless ($CHLD_W) { |
1655 | unless ($CHLD_W) { |
1647 | $CHLD_W = AE::signal CHLD => \&_sigchld; |
1656 | $CHLD_W = AE::signal CHLD => \&_sigchld; |
1648 | # child could be a zombie already, so make at least one round |
1657 | # child could be a zombie already, so make at least one round |
1649 | &_sigchld; |
1658 | &_sigchld; |
1650 | } |
1659 | } |
1651 | |
1660 | |
1652 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
1661 | bless [$pid, $cb+0], "AnyEvent::Base::child" |
1653 | }; |
1662 | }; |
1654 | |
1663 | |
1655 | *AnyEvent::Base::child::DESTROY = sub { |
1664 | *AnyEvent::Base::child::DESTROY = sub { |
1656 | my ($pid, $cb) = @{$_[0]}; |
1665 | my ($pid, $icb) = @{$_[0]}; |
1657 | |
1666 | |
1658 | delete $PID_CB{$pid}{$cb}; |
1667 | delete $PID_CB{$pid}{$icb}; |
1659 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1668 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1660 | |
1669 | |
1661 | undef $CHLD_W unless keys %PID_CB; |
1670 | undef $CHLD_W unless keys %PID_CB; |
1662 | }; |
1671 | }; |
1663 | }; |
1672 | }; |
… | |
… | |
1735 | |
1744 | |
1736 | sub _send { |
1745 | sub _send { |
1737 | # nop |
1746 | # nop |
1738 | } |
1747 | } |
1739 | |
1748 | |
|
|
1749 | sub _wait { |
|
|
1750 | AnyEvent->_poll until $_[0]{_ae_sent}; |
|
|
1751 | } |
|
|
1752 | |
1740 | sub send { |
1753 | sub send { |
1741 | my $cv = shift; |
1754 | my $cv = shift; |
1742 | $cv->{_ae_sent} = [@_]; |
1755 | $cv->{_ae_sent} = [@_]; |
1743 | (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; |
1756 | (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; |
1744 | $cv->_send; |
1757 | $cv->_send; |
… | |
… | |
1751 | |
1764 | |
1752 | sub ready { |
1765 | sub ready { |
1753 | $_[0]{_ae_sent} |
1766 | $_[0]{_ae_sent} |
1754 | } |
1767 | } |
1755 | |
1768 | |
1756 | sub _wait { |
|
|
1757 | $WAITING |
|
|
1758 | and !$_[0]{_ae_sent} |
|
|
1759 | and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected"; |
|
|
1760 | |
|
|
1761 | local $WAITING = 1; |
|
|
1762 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
|
|
1763 | } |
|
|
1764 | |
|
|
1765 | sub recv { |
1769 | sub recv { |
|
|
1770 | unless ($_[0]{_ae_sent}) { |
|
|
1771 | $WAITING |
|
|
1772 | and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted"; |
|
|
1773 | |
|
|
1774 | local $WAITING = 1; |
1766 | $_[0]->_wait; |
1775 | $_[0]->_wait; |
|
|
1776 | } |
1767 | |
1777 | |
1768 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
1778 | $_[0]{_ae_croak} |
1769 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
1779 | and Carp::croak $_[0]{_ae_croak}; |
|
|
1780 | |
|
|
1781 | wantarray |
|
|
1782 | ? @{ $_[0]{_ae_sent} } |
|
|
1783 | : $_[0]{_ae_sent}[0] |
1770 | } |
1784 | } |
1771 | |
1785 | |
1772 | sub cb { |
1786 | sub cb { |
1773 | my $cv = shift; |
1787 | my $cv = shift; |
1774 | |
1788 | |
… | |
… | |
1790 | &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; |
1804 | &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; |
1791 | } |
1805 | } |
1792 | |
1806 | |
1793 | # undocumented/compatibility with pre-3.4 |
1807 | # undocumented/compatibility with pre-3.4 |
1794 | *broadcast = \&send; |
1808 | *broadcast = \&send; |
1795 | *wait = \&_wait; |
1809 | *wait = \&recv; |
1796 | |
1810 | |
1797 | =head1 ERROR AND EXCEPTION HANDLING |
1811 | =head1 ERROR AND EXCEPTION HANDLING |
1798 | |
1812 | |
1799 | In general, AnyEvent does not do any error handling - it relies on the |
1813 | In general, AnyEvent does not do any error handling - it relies on the |
1800 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
1814 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
… | |
… | |
1863 | used as event model. If it fails to load AnyEvent will proceed with |
1877 | used as event model. If it fails to load AnyEvent will proceed with |
1864 | auto detection and -probing. |
1878 | auto detection and -probing. |
1865 | |
1879 | |
1866 | This functionality might change in future versions. |
1880 | This functionality might change in future versions. |
1867 | |
1881 | |
1868 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1882 | For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you |
1869 | could start your program like this: |
1883 | could start your program like this: |
1870 | |
1884 | |
1871 | PERL_ANYEVENT_MODEL=Perl perl ... |
1885 | PERL_ANYEVENT_MODEL=Perl perl ... |
1872 | |
1886 | |
1873 | =item C<PERL_ANYEVENT_PROTOCOLS> |
1887 | =item C<PERL_ANYEVENT_PROTOCOLS> |
… | |
… | |
2572 | |
2586 | |
2573 | =item L<Time::HiRes> |
2587 | =item L<Time::HiRes> |
2574 | |
2588 | |
2575 | This module is part of perl since release 5.008. It will be used when the |
2589 | This module is part of perl since release 5.008. It will be used when the |
2576 | chosen event library does not come with a timing source of its own. The |
2590 | chosen event library does not come with a timing source of its own. The |
2577 | pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to |
2591 | pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to |
2578 | try to use a monotonic clock for timing stability. |
2592 | try to use a monotonic clock for timing stability. |
2579 | |
2593 | |
2580 | =back |
2594 | =back |
2581 | |
2595 | |
2582 | |
2596 | |
… | |
… | |
2650 | |
2664 | |
2651 | FAQ: L<AnyEvent::FAQ>. |
2665 | FAQ: L<AnyEvent::FAQ>. |
2652 | |
2666 | |
2653 | Utility functions: L<AnyEvent::Util>. |
2667 | Utility functions: L<AnyEvent::Util>. |
2654 | |
2668 | |
2655 | Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, |
2669 | Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>, |
2656 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2670 | L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2657 | |
2671 | |
2658 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2672 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2659 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2673 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2660 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2674 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2661 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
2675 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |