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.329 by root, Sun Jul 11 05:44:22 2010 UTC vs.
Revision 1.350 by root, Tue Aug 2 20:02:44 2011 UTC

15 # file handle or descriptor readable 15 # file handle or descriptor readable
16 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); 16 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
17 17
18 # one-shot or repeating timers 18 # one-shot or repeating timers
19 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); 19 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
20 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... 20 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
21 21
22 print AnyEvent->now; # prints current event loop time 22 print AnyEvent->now; # prints current event loop time
23 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. 23 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
24 24
25 # POSIX signal 25 # POSIX signal
46in a tutorial or some gentle introduction, have a look at the 46in a tutorial or some gentle introduction, have a look at the
47L<AnyEvent::Intro> manpage. 47L<AnyEvent::Intro> manpage.
48 48
49=head1 SUPPORT 49=head1 SUPPORT
50 50
51An FAQ document is available as L<AnyEvent::FAQ>.
52
51There is a mailinglist for discussing all things AnyEvent, and an IRC 53There also is a mailinglist for discussing all things AnyEvent, and an IRC
52channel, too. 54channel, too.
53 55
54See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software 56See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
55Repository>, at L<http://anyevent.schmorp.de>, for more info. 57Repository>, at L<http://anyevent.schmorp.de>, for more info.
56 58
76module users into the same thing by forcing them to use the same event 78module users into the same thing by forcing them to use the same event
77model you use. 79model you use.
78 80
79For modules like POE or IO::Async (which is a total misnomer as it is 81For modules like POE or IO::Async (which is a total misnomer as it is
80actually doing all I/O I<synchronously>...), using them in your module is 82actually doing all I/O I<synchronously>...), using them in your module is
81like joining a cult: After you joined, you are dependent on them and you 83like joining a cult: After you join, you are dependent on them and you
82cannot use anything else, as they are simply incompatible to everything 84cannot use anything else, as they are simply incompatible to everything
83that isn't them. What's worse, all the potential users of your 85that isn't them. What's worse, all the potential users of your
84module are I<also> forced to use the same event loop you use. 86module are I<also> forced to use the same event loop you use.
85 87
86AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 88AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
87fine. AnyEvent + Tk works fine etc. etc. but none of these work together 89fine. AnyEvent + Tk works fine etc. etc. but none of these work together
88with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if 90with the rest: POE + EV? No go. Tk + Event? No go. Again: if your module
89your module uses one of those, every user of your module has to use it, 91uses one of those, every user of your module has to use it, too. But if
90too. But if your module uses AnyEvent, it works transparently with all 92your module uses AnyEvent, it works transparently with all event models it
91event models it supports (including stuff like IO::Async, as long as those 93supports (including stuff like IO::Async, as long as those use one of the
92use one of the supported event loops. It is trivial to add new event loops 94supported event loops. It is easy to add new event loops to AnyEvent, too,
93to AnyEvent, too, so it is future-proof). 95so it is future-proof).
94 96
95In addition to being free of having to use I<the one and only true event 97In addition to being free of having to use I<the one and only true event
96model>, AnyEvent also is free of bloat and policy: with POE or similar 98model>, AnyEvent also is free of bloat and policy: with POE or similar
97modules, you get an enormous amount of code and strict rules you have to 99modules, you get an enormous amount of code and strict rules you have to
98follow. AnyEvent, on the other hand, is lean and up to the point, by only 100follow. AnyEvent, on the other hand, is lean and to the point, by only
99offering the functionality that is necessary, in as thin as a wrapper as 101offering the functionality that is necessary, in as thin as a wrapper as
100technically possible. 102technically possible.
101 103
102Of course, AnyEvent comes with a big (and fully optional!) toolbox 104Of course, AnyEvent comes with a big (and fully optional!) toolbox
103of useful functionality, such as an asynchronous DNS resolver, 100% 105of useful functionality, such as an asynchronous DNS resolver, 100%
109useful) and you want to force your users to use the one and only event 111useful) and you want to force your users to use the one and only event
110model, you should I<not> use this module. 112model, you should I<not> use this module.
111 113
112=head1 DESCRIPTION 114=head1 DESCRIPTION
113 115
114L<AnyEvent> provides an identical interface to multiple event loops. This 116L<AnyEvent> provides a uniform interface to various event loops. This
115allows module authors to utilise an event loop without forcing module 117allows module authors to use event loop functionality without forcing
116users to use the same event loop (as only a single event loop can coexist 118module users to use a specific event loop implementation (since more
117peacefully at any one time). 119than one event loop cannot coexist peacefully).
118 120
119The interface itself is vaguely similar, but not identical to the L<Event> 121The interface itself is vaguely similar, but not identical to the L<Event>
120module. 122module.
121 123
122During the first call of any watcher-creation method, the module tries 124During the first call of any watcher-creation method, the module tries
123to detect the currently loaded event loop by probing whether one of the 125to detect the currently loaded event loop by probing whether one of the
124following modules is already loaded: L<EV>, 126following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>,
125L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, 127L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
126L<POE>. The first one found is used. If none are found, the module tries 128found is used. If none are detected, the module tries to load the first
127to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl 129four modules in the order given; but note that if L<EV> is not
128adaptor should always succeed) in the order given. The first one that can 130available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so
129be successfully loaded will be used. If, after this, still none could be 131the other two are not normally tried.
130found, AnyEvent will fall back to a pure-perl event loop, which is not
131very efficient, but should work everywhere.
132 132
133Because AnyEvent first checks for modules that are already loaded, loading 133Because AnyEvent first checks for modules that are already loaded, loading
134an event model explicitly before first using AnyEvent will likely make 134an event model explicitly before first using AnyEvent will likely make
135that model the default. For example: 135that model the default. For example:
136 136
159callback when the event occurs (of course, only when the event model 159callback when the event occurs (of course, only when the event model
160is in control). 160is in control).
161 161
162Note that B<callbacks must not permanently change global variables> 162Note that B<callbacks must not permanently change global variables>
163potentially in use by the event loop (such as C<$_> or C<$[>) and that B<< 163potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
164callbacks must not C<die> >>. The former is good programming practise in 164callbacks must not C<die> >>. The former is good programming practice in
165Perl and the latter stems from the fact that exception handling differs 165Perl and the latter stems from the fact that exception handling differs
166widely between event loops. 166widely between event loops.
167 167
168To disable the watcher you have to destroy it (e.g. by setting the 168To disable a watcher you have to destroy it (e.g. by setting the
169variable you store it in to C<undef> or otherwise deleting all references 169variable you store it in to C<undef> or otherwise deleting all references
170to it). 170to it).
171 171
172All watchers are created by calling a method on the C<AnyEvent> class. 172All watchers are created by calling a method on the C<AnyEvent> class.
173 173
174Many watchers either are used with "recursion" (repeating timers for 174Many watchers either are used with "recursion" (repeating timers for
175example), or need to refer to their watcher object in other ways. 175example), or need to refer to their watcher object in other ways.
176 176
177An any way to achieve that is this pattern: 177One way to achieve that is this pattern:
178 178
179 my $w; $w = AnyEvent->type (arg => value ..., cb => sub { 179 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
180 # you can use $w here, for example to undef it 180 # you can use $w here, for example to undef it
181 undef $w; 181 undef $w;
182 }); 182 });
214 214
215The I/O watcher might use the underlying file descriptor or a copy of it. 215The I/O watcher might use the underlying file descriptor or a copy of it.
216You must not close a file handle as long as any watcher is active on the 216You must not close a file handle as long as any watcher is active on the
217underlying file descriptor. 217underlying file descriptor.
218 218
219Some event loops issue spurious readyness notifications, so you should 219Some event loops issue spurious readiness notifications, so you should
220always use non-blocking calls when reading/writing from/to your file 220always use non-blocking calls when reading/writing from/to your file
221handles. 221handles.
222 222
223Example: wait for readability of STDIN, then read a line and disable the 223Example: wait for readability of STDIN, then read a line and disable the
224watcher. 224watcher.
248 248
249Although the callback might get passed parameters, their value and 249Although the callback might get passed parameters, their value and
250presence is undefined and you cannot rely on them. Portable AnyEvent 250presence is undefined and you cannot rely on them. Portable AnyEvent
251callbacks cannot use arguments passed to time watcher callbacks. 251callbacks cannot use arguments passed to time watcher callbacks.
252 252
253The callback will normally be invoked once only. If you specify another 253The callback will normally be invoked only once. If you specify another
254parameter, C<interval>, as a strictly positive number (> 0), then the 254parameter, C<interval>, as a strictly positive number (> 0), then the
255callback will be invoked regularly at that interval (in fractional 255callback will be invoked regularly at that interval (in fractional
256seconds) after the first invocation. If C<interval> is specified with a 256seconds) after the first invocation. If C<interval> is specified with a
257false value, then it is treated as if it were missing. 257false value, then it is treated as if it were not specified at all.
258 258
259The callback will be rescheduled before invoking the callback, but no 259The callback will be rescheduled before invoking the callback, but no
260attempt is done to avoid timer drift in most backends, so the interval is 260attempt is made to avoid timer drift in most backends, so the interval is
261only approximate. 261only approximate.
262 262
263Example: fire an event after 7.7 seconds. 263Example: fire an event after 7.7 seconds.
264 264
265 my $w = AnyEvent->timer (after => 7.7, cb => sub { 265 my $w = AnyEvent->timer (after => 7.7, cb => sub {
283 283
284While most event loops expect timers to specified in a relative way, they 284While most event loops expect timers to specified in a relative way, they
285use absolute time internally. This makes a difference when your clock 285use absolute time internally. This makes a difference when your clock
286"jumps", for example, when ntp decides to set your clock backwards from 286"jumps", for example, when ntp decides to set your clock backwards from
287the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to 287the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to
288fire "after" a second might actually take six years to finally fire. 288fire "after a second" might actually take six years to finally fire.
289 289
290AnyEvent cannot compensate for this. The only event loop that is conscious 290AnyEvent cannot compensate for this. The only event loop that is conscious
291about these issues is L<EV>, which offers both relative (ev_timer, based 291of these issues is L<EV>, which offers both relative (ev_timer, based
292on true relative time) and absolute (ev_periodic, based on wallclock time) 292on true relative time) and absolute (ev_periodic, based on wallclock time)
293timers. 293timers.
294 294
295AnyEvent always prefers relative timers, if available, matching the 295AnyEvent always prefers relative timers, if available, matching the
296AnyEvent API. 296AnyEvent API.
318I<In almost all cases (in all cases if you don't care), this is the 318I<In almost all cases (in all cases if you don't care), this is the
319function to call when you want to know the current time.> 319function to call when you want to know the current time.>
320 320
321This function is also often faster then C<< AnyEvent->time >>, and 321This function is also often faster then C<< AnyEvent->time >>, and
322thus the preferred method if you want some timestamp (for example, 322thus the preferred method if you want some timestamp (for example,
323L<AnyEvent::Handle> uses this to update it's activity timeouts). 323L<AnyEvent::Handle> uses this to update its activity timeouts).
324 324
325The rest of this section is only of relevance if you try to be very exact 325The rest of this section is only of relevance if you try to be very exact
326with your timing, you can skip it without bad conscience. 326with your timing; you can skip it without a bad conscience.
327 327
328For a practical example of when these times differ, consider L<Event::Lib> 328For a practical example of when these times differ, consider L<Event::Lib>
329and L<EV> and the following set-up: 329and L<EV> and the following set-up:
330 330
331The event loop is running and has just invoked one of your callback at 331The event loop is running and has just invoked one of your callbacks at
332time=500 (assume no other callbacks delay processing). In your callback, 332time=500 (assume no other callbacks delay processing). In your callback,
333you wait a second by executing C<sleep 1> (blocking the process for a 333you wait a second by executing C<sleep 1> (blocking the process for a
334second) and then (at time=501) you create a relative timer that fires 334second) and then (at time=501) you create a relative timer that fires
335after three seconds. 335after three seconds.
336 336
429=head3 Signal Races, Delays and Workarounds 429=head3 Signal Races, Delays and Workarounds
430 430
431Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 431Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
432callbacks to signals in a generic way, which is a pity, as you cannot 432callbacks to signals in a generic way, which is a pity, as you cannot
433do race-free signal handling in perl, requiring C libraries for 433do race-free signal handling in perl, requiring C libraries for
434this. AnyEvent will try to do it's best, which means in some cases, 434this. AnyEvent will try to do its best, which means in some cases,
435signals will be delayed. The maximum time a signal might be delayed is 435signals will be delayed. The maximum time a signal might be delayed is
436specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This 436specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
437variable can be changed only before the first signal watcher is created, 437variable can be changed only before the first signal watcher is created,
438and should be left alone otherwise. This variable determines how often 438and should be left alone otherwise. This variable determines how often
439AnyEvent polls for signals (in case a wake-up was missed). Higher values 439AnyEvent polls for signals (in case a wake-up was missed). Higher values
441saving. 441saving.
442 442
443All these problems can be avoided by installing the optional 443All these problems can be avoided by installing the optional
444L<Async::Interrupt> module, which works with most event loops. It will not 444L<Async::Interrupt> module, which works with most event loops. It will not
445work with inherently broken event loops such as L<Event> or L<Event::Lib> 445work with inherently broken event loops such as L<Event> or L<Event::Lib>
446(and not with L<POE> currently, as POE does it's own workaround with 446(and not with L<POE> currently, as POE does its own workaround with
447one-second latency). For those, you just have to suffer the delays. 447one-second latency). For those, you just have to suffer the delays.
448 448
449=head2 CHILD PROCESS WATCHERS 449=head2 CHILD PROCESS WATCHERS
450 450
451 $w = AnyEvent->child (pid => <process id>, cb => <callback>); 451 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
452 452
453You can also watch on a child process exit and catch its exit status. 453You can also watch for a child process exit and catch its exit status.
454 454
455The child process is specified by the C<pid> argument (one some backends, 455The child process is specified by the C<pid> argument (on some backends,
456using C<0> watches for any child process exit, on others this will 456using C<0> watches for any child process exit, on others this will
457croak). The watcher will be triggered only when the child process has 457croak). The watcher will be triggered only when the child process has
458finished and an exit status is available, not on any trace events 458finished and an exit status is available, not on any trace events
459(stopped/continued). 459(stopped/continued).
460 460
507 507
508=head2 IDLE WATCHERS 508=head2 IDLE WATCHERS
509 509
510 $w = AnyEvent->idle (cb => <callback>); 510 $w = AnyEvent->idle (cb => <callback>);
511 511
512Repeatedly invoke the callback after the process becomes idle, until 512This will repeatedly invoke the callback after the process becomes idle,
513either the watcher is destroyed or new events have been detected. 513until either the watcher is destroyed or new events have been detected.
514 514
515Idle watchers are useful when there is a need to do something, but it 515Idle watchers are useful when there is a need to do something, but it
516is not so important (or wise) to do it instantly. The callback will be 516is not so important (or wise) to do it instantly. The callback will be
517invoked only when there is "nothing better to do", which is usually 517invoked only when there is "nothing better to do", which is usually
518defined as "all outstanding events have been handled and no new events 518defined as "all outstanding events have been handled and no new events
588the signal fires. 588the signal fires.
589 589
590=item * Condition variables are like "Merge Points" - points in your program 590=item * Condition variables are like "Merge Points" - points in your program
591where you merge multiple independent results/control flows into one. 591where you merge multiple independent results/control flows into one.
592 592
593=item * Condition variables represent a transaction - function that start 593=item * Condition variables represent a transaction - functions that start
594some kind of transaction can return them, leaving the caller the choice 594some kind of transaction can return them, leaving the caller the choice
595between waiting in a blocking fashion, or setting a callback. 595between waiting in a blocking fashion, or setting a callback.
596 596
597=item * Condition variables represent future values, or promises to deliver 597=item * Condition variables represent future values, or promises to deliver
598some result, long before the result is available. 598some result, long before the result is available.
618 618
619Condition variables are represented by hash refs in perl, and the keys 619Condition variables are represented by hash refs in perl, and the keys
620used by AnyEvent itself are all named C<_ae_XXX> to make subclassing 620used by AnyEvent itself are all named C<_ae_XXX> to make subclassing
621easy (it is often useful to build your own transaction class on top of 621easy (it is often useful to build your own transaction class on top of
622AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call 622AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
623it's C<new> method in your own C<new> method. 623its C<new> method in your own C<new> method.
624 624
625There are two "sides" to a condition variable - the "producer side" which 625There are two "sides" to a condition variable - the "producer side" which
626eventually calls C<< -> send >>, and the "consumer side", which waits 626eventually calls C<< -> send >>, and the "consumer side", which waits
627for the send to occur. 627for the send to occur.
628 628
693they were a code reference). Calling them directly is the same as calling 693they were a code reference). Calling them directly is the same as calling
694C<send>. 694C<send>.
695 695
696=item $cv->croak ($error) 696=item $cv->croak ($error)
697 697
698Similar to send, but causes all call's to C<< ->recv >> to invoke 698Similar to send, but causes all calls to C<< ->recv >> to invoke
699C<Carp::croak> with the given error message/object/scalar. 699C<Carp::croak> with the given error message/object/scalar.
700 700
701This can be used to signal any errors to the condition variable 701This can be used to signal any errors to the condition variable
702user/consumer. Doing it this way instead of calling C<croak> directly 702user/consumer. Doing it this way instead of calling C<croak> directly
703delays the error detetcion, but has the overwhelmign advantage that it 703delays the error detection, but has the overwhelming advantage that it
704diagnoses the error at the place where the result is expected, and not 704diagnoses the error at the place where the result is expected, and not
705deep in some event clalback without connection to the actual code causing 705deep in some event callback with no connection to the actual code causing
706the problem. 706the problem.
707 707
708=item $cv->begin ([group callback]) 708=item $cv->begin ([group callback])
709 709
710=item $cv->end 710=item $cv->end
748one call to C<begin>, so the condvar waits for all calls to C<end> before 748one call to C<begin>, so the condvar waits for all calls to C<end> before
749sending. 749sending.
750 750
751The ping example mentioned above is slightly more complicated, as the 751The ping example mentioned above is slightly more complicated, as the
752there are results to be passwd back, and the number of tasks that are 752there are results to be passwd back, and the number of tasks that are
753begung can potentially be zero: 753begun can potentially be zero:
754 754
755 my $cv = AnyEvent->condvar; 755 my $cv = AnyEvent->condvar;
756 756
757 my %result; 757 my %result;
758 $cv->begin (sub { shift->send (\%result) }); 758 $cv->begin (sub { shift->send (\%result) });
779to be called once the counter reaches C<0>, and second, it ensures that 779to be called once the counter reaches C<0>, and second, it ensures that
780C<send> is called even when C<no> hosts are being pinged (the loop 780C<send> is called even when C<no> hosts are being pinged (the loop
781doesn't execute once). 781doesn't execute once).
782 782
783This is the general pattern when you "fan out" into multiple (but 783This is the general pattern when you "fan out" into multiple (but
784potentially none) subrequests: use an outer C<begin>/C<end> pair to set 784potentially zero) subrequests: use an outer C<begin>/C<end> pair to set
785the callback and ensure C<end> is called at least once, and then, for each 785the callback and ensure C<end> is called at least once, and then, for each
786subrequest you start, call C<begin> and for each subrequest you finish, 786subrequest you start, call C<begin> and for each subrequest you finish,
787call C<end>. 787call C<end>.
788 788
789=back 789=back
796=over 4 796=over 4
797 797
798=item $cv->recv 798=item $cv->recv
799 799
800Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak 800Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
801>> methods have been called on c<$cv>, while servicing other watchers 801>> methods have been called on C<$cv>, while servicing other watchers
802normally. 802normally.
803 803
804You can only wait once on a condition - additional calls are valid but 804You can only wait once on a condition - additional calls are valid but
805will return immediately. 805will return immediately.
806 806
823caller decide whether the call will block or not (for example, by coupling 823caller decide whether the call will block or not (for example, by coupling
824condition variables with some kind of request results and supporting 824condition variables with some kind of request results and supporting
825callbacks so the caller knows that getting the result will not block, 825callbacks so the caller knows that getting the result will not block,
826while still supporting blocking waits if the caller so desires). 826while still supporting blocking waits if the caller so desires).
827 827
828You can ensure that C<< -recv >> never blocks by setting a callback and 828You can ensure that C<< ->recv >> never blocks by setting a callback and
829only calling C<< ->recv >> from within that callback (or at a later 829only calling C<< ->recv >> from within that callback (or at a later
830time). This will work even when the event loop does not support blocking 830time). This will work even when the event loop does not support blocking
831waits otherwise. 831waits otherwise.
832 832
833=item $bool = $cv->ready 833=item $bool = $cv->ready
838=item $cb = $cv->cb ($cb->($cv)) 838=item $cb = $cv->cb ($cb->($cv))
839 839
840This is a mutator function that returns the callback set and optionally 840This is a mutator function that returns the callback set and optionally
841replaces it before doing so. 841replaces it before doing so.
842 842
843The callback will be called when the condition becomes (or already was) 843The callback will be called when the condition becomes "true", i.e. when
844"true", i.e. when C<send> or C<croak> are called (or were called), with 844C<send> or C<croak> are called, with the only argument being the
845the only argument being the condition variable itself. Calling C<recv> 845condition variable itself. If the condition is already true, the
846callback is called immediately when it is set. Calling C<recv> inside
846inside the callback or at any later time is guaranteed not to block. 847the callback or at any later time is guaranteed not to block.
847 848
848=back 849=back
849 850
850=head1 SUPPORTED EVENT LOOPS/BACKENDS 851=head1 SUPPORTED EVENT LOOPS/BACKENDS
851 852
863 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 864 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
864 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 865 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
865 866
866=item Backends that are transparently being picked up when they are used. 867=item Backends that are transparently being picked up when they are used.
867 868
868These will be used when they are currently loaded when the first watcher 869These will be used if they are already loaded when the first watcher
869is created, in which case it is assumed that the application is using 870is created, in which case it is assumed that the application is using
870them. This means that AnyEvent will automatically pick the right backend 871them. This means that AnyEvent will automatically pick the right backend
871when the main program loads an event module before anything starts to 872when the main program loads an event module before anything starts to
872create watchers. Nothing special needs to be done by the main program. 873create watchers. Nothing special needs to be done by the main program.
873 874
875 AnyEvent::Impl::Glib based on Glib, slow but very stable. 876 AnyEvent::Impl::Glib based on Glib, slow but very stable.
876 AnyEvent::Impl::Tk based on Tk, very broken. 877 AnyEvent::Impl::Tk based on Tk, very broken.
877 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
878 AnyEvent::Impl::POE based on POE, very slow, some limitations. 879 AnyEvent::Impl::POE based on POE, very slow, some limitations.
879 AnyEvent::Impl::Irssi used when running within irssi. 880 AnyEvent::Impl::Irssi used when running within irssi.
881 AnyEvent::Impl::IOAsync based on IO::Async.
882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
883 AnyEvent::Impl::FLTK based on FLTK.
880 884
881=item Backends with special needs. 885=item Backends with special needs.
882 886
883Qt requires the Qt::Application to be instantiated first, but will 887Qt requires the Qt::Application to be instantiated first, but will
884otherwise be picked up automatically. As long as the main program 888otherwise be picked up automatically. As long as the main program
885instantiates the application before any AnyEvent watchers are created, 889instantiates the application before any AnyEvent watchers are created,
886everything should just work. 890everything should just work.
887 891
888 AnyEvent::Impl::Qt based on Qt. 892 AnyEvent::Impl::Qt based on Qt.
889 893
890Support for IO::Async can only be partial, as it is too broken and
891architecturally limited to even support the AnyEvent API. It also
892is the only event loop that needs the loop to be set explicitly, so
893it can only be used by a main program knowing about AnyEvent. See
894L<AnyEvent::Impl::Async> for the gory details.
895
896 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
897
898=item Event loops that are indirectly supported via other backends. 894=item Event loops that are indirectly supported via other backends.
899 895
900Some event loops can be supported via other modules: 896Some event loops can be supported via other modules:
901 897
902There is no direct support for WxWidgets (L<Wx>) or L<Prima>. 898There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
927Contains C<undef> until the first watcher is being created, before the 923Contains C<undef> until the first watcher is being created, before the
928backend has been autodetected. 924backend has been autodetected.
929 925
930Afterwards it contains the event model that is being used, which is the 926Afterwards it contains the event model that is being used, which is the
931name of the Perl class implementing the model. This class is usually one 927name of the Perl class implementing the model. This class is usually one
932of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the 928of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
933case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it 929case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
934will be C<urxvt::anyevent>). 930will be C<urxvt::anyevent>).
935 931
936=item AnyEvent::detect 932=item AnyEvent::detect
937 933
938Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
939if necessary. You should only call this function right before you would 935if necessary. You should only call this function right before you would
940have created an AnyEvent watcher anyway, that is, as late as possible at 936have created an AnyEvent watcher anyway, that is, as late as possible at
941runtime, and not e.g. while initialising of your module. 937runtime, and not e.g. during initialisation of your module.
942 938
943If you need to do some initialisation before AnyEvent watchers are 939If you need to do some initialisation before AnyEvent watchers are
944created, use C<post_detect>. 940created, use C<post_detect>.
945 941
946=item $guard = AnyEvent::post_detect { BLOCK } 942=item $guard = AnyEvent::post_detect { BLOCK }
947 943
948Arranges for the code block to be executed as soon as the event model is 944Arranges for the code block to be executed as soon as the event model is
949autodetected (or immediately if this has already happened). 945autodetected (or immediately if that has already happened).
950 946
951The block will be executed I<after> the actual backend has been detected 947The block will be executed I<after> the actual backend has been detected
952(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been 948(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
953created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do 949created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
954other initialisations - see the sources of L<AnyEvent::Strict> or 950other initialisations - see the sources of L<AnyEvent::Strict> or
963that automatically removes the callback again when it is destroyed (or 959that automatically removes the callback again when it is destroyed (or
964C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for 960C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
965a case where this is useful. 961a case where this is useful.
966 962
967Example: Create a watcher for the IO::AIO module and store it in 963Example: Create a watcher for the IO::AIO module and store it in
968C<$WATCHER>. Only do so after the event loop is initialised, though. 964C<$WATCHER>, but do so only do so after the event loop is initialised.
969 965
970 our WATCHER; 966 our WATCHER;
971 967
972 my $guard = AnyEvent::post_detect { 968 my $guard = AnyEvent::post_detect {
973 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb); 969 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
981 $WATCHER ||= $guard; 977 $WATCHER ||= $guard;
982 978
983=item @AnyEvent::post_detect 979=item @AnyEvent::post_detect
984 980
985If there are any code references in this array (you can C<push> to it 981If there are any code references in this array (you can C<push> to it
986before or after loading AnyEvent), then they will called directly after 982before or after loading AnyEvent), then they will be called directly
987the event loop has been chosen. 983after the event loop has been chosen.
988 984
989You should check C<$AnyEvent::MODEL> before adding to this array, though: 985You should check C<$AnyEvent::MODEL> before adding to this array, though:
990if it is defined then the event loop has already been detected, and the 986if it is defined then the event loop has already been detected, and the
991array will be ignored. 987array will be ignored.
992 988
1028because it will stall the whole program, and the whole point of using 1024because it will stall the whole program, and the whole point of using
1029events is to stay interactive. 1025events is to stay interactive.
1030 1026
1031It is fine, however, to call C<< ->recv >> when the user of your module 1027It is fine, however, to call C<< ->recv >> when the user of your module
1032requests it (i.e. if you create a http request object ad have a method 1028requests it (i.e. if you create a http request object ad have a method
1033called C<results> that returns the results, it should call C<< ->recv >> 1029called C<results> that returns the results, it may call C<< ->recv >>
1034freely, as the user of your module knows what she is doing. always). 1030freely, as the user of your module knows what she is doing. Always).
1035 1031
1036=head1 WHAT TO DO IN THE MAIN PROGRAM 1032=head1 WHAT TO DO IN THE MAIN PROGRAM
1037 1033
1038There will always be a single main program - the only place that should 1034There will always be a single main program - the only place that should
1039dictate which event model to use. 1035dictate which event model to use.
1040 1036
1041If it doesn't care, it can just "use AnyEvent" and use it itself, or not 1037If the program is not event-based, it need not do anything special, even
1042do anything special (it does not need to be event-based) and let AnyEvent 1038when it depends on a module that uses an AnyEvent. If the program itself
1043decide which implementation to chose if some module relies on it. 1039uses AnyEvent, but does not care which event loop is used, all it needs
1040to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
1041available loop implementation.
1044 1042
1045If the main program relies on a specific event model - for example, in 1043If the main program relies on a specific event model - for example, in
1046Gtk2 programs you have to rely on the Glib module - you should load the 1044Gtk2 programs you have to rely on the Glib module - you should load the
1047event module before loading AnyEvent or any module that uses it: generally 1045event module before loading AnyEvent or any module that uses it: generally
1048speaking, you should load it as early as possible. The reason is that 1046speaking, you should load it as early as possible. The reason is that
1049modules might create watchers when they are loaded, and AnyEvent will 1047modules might create watchers when they are loaded, and AnyEvent will
1050decide on the event model to use as soon as it creates watchers, and it 1048decide on the event model to use as soon as it creates watchers, and it
1051might chose the wrong one unless you load the correct one yourself. 1049might choose the wrong one unless you load the correct one yourself.
1052 1050
1053You can chose to use a pure-perl implementation by loading the 1051You can chose to use a pure-perl implementation by loading the
1054C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1052C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
1055everywhere, but letting AnyEvent chose the model is generally better. 1053everywhere, but letting AnyEvent chose the model is generally better.
1056 1054
1080 1078
1081=over 4 1079=over 4
1082 1080
1083=item L<AnyEvent::Util> 1081=item L<AnyEvent::Util>
1084 1082
1085Contains various utility functions that replace often-used but blocking 1083Contains various utility functions that replace often-used blocking
1086functions such as C<inet_aton> by event-/callback-based versions. 1084functions such as C<inet_aton> with event/callback-based versions.
1087 1085
1088=item L<AnyEvent::Socket> 1086=item L<AnyEvent::Socket>
1089 1087
1090Provides various utility functions for (internet protocol) sockets, 1088Provides various utility functions for (internet protocol) sockets,
1091addresses and name resolution. Also functions to create non-blocking tcp 1089addresses and name resolution. Also functions to create non-blocking tcp
1093 1091
1094=item L<AnyEvent::Handle> 1092=item L<AnyEvent::Handle>
1095 1093
1096Provide read and write buffers, manages watchers for reads and writes, 1094Provide read and write buffers, manages watchers for reads and writes,
1097supports raw and formatted I/O, I/O queued and fully transparent and 1095supports raw and formatted I/O, I/O queued and fully transparent and
1098non-blocking SSL/TLS (via L<AnyEvent::TLS>. 1096non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1099 1097
1100=item L<AnyEvent::DNS> 1098=item L<AnyEvent::DNS>
1101 1099
1102Provides rich asynchronous DNS resolver capabilities. 1100Provides rich asynchronous DNS resolver capabilities.
1103 1101
1111 1109
1112Here be danger! 1110Here be danger!
1113 1111
1114As Pauli would put it, "Not only is it not right, it's not even wrong!" - 1112As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1115there are so many things wrong with AnyEvent::Handle::UDP, most notably 1113there are so many things wrong with AnyEvent::Handle::UDP, most notably
1116it's use of a stream-based API with a protocol that isn't streamable, that 1114its use of a stream-based API with a protocol that isn't streamable, that
1117the only way to improve it is to delete it. 1115the only way to improve it is to delete it.
1118 1116
1119It features data corruption (but typically only under load) and general 1117It features data corruption (but typically only under load) and general
1120confusion. On top, the author is not only clueless about UDP but also 1118confusion. On top, the author is not only clueless about UDP but also
1121fact-resistant - some gems of his understanding: "connect doesn't work 1119fact-resistant - some gems of his understanding: "connect doesn't work
1125wrong with his module when it is explained to him. 1123wrong with his module when it is explained to him.
1126 1124
1127=item L<AnyEvent::DBI> 1125=item L<AnyEvent::DBI>
1128 1126
1129Executes L<DBI> requests asynchronously in a proxy process for you, 1127Executes L<DBI> requests asynchronously in a proxy process for you,
1130notifying you in an event-bnased way when the operation is finished. 1128notifying you in an event-based way when the operation is finished.
1131 1129
1132=item L<AnyEvent::AIO> 1130=item L<AnyEvent::AIO>
1133 1131
1134Truly asynchronous (as opposed to non-blocking) I/O, should be in the 1132Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1135toolbox of every event programmer. AnyEvent::AIO transparently fuses 1133toolbox of every event programmer. AnyEvent::AIO transparently fuses
1154 1152
1155package AnyEvent; 1153package AnyEvent;
1156 1154
1157# basically a tuned-down version of common::sense 1155# basically a tuned-down version of common::sense
1158sub common_sense { 1156sub common_sense {
1159 # from common:.sense 1.0 1157 # from common:.sense 3.4
1160 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00"; 1158 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1161 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) 1159 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1162 $^H |= 0x00000600; 1160 $^H |= 0x00000600;
1163} 1161}
1164 1162
1165BEGIN { AnyEvent::common_sense } 1163BEGIN { AnyEvent::common_sense }
1166 1164
1167use Carp (); 1165use Carp ();
1168 1166
1169our $VERSION = '5.271'; 1167our $VERSION = '5.34';
1170our $MODEL; 1168our $MODEL;
1171 1169
1172our $AUTOLOAD; 1170our $AUTOLOAD;
1173our @ISA; 1171our @ISA;
1174 1172
1212 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1210 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1213 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1211 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1214 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1212 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1215 [Wx:: => AnyEvent::Impl::POE::], 1213 [Wx:: => AnyEvent::Impl::POE::],
1216 [Prima:: => AnyEvent::Impl::POE::], 1214 [Prima:: => AnyEvent::Impl::POE::],
1217 # IO::Async is just too broken - we would need workarounds for its
1218 # byzantine signal and broken child handling, among others.
1219 # IO::Async is rather hard to detect, as it doesn't have any
1220 # obvious default class.
1221 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1222 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1215 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],
1223 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1216 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1224 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program 1217 [FLTK:: => AnyEvent::Impl::FLTK::],
1225); 1218);
1226 1219
1227our %method = map +($_ => 1), 1220our %method = map +($_ => 1),
1228 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1221 qw(io timer time now now_update signal child idle condvar DESTROY);
1229 1222
1230our @post_detect; 1223our @post_detect;
1231 1224
1232sub post_detect(&) { 1225sub post_detect(&) {
1233 my ($cb) = @_; 1226 my ($cb) = @_;
1288 last; 1281 last;
1289 } 1282 }
1290 } 1283 }
1291 1284
1292 $MODEL 1285 $MODEL
1293 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1286 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1294 } 1287 }
1295 } 1288 }
1296 1289
1297 @models = (); # free probe data 1290 @models = (); # free probe data
1298 1291
1299 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1292 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1300 unshift @ISA, $MODEL; 1293 unshift @ISA, $MODEL;
1301 1294
1302 # now nuke some methods that are overriden by the backend. 1295 # now nuke some methods that are overridden by the backend.
1303 # SUPER is not allowed. 1296 # SUPER is not allowed.
1304 for (qw(time signal child idle)) { 1297 for (qw(time signal child idle)) {
1305 undef &{"AnyEvent::Base::$_"} 1298 undef &{"AnyEvent::Base::$_"}
1306 if defined &{"$MODEL\::$_"}; 1299 if defined &{"$MODEL\::$_"};
1307 } 1300 }
1308 1301
1309 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; 1302 if ($ENV{PERL_ANYEVENT_STRICT}) {
1303 eval { require AnyEvent::Strict };
1304 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1305 if $@ && $VERBOSE;
1306 }
1310 1307
1311 (shift @post_detect)->() while @post_detect; 1308 (shift @post_detect)->() while @post_detect;
1312 1309
1313 *post_detect = sub(&) { 1310 *post_detect = sub(&) {
1314 shift->(); 1311 shift->();
1621# default implementation for ->child 1618# default implementation for ->child
1622 1619
1623our %PID_CB; 1620our %PID_CB;
1624our $CHLD_W; 1621our $CHLD_W;
1625our $CHLD_DELAY_W; 1622our $CHLD_DELAY_W;
1626our $WNOHANG;
1627 1623
1628# used by many Impl's 1624# used by many Impl's
1629sub _emit_childstatus($$) { 1625sub _emit_childstatus($$) {
1630 my (undef, $rpid, $rstatus) = @_; 1626 my (undef, $rpid, $rstatus) = @_;
1631 1627
1638 eval q{ # poor man's autoloading {} 1634 eval q{ # poor man's autoloading {}
1639 *_sigchld = sub { 1635 *_sigchld = sub {
1640 my $pid; 1636 my $pid;
1641 1637
1642 AnyEvent->_emit_childstatus ($pid, $?) 1638 AnyEvent->_emit_childstatus ($pid, $?)
1643 while ($pid = waitpid -1, $WNOHANG) > 0; 1639 while ($pid = waitpid -1, WNOHANG) > 0;
1644 }; 1640 };
1645 1641
1646 *child = sub { 1642 *child = sub {
1647 my (undef, %arg) = @_; 1643 my (undef, %arg) = @_;
1648 1644
1649 defined (my $pid = $arg{pid} + 0) 1645 defined (my $pid = $arg{pid} + 0)
1650 or Carp::croak "required option 'pid' is missing"; 1646 or Carp::croak "required option 'pid' is missing";
1651 1647
1652 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1648 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1653
1654 # WNOHANG is almost cetrainly 1 everywhere
1655 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1656 ? 1
1657 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1658 1649
1659 unless ($CHLD_W) { 1650 unless ($CHLD_W) {
1660 $CHLD_W = AE::signal CHLD => \&_sigchld; 1651 $CHLD_W = AE::signal CHLD => \&_sigchld;
1661 # child could be a zombie already, so make at least one round 1652 # child could be a zombie already, so make at least one round
1662 &_sigchld; 1653 &_sigchld;
1724 1715
1725package AnyEvent::CondVar; 1716package AnyEvent::CondVar;
1726 1717
1727our @ISA = AnyEvent::CondVar::Base::; 1718our @ISA = AnyEvent::CondVar::Base::;
1728 1719
1720# only to be used for subclassing
1721sub new {
1722 my $class = shift;
1723 bless AnyEvent->condvar (@_), $class
1724}
1725
1729package AnyEvent::CondVar::Base; 1726package AnyEvent::CondVar::Base;
1730 1727
1731#use overload 1728#use overload
1732# '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1729# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1733# fallback => 1; 1730# fallback => 1;
1742 1739
1743sub _send { 1740sub _send {
1744 # nop 1741 # nop
1745} 1742}
1746 1743
1744sub _wait {
1745 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1746}
1747
1747sub send { 1748sub send {
1748 my $cv = shift; 1749 my $cv = shift;
1749 $cv->{_ae_sent} = [@_]; 1750 $cv->{_ae_sent} = [@_];
1750 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1751 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1751 $cv->_send; 1752 $cv->_send;
1758 1759
1759sub ready { 1760sub ready {
1760 $_[0]{_ae_sent} 1761 $_[0]{_ae_sent}
1761} 1762}
1762 1763
1763sub _wait {
1764 $WAITING
1765 and !$_[0]{_ae_sent}
1766 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1767
1768 local $WAITING = 1;
1769 AnyEvent->one_event while !$_[0]{_ae_sent};
1770}
1771
1772sub recv { 1764sub recv {
1765 unless ($_[0]{_ae_sent}) {
1766 $WAITING
1767 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1768
1769 local $WAITING = 1;
1773 $_[0]->_wait; 1770 $_[0]->_wait;
1771 }
1774 1772
1775 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1773 $_[0]{_ae_croak}
1776 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1774 and Carp::croak $_[0]{_ae_croak};
1775
1776 wantarray
1777 ? @{ $_[0]{_ae_sent} }
1778 : $_[0]{_ae_sent}[0]
1777} 1779}
1778 1780
1779sub cb { 1781sub cb {
1780 my $cv = shift; 1782 my $cv = shift;
1781 1783
1797 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 1799 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1798} 1800}
1799 1801
1800# undocumented/compatibility with pre-3.4 1802# undocumented/compatibility with pre-3.4
1801*broadcast = \&send; 1803*broadcast = \&send;
1802*wait = \&_wait; 1804*wait = \&recv;
1803 1805
1804=head1 ERROR AND EXCEPTION HANDLING 1806=head1 ERROR AND EXCEPTION HANDLING
1805 1807
1806In general, AnyEvent does not do any error handling - it relies on the 1808In general, AnyEvent does not do any error handling - it relies on the
1807caller to do that if required. The L<AnyEvent::Strict> module (see also 1809caller to do that if required. The L<AnyEvent::Strict> module (see also
1854check the arguments passed to most method calls. If it finds any problems, 1856check the arguments passed to most method calls. If it finds any problems,
1855it will croak. 1857it will croak.
1856 1858
1857In other words, enables "strict" mode. 1859In other words, enables "strict" mode.
1858 1860
1859Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense> 1861Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1860>>, it is definitely recommended to keep it off in production. Keeping 1862>>, it is definitely recommended to keep it off in production. Keeping
1861C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 1863C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1862can be very useful, however. 1864can be very useful, however.
1863 1865
1864=item C<PERL_ANYEVENT_MODEL> 1866=item C<PERL_ANYEVENT_MODEL>
2510 unless defined $SIG{PIPE}; 2512 unless defined $SIG{PIPE};
2511 2513
2512=head1 RECOMMENDED/OPTIONAL MODULES 2514=head1 RECOMMENDED/OPTIONAL MODULES
2513 2515
2514One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and 2516One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2515it's built-in modules) are required to use it. 2517its built-in modules) are required to use it.
2516 2518
2517That does not mean that AnyEvent won't take advantage of some additional 2519That does not mean that AnyEvent won't take advantage of some additional
2518modules if they are installed. 2520modules if they are installed.
2519 2521
2520This section explains which additional modules will be used, and how they 2522This section explains which additional modules will be used, and how they
2578the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. 2580the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2579 2581
2580=item L<Time::HiRes> 2582=item L<Time::HiRes>
2581 2583
2582This module is part of perl since release 5.008. It will be used when the 2584This module is part of perl since release 5.008. It will be used when the
2583chosen event library does not come with a timing source on it's own. The 2585chosen event library does not come with a timing source of its own. The
2584pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2586pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2585try to use a monotonic clock for timing stability. 2587try to use a monotonic clock for timing stability.
2586 2588
2587=back 2589=back
2588 2590
2651pronounced). 2653pronounced).
2652 2654
2653 2655
2654=head1 SEE ALSO 2656=head1 SEE ALSO
2655 2657
2658Tutorial/Introduction: L<AnyEvent::Intro>.
2659
2660FAQ: L<AnyEvent::FAQ>.
2661
2656Utility functions: L<AnyEvent::Util>. 2662Utility functions: L<AnyEvent::Util>.
2657 2663
2658Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2664Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
2659L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2665L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2660 2666
2666Non-blocking file handles, sockets, TCP clients and 2672Non-blocking file handles, sockets, TCP clients and
2667servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2673servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2668 2674
2669Asynchronous DNS: L<AnyEvent::DNS>. 2675Asynchronous DNS: L<AnyEvent::DNS>.
2670 2676
2671Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, 2677Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2672L<Coro::Event>,
2673 2678
2674Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, 2679Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2675L<AnyEvent::HTTP>. 2680L<AnyEvent::HTTP>.
2676 2681
2677 2682
2678=head1 AUTHOR 2683=head1 AUTHOR
2679 2684

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines