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 | |
… | |
… | |
14 | |
14 | |
15 | my $w = AnyEvent->timer (after => $seconds, cb => sub { |
15 | my $w = AnyEvent->timer (after => $seconds, cb => sub { |
16 | ... |
16 | ... |
17 | }); |
17 | }); |
18 | |
18 | |
19 | my $w = AnyEvent->condvar; # stores wether a condition was flagged |
19 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
20 | $w->wait; # enters "main loop" till $condvar gets ->broadcast |
20 | $w->wait; # enters "main loop" till $condvar gets ->broadcast |
21 | $w->broadcast; # wake up current and all future wait's |
21 | $w->broadcast; # wake up current and all future wait's |
22 | |
22 | |
23 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
23 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
24 | |
24 | |
… | |
… | |
74 | |
74 | |
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 whether 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 | |
… | |
… | |
185 | immediately. |
181 | immediately. |
186 | |
182 | |
187 | Not all event models support a blocking wait - some die in that case |
183 | Not all event models support a blocking wait - some die in that case |
188 | (programs might want to do that so they stay interactive), so I<if you |
184 | (programs might want to do that so they stay interactive), so I<if you |
189 | are using this from a module, never require a blocking wait>, but let the |
185 | are using this from a module, never require a blocking wait>, but let the |
190 | caller decide wether the call will block or not (for example, by coupling |
186 | caller decide whether the call will block or not (for example, by coupling |
191 | condition variables with some kind of request results and supporting |
187 | condition variables with some kind of request results and supporting |
192 | callbacks so the caller knows that getting the result will not block, |
188 | callbacks so the caller knows that getting the result will not block, |
193 | while still suppporting blocking waits if the caller so desires). |
189 | while still suppporting blocking waits if the caller so desires). |
194 | |
190 | |
195 | Another reason I<never> to C<< ->wait >> in a module is that you cannot |
191 | Another reason I<never> to C<< ->wait >> in a module is that you cannot |
… | |
… | |
257 | 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>). |
258 | |
254 | |
259 | The known classes so far are: |
255 | The known classes so far are: |
260 | |
256 | |
261 | 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. |
262 | 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). |
263 | AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice. |
|
|
264 | AnyEvent::Impl::Event based on Event, also second best choice :) |
260 | AnyEvent::Impl::Event based on Event, also second best choice :) |
265 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
261 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
266 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
262 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
267 | AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable. |
263 | AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable. |
268 | |
264 | |
… | |
… | |
311 | no warnings; |
307 | no warnings; |
312 | use strict; |
308 | use strict; |
313 | |
309 | |
314 | use Carp; |
310 | use Carp; |
315 | |
311 | |
316 | our $VERSION = '3.0'; |
312 | our $VERSION = '3.1'; |
317 | our $MODEL; |
313 | our $MODEL; |
318 | |
314 | |
319 | our $AUTOLOAD; |
315 | our $AUTOLOAD; |
320 | our @ISA; |
316 | our @ISA; |
321 | |
317 | |
… | |
… | |
323 | |
319 | |
324 | our @REGISTRY; |
320 | our @REGISTRY; |
325 | |
321 | |
326 | my @models = ( |
322 | my @models = ( |
327 | [Coro::EV:: => AnyEvent::Impl::CoroEV::], |
323 | [Coro::EV:: => AnyEvent::Impl::CoroEV::], |
|
|
324 | [Coro::Event:: => AnyEvent::Impl::CoroEvent::], |
328 | [EV:: => AnyEvent::Impl::EV::], |
325 | [EV:: => AnyEvent::Impl::EV::], |
329 | [Coro::Event:: => AnyEvent::Impl::CoroEvent::], |
|
|
330 | [Event:: => AnyEvent::Impl::Event::], |
326 | [Event:: => AnyEvent::Impl::Event::], |
331 | [Glib:: => AnyEvent::Impl::Glib::], |
327 | [Glib:: => AnyEvent::Impl::Glib::], |
332 | [Tk:: => AnyEvent::Impl::Tk::], |
328 | [Tk:: => AnyEvent::Impl::Tk::], |
333 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
329 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
334 | ); |
330 | ); |
… | |
… | |
631 | $txn->{finished}->wait; |
627 | $txn->{finished}->wait; |
632 | return $txn->{result}; |
628 | return $txn->{result}; |
633 | |
629 | |
634 | The actual code goes further and collects all errors (C<die>s, exceptions) |
630 | The actual code goes further and collects all errors (C<die>s, exceptions) |
635 | that occured during request processing. The C<result> method detects |
631 | that occured during request processing. The C<result> method detects |
636 | wether an exception as thrown (it is stored inside the $txn object) |
632 | whether an exception as thrown (it is stored inside the $txn object) |
637 | and just throws the exception, which means connection errors and other |
633 | and just throws the exception, which means connection errors and other |
638 | problems get reported tot he code that tries to use the result, not in a |
634 | problems get reported tot he code that tries to use the result, not in a |
639 | random callback. |
635 | random callback. |
640 | |
636 | |
641 | All of this enables the following usage styles: |
637 | All of this enables the following usage styles: |
642 | |
638 | |
643 | 1. Blocking: |
639 | 1. Blocking: |
644 | |
640 | |
645 | my $data = $fcp->client_get ($url); |
641 | my $data = $fcp->client_get ($url); |
646 | |
642 | |
647 | 2. Blocking, but parallelizing: |
643 | 2. Blocking, but running in parallel: |
648 | |
644 | |
649 | my @datas = map $_->result, |
645 | my @datas = map $_->result, |
650 | map $fcp->txn_client_get ($_), |
646 | map $fcp->txn_client_get ($_), |
651 | @urls; |
647 | @urls; |
652 | |
648 | |
653 | Both blocking examples work without the module user having to know |
649 | Both blocking examples work without the module user having to know |
654 | anything about events. |
650 | anything about events. |
655 | |
651 | |
656 | 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: |
657 | |
653 | |
658 | use Event; |
654 | use EV; |
659 | |
655 | |
660 | $fcp->txn_client_get ($url)->cb (sub { |
656 | $fcp->txn_client_get ($url)->cb (sub { |
661 | my $txn = shift; |
657 | my $txn = shift; |
662 | my $data = $txn->result; |
658 | my $data = $txn->result; |
663 | ... |
659 | ... |
664 | }); |
660 | }); |
665 | |
661 | |
666 | Event::loop; |
662 | EV::loop; |
667 | |
663 | |
668 | 3b. The module user could use AnyEvent, too: |
664 | 3b. The module user could use AnyEvent, too: |
669 | |
665 | |
670 | use AnyEvent; |
666 | use AnyEvent; |
671 | |
667 | |
… | |
… | |
678 | |
674 | |
679 | $quit->wait; |
675 | $quit->wait; |
680 | |
676 | |
681 | =head1 SEE ALSO |
677 | =head1 SEE ALSO |
682 | |
678 | |
683 | 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>. |
684 | |
681 | |
685 | 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>. |
686 | |
685 | |
687 | Nontrivial usage example: L<Net::FCP>. |
686 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. |
688 | |
687 | |
689 | =head1 |
688 | =head1 |
690 | |
689 | |
691 | =cut |
690 | =cut |
692 | |
691 | |