ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.317 by root, Wed Mar 24 21:22:57 2010 UTC vs.
Revision 1.332 by root, Tue Aug 31 23:32:40 2010 UTC

7 7
8=head1 SYNOPSIS 8=head1 SYNOPSIS
9 9
10 use AnyEvent; 10 use AnyEvent;
11 11
12 # if you prefer function calls, look at the AE manpage for
13 # an alternative API.
14
12 # file descriptor readable 15 # file handle or descriptor readable
13 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); 16 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14 17
15 # one-shot or repeating timers 18 # one-shot or repeating timers
16 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); 19 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... 20 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
18 21
19 print AnyEvent->now; # prints current event loop time 22 print AnyEvent->now; # prints current event loop time
20 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. 23 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
21 24
22 # POSIX signal 25 # POSIX signal
73module users into the same thing by forcing them to use the same event 76module users into the same thing by forcing them to use the same event
74model you use. 77model you use.
75 78
76For modules like POE or IO::Async (which is a total misnomer as it is 79For modules like POE or IO::Async (which is a total misnomer as it is
77actually doing all I/O I<synchronously>...), using them in your module is 80actually doing all I/O I<synchronously>...), using them in your module is
78like joining a cult: After you joined, you are dependent on them and you 81like joining a cult: After you join, you are dependent on them and you
79cannot use anything else, as they are simply incompatible to everything 82cannot use anything else, as they are simply incompatible to everything
80that isn't them. What's worse, all the potential users of your 83that isn't them. What's worse, all the potential users of your
81module are I<also> forced to use the same event loop you use. 84module are I<also> forced to use the same event loop you use.
82 85
83AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 86AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
84fine. AnyEvent + Tk works fine etc. etc. but none of these work together 87fine. AnyEvent + Tk works fine etc. etc. but none of these work together
85with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if 88with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
86your module uses one of those, every user of your module has to use it, 89your module uses one of those, every user of your module has to use it,
87too. But if your module uses AnyEvent, it works transparently with all 90too. But if your module uses AnyEvent, it works transparently with all
88event models it supports (including stuff like IO::Async, as long as those 91event models it supports (including stuff like IO::Async, as long as those
89use one of the supported event loops. It is trivial to add new event loops 92use one of the supported event loops. It is easy to add new event loops
90to AnyEvent, too, so it is future-proof). 93to AnyEvent, too, so it is future-proof).
91 94
92In addition to being free of having to use I<the one and only true event 95In addition to being free of having to use I<the one and only true event
93model>, AnyEvent also is free of bloat and policy: with POE or similar 96model>, AnyEvent also is free of bloat and policy: with POE or similar
94modules, you get an enormous amount of code and strict rules you have to 97modules, you get an enormous amount of code and strict rules you have to
95follow. AnyEvent, on the other hand, is lean and up to the point, by only 98follow. AnyEvent, on the other hand, is lean and to the point, by only
96offering the functionality that is necessary, in as thin as a wrapper as 99offering the functionality that is necessary, in as thin as a wrapper as
97technically possible. 100technically possible.
98 101
99Of course, AnyEvent comes with a big (and fully optional!) toolbox 102Of course, AnyEvent comes with a big (and fully optional!) toolbox
100of useful functionality, such as an asynchronous DNS resolver, 100% 103of useful functionality, such as an asynchronous DNS resolver, 100%
106useful) and you want to force your users to use the one and only event 109useful) and you want to force your users to use the one and only event
107model, you should I<not> use this module. 110model, you should I<not> use this module.
108 111
109=head1 DESCRIPTION 112=head1 DESCRIPTION
110 113
111L<AnyEvent> provides an identical interface to multiple event loops. This 114L<AnyEvent> provides a uniform interface to various event loops. This
112allows module authors to utilise an event loop without forcing module 115allows module authors to use event loop functionality without forcing
113users to use the same event loop (as only a single event loop can coexist 116module users to use a specific event loop implementation (since more
114peacefully at any one time). 117than one event loop cannot coexist peacefully).
115 118
116The interface itself is vaguely similar, but not identical to the L<Event> 119The interface itself is vaguely similar, but not identical to the L<Event>
117module. 120module.
118 121
119During the first call of any watcher-creation method, the module tries 122During the first call of any watcher-creation method, the module tries
120to detect the currently loaded event loop by probing whether one of the 123to detect the currently loaded event loop by probing whether one of the
121following modules is already loaded: L<EV>, 124following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>,
122L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, 125L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
123L<POE>. The first one found is used. If none are found, the module tries 126found is used. If none are detected, the module tries to load the first
124to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl 127four modules in the order given; but note that if L<EV> is not
125adaptor should always succeed) in the order given. The first one that can 128available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so
126be successfully loaded will be used. If, after this, still none could be 129the other two are not normally tried.
127found, AnyEvent will fall back to a pure-perl event loop, which is not
128very efficient, but should work everywhere.
129 130
130Because AnyEvent first checks for modules that are already loaded, loading 131Because AnyEvent first checks for modules that are already loaded, loading
131an event model explicitly before first using AnyEvent will likely make 132an event model explicitly before first using AnyEvent will likely make
132that model the default. For example: 133that model the default. For example:
133 134
135 use AnyEvent; 136 use AnyEvent;
136 137
137 # .. AnyEvent will likely default to Tk 138 # .. AnyEvent will likely default to Tk
138 139
139The I<likely> means that, if any module loads another event model and 140The I<likely> means that, if any module loads another event model and
140starts using it, all bets are off. Maybe you should tell their authors to 141starts using it, all bets are off - this case should be very rare though,
141use AnyEvent so their modules work together with others seamlessly... 142as very few modules hardcode event loops without announcing this very
143loudly.
142 144
143The pure-perl implementation of AnyEvent is called 145The pure-perl implementation of AnyEvent is called
144C<AnyEvent::Impl::Perl>. Like other event modules you can load it 146C<AnyEvent::Impl::Perl>. Like other event modules you can load it
145explicitly and enjoy the high availability of that event loop :) 147explicitly and enjoy the high availability of that event loop :)
146 148
155callback when the event occurs (of course, only when the event model 157callback when the event occurs (of course, only when the event model
156is in control). 158is in control).
157 159
158Note that B<callbacks must not permanently change global variables> 160Note that B<callbacks must not permanently change global variables>
159potentially in use by the event loop (such as C<$_> or C<$[>) and that B<< 161potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
160callbacks must not C<die> >>. The former is good programming practise in 162callbacks must not C<die> >>. The former is good programming practice in
161Perl and the latter stems from the fact that exception handling differs 163Perl and the latter stems from the fact that exception handling differs
162widely between event loops. 164widely between event loops.
163 165
164To disable the watcher you have to destroy it (e.g. by setting the 166To disable a watcher you have to destroy it (e.g. by setting the
165variable you store it in to C<undef> or otherwise deleting all references 167variable you store it in to C<undef> or otherwise deleting all references
166to it). 168to it).
167 169
168All watchers are created by calling a method on the C<AnyEvent> class. 170All watchers are created by calling a method on the C<AnyEvent> class.
169 171
170Many watchers either are used with "recursion" (repeating timers for 172Many watchers either are used with "recursion" (repeating timers for
171example), or need to refer to their watcher object in other ways. 173example), or need to refer to their watcher object in other ways.
172 174
173An any way to achieve that is this pattern: 175One way to achieve that is this pattern:
174 176
175 my $w; $w = AnyEvent->type (arg => value ..., cb => sub { 177 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
176 # you can use $w here, for example to undef it 178 # you can use $w here, for example to undef it
177 undef $w; 179 undef $w;
178 }); 180 });
210 212
211The I/O watcher might use the underlying file descriptor or a copy of it. 213The I/O watcher might use the underlying file descriptor or a copy of it.
212You must not close a file handle as long as any watcher is active on the 214You must not close a file handle as long as any watcher is active on the
213underlying file descriptor. 215underlying file descriptor.
214 216
215Some event loops issue spurious readyness notifications, so you should 217Some event loops issue spurious readiness notifications, so you should
216always use non-blocking calls when reading/writing from/to your file 218always use non-blocking calls when reading/writing from/to your file
217handles. 219handles.
218 220
219Example: wait for readability of STDIN, then read a line and disable the 221Example: wait for readability of STDIN, then read a line and disable the
220watcher. 222watcher.
244 246
245Although the callback might get passed parameters, their value and 247Although the callback might get passed parameters, their value and
246presence is undefined and you cannot rely on them. Portable AnyEvent 248presence is undefined and you cannot rely on them. Portable AnyEvent
247callbacks cannot use arguments passed to time watcher callbacks. 249callbacks cannot use arguments passed to time watcher callbacks.
248 250
249The callback will normally be invoked once only. If you specify another 251The callback will normally be invoked only once. If you specify another
250parameter, C<interval>, as a strictly positive number (> 0), then the 252parameter, C<interval>, as a strictly positive number (> 0), then the
251callback will be invoked regularly at that interval (in fractional 253callback will be invoked regularly at that interval (in fractional
252seconds) after the first invocation. If C<interval> is specified with a 254seconds) after the first invocation. If C<interval> is specified with a
253false value, then it is treated as if it were missing. 255false value, then it is treated as if it were not specified at all.
254 256
255The callback will be rescheduled before invoking the callback, but no 257The callback will be rescheduled before invoking the callback, but no
256attempt is done to avoid timer drift in most backends, so the interval is 258attempt is made to avoid timer drift in most backends, so the interval is
257only approximate. 259only approximate.
258 260
259Example: fire an event after 7.7 seconds. 261Example: fire an event after 7.7 seconds.
260 262
261 my $w = AnyEvent->timer (after => 7.7, cb => sub { 263 my $w = AnyEvent->timer (after => 7.7, cb => sub {
279 281
280While most event loops expect timers to specified in a relative way, they 282While most event loops expect timers to specified in a relative way, they
281use absolute time internally. This makes a difference when your clock 283use absolute time internally. This makes a difference when your clock
282"jumps", for example, when ntp decides to set your clock backwards from 284"jumps", for example, when ntp decides to set your clock backwards from
283the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to 285the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to
284fire "after" a second might actually take six years to finally fire. 286fire "after a second" might actually take six years to finally fire.
285 287
286AnyEvent cannot compensate for this. The only event loop that is conscious 288AnyEvent cannot compensate for this. The only event loop that is conscious
287about these issues is L<EV>, which offers both relative (ev_timer, based 289of these issues is L<EV>, which offers both relative (ev_timer, based
288on true relative time) and absolute (ev_periodic, based on wallclock time) 290on true relative time) and absolute (ev_periodic, based on wallclock time)
289timers. 291timers.
290 292
291AnyEvent always prefers relative timers, if available, matching the 293AnyEvent always prefers relative timers, if available, matching the
292AnyEvent API. 294AnyEvent API.
314I<In almost all cases (in all cases if you don't care), this is the 316I<In almost all cases (in all cases if you don't care), this is the
315function to call when you want to know the current time.> 317function to call when you want to know the current time.>
316 318
317This function is also often faster then C<< AnyEvent->time >>, and 319This function is also often faster then C<< AnyEvent->time >>, and
318thus the preferred method if you want some timestamp (for example, 320thus the preferred method if you want some timestamp (for example,
319L<AnyEvent::Handle> uses this to update it's activity timeouts). 321L<AnyEvent::Handle> uses this to update its activity timeouts).
320 322
321The rest of this section is only of relevance if you try to be very exact 323The rest of this section is only of relevance if you try to be very exact
322with your timing, you can skip it without bad conscience. 324with your timing; you can skip it without a bad conscience.
323 325
324For a practical example of when these times differ, consider L<Event::Lib> 326For a practical example of when these times differ, consider L<Event::Lib>
325and L<EV> and the following set-up: 327and L<EV> and the following set-up:
326 328
327The event loop is running and has just invoked one of your callback at 329The event loop is running and has just invoked one of your callbacks at
328time=500 (assume no other callbacks delay processing). In your callback, 330time=500 (assume no other callbacks delay processing). In your callback,
329you wait a second by executing C<sleep 1> (blocking the process for a 331you wait a second by executing C<sleep 1> (blocking the process for a
330second) and then (at time=501) you create a relative timer that fires 332second) and then (at time=501) you create a relative timer that fires
331after three seconds. 333after three seconds.
332 334
425=head3 Signal Races, Delays and Workarounds 427=head3 Signal Races, Delays and Workarounds
426 428
427Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 429Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
428callbacks to signals in a generic way, which is a pity, as you cannot 430callbacks to signals in a generic way, which is a pity, as you cannot
429do race-free signal handling in perl, requiring C libraries for 431do race-free signal handling in perl, requiring C libraries for
430this. AnyEvent will try to do it's best, which means in some cases, 432this. AnyEvent will try to do its best, which means in some cases,
431signals will be delayed. The maximum time a signal might be delayed is 433signals will be delayed. The maximum time a signal might be delayed is
432specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This 434specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
433variable can be changed only before the first signal watcher is created, 435variable can be changed only before the first signal watcher is created,
434and should be left alone otherwise. This variable determines how often 436and should be left alone otherwise. This variable determines how often
435AnyEvent polls for signals (in case a wake-up was missed). Higher values 437AnyEvent polls for signals (in case a wake-up was missed). Higher values
437saving. 439saving.
438 440
439All these problems can be avoided by installing the optional 441All these problems can be avoided by installing the optional
440L<Async::Interrupt> module, which works with most event loops. It will not 442L<Async::Interrupt> module, which works with most event loops. It will not
441work with inherently broken event loops such as L<Event> or L<Event::Lib> 443work with inherently broken event loops such as L<Event> or L<Event::Lib>
442(and not with L<POE> currently, as POE does it's own workaround with 444(and not with L<POE> currently, as POE does its own workaround with
443one-second latency). For those, you just have to suffer the delays. 445one-second latency). For those, you just have to suffer the delays.
444 446
445=head2 CHILD PROCESS WATCHERS 447=head2 CHILD PROCESS WATCHERS
446 448
447 $w = AnyEvent->child (pid => <process id>, cb => <callback>); 449 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
448 450
449You can also watch on a child process exit and catch its exit status. 451You can also watch for a child process exit and catch its exit status.
450 452
451The child process is specified by the C<pid> argument (one some backends, 453The child process is specified by the C<pid> argument (on some backends,
452using C<0> watches for any child process exit, on others this will 454using C<0> watches for any child process exit, on others this will
453croak). The watcher will be triggered only when the child process has 455croak). The watcher will be triggered only when the child process has
454finished and an exit status is available, not on any trace events 456finished and an exit status is available, not on any trace events
455(stopped/continued). 457(stopped/continued).
456 458
503 505
504=head2 IDLE WATCHERS 506=head2 IDLE WATCHERS
505 507
506 $w = AnyEvent->idle (cb => <callback>); 508 $w = AnyEvent->idle (cb => <callback>);
507 509
508Repeatedly invoke the callback after the process becomes idle, until 510This will repeatedly invoke the callback after the process becomes idle,
509either the watcher is destroyed or new events have been detected. 511until either the watcher is destroyed or new events have been detected.
510 512
511Idle watchers are useful when there is a need to do something, but it 513Idle watchers are useful when there is a need to do something, but it
512is not so important (or wise) to do it instantly. The callback will be 514is not so important (or wise) to do it instantly. The callback will be
513invoked only when there is "nothing better to do", which is usually 515invoked only when there is "nothing better to do", which is usually
514defined as "all outstanding events have been handled and no new events 516defined as "all outstanding events have been handled and no new events
553will actively watch for new events and call your callbacks. 555will actively watch for new events and call your callbacks.
554 556
555AnyEvent is slightly different: it expects somebody else to run the event 557AnyEvent is slightly different: it expects somebody else to run the event
556loop and will only block when necessary (usually when told by the user). 558loop and will only block when necessary (usually when told by the user).
557 559
558The instrument to do that is called a "condition variable", so called 560The tool to do that is called a "condition variable", so called because
559because they represent a condition that must become true. 561they represent a condition that must become true.
560 562
561Now is probably a good time to look at the examples further below. 563Now is probably a good time to look at the examples further below.
562 564
563Condition variables can be created by calling the C<< AnyEvent->condvar 565Condition variables can be created by calling the C<< AnyEvent->condvar
564>> method, usually without arguments. The only argument pair allowed is 566>> method, usually without arguments. The only argument pair allowed is
569After creation, the condition variable is "false" until it becomes "true" 571After creation, the condition variable is "false" until it becomes "true"
570by calling the C<send> method (or calling the condition variable as if it 572by calling the C<send> method (or calling the condition variable as if it
571were a callback, read about the caveats in the description for the C<< 573were a callback, read about the caveats in the description for the C<<
572->send >> method). 574->send >> method).
573 575
574Condition variables are similar to callbacks, except that you can 576Since condition variables are the most complex part of the AnyEvent API, here are
575optionally wait for them. They can also be called merge points - points 577some different mental models of what they are - pick the ones you can connect to:
576in time where multiple outstanding events have been processed. And yet 578
577another way to call them is transactions - each condition variable can be 579=over 4
578used to represent a transaction, which finishes at some point and delivers 580
579a result. And yet some people know them as "futures" - a promise to 581=item * Condition variables are like callbacks - you can call them (and pass them instead
580compute/deliver something that you can wait for. 582of callbacks). Unlike callbacks however, you can also wait for them to be called.
583
584=item * Condition variables are signals - one side can emit or send them,
585the other side can wait for them, or install a handler that is called when
586the signal fires.
587
588=item * Condition variables are like "Merge Points" - points in your program
589where you merge multiple independent results/control flows into one.
590
591=item * Condition variables represent a transaction - functions that start
592some kind of transaction can return them, leaving the caller the choice
593between waiting in a blocking fashion, or setting a callback.
594
595=item * Condition variables represent future values, or promises to deliver
596some result, long before the result is available.
597
598=back
581 599
582Condition variables are very useful to signal that something has finished, 600Condition variables are very useful to signal that something has finished,
583for example, if you write a module that does asynchronous http requests, 601for example, if you write a module that does asynchronous http requests,
584then a condition variable would be the ideal candidate to signal the 602then a condition variable would be the ideal candidate to signal the
585availability of results. The user can either act when the callback is 603availability of results. The user can either act when the callback is
598 616
599Condition variables are represented by hash refs in perl, and the keys 617Condition variables are represented by hash refs in perl, and the keys
600used by AnyEvent itself are all named C<_ae_XXX> to make subclassing 618used by AnyEvent itself are all named C<_ae_XXX> to make subclassing
601easy (it is often useful to build your own transaction class on top of 619easy (it is often useful to build your own transaction class on top of
602AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call 620AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
603it's C<new> method in your own C<new> method. 621its C<new> method in your own C<new> method.
604 622
605There are two "sides" to a condition variable - the "producer side" which 623There are two "sides" to a condition variable - the "producer side" which
606eventually calls C<< -> send >>, and the "consumer side", which waits 624eventually calls C<< -> send >>, and the "consumer side", which waits
607for the send to occur. 625for the send to occur.
608 626
609Example: wait for a timer. 627Example: wait for a timer.
610 628
611 # wait till the result is ready 629 # condition: "wait till the timer is fired"
612 my $result_ready = AnyEvent->condvar; 630 my $timer_fired = AnyEvent->condvar;
613 631
614 # do something such as adding a timer 632 # create the timer - we could wait for, say
615 # or socket watcher the calls $result_ready->send 633 # a handle becomign ready, or even an
616 # when the "result" is ready. 634 # AnyEvent::HTTP request to finish, but
617 # in this case, we simply use a timer: 635 # in this case, we simply use a timer:
618 my $w = AnyEvent->timer ( 636 my $w = AnyEvent->timer (
619 after => 1, 637 after => 1,
620 cb => sub { $result_ready->send }, 638 cb => sub { $timer_fired->send },
621 ); 639 );
622 640
623 # this "blocks" (while handling events) till the callback 641 # this "blocks" (while handling events) till the callback
624 # calls ->send 642 # calls ->send
625 $result_ready->recv; 643 $timer_fired->recv;
626 644
627Example: wait for a timer, but take advantage of the fact that condition 645Example: wait for a timer, but take advantage of the fact that condition
628variables are also callable directly. 646variables are also callable directly.
629 647
630 my $done = AnyEvent->condvar; 648 my $done = AnyEvent->condvar;
673they were a code reference). Calling them directly is the same as calling 691they were a code reference). Calling them directly is the same as calling
674C<send>. 692C<send>.
675 693
676=item $cv->croak ($error) 694=item $cv->croak ($error)
677 695
678Similar to send, but causes all call's to C<< ->recv >> to invoke 696Similar to send, but causes all calls to C<< ->recv >> to invoke
679C<Carp::croak> with the given error message/object/scalar. 697C<Carp::croak> with the given error message/object/scalar.
680 698
681This can be used to signal any errors to the condition variable 699This can be used to signal any errors to the condition variable
682user/consumer. Doing it this way instead of calling C<croak> directly 700user/consumer. Doing it this way instead of calling C<croak> directly
683delays the error detetcion, but has the overwhelmign advantage that it 701delays the error detection, but has the overwhelming advantage that it
684diagnoses the error at the place where the result is expected, and not 702diagnoses the error at the place where the result is expected, and not
685deep in some event clalback without connection to the actual code causing 703deep in some event callback with no connection to the actual code causing
686the problem. 704the problem.
687 705
688=item $cv->begin ([group callback]) 706=item $cv->begin ([group callback])
689 707
690=item $cv->end 708=item $cv->end
728one call to C<begin>, so the condvar waits for all calls to C<end> before 746one call to C<begin>, so the condvar waits for all calls to C<end> before
729sending. 747sending.
730 748
731The ping example mentioned above is slightly more complicated, as the 749The ping example mentioned above is slightly more complicated, as the
732there are results to be passwd back, and the number of tasks that are 750there are results to be passwd back, and the number of tasks that are
733begung can potentially be zero: 751begun can potentially be zero:
734 752
735 my $cv = AnyEvent->condvar; 753 my $cv = AnyEvent->condvar;
736 754
737 my %result; 755 my %result;
738 $cv->begin (sub { shift->send (\%result) }); 756 $cv->begin (sub { shift->send (\%result) });
759to be called once the counter reaches C<0>, and second, it ensures that 777to be called once the counter reaches C<0>, and second, it ensures that
760C<send> is called even when C<no> hosts are being pinged (the loop 778C<send> is called even when C<no> hosts are being pinged (the loop
761doesn't execute once). 779doesn't execute once).
762 780
763This is the general pattern when you "fan out" into multiple (but 781This is the general pattern when you "fan out" into multiple (but
764potentially none) subrequests: use an outer C<begin>/C<end> pair to set 782potentially zero) subrequests: use an outer C<begin>/C<end> pair to set
765the callback and ensure C<end> is called at least once, and then, for each 783the callback and ensure C<end> is called at least once, and then, for each
766subrequest you start, call C<begin> and for each subrequest you finish, 784subrequest you start, call C<begin> and for each subrequest you finish,
767call C<end>. 785call C<end>.
768 786
769=back 787=back
776=over 4 794=over 4
777 795
778=item $cv->recv 796=item $cv->recv
779 797
780Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak 798Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
781>> methods have been called on c<$cv>, while servicing other watchers 799>> methods have been called on C<$cv>, while servicing other watchers
782normally. 800normally.
783 801
784You can only wait once on a condition - additional calls are valid but 802You can only wait once on a condition - additional calls are valid but
785will return immediately. 803will return immediately.
786 804
803caller decide whether the call will block or not (for example, by coupling 821caller decide whether the call will block or not (for example, by coupling
804condition variables with some kind of request results and supporting 822condition variables with some kind of request results and supporting
805callbacks so the caller knows that getting the result will not block, 823callbacks so the caller knows that getting the result will not block,
806while still supporting blocking waits if the caller so desires). 824while still supporting blocking waits if the caller so desires).
807 825
808You can ensure that C<< -recv >> never blocks by setting a callback and 826You can ensure that C<< ->recv >> never blocks by setting a callback and
809only calling C<< ->recv >> from within that callback (or at a later 827only calling C<< ->recv >> from within that callback (or at a later
810time). This will work even when the event loop does not support blocking 828time). This will work even when the event loop does not support blocking
811waits otherwise. 829waits otherwise.
812 830
813=item $bool = $cv->ready 831=item $bool = $cv->ready
818=item $cb = $cv->cb ($cb->($cv)) 836=item $cb = $cv->cb ($cb->($cv))
819 837
820This is a mutator function that returns the callback set and optionally 838This is a mutator function that returns the callback set and optionally
821replaces it before doing so. 839replaces it before doing so.
822 840
823The callback will be called when the condition becomes (or already was) 841The callback will be called when the condition becomes "true", i.e. when
824"true", i.e. when C<send> or C<croak> are called (or were called), with 842C<send> or C<croak> are called, with the only argument being the
825the only argument being the condition variable itself. Calling C<recv> 843condition variable itself. If the condition is already true, the
844callback is called immediately when it is set. Calling C<recv> inside
826inside the callback or at any later time is guaranteed not to block. 845the callback or at any later time is guaranteed not to block.
827 846
828=back 847=back
829 848
830=head1 SUPPORTED EVENT LOOPS/BACKENDS 849=head1 SUPPORTED EVENT LOOPS/BACKENDS
831 850
843 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 862 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
844 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 863 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
845 864
846=item Backends that are transparently being picked up when they are used. 865=item Backends that are transparently being picked up when they are used.
847 866
848These will be used when they are currently loaded when the first watcher 867These will be used if they are already loaded when the first watcher
849is created, in which case it is assumed that the application is using 868is created, in which case it is assumed that the application is using
850them. This means that AnyEvent will automatically pick the right backend 869them. This means that AnyEvent will automatically pick the right backend
851when the main program loads an event module before anything starts to 870when the main program loads an event module before anything starts to
852create watchers. Nothing special needs to be done by the main program. 871create watchers. Nothing special needs to be done by the main program.
853 872
869 888
870Support for IO::Async can only be partial, as it is too broken and 889Support for IO::Async can only be partial, as it is too broken and
871architecturally limited to even support the AnyEvent API. It also 890architecturally limited to even support the AnyEvent API. It also
872is the only event loop that needs the loop to be set explicitly, so 891is the only event loop that needs the loop to be set explicitly, so
873it can only be used by a main program knowing about AnyEvent. See 892it can only be used by a main program knowing about AnyEvent. See
874L<AnyEvent::Impl::Async> for the gory details. 893L<AnyEvent::Impl::IOAsync> for the gory details.
875 894
876 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed. 895 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
877 896
878=item Event loops that are indirectly supported via other backends. 897=item Event loops that are indirectly supported via other backends.
879 898
907Contains C<undef> until the first watcher is being created, before the 926Contains C<undef> until the first watcher is being created, before the
908backend has been autodetected. 927backend has been autodetected.
909 928
910Afterwards it contains the event model that is being used, which is the 929Afterwards it contains the event model that is being used, which is the
911name of the Perl class implementing the model. This class is usually one 930name of the Perl class implementing the model. This class is usually one
912of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the 931of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
913case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it 932case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
914will be C<urxvt::anyevent>). 933will be C<urxvt::anyevent>).
915 934
916=item AnyEvent::detect 935=item AnyEvent::detect
917 936
918Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 937Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
919if necessary. You should only call this function right before you would 938if necessary. You should only call this function right before you would
920have created an AnyEvent watcher anyway, that is, as late as possible at 939have created an AnyEvent watcher anyway, that is, as late as possible at
921runtime, and not e.g. while initialising of your module. 940runtime, and not e.g. during initialisation of your module.
922 941
923If you need to do some initialisation before AnyEvent watchers are 942If you need to do some initialisation before AnyEvent watchers are
924created, use C<post_detect>. 943created, use C<post_detect>.
925 944
926=item $guard = AnyEvent::post_detect { BLOCK } 945=item $guard = AnyEvent::post_detect { BLOCK }
927 946
928Arranges for the code block to be executed as soon as the event model is 947Arranges for the code block to be executed as soon as the event model is
929autodetected (or immediately if this has already happened). 948autodetected (or immediately if that has already happened).
930 949
931The block will be executed I<after> the actual backend has been detected 950The block will be executed I<after> the actual backend has been detected
932(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been 951(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
933created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do 952created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
934other initialisations - see the sources of L<AnyEvent::Strict> or 953other initialisations - see the sources of L<AnyEvent::Strict> or
943that automatically removes the callback again when it is destroyed (or 962that automatically removes the callback again when it is destroyed (or
944C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for 963C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
945a case where this is useful. 964a case where this is useful.
946 965
947Example: Create a watcher for the IO::AIO module and store it in 966Example: Create a watcher for the IO::AIO module and store it in
948C<$WATCHER>. Only do so after the event loop is initialised, though. 967C<$WATCHER>, but do so only do so after the event loop is initialised.
949 968
950 our WATCHER; 969 our WATCHER;
951 970
952 my $guard = AnyEvent::post_detect { 971 my $guard = AnyEvent::post_detect {
953 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb); 972 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
961 $WATCHER ||= $guard; 980 $WATCHER ||= $guard;
962 981
963=item @AnyEvent::post_detect 982=item @AnyEvent::post_detect
964 983
965If there are any code references in this array (you can C<push> to it 984If there are any code references in this array (you can C<push> to it
966before or after loading AnyEvent), then they will called directly after 985before or after loading AnyEvent), then they will be called directly
967the event loop has been chosen. 986after the event loop has been chosen.
968 987
969You should check C<$AnyEvent::MODEL> before adding to this array, though: 988You should check C<$AnyEvent::MODEL> before adding to this array, though:
970if it is defined then the event loop has already been detected, and the 989if it is defined then the event loop has already been detected, and the
971array will be ignored. 990array will be ignored.
972 991
1008because it will stall the whole program, and the whole point of using 1027because it will stall the whole program, and the whole point of using
1009events is to stay interactive. 1028events is to stay interactive.
1010 1029
1011It is fine, however, to call C<< ->recv >> when the user of your module 1030It is fine, however, to call C<< ->recv >> when the user of your module
1012requests it (i.e. if you create a http request object ad have a method 1031requests it (i.e. if you create a http request object ad have a method
1013called C<results> that returns the results, it should call C<< ->recv >> 1032called C<results> that returns the results, it may call C<< ->recv >>
1014freely, as the user of your module knows what she is doing. always). 1033freely, as the user of your module knows what she is doing. Always).
1015 1034
1016=head1 WHAT TO DO IN THE MAIN PROGRAM 1035=head1 WHAT TO DO IN THE MAIN PROGRAM
1017 1036
1018There will always be a single main program - the only place that should 1037There will always be a single main program - the only place that should
1019dictate which event model to use. 1038dictate which event model to use.
1020 1039
1021If it doesn't care, it can just "use AnyEvent" and use it itself, or not 1040If the program is not event-based, it need not do anything special, even
1022do anything special (it does not need to be event-based) and let AnyEvent 1041when it depends on a module that uses an AnyEvent. If the program itself
1023decide which implementation to chose if some module relies on it. 1042uses AnyEvent, but does not care which event loop is used, all it needs
1043to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
1044available loop implementation.
1024 1045
1025If the main program relies on a specific event model - for example, in 1046If the main program relies on a specific event model - for example, in
1026Gtk2 programs you have to rely on the Glib module - you should load the 1047Gtk2 programs you have to rely on the Glib module - you should load the
1027event module before loading AnyEvent or any module that uses it: generally 1048event module before loading AnyEvent or any module that uses it: generally
1028speaking, you should load it as early as possible. The reason is that 1049speaking, you should load it as early as possible. The reason is that
1029modules might create watchers when they are loaded, and AnyEvent will 1050modules might create watchers when they are loaded, and AnyEvent will
1030decide on the event model to use as soon as it creates watchers, and it 1051decide on the event model to use as soon as it creates watchers, and it
1031might chose the wrong one unless you load the correct one yourself. 1052might choose the wrong one unless you load the correct one yourself.
1032 1053
1033You can chose to use a pure-perl implementation by loading the 1054You can chose to use a pure-perl implementation by loading the
1034C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1055C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
1035everywhere, but letting AnyEvent chose the model is generally better. 1056everywhere, but letting AnyEvent chose the model is generally better.
1036 1057
1054=head1 OTHER MODULES 1075=head1 OTHER MODULES
1055 1076
1056The following is a non-exhaustive list of additional modules that use 1077The following is a non-exhaustive list of additional modules that use
1057AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1078AnyEvent as a client and can therefore be mixed easily with other AnyEvent
1058modules and other event loops in the same program. Some of the modules 1079modules and other event loops in the same program. Some of the modules
1059come with AnyEvent, most are available via CPAN. 1080come as part of AnyEvent, the others are available via CPAN.
1060 1081
1061=over 4 1082=over 4
1062 1083
1063=item L<AnyEvent::Util> 1084=item L<AnyEvent::Util>
1064 1085
1065Contains various utility functions that replace often-used but blocking 1086Contains various utility functions that replace often-used blocking
1066functions such as C<inet_aton> by event-/callback-based versions. 1087functions such as C<inet_aton> with event/callback-based versions.
1067 1088
1068=item L<AnyEvent::Socket> 1089=item L<AnyEvent::Socket>
1069 1090
1070Provides various utility functions for (internet protocol) sockets, 1091Provides various utility functions for (internet protocol) sockets,
1071addresses and name resolution. Also functions to create non-blocking tcp 1092addresses and name resolution. Also functions to create non-blocking tcp
1073 1094
1074=item L<AnyEvent::Handle> 1095=item L<AnyEvent::Handle>
1075 1096
1076Provide read and write buffers, manages watchers for reads and writes, 1097Provide read and write buffers, manages watchers for reads and writes,
1077supports raw and formatted I/O, I/O queued and fully transparent and 1098supports raw and formatted I/O, I/O queued and fully transparent and
1078non-blocking SSL/TLS (via L<AnyEvent::TLS>. 1099non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1079 1100
1080=item L<AnyEvent::DNS> 1101=item L<AnyEvent::DNS>
1081 1102
1082Provides rich asynchronous DNS resolver capabilities. 1103Provides rich asynchronous DNS resolver capabilities.
1083 1104
1105=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1106
1107Implement event-based interfaces to the protocols of the same name (for
1108the curious, IGS is the International Go Server and FCP is the Freenet
1109Client Protocol).
1110
1111=item L<AnyEvent::Handle::UDP>
1112
1113Here be danger!
1114
1115As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1116there are so many things wrong with AnyEvent::Handle::UDP, most notably
1117its use of a stream-based API with a protocol that isn't streamable, that
1118the only way to improve it is to delete it.
1119
1120It features data corruption (but typically only under load) and general
1121confusion. On top, the author is not only clueless about UDP but also
1122fact-resistant - some gems of his understanding: "connect doesn't work
1123with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1124packets", "I don't need to implement proper error checking as UDP doesn't
1125support error checking" and so on - he doesn't even understand what's
1126wrong with his module when it is explained to him.
1127
1084=item L<AnyEvent::HTTP> 1128=item L<AnyEvent::DBI>
1085 1129
1086A simple-to-use HTTP library that is capable of making a lot of concurrent 1130Executes L<DBI> requests asynchronously in a proxy process for you,
1087HTTP requests. 1131notifying you in an event-based way when the operation is finished.
1132
1133=item L<AnyEvent::AIO>
1134
1135Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1136toolbox of every event programmer. AnyEvent::AIO transparently fuses
1137L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1138file I/O, and much more.
1088 1139
1089=item L<AnyEvent::HTTPD> 1140=item L<AnyEvent::HTTPD>
1090 1141
1091Provides a simple web application server framework. 1142A simple embedded webserver.
1092 1143
1093=item L<AnyEvent::FastPing> 1144=item L<AnyEvent::FastPing>
1094 1145
1095The fastest ping in the west. 1146The fastest ping in the west.
1096
1097=item L<AnyEvent::DBI>
1098
1099Executes L<DBI> requests asynchronously in a proxy process.
1100
1101=item L<AnyEvent::AIO>
1102
1103Truly asynchronous I/O, should be in the toolbox of every event
1104programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1105together.
1106
1107=item L<AnyEvent::BDB>
1108
1109Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1110L<BDB> and AnyEvent together.
1111
1112=item L<AnyEvent::GPSD>
1113
1114A non-blocking interface to gpsd, a daemon delivering GPS information.
1115
1116=item L<AnyEvent::IRC>
1117
1118AnyEvent based IRC client module family (replacing the older Net::IRC3).
1119
1120=item L<AnyEvent::XMPP>
1121
1122AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1123Net::XMPP2>.
1124
1125=item L<AnyEvent::IGS>
1126
1127A non-blocking interface to the Internet Go Server protocol (used by
1128L<App::IGS>).
1129
1130=item L<Net::FCP>
1131
1132AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1133of AnyEvent.
1134
1135=item L<Event::ExecFlow>
1136
1137High level API for event-based execution flow control.
1138 1147
1139=item L<Coro> 1148=item L<Coro>
1140 1149
1141Has special support for AnyEvent via L<Coro::AnyEvent>. 1150Has special support for AnyEvent via L<Coro::AnyEvent>.
1142 1151
1146 1155
1147package AnyEvent; 1156package AnyEvent;
1148 1157
1149# basically a tuned-down version of common::sense 1158# basically a tuned-down version of common::sense
1150sub common_sense { 1159sub common_sense {
1151 # from common:.sense 1.0 1160 # from common:.sense 3.3
1152 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00"; 1161 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00";
1153 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) 1162 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1154 $^H |= 0x00000600; 1163 $^H |= 0x00000600;
1155} 1164}
1156 1165
1157BEGIN { AnyEvent::common_sense } 1166BEGIN { AnyEvent::common_sense }
1158 1167
1159use Carp (); 1168use Carp ();
1160 1169
1161our $VERSION = '5.251'; 1170our $VERSION = '5.271';
1162our $MODEL; 1171our $MODEL;
1163 1172
1164our $AUTOLOAD; 1173our $AUTOLOAD;
1165our @ISA; 1174our @ISA;
1166 1175
1342 1351
1343=head1 SIMPLIFIED AE API 1352=head1 SIMPLIFIED AE API
1344 1353
1345Starting with version 5.0, AnyEvent officially supports a second, much 1354Starting with version 5.0, AnyEvent officially supports a second, much
1346simpler, API that is designed to reduce the calling, typing and memory 1355simpler, API that is designed to reduce the calling, typing and memory
1347overhead. 1356overhead by using function call syntax and a fixed number of parameters.
1348 1357
1349See the L<AE> manpage for details. 1358See the L<AE> manpage for details.
1350 1359
1351=cut 1360=cut
1352 1361
1353package AE; 1362package AE;
1354 1363
1355our $VERSION = $AnyEvent::VERSION; 1364our $VERSION = $AnyEvent::VERSION;
1365
1366# fall back to the main API by default - backends and AnyEvent::Base
1367# implementations can overwrite these.
1356 1368
1357sub io($$$) { 1369sub io($$$) {
1358 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1370 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1359} 1371}
1360 1372
1843check the arguments passed to most method calls. If it finds any problems, 1855check the arguments passed to most method calls. If it finds any problems,
1844it will croak. 1856it will croak.
1845 1857
1846In other words, enables "strict" mode. 1858In other words, enables "strict" mode.
1847 1859
1848Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense> 1860Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1849>>, it is definitely recommended to keep it off in production. Keeping 1861>>, it is definitely recommended to keep it off in production. Keeping
1850C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 1862C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1851can be very useful, however. 1863can be very useful, however.
1852 1864
1853=item C<PERL_ANYEVENT_MODEL> 1865=item C<PERL_ANYEVENT_MODEL>
2075 2087
2076The actual code goes further and collects all errors (C<die>s, exceptions) 2088The actual code goes further and collects all errors (C<die>s, exceptions)
2077that occurred during request processing. The C<result> method detects 2089that occurred during request processing. The C<result> method detects
2078whether an exception as thrown (it is stored inside the $txn object) 2090whether an exception as thrown (it is stored inside the $txn object)
2079and just throws the exception, which means connection errors and other 2091and just throws the exception, which means connection errors and other
2080problems get reported tot he code that tries to use the result, not in a 2092problems get reported to the code that tries to use the result, not in a
2081random callback. 2093random callback.
2082 2094
2083All of this enables the following usage styles: 2095All of this enables the following usage styles:
2084 2096
20851. Blocking: 20971. Blocking:
2499 unless defined $SIG{PIPE}; 2511 unless defined $SIG{PIPE};
2500 2512
2501=head1 RECOMMENDED/OPTIONAL MODULES 2513=head1 RECOMMENDED/OPTIONAL MODULES
2502 2514
2503One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and 2515One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2504it's built-in modules) are required to use it. 2516its built-in modules) are required to use it.
2505 2517
2506That does not mean that AnyEvent won't take advantage of some additional 2518That does not mean that AnyEvent won't take advantage of some additional
2507modules if they are installed. 2519modules if they are installed.
2508 2520
2509This section explains which additional modules will be used, and how they 2521This section explains which additional modules will be used, and how they
2567the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. 2579the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2568 2580
2569=item L<Time::HiRes> 2581=item L<Time::HiRes>
2570 2582
2571This module is part of perl since release 5.008. It will be used when the 2583This module is part of perl since release 5.008. It will be used when the
2572chosen event library does not come with a timing source on it's own. The 2584chosen event library does not come with a timing source of its own. The
2573pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2585pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2574try to use a monotonic clock for timing stability. 2586try to use a monotonic clock for timing stability.
2575 2587
2576=back 2588=back
2577 2589

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines