… | |
… | |
17 | }); |
17 | }); |
18 | |
18 | |
19 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
19 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
20 | $w->send; # wake up current and all future recv's |
20 | $w->send; # wake up current and all future recv's |
21 | $w->recv; # enters "main loop" till $condvar gets ->send |
21 | $w->recv; # enters "main loop" till $condvar gets ->send |
|
|
22 | |
|
|
23 | =head1 INTRODUCTION/TUTORIAL |
|
|
24 | |
|
|
25 | This manpage is mainly a reference manual. If you are interested |
|
|
26 | in a tutorial or some gentle introduction, have a look at the |
|
|
27 | L<AnyEvent::Intro> manpage. |
22 | |
28 | |
23 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
29 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
24 | |
30 | |
25 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
31 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
26 | nowadays. So what is different about AnyEvent? |
32 | nowadays. So what is different about AnyEvent? |
… | |
… | |
48 | isn't itself. What's worse, all the potential users of your module are |
54 | isn't itself. What's worse, all the potential users of your module are |
49 | I<also> forced to use the same event loop you use. |
55 | I<also> forced to use the same event loop you use. |
50 | |
56 | |
51 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
57 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
52 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
58 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
53 | with the rest: POE + IO::Async? no go. Tk + Event? no go. Again: if |
59 | with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if |
54 | your module uses one of those, every user of your module has to use it, |
60 | your module uses one of those, every user of your module has to use it, |
55 | too. But if your module uses AnyEvent, it works transparently with all |
61 | too. But if your module uses AnyEvent, it works transparently with all |
56 | event models it supports (including stuff like POE and IO::Async, as long |
62 | event models it supports (including stuff like POE and IO::Async, as long |
57 | as those use one of the supported event loops. It is trivial to add new |
63 | as those use one of the supported event loops. It is trivial to add new |
58 | event loops to AnyEvent, too, so it is future-proof). |
64 | event loops to AnyEvent, too, so it is future-proof). |
… | |
… | |
62 | modules, you get an enormous amount of code and strict rules you have to |
68 | modules, you get an enormous amount of code and strict rules you have to |
63 | follow. AnyEvent, on the other hand, is lean and up to the point, by only |
69 | follow. AnyEvent, on the other hand, is lean and up to the point, by only |
64 | offering the functionality that is necessary, in as thin as a wrapper as |
70 | offering the functionality that is necessary, in as thin as a wrapper as |
65 | technically possible. |
71 | technically possible. |
66 | |
72 | |
|
|
73 | Of course, AnyEvent comes with a big (and fully optional!) toolbox |
|
|
74 | of useful functionality, such as an asynchronous DNS resolver, 100% |
|
|
75 | non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms |
|
|
76 | such as Windows) and lots of real-world knowledge and workarounds for |
|
|
77 | platform bugs and differences. |
|
|
78 | |
67 | Of course, if you want lots of policy (this can arguably be somewhat |
79 | Now, if you I<do want> lots of policy (this can arguably be somewhat |
68 | useful) and you want to force your users to use the one and only event |
80 | useful) and you want to force your users to use the one and only event |
69 | model, you should I<not> use this module. |
81 | model, you should I<not> use this module. |
70 | |
82 | |
71 | =head1 DESCRIPTION |
83 | =head1 DESCRIPTION |
72 | |
84 | |
… | |
… | |
102 | starts using it, all bets are off. Maybe you should tell their authors to |
114 | starts using it, all bets are off. Maybe you should tell their authors to |
103 | use AnyEvent so their modules work together with others seamlessly... |
115 | use AnyEvent so their modules work together with others seamlessly... |
104 | |
116 | |
105 | The pure-perl implementation of AnyEvent is called |
117 | The pure-perl implementation of AnyEvent is called |
106 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
118 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
107 | explicitly. |
119 | explicitly and enjoy the high availability of that event loop :) |
108 | |
120 | |
109 | =head1 WATCHERS |
121 | =head1 WATCHERS |
110 | |
122 | |
111 | AnyEvent has the central concept of a I<watcher>, which is an object that |
123 | AnyEvent has the central concept of a I<watcher>, which is an object that |
112 | stores relevant data for each kind of event you are waiting for, such as |
124 | stores relevant data for each kind of event you are waiting for, such as |
… | |
… | |
226 | on true relative time) and absolute (ev_periodic, based on wallclock time) |
238 | on true relative time) and absolute (ev_periodic, based on wallclock time) |
227 | timers. |
239 | timers. |
228 | |
240 | |
229 | AnyEvent always prefers relative timers, if available, matching the |
241 | AnyEvent always prefers relative timers, if available, matching the |
230 | AnyEvent API. |
242 | AnyEvent API. |
|
|
243 | |
|
|
244 | AnyEvent has two additional methods that return the "current time": |
|
|
245 | |
|
|
246 | =over 4 |
|
|
247 | |
|
|
248 | =item AnyEvent->time |
|
|
249 | |
|
|
250 | This returns the "current wallclock time" as a fractional number of |
|
|
251 | seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time> |
|
|
252 | return, and the result is guaranteed to be compatible with those). |
|
|
253 | |
|
|
254 | It progresses independently of any event loop processing, i.e. each call |
|
|
255 | will check the system clock, which usually gets updated frequently. |
|
|
256 | |
|
|
257 | =item AnyEvent->now |
|
|
258 | |
|
|
259 | This also returns the "current wallclock time", but unlike C<time>, above, |
|
|
260 | this value might change only once per event loop iteration, depending on |
|
|
261 | the event loop (most return the same time as C<time>, above). This is the |
|
|
262 | time that AnyEvent's timers get scheduled against. |
|
|
263 | |
|
|
264 | I<In almost all cases (in all cases if you don't care), this is the |
|
|
265 | function to call when you want to know the current time.> |
|
|
266 | |
|
|
267 | This function is also often faster then C<< AnyEvent->time >>, and |
|
|
268 | thus the preferred method if you want some timestamp (for example, |
|
|
269 | L<AnyEvent::Handle> uses this to update it's activity timeouts). |
|
|
270 | |
|
|
271 | The rest of this section is only of relevance if you try to be very exact |
|
|
272 | with your timing, you can skip it without bad conscience. |
|
|
273 | |
|
|
274 | For a practical example of when these times differ, consider L<Event::Lib> |
|
|
275 | and L<EV> and the following set-up: |
|
|
276 | |
|
|
277 | The event loop is running and has just invoked one of your callback at |
|
|
278 | time=500 (assume no other callbacks delay processing). In your callback, |
|
|
279 | you wait a second by executing C<sleep 1> (blocking the process for a |
|
|
280 | second) and then (at time=501) you create a relative timer that fires |
|
|
281 | after three seconds. |
|
|
282 | |
|
|
283 | With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will |
|
|
284 | both return C<501>, because that is the current time, and the timer will |
|
|
285 | be scheduled to fire at time=504 (C<501> + C<3>). |
|
|
286 | |
|
|
287 | With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current |
|
|
288 | time), but C<< AnyEvent->now >> returns C<500>, as that is the time the |
|
|
289 | last event processing phase started. With L<EV>, your timer gets scheduled |
|
|
290 | to run at time=503 (C<500> + C<3>). |
|
|
291 | |
|
|
292 | In one sense, L<Event::Lib> is more exact, as it uses the current time |
|
|
293 | regardless of any delays introduced by event processing. However, most |
|
|
294 | callbacks do not expect large delays in processing, so this causes a |
|
|
295 | higher drift (and a lot more system calls to get the current time). |
|
|
296 | |
|
|
297 | In another sense, L<EV> is more exact, as your timer will be scheduled at |
|
|
298 | the same time, regardless of how long event processing actually took. |
|
|
299 | |
|
|
300 | In either case, if you care (and in most cases, you don't), then you |
|
|
301 | can get whatever behaviour you want with any event loop, by taking the |
|
|
302 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
|
|
303 | account. |
|
|
304 | |
|
|
305 | =back |
231 | |
306 | |
232 | =head2 SIGNAL WATCHERS |
307 | =head2 SIGNAL WATCHERS |
233 | |
308 | |
234 | You can watch for signals using a signal watcher, C<signal> is the signal |
309 | You can watch for signals using a signal watcher, C<signal> is the signal |
235 | I<name> without any C<SIG> prefix, C<cb> is the Perl callback to |
310 | I<name> without any C<SIG> prefix, C<cb> is the Perl callback to |
… | |
… | |
522 | |
597 | |
523 | This is a mutator function that returns the callback set and optionally |
598 | This is a mutator function that returns the callback set and optionally |
524 | replaces it before doing so. |
599 | replaces it before doing so. |
525 | |
600 | |
526 | The callback will be called when the condition becomes "true", i.e. when |
601 | The callback will be called when the condition becomes "true", i.e. when |
527 | C<send> or C<croak> are called. Calling C<recv> inside the callback |
602 | C<send> or C<croak> are called, with the only argument being the condition |
528 | or at any later time is guaranteed not to block. |
603 | variable itself. Calling C<recv> inside the callback or at any later time |
|
|
604 | is guaranteed not to block. |
529 | |
605 | |
530 | =back |
606 | =back |
531 | |
607 | |
532 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
608 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
533 | |
609 | |
… | |
… | |
731 | no warnings; |
807 | no warnings; |
732 | use strict; |
808 | use strict; |
733 | |
809 | |
734 | use Carp; |
810 | use Carp; |
735 | |
811 | |
736 | our $VERSION = '4.04'; |
812 | our $VERSION = 4.11; |
737 | our $MODEL; |
813 | our $MODEL; |
738 | |
814 | |
739 | our $AUTOLOAD; |
815 | our $AUTOLOAD; |
740 | our @ISA; |
816 | our @ISA; |
741 | |
817 | |
… | |
… | |
755 | { |
831 | { |
756 | my $idx; |
832 | my $idx; |
757 | $PROTOCOL{$_} = ++$idx |
833 | $PROTOCOL{$_} = ++$idx |
758 | for reverse split /\s*,\s*/, |
834 | for reverse split /\s*,\s*/, |
759 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
835 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
760 | } |
|
|
761 | |
|
|
762 | sub import { |
|
|
763 | shift; |
|
|
764 | return unless @_; |
|
|
765 | |
|
|
766 | my $pkg = caller; |
|
|
767 | |
|
|
768 | no strict 'refs'; |
|
|
769 | |
|
|
770 | for (@_) { |
|
|
771 | *{"$pkg\::WIN32"} = *WIN32 if $_ eq "WIN32"; |
|
|
772 | } |
|
|
773 | } |
836 | } |
774 | |
837 | |
775 | my @models = ( |
838 | my @models = ( |
776 | [EV:: => AnyEvent::Impl::EV::], |
839 | [EV:: => AnyEvent::Impl::EV::], |
777 | [Event:: => AnyEvent::Impl::Event::], |
840 | [Event:: => AnyEvent::Impl::Event::], |
… | |
… | |
786 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
849 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
787 | [Wx:: => AnyEvent::Impl::POE::], |
850 | [Wx:: => AnyEvent::Impl::POE::], |
788 | [Prima:: => AnyEvent::Impl::POE::], |
851 | [Prima:: => AnyEvent::Impl::POE::], |
789 | ); |
852 | ); |
790 | |
853 | |
791 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
854 | our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); |
792 | |
855 | |
793 | our @post_detect; |
856 | our @post_detect; |
794 | |
857 | |
795 | sub post_detect(&) { |
858 | sub post_detect(&) { |
796 | my ($cb) = @_; |
859 | my ($cb) = @_; |
… | |
… | |
880 | $class->$func (@_); |
943 | $class->$func (@_); |
881 | } |
944 | } |
882 | |
945 | |
883 | package AnyEvent::Base; |
946 | package AnyEvent::Base; |
884 | |
947 | |
|
|
948 | # default implementation for now and time |
|
|
949 | |
|
|
950 | use Time::HiRes (); |
|
|
951 | |
|
|
952 | sub time { Time::HiRes::time } |
|
|
953 | sub now { Time::HiRes::time } |
|
|
954 | |
885 | # default implementation for ->condvar |
955 | # default implementation for ->condvar |
886 | |
956 | |
887 | sub condvar { |
957 | sub condvar { |
888 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
958 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
889 | } |
959 | } |
… | |
… | |
1135 | some (broken) firewalls drop such DNS packets, which is why it is off by |
1205 | some (broken) firewalls drop such DNS packets, which is why it is off by |
1136 | default. |
1206 | default. |
1137 | |
1207 | |
1138 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
1208 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
1139 | EDNS0 in its DNS requests. |
1209 | EDNS0 in its DNS requests. |
|
|
1210 | |
|
|
1211 | =item C<PERL_ANYEVENT_MAX_FORKS> |
|
|
1212 | |
|
|
1213 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
|
|
1214 | will create in parallel. |
1140 | |
1215 | |
1141 | =back |
1216 | =back |
1142 | |
1217 | |
1143 | =head1 EXAMPLE PROGRAM |
1218 | =head1 EXAMPLE PROGRAM |
1144 | |
1219 | |