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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines