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.381 by root, Thu Sep 1 22:09:25 2011 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
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 attaching
431callbacks to signals in a generic way, which is a pity, as you cannot 432callbacks to signals in a generic way, which is a pity, as you cannot
432do race-free signal handling in perl, requiring C libraries for 433do race-free signal handling in perl, requiring C libraries for
433this. AnyEvent will try to do it's best, which means in some cases, 434this. AnyEvent will try to do its best, which means in some cases,
434signals will be delayed. The maximum time a signal might be delayed is 435signals will be delayed. The maximum time a signal might be delayed is
435specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This 436specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
436variable can be changed only before the first signal watcher is created, 437variable can be changed only before the first signal watcher is created,
437and should be left alone otherwise. This variable determines how often 438and should be left alone otherwise. This variable determines how often
438AnyEvent polls for signals (in case a wake-up was missed). Higher values 439AnyEvent polls for signals (in case a wake-up was missed). Higher values
440saving. 441saving.
441 442
442All these problems can be avoided by installing the optional 443All these problems can be avoided by installing the optional
443L<Async::Interrupt> module, which works with most event loops. It will not 444L<Async::Interrupt> module, which works with most event loops. It will not
444work with inherently broken event loops such as L<Event> or L<Event::Lib> 445work with inherently broken event loops such as L<Event> or L<Event::Lib>
445(and not with L<POE> currently, as POE does it's own workaround with 446(and not with L<POE> currently, as POE does its own workaround with
446one-second latency). For those, you just have to suffer the delays. 447one-second latency). For those, you just have to suffer the delays.
447 448
448=head2 CHILD PROCESS WATCHERS 449=head2 CHILD PROCESS WATCHERS
449 450
450 $w = AnyEvent->child (pid => <process id>, cb => <callback>); 451 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
451 452
452You can also watch on a child process exit and catch its exit status. 453You can also watch for a child process exit and catch its exit status.
453 454
454The child process is specified by the C<pid> argument (one some backends, 455The child process is specified by the C<pid> argument (on some backends,
455using C<0> watches for any child process exit, on others this will 456using C<0> watches for any child process exit, on others this will
456croak). The watcher will be triggered only when the child process has 457croak). The watcher will be triggered only when the child process has
457finished and an exit status is available, not on any trace events 458finished and an exit status is available, not on any trace events
458(stopped/continued). 459(stopped/continued).
459 460
481thing in an AnyEvent program, you I<have> to create at least one 482thing in an AnyEvent program, you I<have> to create at least one
482watcher before you C<fork> the child (alternatively, you can call 483watcher before you C<fork> the child (alternatively, you can call
483C<AnyEvent::detect>). 484C<AnyEvent::detect>).
484 485
485As most event loops do not support waiting for child events, they will be 486As 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 487emulated by AnyEvent in most cases, in which case the latency and race
487mentioned in the description of signal watchers apply. 488problems mentioned in the description of signal watchers apply.
488 489
489Example: fork a process and wait for it 490Example: fork a process and wait for it
490 491
491 my $done = AnyEvent->condvar; 492 my $done = AnyEvent->condvar;
492 493
506 507
507=head2 IDLE WATCHERS 508=head2 IDLE WATCHERS
508 509
509 $w = AnyEvent->idle (cb => <callback>); 510 $w = AnyEvent->idle (cb => <callback>);
510 511
511Repeatedly invoke the callback after the process becomes idle, until 512This will repeatedly invoke the callback after the process becomes idle,
512either the watcher is destroyed or new events have been detected. 513until either the watcher is destroyed or new events have been detected.
513 514
514Idle watchers are useful when there is a need to do something, but it 515Idle watchers are useful when there is a need to do something, but it
515is not so important (or wise) to do it instantly. The callback will be 516is not so important (or wise) to do it instantly. The callback will be
516invoked only when there is "nothing better to do", which is usually 517invoked only when there is "nothing better to do", which is usually
517defined as "all outstanding events have been handled and no new events 518defined as "all outstanding events have been handled and no new events
587the signal fires. 588the signal fires.
588 589
589=item * Condition variables are like "Merge Points" - points in your program 590=item * Condition variables are like "Merge Points" - points in your program
590where you merge multiple independent results/control flows into one. 591where you merge multiple independent results/control flows into one.
591 592
592=item * Condition variables represent a transaction - function that start 593=item * Condition variables represent a transaction - functions that start
593some kind of transaction can return them, leaving the caller the choice 594some kind of transaction can return them, leaving the caller the choice
594between waiting in a blocking fashion, or setting a callback. 595between waiting in a blocking fashion, or setting a callback.
595 596
596=item * Condition variables represent future values, or promises to deliver 597=item * Condition variables represent future values, or promises to deliver
597some result, long before the result is available. 598some result, long before the result is available.
617 618
618Condition variables are represented by hash refs in perl, and the keys 619Condition variables are represented by hash refs in perl, and the keys
619used by AnyEvent itself are all named C<_ae_XXX> to make subclassing 620used by AnyEvent itself are all named C<_ae_XXX> to make subclassing
620easy (it is often useful to build your own transaction class on top of 621easy (it is often useful to build your own transaction class on top of
621AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call 622AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
622it's C<new> method in your own C<new> method. 623its C<new> method in your own C<new> method.
623 624
624There are two "sides" to a condition variable - the "producer side" which 625There are two "sides" to a condition variable - the "producer side" which
625eventually calls C<< -> send >>, and the "consumer side", which waits 626eventually calls C<< -> send >>, and the "consumer side", which waits
626for the send to occur. 627for the send to occur.
627 628
692they were a code reference). Calling them directly is the same as calling 693they were a code reference). Calling them directly is the same as calling
693C<send>. 694C<send>.
694 695
695=item $cv->croak ($error) 696=item $cv->croak ($error)
696 697
697Similar to send, but causes all call's to C<< ->recv >> to invoke 698Similar to send, but causes all calls to C<< ->recv >> to invoke
698C<Carp::croak> with the given error message/object/scalar. 699C<Carp::croak> with the given error message/object/scalar.
699 700
700This can be used to signal any errors to the condition variable 701This can be used to signal any errors to the condition variable
701user/consumer. Doing it this way instead of calling C<croak> directly 702user/consumer. Doing it this way instead of calling C<croak> directly
702delays the error detetcion, but has the overwhelmign advantage that it 703delays the error detection, but has the overwhelming advantage that it
703diagnoses the error at the place where the result is expected, and not 704diagnoses the error at the place where the result is expected, and not
704deep in some event clalback without connection to the actual code causing 705deep in some event callback with no connection to the actual code causing
705the problem. 706the problem.
706 707
707=item $cv->begin ([group callback]) 708=item $cv->begin ([group callback])
708 709
709=item $cv->end 710=item $cv->end
747one call to C<begin>, so the condvar waits for all calls to C<end> before 748one call to C<begin>, so the condvar waits for all calls to C<end> before
748sending. 749sending.
749 750
750The ping example mentioned above is slightly more complicated, as the 751The ping example mentioned above is slightly more complicated, as the
751there are results to be passwd back, and the number of tasks that are 752there are results to be passwd back, and the number of tasks that are
752begung can potentially be zero: 753begun can potentially be zero:
753 754
754 my $cv = AnyEvent->condvar; 755 my $cv = AnyEvent->condvar;
755 756
756 my %result; 757 my %result;
757 $cv->begin (sub { shift->send (\%result) }); 758 $cv->begin (sub { shift->send (\%result) });
778to be called once the counter reaches C<0>, and second, it ensures that 779to be called once the counter reaches C<0>, and second, it ensures that
779C<send> is called even when C<no> hosts are being pinged (the loop 780C<send> is called even when C<no> hosts are being pinged (the loop
780doesn't execute once). 781doesn't execute once).
781 782
782This is the general pattern when you "fan out" into multiple (but 783This is the general pattern when you "fan out" into multiple (but
783potentially none) subrequests: use an outer C<begin>/C<end> pair to set 784potentially zero) subrequests: use an outer C<begin>/C<end> pair to set
784the callback and ensure C<end> is called at least once, and then, for each 785the callback and ensure C<end> is called at least once, and then, for each
785subrequest you start, call C<begin> and for each subrequest you finish, 786subrequest you start, call C<begin> and for each subrequest you finish,
786call C<end>. 787call C<end>.
787 788
788=back 789=back
795=over 4 796=over 4
796 797
797=item $cv->recv 798=item $cv->recv
798 799
799Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak 800Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
800>> methods have been called on c<$cv>, while servicing other watchers 801>> methods have been called on C<$cv>, while servicing other watchers
801normally. 802normally.
802 803
803You can only wait once on a condition - additional calls are valid but 804You can only wait once on a condition - additional calls are valid but
804will return immediately. 805will return immediately.
805 806
822caller decide whether the call will block or not (for example, by coupling 823caller decide whether the call will block or not (for example, by coupling
823condition variables with some kind of request results and supporting 824condition variables with some kind of request results and supporting
824callbacks so the caller knows that getting the result will not block, 825callbacks so the caller knows that getting the result will not block,
825while still supporting blocking waits if the caller so desires). 826while still supporting blocking waits if the caller so desires).
826 827
827You can ensure that C<< -recv >> never blocks by setting a callback and 828You can ensure that C<< ->recv >> never blocks by setting a callback and
828only calling C<< ->recv >> from within that callback (or at a later 829only calling C<< ->recv >> from within that callback (or at a later
829time). This will work even when the event loop does not support blocking 830time). This will work even when the event loop does not support blocking
830waits otherwise. 831waits otherwise.
831 832
832=item $bool = $cv->ready 833=item $bool = $cv->ready
837=item $cb = $cv->cb ($cb->($cv)) 838=item $cb = $cv->cb ($cb->($cv))
838 839
839This is a mutator function that returns the callback set and optionally 840This is a mutator function that returns the callback set and optionally
840replaces it before doing so. 841replaces it before doing so.
841 842
842The callback will be called when the condition becomes (or already was) 843The 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 844C<send> or C<croak> are called, with the only argument being the
844the only argument being the condition variable itself. Calling C<recv> 845condition variable itself. If the condition is already true, the
846callback is called immediately when it is set. Calling C<recv> inside
845inside the callback or at any later time is guaranteed not to block. 847the callback or at any later time is guaranteed not to block.
846 848
847=back 849=back
848 850
849=head1 SUPPORTED EVENT LOOPS/BACKENDS 851=head1 SUPPORTED EVENT LOOPS/BACKENDS
850 852
858use. If EV is not installed, then AnyEvent will fall back to its own 860use. If EV is not installed, then AnyEvent will fall back to its own
859pure-perl implementation, which is available everywhere as it comes with 861pure-perl implementation, which is available everywhere as it comes with
860AnyEvent itself. 862AnyEvent itself.
861 863
862 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 864 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
863 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 865 AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
864 866
865=item Backends that are transparently being picked up when they are used. 867=item Backends that are transparently being picked up when they are used.
866 868
867These will be used when they are currently loaded when the first watcher 869These will be used if they are already loaded when the first watcher
868is created, in which case it is assumed that the application is using 870is created, in which case it is assumed that the application is using
869them. This means that AnyEvent will automatically pick the right backend 871them. This means that AnyEvent will automatically pick the right backend
870when the main program loads an event module before anything starts to 872when the main program loads an event module before anything starts to
871create watchers. Nothing special needs to be done by the main program. 873create watchers. Nothing special needs to be done by the main program.
872 874
874 AnyEvent::Impl::Glib based on Glib, slow but very stable. 876 AnyEvent::Impl::Glib based on Glib, slow but very stable.
875 AnyEvent::Impl::Tk based on Tk, very broken. 877 AnyEvent::Impl::Tk based on Tk, very broken.
876 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
877 AnyEvent::Impl::POE based on POE, very slow, some limitations. 879 AnyEvent::Impl::POE based on POE, very slow, some limitations.
878 AnyEvent::Impl::Irssi used when running within irssi. 880 AnyEvent::Impl::Irssi used when running within irssi.
881 AnyEvent::Impl::IOAsync based on IO::Async.
882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
883 AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
879 884
880=item Backends with special needs. 885=item Backends with special needs.
881 886
882Qt requires the Qt::Application to be instantiated first, but will 887Qt requires the Qt::Application to be instantiated first, but will
883otherwise be picked up automatically. As long as the main program 888otherwise be picked up automatically. As long as the main program
884instantiates the application before any AnyEvent watchers are created, 889instantiates the application before any AnyEvent watchers are created,
885everything should just work. 890everything should just work.
886 891
887 AnyEvent::Impl::Qt based on Qt. 892 AnyEvent::Impl::Qt based on Qt.
888 893
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. 894=item Event loops that are indirectly supported via other backends.
898 895
899Some event loops can be supported via other modules: 896Some event loops can be supported via other modules:
900 897
901There is no direct support for WxWidgets (L<Wx>) or L<Prima>. 898There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
926Contains C<undef> until the first watcher is being created, before the 923Contains C<undef> until the first watcher is being created, before the
927backend has been autodetected. 924backend has been autodetected.
928 925
929Afterwards it contains the event model that is being used, which is the 926Afterwards it contains the event model that is being used, which is the
930name of the Perl class implementing the model. This class is usually one 927name of the Perl class implementing the model. This class is usually one
931of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the 928of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
932case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it 929case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
933will be C<urxvt::anyevent>). 930will be C<urxvt::anyevent>).
934 931
935=item AnyEvent::detect 932=item AnyEvent::detect
936 933
937Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
938if necessary. You should only call this function right before you would 935if necessary. You should only call this function right before you would
939have created an AnyEvent watcher anyway, that is, as late as possible at 936have created an AnyEvent watcher anyway, that is, as late as possible at
940runtime, and not e.g. while initialising of your module. 937runtime, and not e.g. during initialisation of your module.
938
939The effect of calling this function is as if a watcher had been created
940(specifically, actions that happen "when the first watcher is created"
941happen when calling detetc as well).
941 942
942If you need to do some initialisation before AnyEvent watchers are 943If you need to do some initialisation before AnyEvent watchers are
943created, use C<post_detect>. 944created, use C<post_detect>.
944 945
945=item $guard = AnyEvent::post_detect { BLOCK } 946=item $guard = AnyEvent::post_detect { BLOCK }
946 947
947Arranges for the code block to be executed as soon as the event model is 948Arranges for the code block to be executed as soon as the event model is
948autodetected (or immediately if this has already happened). 949autodetected (or immediately if that has already happened).
949 950
950The block will be executed I<after> the actual backend has been detected 951The 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 952(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 953created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
953other initialisations - see the sources of L<AnyEvent::Strict> or 954other initialisations - see the sources of L<AnyEvent::Strict> or
962that automatically removes the callback again when it is destroyed (or 963that automatically removes the callback again when it is destroyed (or
963C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for 964C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
964a case where this is useful. 965a case where this is useful.
965 966
966Example: Create a watcher for the IO::AIO module and store it in 967Example: Create a watcher for the IO::AIO module and store it in
967C<$WATCHER>. Only do so after the event loop is initialised, though. 968C<$WATCHER>, but do so only do so after the event loop is initialised.
968 969
969 our WATCHER; 970 our WATCHER;
970 971
971 my $guard = AnyEvent::post_detect { 972 my $guard = AnyEvent::post_detect {
972 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb); 973 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
980 $WATCHER ||= $guard; 981 $WATCHER ||= $guard;
981 982
982=item @AnyEvent::post_detect 983=item @AnyEvent::post_detect
983 984
984If there are any code references in this array (you can C<push> to it 985If 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 986before or after loading AnyEvent), then they will be called directly
986the event loop has been chosen. 987after the event loop has been chosen.
987 988
988You should check C<$AnyEvent::MODEL> before adding to this array, though: 989You 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 990if it is defined then the event loop has already been detected, and the
990array will be ignored. 991array will be ignored.
991 992
1008 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent 1009 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1009 # as soon as it is 1010 # as soon as it is
1010 push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; 1011 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1011 } 1012 }
1012 1013
1014=item AnyEvent::postpone { BLOCK }
1015
1016Arranges for the block to be executed as soon as possible, but not before
1017the call itself returns. In practise, the block will be executed just
1018before the event loop polls for new events, or shortly afterwards.
1019
1020This function never returns anything (to make the C<return postpone { ...
1021}> idiom more useful.
1022
1023To understand the usefulness of this function, consider a function that
1024asynchronously does something for you and returns some transaction
1025object or guard to let you cancel the operation. For example,
1026C<AnyEvent::Socket::tcp_connect>:
1027
1028 # start a conenction attempt unless one is active
1029 $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
1030 delete $self->{connect_guard};
1031 ...
1032 };
1033
1034Imagine that this function could instantly call the callback, for
1035example, because it detects an obvious error such as a negative port
1036number. Invoking the callback before the function returns causes problems
1037however: the callback will be called and will try to delete the guard
1038object. But since the function hasn't returned yet, there is nothing to
1039delete. When the function eventually returns it will assign the guard
1040object to C<< $self->{connect_guard} >>, where it will likely never be
1041deleted, so the program thinks it is still trying to connect.
1042
1043This is where C<AnyEvent::postpone> should be used. Instead of calling the
1044callback directly on error:
1045
1046 $cb->(undef), return # signal error to callback, BAD!
1047 if $some_error_condition;
1048
1049It should use C<postpone>:
1050
1051 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1052 if $some_error_condition;
1053
1054=item AnyEvent::log $level, $msg[, @args]
1055
1056Log the given C<$msg> at the given C<$level>.
1057
1058If L<AnyEvent::Log> is not loaded then this function makes a simple test
1059to see whether the message will be logged. If the test succeeds it will
1060load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
1061the L<AnyEvent::Log> documentation for details.
1062
1063If the test fails it will simply return. Right now this happens when a
1064numerical loglevel is used and it is larger than the level specified via
1065C<$ENV{PERL_ANYEVENT_VERBOSE}>.
1066
1067If you want to sprinkle loads of logging calls around your code, consider
1068creating a logger callback with the C<AnyEvent::Log::logger> function,
1069which can reduce typing, codesize and can reduce the logging overhead
1070enourmously.
1071
1013=back 1072=back
1014 1073
1015=head1 WHAT TO DO IN A MODULE 1074=head1 WHAT TO DO IN A MODULE
1016 1075
1017As a module author, you should C<use AnyEvent> and call AnyEvent methods 1076As 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 1086because it will stall the whole program, and the whole point of using
1028events is to stay interactive. 1087events is to stay interactive.
1029 1088
1030It is fine, however, to call C<< ->recv >> when the user of your module 1089It 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 1090requests 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 >> 1091called C<results> that returns the results, it may call C<< ->recv >>
1033freely, as the user of your module knows what she is doing. always). 1092freely, as the user of your module knows what she is doing. Always).
1034 1093
1035=head1 WHAT TO DO IN THE MAIN PROGRAM 1094=head1 WHAT TO DO IN THE MAIN PROGRAM
1036 1095
1037There will always be a single main program - the only place that should 1096There will always be a single main program - the only place that should
1038dictate which event model to use. 1097dictate which event model to use.
1039 1098
1040If it doesn't care, it can just "use AnyEvent" and use it itself, or not 1099If 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 1100when it depends on a module that uses an AnyEvent. If the program itself
1042decide which implementation to chose if some module relies on it. 1101uses AnyEvent, but does not care which event loop is used, all it needs
1102to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
1103available loop implementation.
1043 1104
1044If the main program relies on a specific event model - for example, in 1105If 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 1106Gtk2 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 1107event module before loading AnyEvent or any module that uses it: generally
1047speaking, you should load it as early as possible. The reason is that 1108speaking, you should load it as early as possible. The reason is that
1048modules might create watchers when they are loaded, and AnyEvent will 1109modules 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 1110decide 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. 1111might choose the wrong one unless you load the correct one yourself.
1051 1112
1052You can chose to use a pure-perl implementation by loading the 1113You can chose to use a pure-perl implementation by loading the
1053C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1114C<AnyEvent::Loop> module, which gives you similar behaviour
1054everywhere, but letting AnyEvent chose the model is generally better. 1115everywhere, but letting AnyEvent chose the model is generally better.
1055 1116
1056=head2 MAINLOOP EMULATION 1117=head2 MAINLOOP EMULATION
1057 1118
1058Sometimes (often for short test scripts, or even standalone programs who 1119Sometimes (often for short test scripts, or even standalone programs who
1071 1132
1072 1133
1073=head1 OTHER MODULES 1134=head1 OTHER MODULES
1074 1135
1075The following is a non-exhaustive list of additional modules that use 1136The following is a non-exhaustive list of additional modules that use
1076AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1137AnyEvent as a client and can therefore be mixed easily with other
1077modules and other event loops in the same program. Some of the modules 1138AnyEvent modules and other event loops in the same program. Some of the
1078come as part of AnyEvent, the others are available via CPAN. 1139modules come as part of AnyEvent, the others are available via CPAN (see
1140L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
1141a longer non-exhaustive list), and the list is heavily biased towards
1142modules of the AnyEvent author himself :)
1079 1143
1080=over 4 1144=over 4
1081 1145
1082=item L<AnyEvent::Util> 1146=item L<AnyEvent::Util>
1083 1147
1084Contains various utility functions that replace often-used but blocking 1148Contains various utility functions that replace often-used blocking
1085functions such as C<inet_aton> by event-/callback-based versions. 1149functions such as C<inet_aton> with event/callback-based versions.
1086 1150
1087=item L<AnyEvent::Socket> 1151=item L<AnyEvent::Socket>
1088 1152
1089Provides various utility functions for (internet protocol) sockets, 1153Provides various utility functions for (internet protocol) sockets,
1090addresses and name resolution. Also functions to create non-blocking tcp 1154addresses and name resolution. Also functions to create non-blocking tcp
1092 1156
1093=item L<AnyEvent::Handle> 1157=item L<AnyEvent::Handle>
1094 1158
1095Provide read and write buffers, manages watchers for reads and writes, 1159Provide read and write buffers, manages watchers for reads and writes,
1096supports raw and formatted I/O, I/O queued and fully transparent and 1160supports raw and formatted I/O, I/O queued and fully transparent and
1097non-blocking SSL/TLS (via L<AnyEvent::TLS>. 1161non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1098 1162
1099=item L<AnyEvent::DNS> 1163=item L<AnyEvent::DNS>
1100 1164
1101Provides rich asynchronous DNS resolver capabilities. 1165Provides rich asynchronous DNS resolver capabilities.
1102 1166
1103=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> 1167=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1104 1168
1105Implement event-based interfaces to the protocols of the same name (for 1169Implement event-based interfaces to the protocols of the same name (for
1106the curious, IGS is the International Go Server and FCP is the Freenet 1170the curious, IGS is the International Go Server and FCP is the Freenet
1107Client Protocol). 1171Client 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 1172
1131=item L<AnyEvent::AIO> 1173=item L<AnyEvent::AIO>
1132 1174
1133Truly asynchronous (as opposed to non-blocking) I/O, should be in the 1175Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1134toolbox of every event programmer. AnyEvent::AIO transparently fuses 1176toolbox of every event programmer. AnyEvent::AIO transparently fuses
1135L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based 1177L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1136file I/O, and much more. 1178file I/O, and much more.
1137 1179
1180=item L<AnyEvent::Filesys::Notify>
1181
1182AnyEvent is good for non-blocking stuff, but it can't detect file or
1183path changes (e.g. "watch this directory for new files", "watch this
1184file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
1185do just that in a portbale fashion, supporting inotify on GNU/Linux and
1186some weird, without doubt broken, stuff on OS X to monitor files. It can
1187fall back to blocking scans at regular intervals transparently on other
1188platforms, so it's about as portable as it gets.
1189
1190(I haven't used it myself, but I haven't heard anybody complaining about
1191it yet).
1192
1193=item L<AnyEvent::DBI>
1194
1195Executes L<DBI> requests asynchronously in a proxy process for you,
1196notifying you in an event-based way when the operation is finished.
1197
1138=item L<AnyEvent::HTTPD> 1198=item L<AnyEvent::HTTPD>
1139 1199
1140A simple embedded webserver. 1200A simple embedded webserver.
1141 1201
1142=item L<AnyEvent::FastPing> 1202=item L<AnyEvent::FastPing>
1143 1203
1144The fastest ping in the west. 1204The fastest ping in the west.
1145 1205
1146=item L<Coro> 1206=item L<Coro>
1147 1207
1148Has special support for AnyEvent via L<Coro::AnyEvent>. 1208Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
1209to simply invert the flow control - don't call us, we will call you:
1210
1211 async {
1212 Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
1213 print "5 seconds later!\n";
1214
1215 Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
1216 my $line = <STDIN>; # works for ttys
1217
1218 AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
1219 my ($body, $hdr) = Coro::rouse_wait;
1220 };
1149 1221
1150=back 1222=back
1151 1223
1152=cut 1224=cut
1153 1225
1154package AnyEvent; 1226package AnyEvent;
1155 1227
1156# basically a tuned-down version of common::sense 1228# basically a tuned-down version of common::sense
1157sub common_sense { 1229sub common_sense {
1158 # from common:.sense 1.0 1230 # from common:.sense 3.4
1159 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00"; 1231 ${^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) 1232 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1161 $^H |= 0x00000600; 1233 $^H |= 0x00000600;
1162} 1234}
1163 1235
1164BEGIN { AnyEvent::common_sense } 1236BEGIN { AnyEvent::common_sense }
1165 1237
1166use Carp (); 1238use Carp ();
1167 1239
1168our $VERSION = '5.27'; 1240our $VERSION = '6.02';
1169our $MODEL; 1241our $MODEL;
1170 1242
1171our $AUTOLOAD;
1172our @ISA; 1243our @ISA;
1173 1244
1174our @REGISTRY; 1245our @REGISTRY;
1175 1246
1176our $VERBOSE; 1247our $VERBOSE;
1181 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1252 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1182 1253
1183 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1254 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1184 if ${^TAINT}; 1255 if ${^TAINT};
1185 1256
1186 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1257 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1258 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1187 1259
1260 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1261 if ${^TAINT};
1262
1263 # $ENV{PERL_ANYEVENT_xxx} now valid
1264
1265 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 3;
1188} 1266}
1189 1267
1190our $MAX_SIGNAL_LATENCY = 10; 1268our $MAX_SIGNAL_LATENCY = 10;
1191 1269
1192our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1270our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1196 $PROTOCOL{$_} = ++$idx 1274 $PROTOCOL{$_} = ++$idx
1197 for reverse split /\s*,\s*/, 1275 for reverse split /\s*,\s*/,
1198 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1276 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1199} 1277}
1200 1278
1279our @post_detect;
1280
1281sub post_detect(&) {
1282 my ($cb) = @_;
1283
1284 push @post_detect, $cb;
1285
1286 defined wantarray
1287 ? bless \$cb, "AnyEvent::Util::postdetect"
1288 : ()
1289}
1290
1291sub AnyEvent::Util::postdetect::DESTROY {
1292 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1293}
1294
1295our $POSTPONE_W;
1296our @POSTPONE;
1297
1298sub _postpone_exec {
1299 undef $POSTPONE_W;
1300
1301 &{ shift @POSTPONE }
1302 while @POSTPONE;
1303}
1304
1305sub postpone(&) {
1306 push @POSTPONE, shift;
1307
1308 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1309
1310 ()
1311}
1312
1313sub log($$;@) {
1314 # only load the big bloated module when we actually are about to log something
1315 if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!)
1316 require AnyEvent::Log;
1317 # AnyEvent::Log overwrites this function
1318 goto &log;
1319 }
1320
1321 0 # not logged
1322}
1323
1324if (length $ENV{PERL_ANYEVENT_LOG}) {
1325 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1326}
1327
1201my @models = ( 1328our @models = (
1202 [EV:: => AnyEvent::Impl::EV:: , 1], 1329 [EV:: => AnyEvent::Impl::EV:: , 1],
1203 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1330 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1204 # everything below here will not (normally) be autoprobed 1331 # everything below here will not (normally) be autoprobed
1205 # as the pureperl backend should work everywhere 1332 # as the pure perl backend should work everywhere
1206 # and is usually faster 1333 # and is usually faster
1207 [Event:: => AnyEvent::Impl::Event::, 1], 1334 [Event:: => AnyEvent::Impl::Event::, 1],
1208 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1335 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1209 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1336 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1210 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1337 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1211 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1338 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1212 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1339 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1213 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1340 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1214 [Wx:: => AnyEvent::Impl::POE::], 1341 [Wx:: => AnyEvent::Impl::POE::],
1215 [Prima:: => AnyEvent::Impl::POE::], 1342 [Prima:: => AnyEvent::Impl::POE::],
1216 # IO::Async is just too broken - we would need workarounds for its 1343 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1217 # byzantine signal and broken child handling, among others. 1344 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1218 # IO::Async is rather hard to detect, as it doesn't have any 1345 [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); 1346);
1225 1347
1226our %method = map +($_ => 1), 1348our @isa_hook;
1349
1350sub _isa_set {
1351 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1352
1353 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1354 for 1 .. $#pkg;
1355
1356 grep $_ && $_->[1], @isa_hook
1357 and AE::_reset ();
1358}
1359
1360# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1361sub _isa_hook($$;$) {
1362 my ($i, $pkg, $reset_ae) = @_;
1363
1364 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1365
1366 _isa_set;
1367}
1368
1369# all autoloaded methods reserve the complete glob, not just the method slot.
1370# due to bugs in perls method cache implementation.
1227 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1371our @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 1372
1245sub detect() { 1373sub detect() {
1374 return $MODEL if $MODEL; # some programs keep references to detect
1375
1376 local $!; # for good measure
1377 local $SIG{__DIE__}; # we use eval
1378
1246 # free some memory 1379 # free some memory
1247 *detect = sub () { $MODEL }; 1380 *detect = sub () { $MODEL };
1381 # undef &func doesn't correctly update the method cache. grmbl.
1382 # so we delete the whole glob. grmbl.
1383 # otoh, perl doesn't let me undef an active usb, but it lets me free
1384 # a glob with an active sub. hrm. i hope it works, but perl is
1385 # usually buggy in this department. sigh.
1386 delete @{"AnyEvent::"}{@methods};
1387 undef @methods;
1248 1388
1249 local $!; # for good measure
1250 local $SIG{__DIE__};
1251
1252 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1389 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1253 my $model = "AnyEvent::Impl::$1"; 1390 my $model = $1;
1391 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1254 if (eval "require $model") { 1392 if (eval "require $model") {
1393 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1255 $MODEL = $model; 1394 $MODEL = $model;
1256 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1257 } else { 1395 } else {
1258 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1396 AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1259 } 1397 }
1260 } 1398 }
1261 1399
1262 # check for already loaded models 1400 # check for already loaded models
1263 unless ($MODEL) { 1401 unless ($MODEL) {
1264 for (@REGISTRY, @models) { 1402 for (@REGISTRY, @models) {
1265 my ($package, $model) = @$_; 1403 my ($package, $model) = @$_;
1266 if (${"$package\::VERSION"} > 0) { 1404 if (${"$package\::VERSION"} > 0) {
1267 if (eval "require $model") { 1405 if (eval "require $model") {
1406 AnyEvent::log 7 => "autodetected model '$model', using it.";
1268 $MODEL = $model; 1407 $MODEL = $model;
1269 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1270 last; 1408 last;
1271 } 1409 }
1272 } 1410 }
1273 } 1411 }
1274 1412
1280 $autoload 1418 $autoload
1281 and eval "require $package" 1419 and eval "require $package"
1282 and ${"$package\::VERSION"} > 0 1420 and ${"$package\::VERSION"} > 0
1283 and eval "require $model" 1421 and eval "require $model"
1284 ) { 1422 ) {
1423 AnyEvent::log 7 => "autoloaded model '$model', using it.";
1285 $MODEL = $model; 1424 $MODEL = $model;
1286 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1287 last; 1425 last;
1288 } 1426 }
1289 } 1427 }
1290 1428
1291 $MODEL 1429 $MODEL
1292 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1430 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1293 } 1431 }
1294 } 1432 }
1295 1433
1296 @models = (); # free probe data 1434 # free memory only needed for probing
1435 undef @models;
1436 undef @REGISTRY;
1297 1437
1298 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1438 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1299 unshift @ISA, $MODEL;
1300 1439
1301 # now nuke some methods that are overriden by the backend. 1440 # now nuke some methods that are overridden by the backend.
1302 # SUPER is not allowed. 1441 # SUPER usage is not allowed in these.
1303 for (qw(time signal child idle)) { 1442 for (qw(time signal child idle)) {
1304 undef &{"AnyEvent::Base::$_"} 1443 undef &{"AnyEvent::Base::$_"}
1305 if defined &{"$MODEL\::$_"}; 1444 if defined &{"$MODEL\::$_"};
1306 } 1445 }
1307 1446
1308 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; 1447 _isa_set;
1448
1449 # we're officially open!
1450
1451 if ($ENV{PERL_ANYEVENT_STRICT}) {
1452 require AnyEvent::Strict;
1453 }
1454
1455 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1456 require AnyEvent::Debug;
1457 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1458 }
1459
1460 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1461 require AnyEvent::Socket;
1462 require AnyEvent::Debug;
1463
1464 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1465 $shell =~ s/\$\$/$$/g;
1466
1467 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1468 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1469 }
1470
1471 # now the anyevent environment is set up as the user told us to, so
1472 # call the actual user code - post detects
1309 1473
1310 (shift @post_detect)->() while @post_detect; 1474 (shift @post_detect)->() while @post_detect;
1475 undef @post_detect;
1311 1476
1312 *post_detect = sub(&) { 1477 *post_detect = sub(&) {
1313 shift->(); 1478 shift->();
1314 1479
1315 undef 1480 undef
1316 }; 1481 };
1317 1482
1318 $MODEL 1483 $MODEL
1319} 1484}
1320 1485
1321sub AUTOLOAD { 1486for my $name (@methods) {
1322 (my $func = $AUTOLOAD) =~ s/.*://; 1487 *$name = sub {
1323
1324 $method{$func}
1325 or Carp::croak "$func: not a valid AnyEvent class method";
1326
1327 detect; 1488 detect;
1328 1489 # we use goto because
1329 my $class = shift; 1490 # a) it makes the thunk more transparent
1330 $class->$func (@_); 1491 # b) it allows us to delete the thunk later
1492 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1493 };
1331} 1494}
1332 1495
1333# utility function to dup a filehandle. this is used by many backends 1496# utility function to dup a filehandle. this is used by many backends
1334# to support binding more than one watcher per filehandle (they usually 1497# 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). 1498# allow only one watcher per fd, so we dup it to get a different one).
1359 1522
1360package AE; 1523package AE;
1361 1524
1362our $VERSION = $AnyEvent::VERSION; 1525our $VERSION = $AnyEvent::VERSION;
1363 1526
1527sub _reset() {
1528 eval q{
1364# fall back to the main API by default - backends and AnyEvent::Base 1529 # fall back to the main API by default - backends and AnyEvent::Base
1365# implementations can overwrite these. 1530 # implementations can overwrite these.
1366 1531
1367sub io($$$) { 1532 sub io($$$) {
1368 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1533 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1369} 1534 }
1370 1535
1371sub timer($$$) { 1536 sub timer($$$) {
1372 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1537 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1373} 1538 }
1374 1539
1375sub signal($$) { 1540 sub signal($$) {
1376 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1541 AnyEvent->signal (signal => $_[0], cb => $_[1])
1377} 1542 }
1378 1543
1379sub child($$) { 1544 sub child($$) {
1380 AnyEvent->child (pid => $_[0], cb => $_[1]) 1545 AnyEvent->child (pid => $_[0], cb => $_[1])
1381} 1546 }
1382 1547
1383sub idle($) { 1548 sub idle($) {
1384 AnyEvent->idle (cb => $_[0]) 1549 AnyEvent->idle (cb => $_[0]);
1385} 1550 }
1386 1551
1387sub cv(;&) { 1552 sub cv(;&) {
1388 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1553 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1389} 1554 }
1390 1555
1391sub now() { 1556 sub now() {
1392 AnyEvent->now 1557 AnyEvent->now
1393} 1558 }
1394 1559
1395sub now_update() { 1560 sub now_update() {
1396 AnyEvent->now_update 1561 AnyEvent->now_update
1397} 1562 }
1398 1563
1399sub time() { 1564 sub time() {
1400 AnyEvent->time 1565 AnyEvent->time
1566 }
1567
1568 *postpone = \&AnyEvent::postpone;
1569 *log = \&AnyEvent::log;
1570 };
1571 die if $@;
1401} 1572}
1573
1574BEGIN { _reset }
1402 1575
1403package AnyEvent::Base; 1576package AnyEvent::Base;
1404 1577
1405# default implementations for many methods 1578# default implementations for many methods
1406 1579
1407sub time { 1580sub time {
1408 eval q{ # poor man's autoloading {} 1581 eval q{ # poor man's autoloading {}
1409 # probe for availability of Time::HiRes 1582 # probe for availability of Time::HiRes
1410 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1583 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1411 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1584 *time = sub { Time::HiRes::time () };
1412 *AE::time = \&Time::HiRes::time; 1585 *AE::time = \& Time::HiRes::time ;
1586 *now = \&time;
1587 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1413 # if (eval "use POSIX (); (POSIX::times())... 1588 # if (eval "use POSIX (); (POSIX::times())...
1414 } else { 1589 } else {
1590 *time = sub { CORE::time };
1591 *AE::time = sub (){ CORE::time };
1592 *now = \&time;
1415 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1593 AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1416 *AE::time = sub (){ time }; # epic fail
1417 } 1594 }
1418
1419 *time = sub { AE::time }; # different prototypes
1420 }; 1595 };
1421 die if $@; 1596 die if $@;
1422 1597
1423 &time 1598 &time
1424} 1599}
1425 1600
1426*now = \&time; 1601*now = \&time;
1427
1428sub now_update { } 1602sub now_update { }
1429 1603
1604sub _poll {
1605 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1606}
1607
1430# default implementation for ->condvar 1608# default implementation for ->condvar
1609# in fact, the default should not be overwritten
1431 1610
1432sub condvar { 1611sub condvar {
1433 eval q{ # poor man's autoloading {} 1612 eval q{ # poor man's autoloading {}
1434 *condvar = sub { 1613 *condvar = sub {
1435 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1614 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1513 1692
1514sub signal { 1693sub signal {
1515 eval q{ # poor man's autoloading {} 1694 eval q{ # poor man's autoloading {}
1516 # probe for availability of Async::Interrupt 1695 # probe for availability of Async::Interrupt
1517 if (_have_async_interrupt) { 1696 if (_have_async_interrupt) {
1518 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1697 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1519 1698
1520 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1699 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1521 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1700 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1522 1701
1523 } else { 1702 } else {
1524 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1703 AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1525 1704
1526 if (AnyEvent::WIN32) { 1705 if (AnyEvent::WIN32) {
1527 require AnyEvent::Util; 1706 require AnyEvent::Util;
1528 1707
1529 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1708 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1605 : sysread $SIGPIPE_R, (my $dummy), 9; 1784 : sysread $SIGPIPE_R, (my $dummy), 9;
1606 1785
1607 while (%SIG_EV) { 1786 while (%SIG_EV) {
1608 for (keys %SIG_EV) { 1787 for (keys %SIG_EV) {
1609 delete $SIG_EV{$_}; 1788 delete $SIG_EV{$_};
1610 $_->() for values %{ $SIG_CB{$_} || {} }; 1789 &$_ for values %{ $SIG_CB{$_} || {} };
1611 } 1790 }
1612 } 1791 }
1613 }; 1792 };
1614 }; 1793 };
1615 die if $@; 1794 die if $@;
1620# default implementation for ->child 1799# default implementation for ->child
1621 1800
1622our %PID_CB; 1801our %PID_CB;
1623our $CHLD_W; 1802our $CHLD_W;
1624our $CHLD_DELAY_W; 1803our $CHLD_DELAY_W;
1625our $WNOHANG;
1626 1804
1627# used by many Impl's 1805# used by many Impl's
1628sub _emit_childstatus($$) { 1806sub _emit_childstatus($$) {
1629 my (undef, $rpid, $rstatus) = @_; 1807 my (undef, $rpid, $rstatus) = @_;
1630 1808
1637 eval q{ # poor man's autoloading {} 1815 eval q{ # poor man's autoloading {}
1638 *_sigchld = sub { 1816 *_sigchld = sub {
1639 my $pid; 1817 my $pid;
1640 1818
1641 AnyEvent->_emit_childstatus ($pid, $?) 1819 AnyEvent->_emit_childstatus ($pid, $?)
1642 while ($pid = waitpid -1, $WNOHANG) > 0; 1820 while ($pid = waitpid -1, WNOHANG) > 0;
1643 }; 1821 };
1644 1822
1645 *child = sub { 1823 *child = sub {
1646 my (undef, %arg) = @_; 1824 my (undef, %arg) = @_;
1647 1825
1648 defined (my $pid = $arg{pid} + 0) 1826 my $pid = $arg{pid};
1649 or Carp::croak "required option 'pid' is missing"; 1827 my $cb = $arg{cb};
1650 1828
1651 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1829 $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 1830
1658 unless ($CHLD_W) { 1831 unless ($CHLD_W) {
1659 $CHLD_W = AE::signal CHLD => \&_sigchld; 1832 $CHLD_W = AE::signal CHLD => \&_sigchld;
1660 # child could be a zombie already, so make at least one round 1833 # child could be a zombie already, so make at least one round
1661 &_sigchld; 1834 &_sigchld;
1662 } 1835 }
1663 1836
1664 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1837 bless [$pid, $cb+0], "AnyEvent::Base::child"
1665 }; 1838 };
1666 1839
1667 *AnyEvent::Base::child::DESTROY = sub { 1840 *AnyEvent::Base::child::DESTROY = sub {
1668 my ($pid, $cb) = @{$_[0]}; 1841 my ($pid, $icb) = @{$_[0]};
1669 1842
1670 delete $PID_CB{$pid}{$cb}; 1843 delete $PID_CB{$pid}{$icb};
1671 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1844 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1672 1845
1673 undef $CHLD_W unless keys %PID_CB; 1846 undef $CHLD_W unless keys %PID_CB;
1674 }; 1847 };
1675 }; 1848 };
1688 1861
1689 my ($cb, $w, $rcb) = $arg{cb}; 1862 my ($cb, $w, $rcb) = $arg{cb};
1690 1863
1691 $rcb = sub { 1864 $rcb = sub {
1692 if ($cb) { 1865 if ($cb) {
1693 $w = _time; 1866 $w = AE::time;
1694 &$cb; 1867 &$cb;
1695 $w = _time - $w; 1868 $w = AE::time - $w;
1696 1869
1697 # never use more then 50% of the time for the idle watcher, 1870 # never use more then 50% of the time for the idle watcher,
1698 # within some limits 1871 # within some limits
1699 $w = 0.0001 if $w < 0.0001; 1872 $w = 0.0001 if $w < 0.0001;
1700 $w = 5 if $w > 5; 1873 $w = 5 if $w > 5;
1723 1896
1724package AnyEvent::CondVar; 1897package AnyEvent::CondVar;
1725 1898
1726our @ISA = AnyEvent::CondVar::Base::; 1899our @ISA = AnyEvent::CondVar::Base::;
1727 1900
1901# only to be used for subclassing
1902sub new {
1903 my $class = shift;
1904 bless AnyEvent->condvar (@_), $class
1905}
1906
1728package AnyEvent::CondVar::Base; 1907package AnyEvent::CondVar::Base;
1729 1908
1730#use overload 1909#use overload
1731# '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1910# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1732# fallback => 1; 1911# fallback => 1;
1741 1920
1742sub _send { 1921sub _send {
1743 # nop 1922 # nop
1744} 1923}
1745 1924
1925sub _wait {
1926 AnyEvent->_poll until $_[0]{_ae_sent};
1927}
1928
1746sub send { 1929sub send {
1747 my $cv = shift; 1930 my $cv = shift;
1748 $cv->{_ae_sent} = [@_]; 1931 $cv->{_ae_sent} = [@_];
1749 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1932 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1750 $cv->_send; 1933 $cv->_send;
1757 1940
1758sub ready { 1941sub ready {
1759 $_[0]{_ae_sent} 1942 $_[0]{_ae_sent}
1760} 1943}
1761 1944
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 { 1945sub recv {
1946 unless ($_[0]{_ae_sent}) {
1947 $WAITING
1948 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1949
1950 local $WAITING = 1;
1772 $_[0]->_wait; 1951 $_[0]->_wait;
1952 }
1773 1953
1774 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1954 $_[0]{_ae_croak}
1775 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1955 and Carp::croak $_[0]{_ae_croak};
1956
1957 wantarray
1958 ? @{ $_[0]{_ae_sent} }
1959 : $_[0]{_ae_sent}[0]
1776} 1960}
1777 1961
1778sub cb { 1962sub cb {
1779 my $cv = shift; 1963 my $cv = shift;
1780 1964
1796 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 1980 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1797} 1981}
1798 1982
1799# undocumented/compatibility with pre-3.4 1983# undocumented/compatibility with pre-3.4
1800*broadcast = \&send; 1984*broadcast = \&send;
1801*wait = \&_wait; 1985*wait = \&recv;
1802 1986
1803=head1 ERROR AND EXCEPTION HANDLING 1987=head1 ERROR AND EXCEPTION HANDLING
1804 1988
1805In general, AnyEvent does not do any error handling - it relies on the 1989In 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 1990caller to do that if required. The L<AnyEvent::Strict> module (see also
1818$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 2002$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1819so on. 2003so on.
1820 2004
1821=head1 ENVIRONMENT VARIABLES 2005=head1 ENVIRONMENT VARIABLES
1822 2006
1823The following environment variables are used by this module or its 2007AnyEvent supports a number of environment variables that tune the
1824submodules. 2008runtime behaviour. They are usually evaluated when AnyEvent is
2009loaded, initialised, or a submodule that uses them is loaded. Many of
2010them also cause AnyEvent to load additional modules - for example,
2011C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
2012loaded.
1825 2013
1826Note that AnyEvent will remove I<all> environment variables starting with 2014All the environment variables documented here start with
1827C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 2015C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1828enabled. 2016namespace. Other modules are encouraged (but by no means required) to use
2017C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
2018namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
2019be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
2020variables starting with C<AE_>, see below).
2021
2022All variables can also be set via the C<AE_> prefix, that is, instead
2023of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
2024case there is a clash btween anyevent and another program that uses
2025C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
2026variable to the empty string, as those variables take precedence.
2027
2028When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
2029to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
2030exists. If taint mode is on, then AnyEvent will remove I<all> environment
2031variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
2032with C<undef> or the empty string, if the corresaponding C<AE_> variable
2033is set).
2034
2035The exact algorithm is currently:
2036
2037 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
2038 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
2039 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
2040
2041This ensures that child processes will not see the C<AE_> variables.
2042
2043The following environment variables are currently known to AnyEvent:
1829 2044
1830=over 4 2045=over 4
1831 2046
1832=item C<PERL_ANYEVENT_VERBOSE> 2047=item C<PERL_ANYEVENT_VERBOSE>
1833 2048
1834By default, AnyEvent will be completely silent except in fatal 2049By default, AnyEvent will only log messages with loglevel C<3>
1835conditions. You can set this environment variable to make AnyEvent more 2050(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
2051environment variable to a numerical loglevel to make AnyEvent more (or
1836talkative. 2052less) talkative.
1837 2053
2054If you want to do more than just set the global logging level
2055you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2056complex specifications.
2057
2058When set to C<0> (C<off>), then no messages whatsoever will be logged with
2059the default logging settings.
2060
1838When set to C<1> or higher, causes AnyEvent to warn about unexpected 2061When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1839conditions, such as not being able to load the event model specified by 2062unexpected conditions, such as not being able to load the event model
1840C<PERL_ANYEVENT_MODEL>. 2063specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
2064exception - this is the minimum recommended level.
1841 2065
1842When set to C<2> or higher, cause AnyEvent to report to STDERR which event 2066When set to C<7> or higher (info), cause AnyEvent to report which event model it
1843model it chooses. 2067chooses.
1844 2068
1845When set to C<8> or higher, then AnyEvent will report extra information on 2069When set to C<8> or higher (debug), then AnyEvent will report extra information on
1846which optional modules it loads and how it implements certain features. 2070which optional modules it loads and how it implements certain features.
2071
2072=item C<PERL_ANYEVENT_LOG>
2073
2074Accepts rather complex logging specifications. For example, you could log
2075all C<debug> messages of some module to stderr, warnings and above to
2076stderr, and errors and above to syslog, with:
2077
2078 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
2079
2080For the rather extensive details, see L<AnyEvent::Log>.
2081
2082This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2083so will take effect even before AnyEvent has initialised itself.
2084
2085Note that specifying this environment variable causes the L<AnyEvent::Log>
2086module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2087using the latter saves a few hundred kB of memory until the first message
2088is being logged.
1847 2089
1848=item C<PERL_ANYEVENT_STRICT> 2090=item C<PERL_ANYEVENT_STRICT>
1849 2091
1850AnyEvent does not do much argument checking by default, as thorough 2092AnyEvent does not do much argument checking by default, as thorough
1851argument checking is very costly. Setting this variable to a true value 2093argument checking is very costly. Setting this variable to a true value
1853check the arguments passed to most method calls. If it finds any problems, 2095check the arguments passed to most method calls. If it finds any problems,
1854it will croak. 2096it will croak.
1855 2097
1856In other words, enables "strict" mode. 2098In other words, enables "strict" mode.
1857 2099
1858Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense> 2100Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1859>>, it is definitely recommended to keep it off in production. Keeping 2101>>, it is definitely recommended to keep it off in production. Keeping
1860C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2102C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1861can be very useful, however. 2103can be very useful, however.
1862 2104
2105=item C<PERL_ANYEVENT_DEBUG_SHELL>
2106
2107If this env variable is set, then its contents will be interpreted by
2108C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
2109C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
2110that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
2111
2112This happens when the first watcher is created.
2113
2114For example, to bind a debug shell on a unix domain socket in
2115F<< /tmp/debug<pid>.sock >>, you could use this:
2116
2117 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2118
2119Note that creating sockets in F</tmp> is very unsafe on multiuser
2120systems.
2121
2122=item C<PERL_ANYEVENT_DEBUG_WRAP>
2123
2124Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2125debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2126
1863=item C<PERL_ANYEVENT_MODEL> 2127=item C<PERL_ANYEVENT_MODEL>
1864 2128
1865This can be used to specify the event model to be used by AnyEvent, before 2129This 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 2130auto detection and -probing kicks in.
1867entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2131
2132It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2133or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1868and the resulting module name is loaded and if the load was successful, 2134resulting 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 2135event model backend. If it fails to load then AnyEvent will proceed with
1870auto detection and -probing. 2136auto detection and -probing.
1871 2137
1872This functionality might change in future versions. 2138If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2139nothing gets prepended and the module name is used as-is (hint: C<::> at
2140the end of a string designates a module name and quotes it appropriately).
1873 2141
1874For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 2142For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1875could start your program like this: 2143could start your program like this:
1876 2144
1877 PERL_ANYEVENT_MODEL=Perl perl ... 2145 PERL_ANYEVENT_MODEL=Perl perl ...
1878 2146
1879=item C<PERL_ANYEVENT_PROTOCOLS> 2147=item C<PERL_ANYEVENT_PROTOCOLS>
1895but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 2163but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1896- only support IPv4, never try to resolve or contact IPv6 2164- only support IPv4, never try to resolve or contact IPv6
1897addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2165addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1898IPv6, but prefer IPv6 over IPv4. 2166IPv6, but prefer IPv6 over IPv4.
1899 2167
2168=item C<PERL_ANYEVENT_HOSTS>
2169
2170This variable, if specified, overrides the F</etc/hosts> file used by
2171L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2172from that file instead.
2173
1900=item C<PERL_ANYEVENT_EDNS0> 2174=item C<PERL_ANYEVENT_EDNS0>
1901 2175
1902Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension 2176Used 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 2177DNS. This extension is generally useful to reduce DNS traffic, especially
1904some (broken) firewalls drop such DNS packets, which is why it is off by 2178when DNSSEC is involved, but some (broken) firewalls drop such DNS
1905default. 2179packets, which is why it is off by default.
1906 2180
1907Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce 2181Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1908EDNS0 in its DNS requests. 2182EDNS0 in its DNS requests.
1909 2183
1910=item C<PERL_ANYEVENT_MAX_FORKS> 2184=item C<PERL_ANYEVENT_MAX_FORKS>
1918resolver - this is the maximum number of parallel DNS requests that are 2192resolver - this is the maximum number of parallel DNS requests that are
1919sent to the DNS server. 2193sent to the DNS server.
1920 2194
1921=item C<PERL_ANYEVENT_RESOLV_CONF> 2195=item C<PERL_ANYEVENT_RESOLV_CONF>
1922 2196
1923The file to use instead of F</etc/resolv.conf> (or OS-specific 2197The 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 2198F</etc/resolv.conf> (or the OS-specific configuration) in the default
1925default config will be used. 2199resolver, or the empty string to select the default configuration.
1926 2200
1927=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. 2201=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1928 2202
1929When neither C<ca_file> nor C<ca_path> was specified during 2203When neither C<ca_file> nor C<ca_path> was specified during
1930L<AnyEvent::TLS> context creation, and either of these environment 2204L<AnyEvent::TLS> context creation, and either of these environment
1931variables exist, they will be used to specify CA certificate locations 2205variables are nonempty, they will be used to specify CA certificate
1932instead of a system-dependent default. 2206locations instead of a system-dependent default.
1933 2207
1934=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> 2208=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1935 2209
1936When these are set to C<1>, then the respective modules are not 2210When these are set to C<1>, then the respective modules are not
1937loaded. Mostly good for testing AnyEvent itself. 2211loaded. Mostly good for testing AnyEvent itself.
2269(even when used without AnyEvent), but most event loops have acceptable 2543(even when used without AnyEvent), but most event loops have acceptable
2270performance with or without AnyEvent. 2544performance with or without AnyEvent.
2271 2545
2272=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2546=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 2547the actual event loop, only with extremely fast event loops such as EV
2274adds AnyEvent significant overhead. 2548does AnyEvent add significant overhead.
2275 2549
2276=item * You should avoid POE like the plague if you want performance or 2550=item * You should avoid POE like the plague if you want performance or
2277reasonable memory usage. 2551reasonable memory usage.
2278 2552
2279=back 2553=back
2509 unless defined $SIG{PIPE}; 2783 unless defined $SIG{PIPE};
2510 2784
2511=head1 RECOMMENDED/OPTIONAL MODULES 2785=head1 RECOMMENDED/OPTIONAL MODULES
2512 2786
2513One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and 2787One 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. 2788its built-in modules) are required to use it.
2515 2789
2516That does not mean that AnyEvent won't take advantage of some additional 2790That does not mean that AnyEvent won't take advantage of some additional
2517modules if they are installed. 2791modules if they are installed.
2518 2792
2519This section explains which additional modules will be used, and how they 2793This section explains which additional modules will be used, and how they
2577the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. 2851the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2578 2852
2579=item L<Time::HiRes> 2853=item L<Time::HiRes>
2580 2854
2581This module is part of perl since release 5.008. It will be used when the 2855This 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 2856chosen 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 2857pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2584try to use a monotonic clock for timing stability. 2858try to use a monotonic clock for timing stability.
2585 2859
2586=back 2860=back
2587 2861
2588 2862
2650pronounced). 2924pronounced).
2651 2925
2652 2926
2653=head1 SEE ALSO 2927=head1 SEE ALSO
2654 2928
2655Utility functions: L<AnyEvent::Util>. 2929Tutorial/Introduction: L<AnyEvent::Intro>.
2656 2930
2657Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2931FAQ: L<AnyEvent::FAQ>.
2658L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2932
2933Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2934(simply logging).
2935
2936Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2937L<AnyEvent::Debug> (interactive shell, watcher tracing).
2938
2939Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2940L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
2941L<Qt>, L<POE>, L<FLTK>.
2659 2942
2660Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2943Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2661L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2944L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2662L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2945L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2663L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2946L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
2947L<AnyEvent::Impl::FLTK>.
2664 2948
2665Non-blocking file handles, sockets, TCP clients and 2949Non-blocking handles, pipes, stream sockets, TCP clients and
2666servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2950servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2667 2951
2668Asynchronous DNS: L<AnyEvent::DNS>. 2952Asynchronous DNS: L<AnyEvent::DNS>.
2669 2953
2670Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, 2954Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2671L<Coro::Event>,
2672 2955
2673Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, 2956Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2674L<AnyEvent::HTTP>. 2957L<AnyEvent::HTTP>.
2675 2958
2676 2959
2677=head1 AUTHOR 2960=head1 AUTHOR
2678 2961

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines