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 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops |
6 | |
6 | |
… | |
… | |
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? |
… | |
… | |
132 | Many watchers either are used with "recursion" (repeating timers for |
138 | Many watchers either are used with "recursion" (repeating timers for |
133 | example), or need to refer to their watcher object in other ways. |
139 | example), or need to refer to their watcher object in other ways. |
134 | |
140 | |
135 | An any way to achieve that is this pattern: |
141 | An any way to achieve that is this pattern: |
136 | |
142 | |
137 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
143 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
138 | # you can use $w here, for example to undef it |
144 | # you can use $w here, for example to undef it |
139 | undef $w; |
145 | undef $w; |
140 | }); |
146 | }); |
141 | |
147 | |
142 | Note that C<my $w; $w => combination. This is necessary because in Perl, |
148 | Note that C<my $w; $w => combination. This is necessary because in Perl, |
143 | my variables are only visible after the statement in which they are |
149 | my variables are only visible after the statement in which they are |
144 | declared. |
150 | declared. |
145 | |
151 | |
… | |
… | |
233 | timers. |
239 | timers. |
234 | |
240 | |
235 | AnyEvent always prefers relative timers, if available, matching the |
241 | AnyEvent always prefers relative timers, if available, matching the |
236 | AnyEvent API. |
242 | AnyEvent API. |
237 | |
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 |
|
|
306 | |
238 | =head2 SIGNAL WATCHERS |
307 | =head2 SIGNAL WATCHERS |
239 | |
308 | |
240 | 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 |
241 | 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 |
242 | be invoked whenever a signal occurs. |
311 | be invoked whenever a signal occurs. |
… | |
… | |
283 | AnyEvent program, you I<have> to create at least one watcher before you |
352 | AnyEvent program, you I<have> to create at least one watcher before you |
284 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
353 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
285 | |
354 | |
286 | Example: fork a process and wait for it |
355 | Example: fork a process and wait for it |
287 | |
356 | |
288 | my $done = AnyEvent->condvar; |
357 | my $done = AnyEvent->condvar; |
289 | |
358 | |
290 | my $pid = fork or exit 5; |
359 | my $pid = fork or exit 5; |
291 | |
360 | |
292 | my $w = AnyEvent->child ( |
361 | my $w = AnyEvent->child ( |
293 | pid => $pid, |
362 | pid => $pid, |
294 | cb => sub { |
363 | cb => sub { |
295 | my ($pid, $status) = @_; |
364 | my ($pid, $status) = @_; |
296 | warn "pid $pid exited with status $status"; |
365 | warn "pid $pid exited with status $status"; |
297 | $done->send; |
366 | $done->send; |
298 | }, |
367 | }, |
299 | ); |
368 | ); |
300 | |
369 | |
301 | # do something else, then wait for process exit |
370 | # do something else, then wait for process exit |
302 | $done->recv; |
371 | $done->recv; |
303 | |
372 | |
304 | =head2 CONDITION VARIABLES |
373 | =head2 CONDITION VARIABLES |
305 | |
374 | |
306 | If you are familiar with some event loops you will know that all of them |
375 | If you are familiar with some event loops you will know that all of them |
307 | require you to run some blocking "loop", "run" or similar function that |
376 | require you to run some blocking "loop", "run" or similar function that |
… | |
… | |
528 | |
597 | |
529 | 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 |
530 | replaces it before doing so. |
599 | replaces it before doing so. |
531 | |
600 | |
532 | 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 |
533 | 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 |
534 | 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. |
535 | |
605 | |
536 | =back |
606 | =back |
537 | |
607 | |
538 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
608 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
539 | |
609 | |
… | |
… | |
682 | |
752 | |
683 | =item L<AnyEvent::DNS> |
753 | =item L<AnyEvent::DNS> |
684 | |
754 | |
685 | Provides rich asynchronous DNS resolver capabilities. |
755 | Provides rich asynchronous DNS resolver capabilities. |
686 | |
756 | |
|
|
757 | =item L<AnyEvent::HTTP> |
|
|
758 | |
|
|
759 | A simple-to-use HTTP library that is capable of making a lot of concurrent |
|
|
760 | HTTP requests. |
|
|
761 | |
687 | =item L<AnyEvent::HTTPD> |
762 | =item L<AnyEvent::HTTPD> |
688 | |
763 | |
689 | Provides a simple web application server framework. |
764 | Provides a simple web application server framework. |
690 | |
765 | |
691 | =item L<AnyEvent::FastPing> |
766 | =item L<AnyEvent::FastPing> |
… | |
… | |
737 | no warnings; |
812 | no warnings; |
738 | use strict; |
813 | use strict; |
739 | |
814 | |
740 | use Carp; |
815 | use Carp; |
741 | |
816 | |
742 | our $VERSION = '4.05'; |
817 | our $VERSION = 4.15; |
743 | our $MODEL; |
818 | our $MODEL; |
744 | |
819 | |
745 | our $AUTOLOAD; |
820 | our $AUTOLOAD; |
746 | our @ISA; |
821 | our @ISA; |
747 | |
822 | |
… | |
… | |
779 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
854 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
780 | [Wx:: => AnyEvent::Impl::POE::], |
855 | [Wx:: => AnyEvent::Impl::POE::], |
781 | [Prima:: => AnyEvent::Impl::POE::], |
856 | [Prima:: => AnyEvent::Impl::POE::], |
782 | ); |
857 | ); |
783 | |
858 | |
784 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
859 | our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); |
785 | |
860 | |
786 | our @post_detect; |
861 | our @post_detect; |
787 | |
862 | |
788 | sub post_detect(&) { |
863 | sub post_detect(&) { |
789 | my ($cb) = @_; |
864 | my ($cb) = @_; |
… | |
… | |
873 | $class->$func (@_); |
948 | $class->$func (@_); |
874 | } |
949 | } |
875 | |
950 | |
876 | package AnyEvent::Base; |
951 | package AnyEvent::Base; |
877 | |
952 | |
|
|
953 | # default implementation for now and time |
|
|
954 | |
|
|
955 | use Time::HiRes (); |
|
|
956 | |
|
|
957 | sub time { Time::HiRes::time } |
|
|
958 | sub now { Time::HiRes::time } |
|
|
959 | |
878 | # default implementation for ->condvar |
960 | # default implementation for ->condvar |
879 | |
961 | |
880 | sub condvar { |
962 | sub condvar { |
881 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
963 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
882 | } |
964 | } |
… | |
… | |
1096 | This functionality might change in future versions. |
1178 | This functionality might change in future versions. |
1097 | |
1179 | |
1098 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1180 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1099 | could start your program like this: |
1181 | could start your program like this: |
1100 | |
1182 | |
1101 | PERL_ANYEVENT_MODEL=Perl perl ... |
1183 | PERL_ANYEVENT_MODEL=Perl perl ... |
1102 | |
1184 | |
1103 | =item C<PERL_ANYEVENT_PROTOCOLS> |
1185 | =item C<PERL_ANYEVENT_PROTOCOLS> |
1104 | |
1186 | |
1105 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
1187 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
1106 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
1188 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
… | |
… | |
1581 | specified in the variable. |
1663 | specified in the variable. |
1582 | |
1664 | |
1583 | You can make AnyEvent completely ignore this variable by deleting it |
1665 | You can make AnyEvent completely ignore this variable by deleting it |
1584 | before the first watcher gets created, e.g. with a C<BEGIN> block: |
1666 | before the first watcher gets created, e.g. with a C<BEGIN> block: |
1585 | |
1667 | |
1586 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1668 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1587 | |
1669 | |
1588 | use AnyEvent; |
1670 | use AnyEvent; |
1589 | |
1671 | |
1590 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1672 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1591 | be used to probe what backend is used and gain other information (which is |
1673 | be used to probe what backend is used and gain other information (which is |
1592 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
1674 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
|
|
1675 | |
|
|
1676 | |
|
|
1677 | =head1 BUGS |
|
|
1678 | |
|
|
1679 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
|
|
1680 | to work around. If you suffer from memleaks, first upgrade to Perl 5.10 |
|
|
1681 | and check wether the leaks still show up. (Perl 5.10.0 has other annoying |
|
|
1682 | mamleaks, such as leaking on C<map> and C<grep> but it is usually not as |
|
|
1683 | pronounced). |
1593 | |
1684 | |
1594 | |
1685 | |
1595 | =head1 SEE ALSO |
1686 | =head1 SEE ALSO |
1596 | |
1687 | |
1597 | Utility functions: L<AnyEvent::Util>. |
1688 | Utility functions: L<AnyEvent::Util>. |
… | |
… | |
1614 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
1705 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
1615 | |
1706 | |
1616 | |
1707 | |
1617 | =head1 AUTHOR |
1708 | =head1 AUTHOR |
1618 | |
1709 | |
1619 | Marc Lehmann <schmorp@schmorp.de> |
1710 | Marc Lehmann <schmorp@schmorp.de> |
1620 | http://home.schmorp.de/ |
1711 | http://home.schmorp.de/ |
1621 | |
1712 | |
1622 | =cut |
1713 | =cut |
1623 | |
1714 | |
1624 | 1 |
1715 | 1 |
1625 | |
1716 | |