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.327 by root, Sun Jun 6 10:13:57 2010 UTC vs.
Revision 1.398 by root, Tue Mar 27 16:21:11 2012 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - the DBI of event loop programming 3AnyEvent - the DBI of event loop programming
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt 5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt,
6and POE are various supported event loops/environments. 6FLTK and POE are various supported event loops/environments.
7 7
8=head1 SYNOPSIS 8=head1 SYNOPSIS
9 9
10 use AnyEvent; 10 use AnyEvent;
11 11
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::Loop>,
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::Loop> 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
138 use AnyEvent; 138 use AnyEvent;
139 139
140 # .. AnyEvent will likely default to Tk 140 # .. AnyEvent will likely default to Tk
141 141
142The I<likely> means that, if any module loads another event model and 142The I<likely> means that, if any module loads another event model and
143starts using it, all bets are off. Maybe you should tell their authors to 143starts using it, all bets are off - this case should be very rare though,
144use AnyEvent so their modules work together with others seamlessly... 144as very few modules hardcode event loops without announcing this very
145loudly.
145 146
146The pure-perl implementation of AnyEvent is called 147The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
147C<AnyEvent::Impl::Perl>. Like other event modules you can load it 148other event modules you can load it explicitly and enjoy the high
148explicitly and enjoy the high availability of that event loop :) 149availability of that event loop :)
149 150
150=head1 WATCHERS 151=head1 WATCHERS
151 152
152AnyEvent has the central concept of a I<watcher>, which is an object that 153AnyEvent has the central concept of a I<watcher>, which is an object that
153stores relevant data for each kind of event you are waiting for, such as 154stores relevant data for each kind of event you are waiting for, such as
158callback when the event occurs (of course, only when the event model 159callback when the event occurs (of course, only when the event model
159is in control). 160is in control).
160 161
161Note that B<callbacks must not permanently change global variables> 162Note that B<callbacks must not permanently change global variables>
162potentially 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<<
163callbacks must not C<die> >>. The former is good programming practise in 164callbacks must not C<die> >>. The former is good programming practice in
164Perl and the latter stems from the fact that exception handling differs 165Perl and the latter stems from the fact that exception handling differs
165widely between event loops. 166widely between event loops.
166 167
167To 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
168variable 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
169to it). 170to it).
170 171
171All 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.
172 173
173Many watchers either are used with "recursion" (repeating timers for 174Many watchers either are used with "recursion" (repeating timers for
174example), or need to refer to their watcher object in other ways. 175example), or need to refer to their watcher object in other ways.
175 176
176An any way to achieve that is this pattern: 177One way to achieve that is this pattern:
177 178
178 my $w; $w = AnyEvent->type (arg => value ..., cb => sub { 179 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
179 # you can use $w here, for example to undef it 180 # you can use $w here, for example to undef it
180 undef $w; 181 undef $w;
181 }); 182 });
213 214
214The 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.
215You 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
216underlying file descriptor. 217underlying file descriptor.
217 218
218Some event loops issue spurious readyness notifications, so you should 219Some event loops issue spurious readiness notifications, so you should
219always use non-blocking calls when reading/writing from/to your file 220always use non-blocking calls when reading/writing from/to your file
220handles. 221handles.
221 222
222Example: 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
223watcher. 224watcher.
247 248
248Although the callback might get passed parameters, their value and 249Although the callback might get passed parameters, their value and
249presence is undefined and you cannot rely on them. Portable AnyEvent 250presence is undefined and you cannot rely on them. Portable AnyEvent
250callbacks cannot use arguments passed to time watcher callbacks. 251callbacks cannot use arguments passed to time watcher callbacks.
251 252
252The callback will normally be invoked once only. If you specify another 253The callback will normally be invoked only once. If you specify another
253parameter, C<interval>, as a strictly positive number (> 0), then the 254parameter, C<interval>, as a strictly positive number (> 0), then the
254callback will be invoked regularly at that interval (in fractional 255callback will be invoked regularly at that interval (in fractional
255seconds) after the first invocation. If C<interval> is specified with a 256seconds) after the first invocation. If C<interval> is specified with a
256false value, then it is treated as if it were missing. 257false value, then it is treated as if it were not specified at all.
257 258
258The callback will be rescheduled before invoking the callback, but no 259The callback will be rescheduled before invoking the callback, but no
259attempt 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
260only approximate. 261only approximate.
261 262
262Example: fire an event after 7.7 seconds. 263Example: fire an event after 7.7 seconds.
263 264
264 my $w = AnyEvent->timer (after => 7.7, cb => sub { 265 my $w = AnyEvent->timer (after => 7.7, cb => sub {
282 283
283While 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
284use absolute time internally. This makes a difference when your clock 285use absolute time internally. This makes a difference when your clock
285"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
286the 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
287fire "after" a second might actually take six years to finally fire. 288fire "after a second" might actually take six years to finally fire.
288 289
289AnyEvent cannot compensate for this. The only event loop that is conscious 290AnyEvent cannot compensate for this. The only event loop that is conscious
290about 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
291on true relative time) and absolute (ev_periodic, based on wallclock time) 292on true relative time) and absolute (ev_periodic, based on wallclock time)
292timers. 293timers.
293 294
294AnyEvent always prefers relative timers, if available, matching the 295AnyEvent always prefers relative timers, if available, matching the
295AnyEvent API. 296AnyEvent API.
317I<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
318function to call when you want to know the current time.> 319function to call when you want to know the current time.>
319 320
320This function is also often faster then C<< AnyEvent->time >>, and 321This function is also often faster then C<< AnyEvent->time >>, and
321thus the preferred method if you want some timestamp (for example, 322thus the preferred method if you want some timestamp (for example,
322L<AnyEvent::Handle> uses this to update it's activity timeouts). 323L<AnyEvent::Handle> uses this to update its activity timeouts).
323 324
324The 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
325with your timing, you can skip it without bad conscience. 326with your timing; you can skip it without a bad conscience.
326 327
327For 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>
328and L<EV> and the following set-up: 329and L<EV> and the following set-up:
329 330
330The 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
331time=500 (assume no other callbacks delay processing). In your callback, 332time=500 (assume no other callbacks delay processing). In your callback,
332you 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
333second) 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
334after three seconds. 335after three seconds.
335 336
355difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
356account. 357account.
357 358
358=item AnyEvent->now_update 359=item AnyEvent->now_update
359 360
360Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache 361Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current
361the current time for each loop iteration (see the discussion of L<< 362time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
362AnyEvent->now >>, above). 363above).
363 364
364When a callback runs for a long time (or when the process sleeps), then 365When a callback runs for a long time (or when the process sleeps), then
365this "current" time will differ substantially from the real time, which 366this "current" time will differ substantially from the real time, which
366might affect timers and time-outs. 367might affect timers and time-outs.
367 368
414not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's 415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
415pure perl implementation). 416pure perl implementation).
416 417
417=head3 Safe/Unsafe Signals 418=head3 Safe/Unsafe Signals
418 419
419Perl signals can be either "safe" (synchronous to opcode handling) or 420Perl signals can be either "safe" (synchronous to opcode handling)
420"unsafe" (asynchronous) - the former might get delayed indefinitely, the 421or "unsafe" (asynchronous) - the former might delay signal delivery
421latter might corrupt your memory. 422indefinitely, the latter might corrupt your memory.
422 423
423AnyEvent signal handlers are, in addition, synchronous to the event loop, 424AnyEvent signal handlers are, in addition, synchronous to the event loop,
424i.e. they will not interrupt your running perl program but will only be 425i.e. they will not interrupt your running perl program but will only be
425called as part of the normal event handling (just like timer, I/O etc. 426called as part of the normal event handling (just like timer, I/O etc.
426callbacks, too). 427callbacks, too).
427 428
428=head3 Signal Races, Delays and Workarounds 429=head3 Signal Races, Delays and Workarounds
429 430
430Many 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
431callbacks to signals in a generic way, which is a pity, as you cannot 432attaching callbacks to signals in a generic way, which is a pity,
432do race-free signal handling in perl, requiring C libraries for 433as you cannot do race-free signal handling in perl, requiring
433this. AnyEvent will try to do it's best, which means in some cases, 434C libraries for this. AnyEvent will try to do its best, which
434signals will be delayed. The maximum time a signal might be delayed is 435means in some cases, signals will be delayed. The maximum time
435specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This 436a signal might be delayed is 10 seconds by default, but can
436variable can be changed only before the first signal watcher is created, 437be overriden via C<$ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY}> or
437and should be left alone otherwise. This variable determines how often 438C<$AnyEvent::MAX_SIGNAL_LATENCY> - see the L<ENVIRONMENT VARIABLES>
438AnyEvent polls for signals (in case a wake-up was missed). Higher values 439section for details.
439will cause fewer spurious wake-ups, which is better for power and CPU
440saving.
441 440
442All these problems can be avoided by installing the optional 441All these problems can be avoided by installing the optional
443L<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
444work 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>
445(and not with L<POE> currently, as POE does it's own workaround with 444(and not with L<POE> currently). For those, you just have to suffer the
446one-second latency). For those, you just have to suffer the delays. 445delays.
447 446
448=head2 CHILD PROCESS WATCHERS 447=head2 CHILD PROCESS WATCHERS
449 448
450 $w = AnyEvent->child (pid => <process id>, cb => <callback>); 449 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
451 450
452You 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.
453 452
454The 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,
455using 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
456croak). The watcher will be triggered only when the child process has 455croak). The watcher will be triggered only when the child process has
457finished and an exit status is available, not on any trace events 456finished and an exit status is available, not on any trace events
458(stopped/continued). 457(stopped/continued).
459 458
481thing in an AnyEvent program, you I<have> to create at least one 480thing in an AnyEvent program, you I<have> to create at least one
482watcher before you C<fork> the child (alternatively, you can call 481watcher before you C<fork> the child (alternatively, you can call
483C<AnyEvent::detect>). 482C<AnyEvent::detect>).
484 483
485As most event loops do not support waiting for child events, they will be 484As most event loops do not support waiting for child events, they will be
486emulated by AnyEvent in most cases, in which the latency and race problems 485emulated by AnyEvent in most cases, in which case the latency and race
487mentioned in the description of signal watchers apply. 486problems mentioned in the description of signal watchers apply.
488 487
489Example: fork a process and wait for it 488Example: fork a process and wait for it
490 489
491 my $done = AnyEvent->condvar; 490 my $done = AnyEvent->condvar;
492 491
506 505
507=head2 IDLE WATCHERS 506=head2 IDLE WATCHERS
508 507
509 $w = AnyEvent->idle (cb => <callback>); 508 $w = AnyEvent->idle (cb => <callback>);
510 509
511Repeatedly invoke the callback after the process becomes idle, until 510This will repeatedly invoke the callback after the process becomes idle,
512either the watcher is destroyed or new events have been detected. 511until either the watcher is destroyed or new events have been detected.
513 512
514Idle 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
515is 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
516invoked only when there is "nothing better to do", which is usually 515invoked only when there is "nothing better to do", which is usually
517defined as "all outstanding events have been handled and no new events 516defined as "all outstanding events have been handled and no new events
587the signal fires. 586the signal fires.
588 587
589=item * Condition variables are like "Merge Points" - points in your program 588=item * Condition variables are like "Merge Points" - points in your program
590where you merge multiple independent results/control flows into one. 589where you merge multiple independent results/control flows into one.
591 590
592=item * Condition variables represent a transaction - function that start 591=item * Condition variables represent a transaction - functions that start
593some kind of transaction can return them, leaving the caller the choice 592some kind of transaction can return them, leaving the caller the choice
594between waiting in a blocking fashion, or setting a callback. 593between waiting in a blocking fashion, or setting a callback.
595 594
596=item * Condition variables represent future values, or promises to deliver 595=item * Condition variables represent future values, or promises to deliver
597some result, long before the result is available. 596some result, long before the result is available.
617 616
618Condition variables are represented by hash refs in perl, and the keys 617Condition variables are represented by hash refs in perl, and the keys
619used 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
620easy (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
621AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call 620AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
622it's C<new> method in your own C<new> method. 621its C<new> method in your own C<new> method.
623 622
624There are two "sides" to a condition variable - the "producer side" which 623There are two "sides" to a condition variable - the "producer side" which
625eventually calls C<< -> send >>, and the "consumer side", which waits 624eventually calls C<< -> send >>, and the "consumer side", which waits
626for the send to occur. 625for the send to occur.
627 626
692they 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
693C<send>. 692C<send>.
694 693
695=item $cv->croak ($error) 694=item $cv->croak ($error)
696 695
697Similar to send, but causes all call's to C<< ->recv >> to invoke 696Similar to send, but causes all calls to C<< ->recv >> to invoke
698C<Carp::croak> with the given error message/object/scalar. 697C<Carp::croak> with the given error message/object/scalar.
699 698
700This can be used to signal any errors to the condition variable 699This can be used to signal any errors to the condition variable
701user/consumer. Doing it this way instead of calling C<croak> directly 700user/consumer. Doing it this way instead of calling C<croak> directly
702delays the error detetcion, but has the overwhelmign advantage that it 701delays the error detection, but has the overwhelming advantage that it
703diagnoses 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
704deep in some event clalback without connection to the actual code causing 703deep in some event callback with no connection to the actual code causing
705the problem. 704the problem.
706 705
707=item $cv->begin ([group callback]) 706=item $cv->begin ([group callback])
708 707
709=item $cv->end 708=item $cv->end
747one 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
748sending. 747sending.
749 748
750The ping example mentioned above is slightly more complicated, as the 749The ping example mentioned above is slightly more complicated, as the
751there 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
752begung can potentially be zero: 751begun can potentially be zero:
753 752
754 my $cv = AnyEvent->condvar; 753 my $cv = AnyEvent->condvar;
755 754
756 my %result; 755 my %result;
757 $cv->begin (sub { shift->send (\%result) }); 756 $cv->begin (sub { shift->send (\%result) });
778to 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
779C<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
780doesn't execute once). 779doesn't execute once).
781 780
782This is the general pattern when you "fan out" into multiple (but 781This is the general pattern when you "fan out" into multiple (but
783potentially 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
784the 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
785subrequest you start, call C<begin> and for each subrequest you finish, 784subrequest you start, call C<begin> and for each subrequest you finish,
786call C<end>. 785call C<end>.
787 786
788=back 787=back
795=over 4 794=over 4
796 795
797=item $cv->recv 796=item $cv->recv
798 797
799Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak 798Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
800>> methods have been called on c<$cv>, while servicing other watchers 799>> methods have been called on C<$cv>, while servicing other watchers
801normally. 800normally.
802 801
803You 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
804will return immediately. 803will return immediately.
805 804
822caller 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
823condition variables with some kind of request results and supporting 822condition variables with some kind of request results and supporting
824callbacks so the caller knows that getting the result will not block, 823callbacks so the caller knows that getting the result will not block,
825while still supporting blocking waits if the caller so desires). 824while still supporting blocking waits if the caller so desires).
826 825
827You 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
828only calling C<< ->recv >> from within that callback (or at a later 827only calling C<< ->recv >> from within that callback (or at a later
829time). 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
830waits otherwise. 829waits otherwise.
831 830
832=item $bool = $cv->ready 831=item $bool = $cv->ready
837=item $cb = $cv->cb ($cb->($cv)) 836=item $cb = $cv->cb ($cb->($cv))
838 837
839This is a mutator function that returns the callback set and optionally 838This is a mutator function that returns the callback set and optionally
840replaces it before doing so. 839replaces it before doing so.
841 840
842The callback will be called when the condition becomes (or already was) 841The callback will be called when the condition becomes "true", i.e. when
843"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
844the 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
845inside the callback or at any later time is guaranteed not to block. 845the callback or at any later time is guaranteed not to block.
846 846
847=back 847=back
848 848
849=head1 SUPPORTED EVENT LOOPS/BACKENDS 849=head1 SUPPORTED EVENT LOOPS/BACKENDS
850 850
858use. If EV is not installed, then AnyEvent will fall back to its own 858use. If EV is not installed, then AnyEvent will fall back to its own
859pure-perl implementation, which is available everywhere as it comes with 859pure-perl implementation, which is available everywhere as it comes with
860AnyEvent itself. 860AnyEvent itself.
861 861
862 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 862 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
863 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 863 AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
864 864
865=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.
866 866
867These 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
868is 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
869them. This means that AnyEvent will automatically pick the right backend 869them. This means that AnyEvent will automatically pick the right backend
870when the main program loads an event module before anything starts to 870when the main program loads an event module before anything starts to
871create watchers. Nothing special needs to be done by the main program. 871create watchers. Nothing special needs to be done by the main program.
872 872
874 AnyEvent::Impl::Glib based on Glib, slow but very stable. 874 AnyEvent::Impl::Glib based on Glib, slow but very stable.
875 AnyEvent::Impl::Tk based on Tk, very broken. 875 AnyEvent::Impl::Tk based on Tk, very broken.
876 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 876 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
877 AnyEvent::Impl::POE based on POE, very slow, some limitations. 877 AnyEvent::Impl::POE based on POE, very slow, some limitations.
878 AnyEvent::Impl::Irssi used when running within irssi. 878 AnyEvent::Impl::Irssi used when running within irssi.
879 AnyEvent::Impl::IOAsync based on IO::Async.
880 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
881 AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
879 882
880=item Backends with special needs. 883=item Backends with special needs.
881 884
882Qt requires the Qt::Application to be instantiated first, but will 885Qt requires the Qt::Application to be instantiated first, but will
883otherwise be picked up automatically. As long as the main program 886otherwise be picked up automatically. As long as the main program
884instantiates the application before any AnyEvent watchers are created, 887instantiates the application before any AnyEvent watchers are created,
885everything should just work. 888everything should just work.
886 889
887 AnyEvent::Impl::Qt based on Qt. 890 AnyEvent::Impl::Qt based on Qt.
888 891
889Support for IO::Async can only be partial, as it is too broken and
890architecturally limited to even support the AnyEvent API. It also
891is the only event loop that needs the loop to be set explicitly, so
892it can only be used by a main program knowing about AnyEvent. See
893L<AnyEvent::Impl::Async> for the gory details.
894
895 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
896
897=item Event loops that are indirectly supported via other backends. 892=item Event loops that are indirectly supported via other backends.
898 893
899Some event loops can be supported via other modules: 894Some event loops can be supported via other modules:
900 895
901There is no direct support for WxWidgets (L<Wx>) or L<Prima>. 896There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
926Contains C<undef> until the first watcher is being created, before the 921Contains C<undef> until the first watcher is being created, before the
927backend has been autodetected. 922backend has been autodetected.
928 923
929Afterwards it contains the event model that is being used, which is the 924Afterwards it contains the event model that is being used, which is the
930name of the Perl class implementing the model. This class is usually one 925name of the Perl class implementing the model. This class is usually one
931of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the 926of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
932case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it 927case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
933will be C<urxvt::anyevent>). 928will be C<urxvt::anyevent>).
934 929
935=item AnyEvent::detect 930=item AnyEvent::detect
936 931
937Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 932Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
938if necessary. You should only call this function right before you would 933if necessary. You should only call this function right before you would
939have created an AnyEvent watcher anyway, that is, as late as possible at 934have created an AnyEvent watcher anyway, that is, as late as possible at
940runtime, and not e.g. while initialising of your module. 935runtime, and not e.g. during initialisation of your module.
936
937The effect of calling this function is as if a watcher had been created
938(specifically, actions that happen "when the first watcher is created"
939happen when calling detetc as well).
941 940
942If you need to do some initialisation before AnyEvent watchers are 941If you need to do some initialisation before AnyEvent watchers are
943created, use C<post_detect>. 942created, use C<post_detect>.
944 943
945=item $guard = AnyEvent::post_detect { BLOCK } 944=item $guard = AnyEvent::post_detect { BLOCK }
946 945
947Arranges for the code block to be executed as soon as the event model is 946Arranges for the code block to be executed as soon as the event model is
948autodetected (or immediately if this has already happened). 947autodetected (or immediately if that has already happened).
949 948
950The block will be executed I<after> the actual backend has been detected 949The block will be executed I<after> the actual backend has been detected
951(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been 950(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
952created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do 951created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
953other initialisations - see the sources of L<AnyEvent::Strict> or 952other initialisations - see the sources of L<AnyEvent::Strict> or
962that automatically removes the callback again when it is destroyed (or 961that automatically removes the callback again when it is destroyed (or
963C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for 962C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
964a case where this is useful. 963a case where this is useful.
965 964
966Example: Create a watcher for the IO::AIO module and store it in 965Example: Create a watcher for the IO::AIO module and store it in
967C<$WATCHER>. Only do so after the event loop is initialised, though. 966C<$WATCHER>, but do so only do so after the event loop is initialised.
968 967
969 our WATCHER; 968 our WATCHER;
970 969
971 my $guard = AnyEvent::post_detect { 970 my $guard = AnyEvent::post_detect {
972 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb); 971 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
980 $WATCHER ||= $guard; 979 $WATCHER ||= $guard;
981 980
982=item @AnyEvent::post_detect 981=item @AnyEvent::post_detect
983 982
984If there are any code references in this array (you can C<push> to it 983If there are any code references in this array (you can C<push> to it
985before or after loading AnyEvent), then they will called directly after 984before or after loading AnyEvent), then they will be called directly
986the event loop has been chosen. 985after the event loop has been chosen.
987 986
988You should check C<$AnyEvent::MODEL> before adding to this array, though: 987You should check C<$AnyEvent::MODEL> before adding to this array, though:
989if it is defined then the event loop has already been detected, and the 988if it is defined then the event loop has already been detected, and the
990array will be ignored. 989array will be ignored.
991 990
1008 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent 1007 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1009 # as soon as it is 1008 # as soon as it is
1010 push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; 1009 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1011 } 1010 }
1012 1011
1012=item AnyEvent::postpone { BLOCK }
1013
1014Arranges for the block to be executed as soon as possible, but not before
1015the call itself returns. In practise, the block will be executed just
1016before the event loop polls for new events, or shortly afterwards.
1017
1018This function never returns anything (to make the C<return postpone { ...
1019}> idiom more useful.
1020
1021To understand the usefulness of this function, consider a function that
1022asynchronously does something for you and returns some transaction
1023object or guard to let you cancel the operation. For example,
1024C<AnyEvent::Socket::tcp_connect>:
1025
1026 # start a conenction attempt unless one is active
1027 $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
1028 delete $self->{connect_guard};
1029 ...
1030 };
1031
1032Imagine that this function could instantly call the callback, for
1033example, because it detects an obvious error such as a negative port
1034number. Invoking the callback before the function returns causes problems
1035however: the callback will be called and will try to delete the guard
1036object. But since the function hasn't returned yet, there is nothing to
1037delete. When the function eventually returns it will assign the guard
1038object to C<< $self->{connect_guard} >>, where it will likely never be
1039deleted, so the program thinks it is still trying to connect.
1040
1041This is where C<AnyEvent::postpone> should be used. Instead of calling the
1042callback directly on error:
1043
1044 $cb->(undef), return # signal error to callback, BAD!
1045 if $some_error_condition;
1046
1047It should use C<postpone>:
1048
1049 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1050 if $some_error_condition;
1051
1052=item AnyEvent::log $level, $msg[, @args]
1053
1054Log the given C<$msg> at the given C<$level>.
1055
1056If L<AnyEvent::Log> is not loaded then this function makes a simple test
1057to see whether the message will be logged. If the test succeeds it will
1058load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
1059the L<AnyEvent::Log> documentation for details.
1060
1061If the test fails it will simply return. Right now this happens when a
1062numerical loglevel is used and it is larger than the level specified via
1063C<$ENV{PERL_ANYEVENT_VERBOSE}>.
1064
1065If you want to sprinkle loads of logging calls around your code, consider
1066creating a logger callback with the C<AnyEvent::Log::logger> function,
1067which can reduce typing, codesize and can reduce the logging overhead
1068enourmously.
1069
1013=back 1070=back
1014 1071
1015=head1 WHAT TO DO IN A MODULE 1072=head1 WHAT TO DO IN A MODULE
1016 1073
1017As a module author, you should C<use AnyEvent> and call AnyEvent methods 1074As a module author, you should C<use AnyEvent> and call AnyEvent methods
1027because it will stall the whole program, and the whole point of using 1084because it will stall the whole program, and the whole point of using
1028events is to stay interactive. 1085events is to stay interactive.
1029 1086
1030It is fine, however, to call C<< ->recv >> when the user of your module 1087It is fine, however, to call C<< ->recv >> when the user of your module
1031requests it (i.e. if you create a http request object ad have a method 1088requests it (i.e. if you create a http request object ad have a method
1032called C<results> that returns the results, it should call C<< ->recv >> 1089called C<results> that returns the results, it may call C<< ->recv >>
1033freely, as the user of your module knows what she is doing. always). 1090freely, as the user of your module knows what she is doing. Always).
1034 1091
1035=head1 WHAT TO DO IN THE MAIN PROGRAM 1092=head1 WHAT TO DO IN THE MAIN PROGRAM
1036 1093
1037There will always be a single main program - the only place that should 1094There will always be a single main program - the only place that should
1038dictate which event model to use. 1095dictate which event model to use.
1039 1096
1040If it doesn't care, it can just "use AnyEvent" and use it itself, or not 1097If the program is not event-based, it need not do anything special, even
1041do anything special (it does not need to be event-based) and let AnyEvent 1098when it depends on a module that uses an AnyEvent. If the program itself
1042decide which implementation to chose if some module relies on it. 1099uses AnyEvent, but does not care which event loop is used, all it needs
1100to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
1101available loop implementation.
1043 1102
1044If the main program relies on a specific event model - for example, in 1103If the main program relies on a specific event model - for example, in
1045Gtk2 programs you have to rely on the Glib module - you should load the 1104Gtk2 programs you have to rely on the Glib module - you should load the
1046event module before loading AnyEvent or any module that uses it: generally 1105event module before loading AnyEvent or any module that uses it: generally
1047speaking, you should load it as early as possible. The reason is that 1106speaking, you should load it as early as possible. The reason is that
1048modules might create watchers when they are loaded, and AnyEvent will 1107modules might create watchers when they are loaded, and AnyEvent will
1049decide on the event model to use as soon as it creates watchers, and it 1108decide on the event model to use as soon as it creates watchers, and it
1050might chose the wrong one unless you load the correct one yourself. 1109might choose the wrong one unless you load the correct one yourself.
1051 1110
1052You can chose to use a pure-perl implementation by loading the 1111You can chose to use a pure-perl implementation by loading the
1053C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1112C<AnyEvent::Loop> module, which gives you similar behaviour
1054everywhere, but letting AnyEvent chose the model is generally better. 1113everywhere, but letting AnyEvent chose the model is generally better.
1055 1114
1056=head2 MAINLOOP EMULATION 1115=head2 MAINLOOP EMULATION
1057 1116
1058Sometimes (often for short test scripts, or even standalone programs who 1117Sometimes (often for short test scripts, or even standalone programs who
1071 1130
1072 1131
1073=head1 OTHER MODULES 1132=head1 OTHER MODULES
1074 1133
1075The following is a non-exhaustive list of additional modules that use 1134The following is a non-exhaustive list of additional modules that use
1076AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1135AnyEvent as a client and can therefore be mixed easily with other
1077modules and other event loops in the same program. Some of the modules 1136AnyEvent modules and other event loops in the same program. Some of the
1078come as part of AnyEvent, the others are available via CPAN. 1137modules come as part of AnyEvent, the others are available via CPAN (see
1138L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
1139a longer non-exhaustive list), and the list is heavily biased towards
1140modules of the AnyEvent author himself :)
1079 1141
1080=over 4 1142=over 4
1081 1143
1082=item L<AnyEvent::Util> 1144=item L<AnyEvent::Util>
1083 1145
1084Contains various utility functions that replace often-used but blocking 1146Contains various utility functions that replace often-used blocking
1085functions such as C<inet_aton> by event-/callback-based versions. 1147functions such as C<inet_aton> with event/callback-based versions.
1086 1148
1087=item L<AnyEvent::Socket> 1149=item L<AnyEvent::Socket>
1088 1150
1089Provides various utility functions for (internet protocol) sockets, 1151Provides various utility functions for (internet protocol) sockets,
1090addresses and name resolution. Also functions to create non-blocking tcp 1152addresses and name resolution. Also functions to create non-blocking tcp
1092 1154
1093=item L<AnyEvent::Handle> 1155=item L<AnyEvent::Handle>
1094 1156
1095Provide read and write buffers, manages watchers for reads and writes, 1157Provide read and write buffers, manages watchers for reads and writes,
1096supports raw and formatted I/O, I/O queued and fully transparent and 1158supports raw and formatted I/O, I/O queued and fully transparent and
1097non-blocking SSL/TLS (via L<AnyEvent::TLS>. 1159non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1098 1160
1099=item L<AnyEvent::DNS> 1161=item L<AnyEvent::DNS>
1100 1162
1101Provides rich asynchronous DNS resolver capabilities. 1163Provides rich asynchronous DNS resolver capabilities.
1102 1164
1103=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> 1165=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1104 1166
1105Implement event-based interfaces to the protocols of the same name (for 1167Implement event-based interfaces to the protocols of the same name (for
1106the curious, IGS is the International Go Server and FCP is the Freenet 1168the curious, IGS is the International Go Server and FCP is the Freenet
1107Client Protocol). 1169Client Protocol).
1108
1109=item L<AnyEvent::Handle::UDP>
1110
1111Here be danger!
1112
1113As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1114there are so many things wrong with AnyEvent::Handle::UDP, most notably
1115it's use of a stream-based API with a protocol that isn't streamable, that
1116the only way to improve it is to delete it.
1117
1118It features data corruption (but typically only under load) and general
1119confusion. On top, the author is not only clueless about UDP but also
1120fact-resistant - some gems of his understanding: "connect doesn't work
1121with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1122packets", "I don't need to implement proper error checking as UDP doesn't
1123support error checking" and so on - he doesn't even understand what's
1124wrong with his module when it is explained to him.
1125
1126=item L<AnyEvent::DBI>
1127
1128Executes L<DBI> requests asynchronously in a proxy process for you,
1129notifying you in an event-bnased way when the operation is finished.
1130 1170
1131=item L<AnyEvent::AIO> 1171=item L<AnyEvent::AIO>
1132 1172
1133Truly asynchronous (as opposed to non-blocking) I/O, should be in the 1173Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1134toolbox of every event programmer. AnyEvent::AIO transparently fuses 1174toolbox of every event programmer. AnyEvent::AIO transparently fuses
1135L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based 1175L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1136file I/O, and much more. 1176file I/O, and much more.
1137 1177
1178=item L<AnyEvent::Filesys::Notify>
1179
1180AnyEvent is good for non-blocking stuff, but it can't detect file or
1181path changes (e.g. "watch this directory for new files", "watch this
1182file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
1183do just that in a portbale fashion, supporting inotify on GNU/Linux and
1184some weird, without doubt broken, stuff on OS X to monitor files. It can
1185fall back to blocking scans at regular intervals transparently on other
1186platforms, so it's about as portable as it gets.
1187
1188(I haven't used it myself, but I haven't heard anybody complaining about
1189it yet).
1190
1191=item L<AnyEvent::DBI>
1192
1193Executes L<DBI> requests asynchronously in a proxy process for you,
1194notifying you in an event-based way when the operation is finished.
1195
1138=item L<AnyEvent::HTTPD> 1196=item L<AnyEvent::HTTPD>
1139 1197
1140A simple embedded webserver. 1198A simple embedded webserver.
1141 1199
1142=item L<AnyEvent::FastPing> 1200=item L<AnyEvent::FastPing>
1143 1201
1144The fastest ping in the west. 1202The fastest ping in the west.
1145 1203
1146=item L<Coro> 1204=item L<Coro>
1147 1205
1148Has special support for AnyEvent via L<Coro::AnyEvent>. 1206Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
1207to simply invert the flow control - don't call us, we will call you:
1208
1209 async {
1210 Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
1211 print "5 seconds later!\n";
1212
1213 Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
1214 my $line = <STDIN>; # works for ttys
1215
1216 AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
1217 my ($body, $hdr) = Coro::rouse_wait;
1218 };
1149 1219
1150=back 1220=back
1151 1221
1152=cut 1222=cut
1153 1223
1154package AnyEvent; 1224package AnyEvent;
1155 1225
1156# basically a tuned-down version of common::sense 1226# basically a tuned-down version of common::sense
1157sub common_sense { 1227sub common_sense {
1158 # from common:.sense 1.0 1228 # from common:.sense 3.5
1229 local $^W;
1159 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00"; 1230 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1160 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) 1231 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1161 $^H |= 0x00000600; 1232 $^H |= 0x00000600;
1162} 1233}
1163 1234
1164BEGIN { AnyEvent::common_sense } 1235BEGIN { AnyEvent::common_sense }
1165 1236
1166use Carp (); 1237use Carp ();
1167 1238
1168our $VERSION = '5.27'; 1239our $VERSION = '6.14';
1169our $MODEL; 1240our $MODEL;
1170
1171our $AUTOLOAD;
1172our @ISA; 1241our @ISA;
1173
1174our @REGISTRY; 1242our @REGISTRY;
1175
1176our $VERBOSE; 1243our $VERBOSE;
1244our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1245our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} || 10; # executes after the BEGIN block below (tainting!)
1177 1246
1178BEGIN { 1247BEGIN {
1179 require "AnyEvent/constants.pl"; 1248 require "AnyEvent/constants.pl";
1180 1249
1181 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1250 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1182 1251
1183 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1252 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1184 if ${^TAINT}; 1253 if ${^TAINT};
1185 1254
1186 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1255 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1256 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1187 1257
1188} 1258 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1259 if ${^TAINT};
1189 1260
1190our $MAX_SIGNAL_LATENCY = 10; 1261 # $ENV{PERL_ANYEVENT_xxx} now valid
1191 1262
1192our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1263 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1193 1264
1194{
1195 my $idx; 1265 my $idx;
1196 $PROTOCOL{$_} = ++$idx 1266 $PROTOCOL{$_} = ++$idx
1197 for reverse split /\s*,\s*/, 1267 for reverse split /\s*,\s*/,
1198 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1268 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1199} 1269}
1200 1270
1271our @post_detect;
1272
1273sub post_detect(&) {
1274 my ($cb) = @_;
1275
1276 push @post_detect, $cb;
1277
1278 defined wantarray
1279 ? bless \$cb, "AnyEvent::Util::postdetect"
1280 : ()
1281}
1282
1283sub AnyEvent::Util::postdetect::DESTROY {
1284 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1285}
1286
1287our $POSTPONE_W;
1288our @POSTPONE;
1289
1290sub _postpone_exec {
1291 undef $POSTPONE_W;
1292
1293 &{ shift @POSTPONE }
1294 while @POSTPONE;
1295}
1296
1297sub postpone(&) {
1298 push @POSTPONE, shift;
1299
1300 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1301
1302 ()
1303}
1304
1305sub log($$;@) {
1306 # only load the big bloated module when we actually are about to log something
1307 if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal
1308 local ($!, $@);
1309 require AnyEvent::Log; # among other things, sets $VERBOSE to 9
1310 # AnyEvent::Log overwrites this function
1311 goto &log;
1312 }
1313
1314 0 # not logged
1315}
1316
1317sub _logger($;$) {
1318 my ($level, $renabled) = @_;
1319
1320 $$renabled = $level <= $VERBOSE;
1321
1322 my $logger = [(caller)[0], $level, $renabled];
1323
1324 $AnyEvent::Log::LOGGER{$logger+0} = $logger;
1325
1326# return unless defined wantarray;
1327#
1328# require AnyEvent::Util;
1329# my $guard = AnyEvent::Util::guard (sub {
1330# # "clean up"
1331# delete $LOGGER{$logger+0};
1332# });
1333#
1334# sub {
1335# return 0 unless $$renabled;
1336#
1337# $guard if 0; # keep guard alive, but don't cause runtime overhead
1338# require AnyEvent::Log unless $AnyEvent::Log::VERSION;
1339# package AnyEvent::Log;
1340# _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
1341# }
1342}
1343
1344if (length $ENV{PERL_ANYEVENT_LOG}) {
1345 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1346}
1347
1201my @models = ( 1348our @models = (
1202 [EV:: => AnyEvent::Impl::EV:: , 1], 1349 [EV:: => AnyEvent::Impl::EV::],
1203 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1350 [AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1204 # everything below here will not (normally) be autoprobed 1351 # everything below here will not (normally) be autoprobed
1205 # as the pureperl backend should work everywhere 1352 # as the pure perl backend should work everywhere
1206 # and is usually faster 1353 # and is usually faster
1354 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
1207 [Event:: => AnyEvent::Impl::Event::, 1], 1355 [Event:: => AnyEvent::Impl::Event::], # slow, stable
1208 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1356 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1357 # everything below here should not be autoloaded
1209 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1358 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1210 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1211 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1359 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1212 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1360 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1213 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1361 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1214 [Wx:: => AnyEvent::Impl::POE::], 1362 [Wx:: => AnyEvent::Impl::POE::],
1215 [Prima:: => AnyEvent::Impl::POE::], 1363 [Prima:: => AnyEvent::Impl::POE::],
1216 # IO::Async is just too broken - we would need workarounds for its 1364 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1217 # byzantine signal and broken child handling, among others. 1365 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1218 # IO::Async is rather hard to detect, as it doesn't have any 1366 [FLTK:: => AnyEvent::Impl::FLTK::],
1219 # obvious default class.
1220 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1221 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1222 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1223 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1224); 1367);
1225 1368
1226our %method = map +($_ => 1), 1369our @isa_hook;
1370
1371sub _isa_set {
1372 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1373
1374 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1375 for 1 .. $#pkg;
1376
1377 grep $_ && $_->[1], @isa_hook
1378 and AE::_reset ();
1379}
1380
1381# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1382sub _isa_hook($$;$) {
1383 my ($i, $pkg, $reset_ae) = @_;
1384
1385 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1386
1387 _isa_set;
1388}
1389
1390# all autoloaded methods reserve the complete glob, not just the method slot.
1391# due to bugs in perls method cache implementation.
1227 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1392our @methods = qw(io timer time now now_update signal child idle condvar);
1228
1229our @post_detect;
1230
1231sub post_detect(&) {
1232 my ($cb) = @_;
1233
1234 push @post_detect, $cb;
1235
1236 defined wantarray
1237 ? bless \$cb, "AnyEvent::Util::postdetect"
1238 : ()
1239}
1240
1241sub AnyEvent::Util::postdetect::DESTROY {
1242 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1243}
1244 1393
1245sub detect() { 1394sub detect() {
1395 return $MODEL if $MODEL; # some programs keep references to detect
1396
1397 # IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
1398 # the author knows about the problems and what it does to AnyEvent as a whole
1399 # (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
1400 # anyway.
1401 AnyEvent::log fatal => "AnyEvent: IO::Async::Loop::AnyEvent detected - that module is broken by\n"
1402 . "design, abuses internals and breaks AnyEvent - will not continue."
1403 if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
1404
1405 local $!; # for good measure
1406 local $SIG{__DIE__}; # we use eval
1407
1246 # free some memory 1408 # free some memory
1247 *detect = sub () { $MODEL }; 1409 *detect = sub () { $MODEL };
1410 # undef &func doesn't correctly update the method cache. grmbl.
1411 # so we delete the whole glob. grmbl.
1412 # otoh, perl doesn't let me undef an active usb, but it lets me free
1413 # a glob with an active sub. hrm. i hope it works, but perl is
1414 # usually buggy in this department. sigh.
1415 delete @{"AnyEvent::"}{@methods};
1416 undef @methods;
1248 1417
1249 local $!; # for good measure
1250 local $SIG{__DIE__};
1251
1252 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1418 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1253 my $model = "AnyEvent::Impl::$1"; 1419 my $model = $1;
1420 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1254 if (eval "require $model") { 1421 if (eval "require $model") {
1422 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1255 $MODEL = $model; 1423 $MODEL = $model;
1256 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1257 } else { 1424 } else {
1258 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1425 AnyEvent::log 4 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1259 } 1426 }
1260 } 1427 }
1261 1428
1262 # check for already loaded models 1429 # check for already loaded models
1263 unless ($MODEL) { 1430 unless ($MODEL) {
1264 for (@REGISTRY, @models) { 1431 for (@REGISTRY, @models) {
1265 my ($package, $model) = @$_; 1432 my ($package, $model) = @$_;
1266 if (${"$package\::VERSION"} > 0) { 1433 if (${"$package\::VERSION"} > 0) {
1267 if (eval "require $model") { 1434 if (eval "require $model") {
1435 AnyEvent::log 7 => "autodetected model '$model', using it.";
1268 $MODEL = $model; 1436 $MODEL = $model;
1269 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1437 last;
1438 } else {
1439 AnyEvent::log 8 => "detected event loop $package, but cannot load '$model', skipping: $@";
1440 }
1441 }
1442 }
1443
1444 unless ($MODEL) {
1445 # try to autoload a model
1446 for (@REGISTRY, @models) {
1447 my ($package, $model) = @$_;
1448 if (
1449 eval "require $package"
1450 and ${"$package\::VERSION"} > 0
1451 and eval "require $model"
1452 ) {
1453 AnyEvent::log 7 => "autoloaded model '$model', using it.";
1454 $MODEL = $model;
1270 last; 1455 last;
1271 } 1456 }
1272 } 1457 }
1273 }
1274
1275 unless ($MODEL) {
1276 # try to autoload a model
1277 for (@REGISTRY, @models) {
1278 my ($package, $model, $autoload) = @$_;
1279 if (
1280 $autoload
1281 and eval "require $package"
1282 and ${"$package\::VERSION"} > 0
1283 and eval "require $model"
1284 ) {
1285 $MODEL = $model;
1286 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1287 last;
1288 }
1289 }
1290 1458
1291 $MODEL 1459 $MODEL
1292 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1460 or AnyEvent::log fatal => "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1293 } 1461 }
1294 } 1462 }
1295 1463
1296 @models = (); # free probe data 1464 # free memory only needed for probing
1465 undef @models;
1466 undef @REGISTRY;
1297 1467
1298 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1468 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1299 unshift @ISA, $MODEL;
1300 1469
1301 # now nuke some methods that are overriden by the backend. 1470 # now nuke some methods that are overridden by the backend.
1302 # SUPER is not allowed. 1471 # SUPER usage is not allowed in these.
1303 for (qw(time signal child idle)) { 1472 for (qw(time signal child idle)) {
1304 undef &{"AnyEvent::Base::$_"} 1473 undef &{"AnyEvent::Base::$_"}
1305 if defined &{"$MODEL\::$_"}; 1474 if defined &{"$MODEL\::$_"};
1306 } 1475 }
1307 1476
1308 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; 1477 _isa_set;
1478
1479 # we're officially open!
1480
1481 if ($ENV{PERL_ANYEVENT_STRICT}) {
1482 require AnyEvent::Strict;
1483 }
1484
1485 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1486 require AnyEvent::Debug;
1487 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1488 }
1489
1490 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1491 require AnyEvent::Socket;
1492 require AnyEvent::Debug;
1493
1494 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1495 $shell =~ s/\$\$/$$/g;
1496
1497 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1498 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1499 }
1500
1501 # now the anyevent environment is set up as the user told us to, so
1502 # call the actual user code - post detects
1309 1503
1310 (shift @post_detect)->() while @post_detect; 1504 (shift @post_detect)->() while @post_detect;
1505 undef @post_detect;
1311 1506
1312 *post_detect = sub(&) { 1507 *post_detect = sub(&) {
1313 shift->(); 1508 shift->();
1314 1509
1315 undef 1510 undef
1316 }; 1511 };
1317 1512
1318 $MODEL 1513 $MODEL
1319} 1514}
1320 1515
1321sub AUTOLOAD { 1516for my $name (@methods) {
1322 (my $func = $AUTOLOAD) =~ s/.*://; 1517 *$name = sub {
1323
1324 $method{$func}
1325 or Carp::croak "$func: not a valid AnyEvent class method";
1326
1327 detect; 1518 detect;
1328 1519 # we use goto because
1329 my $class = shift; 1520 # a) it makes the thunk more transparent
1330 $class->$func (@_); 1521 # b) it allows us to delete the thunk later
1522 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1523 };
1331} 1524}
1332 1525
1333# utility function to dup a filehandle. this is used by many backends 1526# utility function to dup a filehandle. this is used by many backends
1334# to support binding more than one watcher per filehandle (they usually 1527# to support binding more than one watcher per filehandle (they usually
1335# allow only one watcher per fd, so we dup it to get a different one). 1528# allow only one watcher per fd, so we dup it to get a different one).
1359 1552
1360package AE; 1553package AE;
1361 1554
1362our $VERSION = $AnyEvent::VERSION; 1555our $VERSION = $AnyEvent::VERSION;
1363 1556
1557sub _reset() {
1558 eval q{
1364# fall back to the main API by default - backends and AnyEvent::Base 1559 # fall back to the main API by default - backends and AnyEvent::Base
1365# implementations can overwrite these. 1560 # implementations can overwrite these.
1366 1561
1367sub io($$$) { 1562 sub io($$$) {
1368 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1563 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1369} 1564 }
1370 1565
1371sub timer($$$) { 1566 sub timer($$$) {
1372 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1567 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1373} 1568 }
1374 1569
1375sub signal($$) { 1570 sub signal($$) {
1376 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1571 AnyEvent->signal (signal => $_[0], cb => $_[1])
1377} 1572 }
1378 1573
1379sub child($$) { 1574 sub child($$) {
1380 AnyEvent->child (pid => $_[0], cb => $_[1]) 1575 AnyEvent->child (pid => $_[0], cb => $_[1])
1381} 1576 }
1382 1577
1383sub idle($) { 1578 sub idle($) {
1384 AnyEvent->idle (cb => $_[0]) 1579 AnyEvent->idle (cb => $_[0]);
1385} 1580 }
1386 1581
1387sub cv(;&) { 1582 sub cv(;&) {
1388 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1583 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1389} 1584 }
1390 1585
1391sub now() { 1586 sub now() {
1392 AnyEvent->now 1587 AnyEvent->now
1393} 1588 }
1394 1589
1395sub now_update() { 1590 sub now_update() {
1396 AnyEvent->now_update 1591 AnyEvent->now_update
1397} 1592 }
1398 1593
1399sub time() { 1594 sub time() {
1400 AnyEvent->time 1595 AnyEvent->time
1596 }
1597
1598 *postpone = \&AnyEvent::postpone;
1599 *log = \&AnyEvent::log;
1600 };
1601 die if $@;
1401} 1602}
1603
1604BEGIN { _reset }
1402 1605
1403package AnyEvent::Base; 1606package AnyEvent::Base;
1404 1607
1405# default implementations for many methods 1608# default implementations for many methods
1406 1609
1407sub time { 1610sub time {
1408 eval q{ # poor man's autoloading {} 1611 eval q{ # poor man's autoloading {}
1409 # probe for availability of Time::HiRes 1612 # probe for availability of Time::HiRes
1410 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1613 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1411 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1614 *time = sub { Time::HiRes::time () };
1412 *AE::time = \&Time::HiRes::time; 1615 *AE::time = \& Time::HiRes::time ;
1616 *now = \&time;
1617 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1413 # if (eval "use POSIX (); (POSIX::times())... 1618 # if (eval "use POSIX (); (POSIX::times())...
1414 } else { 1619 } else {
1620 *time = sub { CORE::time };
1621 *AE::time = sub (){ CORE::time };
1622 *now = \&time;
1415 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1623 AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1416 *AE::time = sub (){ time }; # epic fail
1417 } 1624 }
1418
1419 *time = sub { AE::time }; # different prototypes
1420 }; 1625 };
1421 die if $@; 1626 die if $@;
1422 1627
1423 &time 1628 &time
1424} 1629}
1425 1630
1426*now = \&time; 1631*now = \&time;
1427
1428sub now_update { } 1632sub now_update { }
1429 1633
1634sub _poll {
1635 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1636}
1637
1430# default implementation for ->condvar 1638# default implementation for ->condvar
1639# in fact, the default should not be overwritten
1431 1640
1432sub condvar { 1641sub condvar {
1433 eval q{ # poor man's autoloading {} 1642 eval q{ # poor man's autoloading {}
1434 *condvar = sub { 1643 *condvar = sub {
1435 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1644 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1513 1722
1514sub signal { 1723sub signal {
1515 eval q{ # poor man's autoloading {} 1724 eval q{ # poor man's autoloading {}
1516 # probe for availability of Async::Interrupt 1725 # probe for availability of Async::Interrupt
1517 if (_have_async_interrupt) { 1726 if (_have_async_interrupt) {
1518 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1727 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1519 1728
1520 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1729 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1521 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1730 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1522 1731
1523 } else { 1732 } else {
1524 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1733 AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1525 1734
1526 if (AnyEvent::WIN32) { 1735 if (AnyEvent::WIN32) {
1527 require AnyEvent::Util; 1736 require AnyEvent::Util;
1528 1737
1529 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1738 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1605 : sysread $SIGPIPE_R, (my $dummy), 9; 1814 : sysread $SIGPIPE_R, (my $dummy), 9;
1606 1815
1607 while (%SIG_EV) { 1816 while (%SIG_EV) {
1608 for (keys %SIG_EV) { 1817 for (keys %SIG_EV) {
1609 delete $SIG_EV{$_}; 1818 delete $SIG_EV{$_};
1610 $_->() for values %{ $SIG_CB{$_} || {} }; 1819 &$_ for values %{ $SIG_CB{$_} || {} };
1611 } 1820 }
1612 } 1821 }
1613 }; 1822 };
1614 }; 1823 };
1615 die if $@; 1824 die if $@;
1620# default implementation for ->child 1829# default implementation for ->child
1621 1830
1622our %PID_CB; 1831our %PID_CB;
1623our $CHLD_W; 1832our $CHLD_W;
1624our $CHLD_DELAY_W; 1833our $CHLD_DELAY_W;
1625our $WNOHANG;
1626 1834
1627# used by many Impl's 1835# used by many Impl's
1628sub _emit_childstatus($$) { 1836sub _emit_childstatus($$) {
1629 my (undef, $rpid, $rstatus) = @_; 1837 my (undef, $rpid, $rstatus) = @_;
1630 1838
1637 eval q{ # poor man's autoloading {} 1845 eval q{ # poor man's autoloading {}
1638 *_sigchld = sub { 1846 *_sigchld = sub {
1639 my $pid; 1847 my $pid;
1640 1848
1641 AnyEvent->_emit_childstatus ($pid, $?) 1849 AnyEvent->_emit_childstatus ($pid, $?)
1642 while ($pid = waitpid -1, $WNOHANG) > 0; 1850 while ($pid = waitpid -1, WNOHANG) > 0;
1643 }; 1851 };
1644 1852
1645 *child = sub { 1853 *child = sub {
1646 my (undef, %arg) = @_; 1854 my (undef, %arg) = @_;
1647 1855
1648 defined (my $pid = $arg{pid} + 0) 1856 my $pid = $arg{pid};
1649 or Carp::croak "required option 'pid' is missing"; 1857 my $cb = $arg{cb};
1650 1858
1651 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1859 $PID_CB{$pid}{$cb+0} = $cb;
1652
1653 # WNOHANG is almost cetrainly 1 everywhere
1654 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1655 ? 1
1656 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1657 1860
1658 unless ($CHLD_W) { 1861 unless ($CHLD_W) {
1659 $CHLD_W = AE::signal CHLD => \&_sigchld; 1862 $CHLD_W = AE::signal CHLD => \&_sigchld;
1660 # child could be a zombie already, so make at least one round 1863 # child could be a zombie already, so make at least one round
1661 &_sigchld; 1864 &_sigchld;
1662 } 1865 }
1663 1866
1664 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1867 bless [$pid, $cb+0], "AnyEvent::Base::child"
1665 }; 1868 };
1666 1869
1667 *AnyEvent::Base::child::DESTROY = sub { 1870 *AnyEvent::Base::child::DESTROY = sub {
1668 my ($pid, $cb) = @{$_[0]}; 1871 my ($pid, $icb) = @{$_[0]};
1669 1872
1670 delete $PID_CB{$pid}{$cb}; 1873 delete $PID_CB{$pid}{$icb};
1671 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1874 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1672 1875
1673 undef $CHLD_W unless keys %PID_CB; 1876 undef $CHLD_W unless keys %PID_CB;
1674 }; 1877 };
1675 }; 1878 };
1688 1891
1689 my ($cb, $w, $rcb) = $arg{cb}; 1892 my ($cb, $w, $rcb) = $arg{cb};
1690 1893
1691 $rcb = sub { 1894 $rcb = sub {
1692 if ($cb) { 1895 if ($cb) {
1693 $w = _time; 1896 $w = AE::time;
1694 &$cb; 1897 &$cb;
1695 $w = _time - $w; 1898 $w = AE::time - $w;
1696 1899
1697 # never use more then 50% of the time for the idle watcher, 1900 # never use more then 50% of the time for the idle watcher,
1698 # within some limits 1901 # within some limits
1699 $w = 0.0001 if $w < 0.0001; 1902 $w = 0.0001 if $w < 0.0001;
1700 $w = 5 if $w > 5; 1903 $w = 5 if $w > 5;
1723 1926
1724package AnyEvent::CondVar; 1927package AnyEvent::CondVar;
1725 1928
1726our @ISA = AnyEvent::CondVar::Base::; 1929our @ISA = AnyEvent::CondVar::Base::;
1727 1930
1931# only to be used for subclassing
1932sub new {
1933 my $class = shift;
1934 bless AnyEvent->condvar (@_), $class
1935}
1936
1728package AnyEvent::CondVar::Base; 1937package AnyEvent::CondVar::Base;
1729 1938
1730#use overload 1939#use overload
1731# '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1940# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1732# fallback => 1; 1941# fallback => 1;
1741 1950
1742sub _send { 1951sub _send {
1743 # nop 1952 # nop
1744} 1953}
1745 1954
1955sub _wait {
1956 AnyEvent->_poll until $_[0]{_ae_sent};
1957}
1958
1746sub send { 1959sub send {
1747 my $cv = shift; 1960 my $cv = shift;
1748 $cv->{_ae_sent} = [@_]; 1961 $cv->{_ae_sent} = [@_];
1749 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1962 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1750 $cv->_send; 1963 $cv->_send;
1757 1970
1758sub ready { 1971sub ready {
1759 $_[0]{_ae_sent} 1972 $_[0]{_ae_sent}
1760} 1973}
1761 1974
1762sub _wait {
1763 $WAITING
1764 and !$_[0]{_ae_sent}
1765 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1766
1767 local $WAITING = 1;
1768 AnyEvent->one_event while !$_[0]{_ae_sent};
1769}
1770
1771sub recv { 1975sub recv {
1976 unless ($_[0]{_ae_sent}) {
1977 $WAITING
1978 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1979
1980 local $WAITING = 1;
1772 $_[0]->_wait; 1981 $_[0]->_wait;
1982 }
1773 1983
1774 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1984 $_[0]{_ae_croak}
1775 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1985 and Carp::croak $_[0]{_ae_croak};
1986
1987 wantarray
1988 ? @{ $_[0]{_ae_sent} }
1989 : $_[0]{_ae_sent}[0]
1776} 1990}
1777 1991
1778sub cb { 1992sub cb {
1779 my $cv = shift; 1993 my $cv = shift;
1780 1994
1796 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 2010 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1797} 2011}
1798 2012
1799# undocumented/compatibility with pre-3.4 2013# undocumented/compatibility with pre-3.4
1800*broadcast = \&send; 2014*broadcast = \&send;
1801*wait = \&_wait; 2015*wait = \&recv;
1802 2016
1803=head1 ERROR AND EXCEPTION HANDLING 2017=head1 ERROR AND EXCEPTION HANDLING
1804 2018
1805In general, AnyEvent does not do any error handling - it relies on the 2019In general, AnyEvent does not do any error handling - it relies on the
1806caller to do that if required. The L<AnyEvent::Strict> module (see also 2020caller to do that if required. The L<AnyEvent::Strict> module (see also
1818$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 2032$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1819so on. 2033so on.
1820 2034
1821=head1 ENVIRONMENT VARIABLES 2035=head1 ENVIRONMENT VARIABLES
1822 2036
1823The following environment variables are used by this module or its 2037AnyEvent supports a number of environment variables that tune the
1824submodules. 2038runtime behaviour. They are usually evaluated when AnyEvent is
2039loaded, initialised, or a submodule that uses them is loaded. Many of
2040them also cause AnyEvent to load additional modules - for example,
2041C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
2042loaded.
1825 2043
1826Note that AnyEvent will remove I<all> environment variables starting with 2044All the environment variables documented here start with
1827C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 2045C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1828enabled. 2046namespace. Other modules are encouraged (but by no means required) to use
2047C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
2048namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
2049be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
2050variables starting with C<AE_>, see below).
2051
2052All variables can also be set via the C<AE_> prefix, that is, instead
2053of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
2054case there is a clash btween anyevent and another program that uses
2055C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
2056variable to the empty string, as those variables take precedence.
2057
2058When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
2059to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
2060exists. If taint mode is on, then AnyEvent will remove I<all> environment
2061variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
2062with C<undef> or the empty string, if the corresaponding C<AE_> variable
2063is set).
2064
2065The exact algorithm is currently:
2066
2067 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
2068 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
2069 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
2070
2071This ensures that child processes will not see the C<AE_> variables.
2072
2073The following environment variables are currently known to AnyEvent:
1829 2074
1830=over 4 2075=over 4
1831 2076
1832=item C<PERL_ANYEVENT_VERBOSE> 2077=item C<PERL_ANYEVENT_VERBOSE>
1833 2078
1834By default, AnyEvent will be completely silent except in fatal 2079By default, AnyEvent will log messages with loglevel C<4> (C<error>) or
1835conditions. You can set this environment variable to make AnyEvent more 2080higher (see L<AnyEvent::Log>). You can set this environment variable to a
1836talkative. 2081numerical loglevel to make AnyEvent more (or less) talkative.
1837 2082
2083If you want to do more than just set the global logging level
2084you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2085complex specifications.
2086
2087When set to C<0> (C<off>), then no messages whatsoever will be logged with
2088everything else at defaults.
2089
1838When set to C<1> or higher, causes AnyEvent to warn about unexpected 2090When set to C<5> or higher (C<warn>), AnyEvent warns about unexpected
1839conditions, such as not being able to load the event model specified by 2091conditions, such as not being able to load the event model specified by
1840C<PERL_ANYEVENT_MODEL>. 2092C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this
2093is the minimum recommended level for use during development.
1841 2094
1842When set to C<2> or higher, cause AnyEvent to report to STDERR which event 2095When set to C<7> or higher (info), AnyEvent reports which event model it
1843model it chooses. 2096chooses.
1844 2097
1845When set to C<8> or higher, then AnyEvent will report extra information on 2098When set to C<8> or higher (debug), then AnyEvent will report extra
1846which optional modules it loads and how it implements certain features. 2099information on which optional modules it loads and how it implements
2100certain features.
2101
2102=item C<PERL_ANYEVENT_LOG>
2103
2104Accepts rather complex logging specifications. For example, you could log
2105all C<debug> messages of some module to stderr, warnings and above to
2106stderr, and errors and above to syslog, with:
2107
2108 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
2109
2110For the rather extensive details, see L<AnyEvent::Log>.
2111
2112This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2113so will take effect even before AnyEvent has initialised itself.
2114
2115Note that specifying this environment variable causes the L<AnyEvent::Log>
2116module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2117using the latter saves a few hundred kB of memory unless a module
2118explicitly needs the extra features of AnyEvent::Log.
1847 2119
1848=item C<PERL_ANYEVENT_STRICT> 2120=item C<PERL_ANYEVENT_STRICT>
1849 2121
1850AnyEvent does not do much argument checking by default, as thorough 2122AnyEvent does not do much argument checking by default, as thorough
1851argument checking is very costly. Setting this variable to a true value 2123argument checking is very costly. Setting this variable to a true value
1853check the arguments passed to most method calls. If it finds any problems, 2125check the arguments passed to most method calls. If it finds any problems,
1854it will croak. 2126it will croak.
1855 2127
1856In other words, enables "strict" mode. 2128In other words, enables "strict" mode.
1857 2129
1858Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense> 2130Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1859>>, it is definitely recommended to keep it off in production. Keeping 2131>>, it is definitely recommended to keep it off in production. Keeping
1860C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2132C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1861can be very useful, however. 2133can be very useful, however.
1862 2134
2135=item C<PERL_ANYEVENT_DEBUG_SHELL>
2136
2137If this env variable is nonempty, then its contents will be interpreted by
2138C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
2139replacing every occurance of C<$$> by the process pid). The shell object
2140is saved in C<$AnyEvent::Debug::SHELL>.
2141
2142This happens when the first watcher is created.
2143
2144For example, to bind a debug shell on a unix domain socket in
2145F<< /tmp/debug<pid>.sock >>, you could use this:
2146
2147 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2148 # connect with e.g.: socat readline /tmp/debug123.sock
2149
2150Or to bind to tcp port 4545 on localhost:
2151
2152 PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
2153 # connect with e.g.: telnet localhost 4545
2154
2155Note that creating sockets in F</tmp> or on localhost is very unsafe on
2156multiuser systems.
2157
2158=item C<PERL_ANYEVENT_DEBUG_WRAP>
2159
2160Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2161debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2162
1863=item C<PERL_ANYEVENT_MODEL> 2163=item C<PERL_ANYEVENT_MODEL>
1864 2164
1865This can be used to specify the event model to be used by AnyEvent, before 2165This can be used to specify the event model to be used by AnyEvent, before
1866auto detection and -probing kicks in. It must be a string consisting 2166auto detection and -probing kicks in.
1867entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2167
2168It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2169or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1868and the resulting module name is loaded and if the load was successful, 2170resulting module name is loaded and - if the load was successful - used as
1869used as event model. If it fails to load AnyEvent will proceed with 2171event model backend. If it fails to load then AnyEvent will proceed with
1870auto detection and -probing. 2172auto detection and -probing.
1871 2173
1872This functionality might change in future versions. 2174If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2175nothing gets prepended and the module name is used as-is (hint: C<::> at
2176the end of a string designates a module name and quotes it appropriately).
1873 2177
1874For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 2178For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1875could start your program like this: 2179could start your program like this:
1876 2180
1877 PERL_ANYEVENT_MODEL=Perl perl ... 2181 PERL_ANYEVENT_MODEL=Perl perl ...
1878 2182
1879=item C<PERL_ANYEVENT_PROTOCOLS> 2183=item C<PERL_ANYEVENT_PROTOCOLS>
1895but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 2199but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1896- only support IPv4, never try to resolve or contact IPv6 2200- only support IPv4, never try to resolve or contact IPv6
1897addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2201addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1898IPv6, but prefer IPv6 over IPv4. 2202IPv6, but prefer IPv6 over IPv4.
1899 2203
2204=item C<PERL_ANYEVENT_HOSTS>
2205
2206This variable, if specified, overrides the F</etc/hosts> file used by
2207L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2208from that file instead.
2209
1900=item C<PERL_ANYEVENT_EDNS0> 2210=item C<PERL_ANYEVENT_EDNS0>
1901 2211
1902Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension 2212Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1903for DNS. This extension is generally useful to reduce DNS traffic, but 2213DNS. This extension is generally useful to reduce DNS traffic, especially
1904some (broken) firewalls drop such DNS packets, which is why it is off by 2214when DNSSEC is involved, but some (broken) firewalls drop such DNS
1905default. 2215packets, which is why it is off by default.
1906 2216
1907Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce 2217Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1908EDNS0 in its DNS requests. 2218EDNS0 in its DNS requests.
1909 2219
1910=item C<PERL_ANYEVENT_MAX_FORKS> 2220=item C<PERL_ANYEVENT_MAX_FORKS>
1916 2226
1917The default value for the C<max_outstanding> parameter for the default DNS 2227The default value for the C<max_outstanding> parameter for the default DNS
1918resolver - this is the maximum number of parallel DNS requests that are 2228resolver - this is the maximum number of parallel DNS requests that are
1919sent to the DNS server. 2229sent to the DNS server.
1920 2230
2231=item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY>
2232
2233Perl has inherently racy signal handling (you can basically choose between
2234losing signals and memory corruption) - pure perl event loops (including
2235C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore
2236have to poll regularly to avoid losing signals.
2237
2238Some event loops are racy, but don't poll regularly, and some event loops
2239are written in C but are still racy. For those event loops, AnyEvent
2240installs a timer that regularly wakes up the event loop.
2241
2242By default, the interval for this timer is C<10> seconds, but you can
2243override this delay with this environment variable (or by setting
2244the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal
2245watchers).
2246
2247Lower values increase CPU (and energy) usage, higher values can introduce
2248long delays when reaping children or waiting for signals.
2249
2250The L<AnyEvent::Async> module, if available, will be used to avoid this
2251polling (with most event loops).
2252
1921=item C<PERL_ANYEVENT_RESOLV_CONF> 2253=item C<PERL_ANYEVENT_RESOLV_CONF>
1922 2254
1923The file to use instead of F</etc/resolv.conf> (or OS-specific 2255The absolute path to a F<resolv.conf>-style file to use instead of
1924configuration) in the default resolver. When set to the empty string, no 2256F</etc/resolv.conf> (or the OS-specific configuration) in the default
1925default config will be used. 2257resolver, or the empty string to select the default configuration.
1926 2258
1927=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. 2259=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1928 2260
1929When neither C<ca_file> nor C<ca_path> was specified during 2261When neither C<ca_file> nor C<ca_path> was specified during
1930L<AnyEvent::TLS> context creation, and either of these environment 2262L<AnyEvent::TLS> context creation, and either of these environment
1931variables exist, they will be used to specify CA certificate locations 2263variables are nonempty, they will be used to specify CA certificate
1932instead of a system-dependent default. 2264locations instead of a system-dependent default.
1933 2265
1934=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> 2266=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1935 2267
1936When these are set to C<1>, then the respective modules are not 2268When these are set to C<1>, then the respective modules are not
1937loaded. Mostly good for testing AnyEvent itself. 2269loaded. Mostly good for testing AnyEvent itself.
2269(even when used without AnyEvent), but most event loops have acceptable 2601(even when used without AnyEvent), but most event loops have acceptable
2270performance with or without AnyEvent. 2602performance with or without AnyEvent.
2271 2603
2272=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2604=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2273the actual event loop, only with extremely fast event loops such as EV 2605the actual event loop, only with extremely fast event loops such as EV
2274adds AnyEvent significant overhead. 2606does AnyEvent add significant overhead.
2275 2607
2276=item * You should avoid POE like the plague if you want performance or 2608=item * You should avoid POE like the plague if you want performance or
2277reasonable memory usage. 2609reasonable memory usage.
2278 2610
2279=back 2611=back
2509 unless defined $SIG{PIPE}; 2841 unless defined $SIG{PIPE};
2510 2842
2511=head1 RECOMMENDED/OPTIONAL MODULES 2843=head1 RECOMMENDED/OPTIONAL MODULES
2512 2844
2513One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and 2845One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2514it's built-in modules) are required to use it. 2846its built-in modules) are required to use it.
2515 2847
2516That does not mean that AnyEvent won't take advantage of some additional 2848That does not mean that AnyEvent won't take advantage of some additional
2517modules if they are installed. 2849modules if they are installed.
2518 2850
2519This section explains which additional modules will be used, and how they 2851This section explains which additional modules will be used, and how they
2577the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. 2909the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2578 2910
2579=item L<Time::HiRes> 2911=item L<Time::HiRes>
2580 2912
2581This module is part of perl since release 5.008. It will be used when the 2913This module is part of perl since release 5.008. It will be used when the
2582chosen event library does not come with a timing source on it's own. The 2914chosen event library does not come with a timing source of its own. The
2583pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2915pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2584try to use a monotonic clock for timing stability. 2916try to use a monotonic clock for timing stability.
2585 2917
2586=back 2918=back
2587 2919
2588 2920
2650pronounced). 2982pronounced).
2651 2983
2652 2984
2653=head1 SEE ALSO 2985=head1 SEE ALSO
2654 2986
2655Utility functions: L<AnyEvent::Util>. 2987Tutorial/Introduction: L<AnyEvent::Intro>.
2656 2988
2657Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2989FAQ: L<AnyEvent::FAQ>.
2658L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2990
2991Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2992(simply logging).
2993
2994Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2995L<AnyEvent::Debug> (interactive shell, watcher tracing).
2996
2997Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2998L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
2999L<Qt>, L<POE>, L<FLTK>.
2659 3000
2660Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 3001Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2661L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 3002L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2662L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 3003L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2663L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 3004L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
3005L<AnyEvent::Impl::FLTK>.
2664 3006
2665Non-blocking file handles, sockets, TCP clients and 3007Non-blocking handles, pipes, stream sockets, TCP clients and
2666servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 3008servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2667 3009
2668Asynchronous DNS: L<AnyEvent::DNS>. 3010Asynchronous DNS: L<AnyEvent::DNS>.
2669 3011
2670Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, 3012Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2671L<Coro::Event>,
2672 3013
2673Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, 3014Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2674L<AnyEvent::HTTP>. 3015L<AnyEvent::HTTP>.
2675 3016
2676 3017
2677=head1 AUTHOR 3018=head1 AUTHOR
2678 3019

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines