… | |
… | |
17 | }); |
17 | }); |
18 | |
18 | |
19 | my $w = AnyEvent->condvar; # stores wether a condition was flagged |
19 | my $w = AnyEvent->condvar; # stores wether 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 | |
|
|
23 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
|
|
24 | |
|
|
25 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
|
|
26 | nowadays. So what is different about AnyEvent? |
|
|
27 | |
|
|
28 | Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of |
|
|
29 | policy> and AnyEvent is I<small and efficient>. |
|
|
30 | |
|
|
31 | First and foremost, I<AnyEvent is not an event model> itself, it only |
|
|
32 | interfaces to whatever event model the main program happens to use in a |
|
|
33 | pragmatic way. For event models and certain classes of immortals alike, |
|
|
34 | the statement "there can only be one" is a bitter reality, and AnyEvent |
|
|
35 | helps hiding the differences. |
|
|
36 | |
|
|
37 | The goal of AnyEvent is to offer module authors the ability to do event |
|
|
38 | programming (waiting for I/O or timer events) without subscribing to a |
|
|
39 | religion, a way of living, and most importantly: without forcing your |
|
|
40 | module users into the same thing by forcing them to use the same event |
|
|
41 | model you use. |
|
|
42 | |
|
|
43 | For modules like POE or IO::Async (which is actually doing all I/O |
|
|
44 | I<synchronously>...), using them in your module is like joining a |
|
|
45 | cult: After you joined, you are dependent on them and you cannot use |
|
|
46 | anything else, as it is simply incompatible to everything that isn't |
|
|
47 | itself. |
|
|
48 | |
|
|
49 | AnyEvent + POE works fine. AnyEvent + Glib works fine. AnyEvent + Tk |
|
|
50 | works fine etc. etc. but none of these work together with the rest: POE |
|
|
51 | + IO::Async? no go. Tk + Event? no go. If your module uses one of |
|
|
52 | those, every user of your module has to use it, too. If your module |
|
|
53 | uses AnyEvent, it works transparently with all event models it supports |
|
|
54 | (including stuff like POE and IO::Async). |
|
|
55 | |
|
|
56 | In addition of being free of having to use I<the one and only true event |
|
|
57 | model>, AnyEvent also is free of bloat and policy: with POE or similar |
|
|
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 |
|
|
60 | offering the functionality that is useful, in as thin as a wrapper as |
|
|
61 | technically possible. |
|
|
62 | |
|
|
63 | Of course, if you want lots of policy (this can arguably be somewhat |
|
|
64 | useful) and you want to force your users to use the one and only event |
|
|
65 | model, you should I<not> use this module. |
|
|
66 | |
22 | |
67 | |
23 | =head1 DESCRIPTION |
68 | =head1 DESCRIPTION |
24 | |
69 | |
25 | L<AnyEvent> provides an identical interface to multiple event loops. This |
70 | L<AnyEvent> provides an identical interface to multiple event loops. This |
26 | allows module authors to utilise an event loop without forcing module |
71 | allows module authors to utilise an event loop without forcing module |
… | |
… | |
119 | method without any arguments. |
164 | method without any arguments. |
120 | |
165 | |
121 | A condition watcher watches for a condition - precisely that the C<< |
166 | A condition watcher watches for a condition - precisely that the C<< |
122 | ->broadcast >> method has been called. |
167 | ->broadcast >> method has been called. |
123 | |
168 | |
|
|
169 | Note that condition watchers recurse into the event loop - if you have |
|
|
170 | two watchers that call C<< ->wait >> in a round-robbin fashion, you |
|
|
171 | lose. Therefore, condition watchers are good to export to your caller, but |
|
|
172 | you should avoid making a blocking wait, at least in callbacks, as this |
|
|
173 | usually asks for trouble. |
|
|
174 | |
124 | The watcher has only two methods: |
175 | The watcher has only two methods: |
125 | |
176 | |
126 | =over 4 |
177 | =over 4 |
127 | |
178 | |
128 | =item $cv->wait |
179 | =item $cv->wait |
129 | |
180 | |
130 | Wait (blocking if necessary) until the C<< ->broadcast >> method has been |
181 | Wait (blocking if necessary) until the C<< ->broadcast >> method has been |
131 | called on c<$cv>, while servicing other watchers normally. |
182 | called on c<$cv>, while servicing other watchers normally. |
132 | |
183 | |
133 | Not all event models support a blocking wait - some die in that case, so |
|
|
134 | if you are using this from a module, never require a blocking wait, but |
|
|
135 | let the caller decide wether the call will block or not (for example, |
|
|
136 | by coupling condition variables with some kind of request results and |
|
|
137 | supporting callbacks so the caller knows that getting the result will not |
|
|
138 | block, while still suppporting blockign waits if the caller so desires). |
|
|
139 | |
|
|
140 | You can only wait once on a condition - additional calls will return |
184 | You can only wait once on a condition - additional calls will return |
141 | immediately. |
185 | immediately. |
|
|
186 | |
|
|
187 | 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 |
|
|
189 | 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 |
|
|
191 | condition variables with some kind of request results and supporting |
|
|
192 | callbacks so the caller knows that getting the result will not block, |
|
|
193 | while still suppporting blocking waits if the caller so desires). |
|
|
194 | |
|
|
195 | Another reason I<never> to C<< ->wait >> in a module is that you cannot |
|
|
196 | sensibly have two C<< ->wait >>'s in parallel, as that would require |
|
|
197 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
|
|
198 | can supply (the coroutine-aware backends C<Coro::EV> and C<Coro::Event> |
|
|
199 | explicitly support concurrent C<< ->wait >>'s from different coroutines, |
|
|
200 | however). |
142 | |
201 | |
143 | =item $cv->broadcast |
202 | =item $cv->broadcast |
144 | |
203 | |
145 | Flag the condition as ready - a running C<< ->wait >> and all further |
204 | Flag the condition as ready - a running C<< ->wait >> and all further |
146 | calls to C<wait> will return after this method has been called. If nobody |
205 | calls to C<wait> will return after this method has been called. If nobody |
… | |
… | |
199 | |
258 | |
200 | The known classes so far are: |
259 | The known classes so far are: |
201 | |
260 | |
202 | AnyEvent::Impl::CoroEV based on Coro::EV, best choice. |
261 | AnyEvent::Impl::CoroEV based on Coro::EV, best choice. |
203 | AnyEvent::Impl::EV based on EV (an interface to libev, also best choice). |
262 | AnyEvent::Impl::EV based on EV (an interface to libev, also best choice). |
204 | AnyEvent::Impl::Coro based on Coro::Event, second best choice. |
263 | AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice. |
205 | AnyEvent::Impl::Event based on Event, also second best choice :) |
264 | AnyEvent::Impl::Event based on Event, also second best choice :) |
206 | AnyEvent::Impl::Glib based on Glib, second-best choice. |
265 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
207 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
266 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
208 | AnyEvent::Impl::Perl pure-perl implementation, inefficient. |
267 | AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable. |
209 | |
268 | |
210 | =item AnyEvent::detect |
269 | =item AnyEvent::detect |
211 | |
270 | |
212 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model if |
271 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model if |
213 | necessary. You should only call this function right before you would have |
272 | necessary. You should only call this function right before you would have |
… | |
… | |
252 | no warnings; |
311 | no warnings; |
253 | use strict; |
312 | use strict; |
254 | |
313 | |
255 | use Carp; |
314 | use Carp; |
256 | |
315 | |
257 | our $VERSION = '2.9'; |
316 | our $VERSION = '3.0'; |
258 | our $MODEL; |
317 | our $MODEL; |
259 | |
318 | |
260 | our $AUTOLOAD; |
319 | our $AUTOLOAD; |
261 | our @ISA; |
320 | our @ISA; |
262 | |
321 | |
… | |
… | |
265 | our @REGISTRY; |
324 | our @REGISTRY; |
266 | |
325 | |
267 | my @models = ( |
326 | my @models = ( |
268 | [Coro::EV:: => AnyEvent::Impl::CoroEV::], |
327 | [Coro::EV:: => AnyEvent::Impl::CoroEV::], |
269 | [EV:: => AnyEvent::Impl::EV::], |
328 | [EV:: => AnyEvent::Impl::EV::], |
270 | [Coro::Event:: => AnyEvent::Impl::Coro::], |
329 | [Coro::Event:: => AnyEvent::Impl::CoroEvent::], |
271 | [Event:: => AnyEvent::Impl::Event::], |
330 | [Event:: => AnyEvent::Impl::Event::], |
272 | [Glib:: => AnyEvent::Impl::Glib::], |
331 | [Glib:: => AnyEvent::Impl::Glib::], |
273 | [Tk:: => AnyEvent::Impl::Tk::], |
332 | [Tk:: => AnyEvent::Impl::Tk::], |
274 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
333 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
275 | ); |
334 | ); |
… | |
… | |
583 | |
642 | |
584 | 1. Blocking: |
643 | 1. Blocking: |
585 | |
644 | |
586 | my $data = $fcp->client_get ($url); |
645 | my $data = $fcp->client_get ($url); |
587 | |
646 | |
588 | 2. Blocking, but parallelizing: |
647 | 2. Blocking, but running in parallel: |
589 | |
648 | |
590 | my @datas = map $_->result, |
649 | my @datas = map $_->result, |
591 | map $fcp->txn_client_get ($_), |
650 | map $fcp->txn_client_get ($_), |
592 | @urls; |
651 | @urls; |
593 | |
652 | |
594 | Both blocking examples work without the module user having to know |
653 | Both blocking examples work without the module user having to know |
595 | anything about events. |
654 | anything about events. |
596 | |
655 | |
597 | 3a. Event-based in a main program, using any support Event module: |
656 | 3a. Event-based in a main program, using any supported event module: |
598 | |
657 | |
599 | use Event; |
658 | use EV; |
600 | |
659 | |
601 | $fcp->txn_client_get ($url)->cb (sub { |
660 | $fcp->txn_client_get ($url)->cb (sub { |
602 | my $txn = shift; |
661 | my $txn = shift; |
603 | my $data = $txn->result; |
662 | my $data = $txn->result; |
604 | ... |
663 | ... |
605 | }); |
664 | }); |
606 | |
665 | |
607 | Event::loop; |
666 | EV::loop; |
608 | |
667 | |
609 | 3b. The module user could use AnyEvent, too: |
668 | 3b. The module user could use AnyEvent, too: |
610 | |
669 | |
611 | use AnyEvent; |
670 | use AnyEvent; |
612 | |
671 | |
… | |
… | |
619 | |
678 | |
620 | $quit->wait; |
679 | $quit->wait; |
621 | |
680 | |
622 | =head1 SEE ALSO |
681 | =head1 SEE ALSO |
623 | |
682 | |
624 | Event modules: L<Coro::Event>, L<Coro>, L<Event>, L<Glib::Event>, L<Glib>. |
683 | Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>, |
|
|
684 | L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>. |
625 | |
685 | |
626 | Implementations: L<AnyEvent::Impl::Coro>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>. |
686 | Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>, |
|
|
687 | L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, |
|
|
688 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>. |
627 | |
689 | |
628 | Nontrivial usage example: L<Net::FCP>. |
690 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. |
629 | |
691 | |
630 | =head1 |
692 | =head1 |
631 | |
693 | |
632 | =cut |
694 | =cut |
633 | |
695 | |