… | |
… | |
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 |
… | |
… | |
731 | no warnings; |
806 | no warnings; |
732 | use strict; |
807 | use strict; |
733 | |
808 | |
734 | use Carp; |
809 | use Carp; |
735 | |
810 | |
736 | our $VERSION = '4.03'; |
811 | our $VERSION = 4.11; |
737 | our $MODEL; |
812 | our $MODEL; |
738 | |
813 | |
739 | our $AUTOLOAD; |
814 | our $AUTOLOAD; |
740 | our @ISA; |
815 | our @ISA; |
741 | |
816 | |
742 | our @REGISTRY; |
817 | our @REGISTRY; |
|
|
818 | |
|
|
819 | our $WIN32; |
|
|
820 | |
|
|
821 | BEGIN { |
|
|
822 | my $win32 = ! ! ($^O =~ /mswin32/i); |
|
|
823 | eval "sub WIN32(){ $win32 }"; |
|
|
824 | } |
743 | |
825 | |
744 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
826 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
745 | |
827 | |
746 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
828 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
747 | |
829 | |
… | |
… | |
766 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
848 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
767 | [Wx:: => AnyEvent::Impl::POE::], |
849 | [Wx:: => AnyEvent::Impl::POE::], |
768 | [Prima:: => AnyEvent::Impl::POE::], |
850 | [Prima:: => AnyEvent::Impl::POE::], |
769 | ); |
851 | ); |
770 | |
852 | |
771 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
853 | our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); |
772 | |
854 | |
773 | our @post_detect; |
855 | our @post_detect; |
774 | |
856 | |
775 | sub post_detect(&) { |
857 | sub post_detect(&) { |
776 | my ($cb) = @_; |
858 | my ($cb) = @_; |
… | |
… | |
793 | } |
875 | } |
794 | |
876 | |
795 | sub detect() { |
877 | sub detect() { |
796 | unless ($MODEL) { |
878 | unless ($MODEL) { |
797 | no strict 'refs'; |
879 | no strict 'refs'; |
|
|
880 | local $SIG{__DIE__}; |
798 | |
881 | |
799 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
882 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
800 | my $model = "AnyEvent::Impl::$1"; |
883 | my $model = "AnyEvent::Impl::$1"; |
801 | if (eval "require $model") { |
884 | if (eval "require $model") { |
802 | $MODEL = $model; |
885 | $MODEL = $model; |
… | |
… | |
859 | $class->$func (@_); |
942 | $class->$func (@_); |
860 | } |
943 | } |
861 | |
944 | |
862 | package AnyEvent::Base; |
945 | package AnyEvent::Base; |
863 | |
946 | |
|
|
947 | # default implementation for now and time |
|
|
948 | |
|
|
949 | use Time::HiRes (); |
|
|
950 | |
|
|
951 | sub time { Time::HiRes::time } |
|
|
952 | sub now { Time::HiRes::time } |
|
|
953 | |
864 | # default implementation for ->condvar |
954 | # default implementation for ->condvar |
865 | |
955 | |
866 | sub condvar { |
956 | sub condvar { |
867 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
957 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
868 | } |
958 | } |
… | |
… | |
925 | or Carp::croak "required option 'pid' is missing"; |
1015 | or Carp::croak "required option 'pid' is missing"; |
926 | |
1016 | |
927 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1017 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
928 | |
1018 | |
929 | unless ($WNOHANG) { |
1019 | unless ($WNOHANG) { |
930 | $WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1; |
1020 | $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
931 | } |
1021 | } |
932 | |
1022 | |
933 | unless ($CHLD_W) { |
1023 | unless ($CHLD_W) { |
934 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1024 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
935 | # child could be a zombie already, so make at least one round |
1025 | # child could be a zombie already, so make at least one round |
… | |
… | |
1114 | some (broken) firewalls drop such DNS packets, which is why it is off by |
1204 | some (broken) firewalls drop such DNS packets, which is why it is off by |
1115 | default. |
1205 | default. |
1116 | |
1206 | |
1117 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
1207 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
1118 | EDNS0 in its DNS requests. |
1208 | EDNS0 in its DNS requests. |
|
|
1209 | |
|
|
1210 | =item C<PERL_ANYEVENT_MAX_FORKS> |
|
|
1211 | |
|
|
1212 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
|
|
1213 | will create in parallel. |
1119 | |
1214 | |
1120 | =back |
1215 | =back |
1121 | |
1216 | |
1122 | =head1 EXAMPLE PROGRAM |
1217 | =head1 EXAMPLE PROGRAM |
1123 | |
1218 | |