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 | Event, Coro, Glib, Tk, Perl - various supported event loops |
5 | EV, Event, Coro::EV, Coro::Event, Glib, Tk, Perl - various supported event loops |
6 | |
6 | |
7 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
8 | |
8 | |
9 | use AnyEvent; |
9 | use AnyEvent; |
10 | |
10 | |
… | |
… | |
58 | modules, you get an enourmous amount of code and strict rules you have |
58 | modules, you get an enourmous amount of code and strict rules you have |
59 | to follow. AnyEvent, on the other hand, is lean and to the point by only |
59 | to follow. AnyEvent, on the other hand, is lean and to the point by only |
60 | offering the functionality that is useful, in as thin as a wrapper as |
60 | offering the functionality that is useful, in as thin as a wrapper as |
61 | technically possible. |
61 | technically possible. |
62 | |
62 | |
63 | Of course, if you want lots of policy (this is arguably somewhat useful in |
63 | Of course, if you want lots of policy (this can arguably be somewhat |
64 | many cases) and you want your users to the one and only event model your |
64 | useful) and you want to force your users to use the one and only event |
65 | module forces on them, you should I<not> use this module. |
65 | model, you should I<not> use this module. |
66 | |
66 | |
67 | |
67 | |
68 | =head1 DESCRIPTION |
68 | =head1 DESCRIPTION |
69 | |
69 | |
70 | L<AnyEvent> provides an identical interface to multiple event loops. This |
70 | L<AnyEvent> provides an identical interface to multiple event loops. This |
… | |
… | |
75 | The interface itself is vaguely similar but not identical to the Event |
75 | The interface itself is vaguely similar but not identical to the Event |
76 | module. |
76 | module. |
77 | |
77 | |
78 | On the first call of any method, the module tries to detect the currently |
78 | On the first call of any method, the module tries to detect the currently |
79 | loaded event loop by probing wether any of the following modules is |
79 | loaded event loop by probing wether any of the following modules is |
80 | loaded: L<Coro::Event>, L<Event>, L<Glib>, L<Tk>. The first one found is |
80 | loaded: L<Coro::EV>, L<Coro::Event>, L<EV>, L<Event>, L<Glib>, L<Tk>. The |
81 | used. If none is found, the module tries to load these modules in the |
81 | first one found is used. If none are found, the module tries to load these |
82 | order given. The first one that could be successfully loaded will be |
82 | modules in the order given. The first one that could be successfully |
83 | used. If still none could be found, AnyEvent will fall back to a pure-perl |
83 | loaded will be used. If still none could be found, AnyEvent will fall back |
84 | event loop, which is also not very efficient. |
84 | to a pure-perl event loop, which is also not very efficient. |
85 | |
85 | |
86 | Because AnyEvent first checks for modules that are already loaded, loading |
86 | Because AnyEvent first checks for modules that are already loaded, loading |
87 | an Event model explicitly before first using AnyEvent will likely make |
87 | an Event model explicitly before first using AnyEvent will likely make |
88 | that model the default. For example: |
88 | that model the default. For example: |
89 | |
89 | |
… | |
… | |
118 | C<fh> the Perl I<filehandle> (not filedescriptor) to watch for |
118 | C<fh> the Perl I<filehandle> (not filedescriptor) to watch for |
119 | events. C<poll> must be a string that is either C<r> or C<w>, that creates |
119 | events. C<poll> must be a string that is either C<r> or C<w>, that creates |
120 | a watcher waiting for "r"eadable or "w"ritable events. C<cb> the callback |
120 | a watcher waiting for "r"eadable or "w"ritable events. C<cb> the callback |
121 | to invoke everytime the filehandle becomes ready. |
121 | to invoke everytime the filehandle becomes ready. |
122 | |
122 | |
123 | Only one io watcher per C<fh> and C<poll> combination is allowed (i.e. on |
|
|
124 | a socket you can have one r + one w, not any more (limitation comes from |
|
|
125 | Tk - if you are sure you are not using Tk this limitation is gone). |
|
|
126 | |
|
|
127 | Filehandles will be kept alive, so as long as the watcher exists, the |
123 | Filehandles will be kept alive, so as long as the watcher exists, the |
128 | filehandle exists, too. |
124 | filehandle exists, too. |
129 | |
125 | |
130 | Example: |
126 | Example: |
131 | |
127 | |
… | |
… | |
179 | =item $cv->wait |
175 | =item $cv->wait |
180 | |
176 | |
181 | Wait (blocking if necessary) until the C<< ->broadcast >> method has been |
177 | Wait (blocking if necessary) until the C<< ->broadcast >> method has been |
182 | called on c<$cv>, while servicing other watchers normally. |
178 | called on c<$cv>, while servicing other watchers normally. |
183 | |
179 | |
184 | Not all event models support a blocking wait - some die in that case, so |
|
|
185 | if you are using this from a module, never require a blocking wait, but |
|
|
186 | let the caller decide wether the call will block or not (for example, |
|
|
187 | by coupling condition variables with some kind of request results and |
|
|
188 | supporting callbacks so the caller knows that getting the result will not |
|
|
189 | block, while still suppporting blockign waits if the caller so desires). |
|
|
190 | |
|
|
191 | You can only wait once on a condition - additional calls will return |
180 | You can only wait once on a condition - additional calls will return |
192 | immediately. |
181 | immediately. |
|
|
182 | |
|
|
183 | Not all event models support a blocking wait - some die in that case |
|
|
184 | (programs might want to do that so they stay interactive), so I<if you |
|
|
185 | are using this from a module, never require a blocking wait>, but let the |
|
|
186 | caller decide wether the call will block or not (for example, by coupling |
|
|
187 | condition variables with some kind of request results and supporting |
|
|
188 | callbacks so the caller knows that getting the result will not block, |
|
|
189 | while still suppporting blocking waits if the caller so desires). |
|
|
190 | |
|
|
191 | Another reason I<never> to C<< ->wait >> in a module is that you cannot |
|
|
192 | sensibly have two C<< ->wait >>'s in parallel, as that would require |
|
|
193 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
|
|
194 | can supply (the coroutine-aware backends C<Coro::EV> and C<Coro::Event> |
|
|
195 | explicitly support concurrent C<< ->wait >>'s from different coroutines, |
|
|
196 | however). |
193 | |
197 | |
194 | =item $cv->broadcast |
198 | =item $cv->broadcast |
195 | |
199 | |
196 | Flag the condition as ready - a running C<< ->wait >> and all further |
200 | Flag the condition as ready - a running C<< ->wait >> and all further |
197 | calls to C<wait> will return after this method has been called. If nobody |
201 | calls to C<wait> will return after this method has been called. If nobody |
… | |
… | |
249 | AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). |
253 | AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). |
250 | |
254 | |
251 | The known classes so far are: |
255 | The known classes so far are: |
252 | |
256 | |
253 | AnyEvent::Impl::CoroEV based on Coro::EV, best choice. |
257 | AnyEvent::Impl::CoroEV based on Coro::EV, best choice. |
|
|
258 | AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice. |
254 | AnyEvent::Impl::EV based on EV (an interface to libev, also best choice). |
259 | AnyEvent::Impl::EV based on EV (an interface to libev, also best choice). |
255 | AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice. |
|
|
256 | AnyEvent::Impl::Event based on Event, also second best choice :) |
260 | AnyEvent::Impl::Event based on Event, also second best choice :) |
257 | AnyEvent::Impl::Glib based on Glib, second-best choice. |
261 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
258 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
262 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
259 | AnyEvent::Impl::Perl pure-perl implementation, inefficient. |
263 | AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable. |
260 | |
264 | |
261 | =item AnyEvent::detect |
265 | =item AnyEvent::detect |
262 | |
266 | |
263 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model if |
267 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model if |
264 | necessary. You should only call this function right before you would have |
268 | necessary. You should only call this function right before you would have |
… | |
… | |
303 | no warnings; |
307 | no warnings; |
304 | use strict; |
308 | use strict; |
305 | |
309 | |
306 | use Carp; |
310 | use Carp; |
307 | |
311 | |
308 | our $VERSION = '3.0'; |
312 | our $VERSION = '3.1'; |
309 | our $MODEL; |
313 | our $MODEL; |
310 | |
314 | |
311 | our $AUTOLOAD; |
315 | our $AUTOLOAD; |
312 | our @ISA; |
316 | our @ISA; |
313 | |
317 | |
… | |
… | |
315 | |
319 | |
316 | our @REGISTRY; |
320 | our @REGISTRY; |
317 | |
321 | |
318 | my @models = ( |
322 | my @models = ( |
319 | [Coro::EV:: => AnyEvent::Impl::CoroEV::], |
323 | [Coro::EV:: => AnyEvent::Impl::CoroEV::], |
|
|
324 | [Coro::Event:: => AnyEvent::Impl::CoroEvent::], |
320 | [EV:: => AnyEvent::Impl::EV::], |
325 | [EV:: => AnyEvent::Impl::EV::], |
321 | [Coro::Event:: => AnyEvent::Impl::CoroEvent::], |
|
|
322 | [Event:: => AnyEvent::Impl::Event::], |
326 | [Event:: => AnyEvent::Impl::Event::], |
323 | [Glib:: => AnyEvent::Impl::Glib::], |
327 | [Glib:: => AnyEvent::Impl::Glib::], |
324 | [Tk:: => AnyEvent::Impl::Tk::], |
328 | [Tk:: => AnyEvent::Impl::Tk::], |
325 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
329 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
326 | ); |
330 | ); |
… | |
… | |
634 | |
638 | |
635 | 1. Blocking: |
639 | 1. Blocking: |
636 | |
640 | |
637 | my $data = $fcp->client_get ($url); |
641 | my $data = $fcp->client_get ($url); |
638 | |
642 | |
639 | 2. Blocking, but parallelizing: |
643 | 2. Blocking, but running in parallel: |
640 | |
644 | |
641 | my @datas = map $_->result, |
645 | my @datas = map $_->result, |
642 | map $fcp->txn_client_get ($_), |
646 | map $fcp->txn_client_get ($_), |
643 | @urls; |
647 | @urls; |
644 | |
648 | |
645 | Both blocking examples work without the module user having to know |
649 | Both blocking examples work without the module user having to know |
646 | anything about events. |
650 | anything about events. |
647 | |
651 | |
648 | 3a. Event-based in a main program, using any support Event module: |
652 | 3a. Event-based in a main program, using any supported event module: |
649 | |
653 | |
650 | use Event; |
654 | use EV; |
651 | |
655 | |
652 | $fcp->txn_client_get ($url)->cb (sub { |
656 | $fcp->txn_client_get ($url)->cb (sub { |
653 | my $txn = shift; |
657 | my $txn = shift; |
654 | my $data = $txn->result; |
658 | my $data = $txn->result; |
655 | ... |
659 | ... |
656 | }); |
660 | }); |
657 | |
661 | |
658 | Event::loop; |
662 | EV::loop; |
659 | |
663 | |
660 | 3b. The module user could use AnyEvent, too: |
664 | 3b. The module user could use AnyEvent, too: |
661 | |
665 | |
662 | use AnyEvent; |
666 | use AnyEvent; |
663 | |
667 | |
… | |
… | |
670 | |
674 | |
671 | $quit->wait; |
675 | $quit->wait; |
672 | |
676 | |
673 | =head1 SEE ALSO |
677 | =head1 SEE ALSO |
674 | |
678 | |
675 | Event modules: L<Coro::Event>, L<Coro>, L<Event>, L<Glib::Event>, L<Glib>. |
679 | Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>, |
|
|
680 | L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>. |
676 | |
681 | |
677 | Implementations: L<AnyEvent::Impl::Coro>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>. |
682 | Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>, |
|
|
683 | L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, |
|
|
684 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>. |
678 | |
685 | |
679 | Nontrivial usage example: L<Net::FCP>. |
686 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. |
680 | |
687 | |
681 | =head1 |
688 | =head1 |
682 | |
689 | |
683 | =cut |
690 | =cut |
684 | |
691 | |