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.296 by root, Tue Nov 17 01:19:49 2009 UTC vs.
Revision 1.350 by root, Tue Aug 2 20:02:44 2011 UTC

7 7
8=head1 SYNOPSIS 8=head1 SYNOPSIS
9 9
10 use AnyEvent; 10 use AnyEvent;
11 11
12 # if you prefer function calls, look at the AE manpage for
13 # an alternative API.
14
12 # file descriptor readable 15 # file handle or descriptor readable
13 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); 16 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14 17
15 # one-shot or repeating timers 18 # one-shot or repeating timers
16 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); 19 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... 20 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
18 21
19 print AnyEvent->now; # prints current event loop time 22 print AnyEvent->now; # prints current event loop time
20 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. 23 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
21 24
22 # POSIX signal 25 # POSIX signal
43in a tutorial or some gentle introduction, have a look at the 46in a tutorial or some gentle introduction, have a look at the
44L<AnyEvent::Intro> manpage. 47L<AnyEvent::Intro> manpage.
45 48
46=head1 SUPPORT 49=head1 SUPPORT
47 50
51An FAQ document is available as L<AnyEvent::FAQ>.
52
48There is a mailinglist for discussing all things AnyEvent, and an IRC 53There also is a mailinglist for discussing all things AnyEvent, and an IRC
49channel, too. 54channel, too.
50 55
51See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software 56See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52Repository>, at L<http://anyevent.schmorp.de>, for more info. 57Repository>, at L<http://anyevent.schmorp.de>, for more info.
53 58
73module 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
74model you use. 79model you use.
75 80
76For 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
77actually 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
78like 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
79cannot use anything else, as they are simply incompatible to everything 84cannot use anything else, as they are simply incompatible to everything
80that 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
81module 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.
82 87
83AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 88AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
84fine. 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
85with 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
86your 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
87too. But if your module uses AnyEvent, it works transparently with all 92your module uses AnyEvent, it works transparently with all event models it
88event 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
89use 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,
90to AnyEvent, too, so it is future-proof). 95so it is future-proof).
91 96
92In 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
93model>, 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
94modules, 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
95follow. 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
96offering 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
97technically possible. 102technically possible.
98 103
99Of course, AnyEvent comes with a big (and fully optional!) toolbox 104Of course, AnyEvent comes with a big (and fully optional!) toolbox
100of useful functionality, such as an asynchronous DNS resolver, 100% 105of useful functionality, such as an asynchronous DNS resolver, 100%
106useful) 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
107model, you should I<not> use this module. 112model, you should I<not> use this module.
108 113
109=head1 DESCRIPTION 114=head1 DESCRIPTION
110 115
111L<AnyEvent> provides an identical interface to multiple event loops. This 116L<AnyEvent> provides a uniform interface to various event loops. This
112allows module authors to utilise an event loop without forcing module 117allows module authors to use event loop functionality without forcing
113users 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
114peacefully at any one time). 119than one event loop cannot coexist peacefully).
115 120
116The 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>
117module. 122module.
118 123
119During the first call of any watcher-creation method, the module tries 124During the first call of any watcher-creation method, the module tries
120to 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
121following modules is already loaded: L<EV>, 126following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>,
122L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, 127L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
123L<POE>. The first one found is used. If none are found, the module tries 128found is used. If none are detected, the module tries to load the first
124to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl 129four modules in the order given; but note that if L<EV> is not
125adaptor should always succeed) in the order given. The first one that can 130available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so
126be successfully loaded will be used. If, after this, still none could be 131the other two are not normally tried.
127found, AnyEvent will fall back to a pure-perl event loop, which is not
128very efficient, but should work everywhere.
129 132
130Because AnyEvent first checks for modules that are already loaded, loading 133Because AnyEvent first checks for modules that are already loaded, loading
131an event model explicitly before first using AnyEvent will likely make 134an event model explicitly before first using AnyEvent will likely make
132that model the default. For example: 135that model the default. For example:
133 136
135 use AnyEvent; 138 use AnyEvent;
136 139
137 # .. AnyEvent will likely default to Tk 140 # .. AnyEvent will likely default to Tk
138 141
139The 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
140starts using it, all bets are off. Maybe you should tell their authors to 143starts using it, all bets are off - this case should be very rare though,
141use AnyEvent so their modules work together with others seamlessly... 144as very few modules hardcode event loops without announcing this very
145loudly.
142 146
143The pure-perl implementation of AnyEvent is called 147The pure-perl implementation of AnyEvent is called
144C<AnyEvent::Impl::Perl>. Like other event modules you can load it 148C<AnyEvent::Impl::Perl>. Like other event modules you can load it
145explicitly and enjoy the high availability of that event loop :) 149explicitly and enjoy the high availability of that event loop :)
146 150
155callback when the event occurs (of course, only when the event model 159callback when the event occurs (of course, only when the event model
156is in control). 160is in control).
157 161
158Note that B<callbacks must not permanently change global variables> 162Note that B<callbacks must not permanently change global variables>
159potentially 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<<
160callbacks must not C<die> >>. The former is good programming practise in 164callbacks must not C<die> >>. The former is good programming practice in
161Perl and the latter stems from the fact that exception handling differs 165Perl and the latter stems from the fact that exception handling differs
162widely between event loops. 166widely between event loops.
163 167
164To 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
165variable 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
166to it). 170to it).
167 171
168All 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.
169 173
170Many watchers either are used with "recursion" (repeating timers for 174Many watchers either are used with "recursion" (repeating timers for
171example), or need to refer to their watcher object in other ways. 175example), or need to refer to their watcher object in other ways.
172 176
173An any way to achieve that is this pattern: 177One way to achieve that is this pattern:
174 178
175 my $w; $w = AnyEvent->type (arg => value ..., cb => sub { 179 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
176 # you can use $w here, for example to undef it 180 # you can use $w here, for example to undef it
177 undef $w; 181 undef $w;
178 }); 182 });
210 214
211The 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.
212You 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
213underlying file descriptor. 217underlying file descriptor.
214 218
215Some event loops issue spurious readyness notifications, so you should 219Some event loops issue spurious readiness notifications, so you should
216always use non-blocking calls when reading/writing from/to your file 220always use non-blocking calls when reading/writing from/to your file
217handles. 221handles.
218 222
219Example: 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
220watcher. 224watcher.
244 248
245Although the callback might get passed parameters, their value and 249Although the callback might get passed parameters, their value and
246presence is undefined and you cannot rely on them. Portable AnyEvent 250presence is undefined and you cannot rely on them. Portable AnyEvent
247callbacks cannot use arguments passed to time watcher callbacks. 251callbacks cannot use arguments passed to time watcher callbacks.
248 252
249The callback will normally be invoked once only. If you specify another 253The callback will normally be invoked only once. If you specify another
250parameter, C<interval>, as a strictly positive number (> 0), then the 254parameter, C<interval>, as a strictly positive number (> 0), then the
251callback will be invoked regularly at that interval (in fractional 255callback will be invoked regularly at that interval (in fractional
252seconds) after the first invocation. If C<interval> is specified with a 256seconds) after the first invocation. If C<interval> is specified with a
253false value, then it is treated as if it were missing. 257false value, then it is treated as if it were not specified at all.
254 258
255The callback will be rescheduled before invoking the callback, but no 259The callback will be rescheduled before invoking the callback, but no
256attempt 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
257only approximate. 261only approximate.
258 262
259Example: fire an event after 7.7 seconds. 263Example: fire an event after 7.7 seconds.
260 264
261 my $w = AnyEvent->timer (after => 7.7, cb => sub { 265 my $w = AnyEvent->timer (after => 7.7, cb => sub {
279 283
280While 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
281use absolute time internally. This makes a difference when your clock 285use absolute time internally. This makes a difference when your clock
282"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
283the 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
284fire "after" a second might actually take six years to finally fire. 288fire "after a second" might actually take six years to finally fire.
285 289
286AnyEvent cannot compensate for this. The only event loop that is conscious 290AnyEvent cannot compensate for this. The only event loop that is conscious
287about 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
288on true relative time) and absolute (ev_periodic, based on wallclock time) 292on true relative time) and absolute (ev_periodic, based on wallclock time)
289timers. 293timers.
290 294
291AnyEvent always prefers relative timers, if available, matching the 295AnyEvent always prefers relative timers, if available, matching the
292AnyEvent API. 296AnyEvent API.
314I<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
315function to call when you want to know the current time.> 319function to call when you want to know the current time.>
316 320
317This function is also often faster then C<< AnyEvent->time >>, and 321This function is also often faster then C<< AnyEvent->time >>, and
318thus the preferred method if you want some timestamp (for example, 322thus the preferred method if you want some timestamp (for example,
319L<AnyEvent::Handle> uses this to update it's activity timeouts). 323L<AnyEvent::Handle> uses this to update its activity timeouts).
320 324
321The 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
322with your timing, you can skip it without bad conscience. 326with your timing; you can skip it without a bad conscience.
323 327
324For 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>
325and L<EV> and the following set-up: 329and L<EV> and the following set-up:
326 330
327The 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
328time=500 (assume no other callbacks delay processing). In your callback, 332time=500 (assume no other callbacks delay processing). In your callback,
329you 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
330second) 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
331after three seconds. 335after three seconds.
332 336
403 407
404Example: exit on SIGINT 408Example: exit on SIGINT
405 409
406 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 410 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
407 411
412=head3 Restart Behaviour
413
414While restart behaviour is up to the event loop implementation, most will
415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
416pure perl implementation).
417
418=head3 Safe/Unsafe Signals
419
420Perl signals can be either "safe" (synchronous to opcode handling) or
421"unsafe" (asynchronous) - the former might get delayed indefinitely, the
422latter might corrupt your memory.
423
424AnyEvent signal handlers are, in addition, synchronous to the event loop,
425i.e. they will not interrupt your running perl program but will only be
426called as part of the normal event handling (just like timer, I/O etc.
427callbacks, too).
428
408=head3 Signal Races, Delays and Workarounds 429=head3 Signal Races, Delays and Workarounds
409 430
410Many 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
411callbacks 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
412do race-free signal handling in perl, requiring C libraries for 433do race-free signal handling in perl, requiring C libraries for
413this. 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,
414signals 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
415specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This 436specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
416variable can be changed only before the first signal watcher is created, 437variable can be changed only before the first signal watcher is created,
417and should be left alone otherwise. This variable determines how often 438and should be left alone otherwise. This variable determines how often
418AnyEvent 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
420saving. 441saving.
421 442
422All these problems can be avoided by installing the optional 443All these problems can be avoided by installing the optional
423L<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
424work 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>
425(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
426one-second latency). For those, you just have to suffer the delays. 447one-second latency). For those, you just have to suffer the delays.
427 448
428=head2 CHILD PROCESS WATCHERS 449=head2 CHILD PROCESS WATCHERS
429 450
430 $w = AnyEvent->child (pid => <process id>, cb => <callback>); 451 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
431 452
432You 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.
433 454
434The 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,
435using 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
436croak). The watcher will be triggered only when the child process has 457croak). The watcher will be triggered only when the child process has
437finished and an exit status is available, not on any trace events 458finished and an exit status is available, not on any trace events
438(stopped/continued). 459(stopped/continued).
439 460
486 507
487=head2 IDLE WATCHERS 508=head2 IDLE WATCHERS
488 509
489 $w = AnyEvent->idle (cb => <callback>); 510 $w = AnyEvent->idle (cb => <callback>);
490 511
491Sometimes there is a need to do something, but it is not so important 512This will repeatedly invoke the callback after the process becomes idle,
492to do it instantly, but only when there is nothing better to do. This 513until either the watcher is destroyed or new events have been detected.
493"nothing better to do" is usually defined to be "no other events need
494attention by the event loop".
495 514
496Idle watchers ideally get invoked when the event loop has nothing 515Idle watchers are useful when there is a need to do something, but it
497better to do, just before it would block the process to wait for new 516is not so important (or wise) to do it instantly. The callback will be
498events. Instead of blocking, the idle watcher is invoked. 517invoked only when there is "nothing better to do", which is usually
518defined as "all outstanding events have been handled and no new events
519have been detected". That means that idle watchers ideally get invoked
520when the event loop has just polled for new events but none have been
521detected. Instead of blocking to wait for more events, the idle watchers
522will be invoked.
499 523
500Most event loops unfortunately do not really support idle watchers (only 524Unfortunately, most event loops do not really support idle watchers (only
501EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent 525EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
502will simply call the callback "from time to time". 526will simply call the callback "from time to time".
503 527
504Example: read lines from STDIN, but only process them when the 528Example: read lines from STDIN, but only process them when the
505program is otherwise idle: 529program is otherwise idle:
533will actively watch for new events and call your callbacks. 557will actively watch for new events and call your callbacks.
534 558
535AnyEvent is slightly different: it expects somebody else to run the event 559AnyEvent is slightly different: it expects somebody else to run the event
536loop and will only block when necessary (usually when told by the user). 560loop and will only block when necessary (usually when told by the user).
537 561
538The instrument to do that is called a "condition variable", so called 562The tool to do that is called a "condition variable", so called because
539because they represent a condition that must become true. 563they represent a condition that must become true.
540 564
541Now is probably a good time to look at the examples further below. 565Now is probably a good time to look at the examples further below.
542 566
543Condition variables can be created by calling the C<< AnyEvent->condvar 567Condition variables can be created by calling the C<< AnyEvent->condvar
544>> method, usually without arguments. The only argument pair allowed is 568>> method, usually without arguments. The only argument pair allowed is
549After creation, the condition variable is "false" until it becomes "true" 573After creation, the condition variable is "false" until it becomes "true"
550by calling the C<send> method (or calling the condition variable as if it 574by calling the C<send> method (or calling the condition variable as if it
551were a callback, read about the caveats in the description for the C<< 575were a callback, read about the caveats in the description for the C<<
552->send >> method). 576->send >> method).
553 577
554Condition variables are similar to callbacks, except that you can 578Since condition variables are the most complex part of the AnyEvent API, here are
555optionally wait for them. They can also be called merge points - points 579some different mental models of what they are - pick the ones you can connect to:
556in time where multiple outstanding events have been processed. And yet 580
557another way to call them is transactions - each condition variable can be 581=over 4
558used to represent a transaction, which finishes at some point and delivers 582
559a result. And yet some people know them as "futures" - a promise to 583=item * Condition variables are like callbacks - you can call them (and pass them instead
560compute/deliver something that you can wait for. 584of callbacks). Unlike callbacks however, you can also wait for them to be called.
585
586=item * Condition variables are signals - one side can emit or send them,
587the other side can wait for them, or install a handler that is called when
588the signal fires.
589
590=item * Condition variables are like "Merge Points" - points in your program
591where you merge multiple independent results/control flows into one.
592
593=item * Condition variables represent a transaction - functions that start
594some kind of transaction can return them, leaving the caller the choice
595between waiting in a blocking fashion, or setting a callback.
596
597=item * Condition variables represent future values, or promises to deliver
598some result, long before the result is available.
599
600=back
561 601
562Condition variables are very useful to signal that something has finished, 602Condition variables are very useful to signal that something has finished,
563for example, if you write a module that does asynchronous http requests, 603for example, if you write a module that does asynchronous http requests,
564then a condition variable would be the ideal candidate to signal the 604then a condition variable would be the ideal candidate to signal the
565availability of results. The user can either act when the callback is 605availability of results. The user can either act when the callback is
578 618
579Condition variables are represented by hash refs in perl, and the keys 619Condition variables are represented by hash refs in perl, and the keys
580used 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
581easy (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
582AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call 622AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
583it's C<new> method in your own C<new> method. 623its C<new> method in your own C<new> method.
584 624
585There are two "sides" to a condition variable - the "producer side" which 625There are two "sides" to a condition variable - the "producer side" which
586eventually calls C<< -> send >>, and the "consumer side", which waits 626eventually calls C<< -> send >>, and the "consumer side", which waits
587for the send to occur. 627for the send to occur.
588 628
589Example: wait for a timer. 629Example: wait for a timer.
590 630
591 # wait till the result is ready 631 # condition: "wait till the timer is fired"
592 my $result_ready = AnyEvent->condvar; 632 my $timer_fired = AnyEvent->condvar;
593 633
594 # do something such as adding a timer 634 # create the timer - we could wait for, say
595 # or socket watcher the calls $result_ready->send 635 # a handle becomign ready, or even an
596 # when the "result" is ready. 636 # AnyEvent::HTTP request to finish, but
597 # in this case, we simply use a timer: 637 # in this case, we simply use a timer:
598 my $w = AnyEvent->timer ( 638 my $w = AnyEvent->timer (
599 after => 1, 639 after => 1,
600 cb => sub { $result_ready->send }, 640 cb => sub { $timer_fired->send },
601 ); 641 );
602 642
603 # this "blocks" (while handling events) till the callback 643 # this "blocks" (while handling events) till the callback
604 # calls ->send 644 # calls ->send
605 $result_ready->recv; 645 $timer_fired->recv;
606 646
607Example: wait for a timer, but take advantage of the fact that condition 647Example: wait for a timer, but take advantage of the fact that condition
608variables are also callable directly. 648variables are also callable directly.
609 649
610 my $done = AnyEvent->condvar; 650 my $done = AnyEvent->condvar;
653they 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
654C<send>. 694C<send>.
655 695
656=item $cv->croak ($error) 696=item $cv->croak ($error)
657 697
658Similar to send, but causes all call's to C<< ->recv >> to invoke 698Similar to send, but causes all calls to C<< ->recv >> to invoke
659C<Carp::croak> with the given error message/object/scalar. 699C<Carp::croak> with the given error message/object/scalar.
660 700
661This can be used to signal any errors to the condition variable 701This can be used to signal any errors to the condition variable
662user/consumer. Doing it this way instead of calling C<croak> directly 702user/consumer. Doing it this way instead of calling C<croak> directly
663delays the error detetcion, but has the overwhelmign advantage that it 703delays the error detection, but has the overwhelming advantage that it
664diagnoses 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
665deep in some event clalback without connection to the actual code causing 705deep in some event callback with no connection to the actual code causing
666the problem. 706the problem.
667 707
668=item $cv->begin ([group callback]) 708=item $cv->begin ([group callback])
669 709
670=item $cv->end 710=item $cv->end
708one 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
709sending. 749sending.
710 750
711The ping example mentioned above is slightly more complicated, as the 751The ping example mentioned above is slightly more complicated, as the
712there 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
713begung can potentially be zero: 753begun can potentially be zero:
714 754
715 my $cv = AnyEvent->condvar; 755 my $cv = AnyEvent->condvar;
716 756
717 my %result; 757 my %result;
718 $cv->begin (sub { shift->send (\%result) }); 758 $cv->begin (sub { shift->send (\%result) });
739to 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
740C<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
741doesn't execute once). 781doesn't execute once).
742 782
743This is the general pattern when you "fan out" into multiple (but 783This is the general pattern when you "fan out" into multiple (but
744potentially 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
745the 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
746subrequest you start, call C<begin> and for each subrequest you finish, 786subrequest you start, call C<begin> and for each subrequest you finish,
747call C<end>. 787call C<end>.
748 788
749=back 789=back
756=over 4 796=over 4
757 797
758=item $cv->recv 798=item $cv->recv
759 799
760Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak 800Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
761>> methods have been called on c<$cv>, while servicing other watchers 801>> methods have been called on C<$cv>, while servicing other watchers
762normally. 802normally.
763 803
764You 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
765will return immediately. 805will return immediately.
766 806
783caller 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
784condition variables with some kind of request results and supporting 824condition variables with some kind of request results and supporting
785callbacks so the caller knows that getting the result will not block, 825callbacks so the caller knows that getting the result will not block,
786while still supporting blocking waits if the caller so desires). 826while still supporting blocking waits if the caller so desires).
787 827
788You 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
789only calling C<< ->recv >> from within that callback (or at a later 829only calling C<< ->recv >> from within that callback (or at a later
790time). 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
791waits otherwise. 831waits otherwise.
792 832
793=item $bool = $cv->ready 833=item $bool = $cv->ready
798=item $cb = $cv->cb ($cb->($cv)) 838=item $cb = $cv->cb ($cb->($cv))
799 839
800This is a mutator function that returns the callback set and optionally 840This is a mutator function that returns the callback set and optionally
801replaces it before doing so. 841replaces it before doing so.
802 842
803The callback will be called when the condition becomes (or already was) 843The callback will be called when the condition becomes "true", i.e. when
804"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
805the 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
806inside the callback or at any later time is guaranteed not to block. 847the callback or at any later time is guaranteed not to block.
807 848
808=back 849=back
809 850
810=head1 SUPPORTED EVENT LOOPS/BACKENDS 851=head1 SUPPORTED EVENT LOOPS/BACKENDS
811 852
823 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 864 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
824 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 865 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
825 866
826=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.
827 868
828These 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
829is 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
830them. This means that AnyEvent will automatically pick the right backend 871them. This means that AnyEvent will automatically pick the right backend
831when the main program loads an event module before anything starts to 872when the main program loads an event module before anything starts to
832create watchers. Nothing special needs to be done by the main program. 873create watchers. Nothing special needs to be done by the main program.
833 874
835 AnyEvent::Impl::Glib based on Glib, slow but very stable. 876 AnyEvent::Impl::Glib based on Glib, slow but very stable.
836 AnyEvent::Impl::Tk based on Tk, very broken. 877 AnyEvent::Impl::Tk based on Tk, very broken.
837 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
838 AnyEvent::Impl::POE based on POE, very slow, some limitations. 879 AnyEvent::Impl::POE based on POE, very slow, some limitations.
839 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.
840 884
841=item Backends with special needs. 885=item Backends with special needs.
842 886
843Qt requires the Qt::Application to be instantiated first, but will 887Qt requires the Qt::Application to be instantiated first, but will
844otherwise be picked up automatically. As long as the main program 888otherwise be picked up automatically. As long as the main program
845instantiates the application before any AnyEvent watchers are created, 889instantiates the application before any AnyEvent watchers are created,
846everything should just work. 890everything should just work.
847 891
848 AnyEvent::Impl::Qt based on Qt. 892 AnyEvent::Impl::Qt based on Qt.
849 893
850Support for IO::Async can only be partial, as it is too broken and
851architecturally limited to even support the AnyEvent API. It also
852is the only event loop that needs the loop to be set explicitly, so
853it can only be used by a main program knowing about AnyEvent. See
854L<AnyEvent::Impl::Async> for the gory details.
855
856 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
857
858=item Event loops that are indirectly supported via other backends. 894=item Event loops that are indirectly supported via other backends.
859 895
860Some event loops can be supported via other modules: 896Some event loops can be supported via other modules:
861 897
862There is no direct support for WxWidgets (L<Wx>) or L<Prima>. 898There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
887Contains C<undef> until the first watcher is being created, before the 923Contains C<undef> until the first watcher is being created, before the
888backend has been autodetected. 924backend has been autodetected.
889 925
890Afterwards 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
891name 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
892of 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
893case 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
894will be C<urxvt::anyevent>). 930will be C<urxvt::anyevent>).
895 931
896=item AnyEvent::detect 932=item AnyEvent::detect
897 933
898Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
899if necessary. You should only call this function right before you would 935if necessary. You should only call this function right before you would
900have 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
901runtime, and not e.g. while initialising of your module. 937runtime, and not e.g. during initialisation of your module.
902 938
903If you need to do some initialisation before AnyEvent watchers are 939If you need to do some initialisation before AnyEvent watchers are
904created, use C<post_detect>. 940created, use C<post_detect>.
905 941
906=item $guard = AnyEvent::post_detect { BLOCK } 942=item $guard = AnyEvent::post_detect { BLOCK }
907 943
908Arranges for the code block to be executed as soon as the event model is 944Arranges for the code block to be executed as soon as the event model is
909autodetected (or immediately if this has already happened). 945autodetected (or immediately if that has already happened).
910 946
911The block will be executed I<after> the actual backend has been detected 947The block will be executed I<after> the actual backend has been detected
912(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been 948(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
913created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do 949created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
914other initialisations - see the sources of L<AnyEvent::Strict> or 950other initialisations - see the sources of L<AnyEvent::Strict> or
923that automatically removes the callback again when it is destroyed (or 959that automatically removes the callback again when it is destroyed (or
924C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for 960C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
925a case where this is useful. 961a case where this is useful.
926 962
927Example: Create a watcher for the IO::AIO module and store it in 963Example: Create a watcher for the IO::AIO module and store it in
928C<$WATCHER>. Only do so after the event loop is initialised, though. 964C<$WATCHER>, but do so only do so after the event loop is initialised.
929 965
930 our WATCHER; 966 our WATCHER;
931 967
932 my $guard = AnyEvent::post_detect { 968 my $guard = AnyEvent::post_detect {
933 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb); 969 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
941 $WATCHER ||= $guard; 977 $WATCHER ||= $guard;
942 978
943=item @AnyEvent::post_detect 979=item @AnyEvent::post_detect
944 980
945If there are any code references in this array (you can C<push> to it 981If there are any code references in this array (you can C<push> to it
946before or after loading AnyEvent), then they will called directly after 982before or after loading AnyEvent), then they will be called directly
947the event loop has been chosen. 983after the event loop has been chosen.
948 984
949You should check C<$AnyEvent::MODEL> before adding to this array, though: 985You should check C<$AnyEvent::MODEL> before adding to this array, though:
950if it is defined then the event loop has already been detected, and the 986if it is defined then the event loop has already been detected, and the
951array will be ignored. 987array will be ignored.
952 988
953Best use C<AnyEvent::post_detect { BLOCK }> when your application allows 989Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
954it,as it takes care of these details. 990it, as it takes care of these details.
955 991
956This variable is mainly useful for modules that can do something useful 992This variable is mainly useful for modules that can do something useful
957when AnyEvent is used and thus want to know when it is initialised, but do 993when AnyEvent is used and thus want to know when it is initialised, but do
958not need to even load it by default. This array provides the means to hook 994not need to even load it by default. This array provides the means to hook
959into AnyEvent passively, without loading it. 995into AnyEvent passively, without loading it.
960 996
997Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
998together, you could put this into Coro (this is the actual code used by
999Coro to accomplish this):
1000
1001 if (defined $AnyEvent::MODEL) {
1002 # AnyEvent already initialised, so load Coro::AnyEvent
1003 require Coro::AnyEvent;
1004 } else {
1005 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1006 # as soon as it is
1007 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1008 }
1009
961=back 1010=back
962 1011
963=head1 WHAT TO DO IN A MODULE 1012=head1 WHAT TO DO IN A MODULE
964 1013
965As a module author, you should C<use AnyEvent> and call AnyEvent methods 1014As a module author, you should C<use AnyEvent> and call AnyEvent methods
975because it will stall the whole program, and the whole point of using 1024because it will stall the whole program, and the whole point of using
976events is to stay interactive. 1025events is to stay interactive.
977 1026
978It is fine, however, to call C<< ->recv >> when the user of your module 1027It is fine, however, to call C<< ->recv >> when the user of your module
979requests it (i.e. if you create a http request object ad have a method 1028requests it (i.e. if you create a http request object ad have a method
980called C<results> that returns the results, it should call C<< ->recv >> 1029called C<results> that returns the results, it may call C<< ->recv >>
981freely, as the user of your module knows what she is doing. always). 1030freely, as the user of your module knows what she is doing. Always).
982 1031
983=head1 WHAT TO DO IN THE MAIN PROGRAM 1032=head1 WHAT TO DO IN THE MAIN PROGRAM
984 1033
985There will always be a single main program - the only place that should 1034There will always be a single main program - the only place that should
986dictate which event model to use. 1035dictate which event model to use.
987 1036
988If it doesn't care, it can just "use AnyEvent" and use it itself, or not 1037If the program is not event-based, it need not do anything special, even
989do anything special (it does not need to be event-based) and let AnyEvent 1038when it depends on a module that uses an AnyEvent. If the program itself
990decide which implementation to chose if some module relies on it. 1039uses AnyEvent, but does not care which event loop is used, all it needs
1040to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
1041available loop implementation.
991 1042
992If the main program relies on a specific event model - for example, in 1043If the main program relies on a specific event model - for example, in
993Gtk2 programs you have to rely on the Glib module - you should load the 1044Gtk2 programs you have to rely on the Glib module - you should load the
994event module before loading AnyEvent or any module that uses it: generally 1045event module before loading AnyEvent or any module that uses it: generally
995speaking, you should load it as early as possible. The reason is that 1046speaking, you should load it as early as possible. The reason is that
996modules might create watchers when they are loaded, and AnyEvent will 1047modules might create watchers when they are loaded, and AnyEvent will
997decide on the event model to use as soon as it creates watchers, and it 1048decide on the event model to use as soon as it creates watchers, and it
998might chose the wrong one unless you load the correct one yourself. 1049might choose the wrong one unless you load the correct one yourself.
999 1050
1000You can chose to use a pure-perl implementation by loading the 1051You can chose to use a pure-perl implementation by loading the
1001C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1052C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
1002everywhere, but letting AnyEvent chose the model is generally better. 1053everywhere, but letting AnyEvent chose the model is generally better.
1003 1054
1021=head1 OTHER MODULES 1072=head1 OTHER MODULES
1022 1073
1023The following is a non-exhaustive list of additional modules that use 1074The following is a non-exhaustive list of additional modules that use
1024AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1075AnyEvent as a client and can therefore be mixed easily with other AnyEvent
1025modules and other event loops in the same program. Some of the modules 1076modules and other event loops in the same program. Some of the modules
1026come with AnyEvent, most are available via CPAN. 1077come as part of AnyEvent, the others are available via CPAN.
1027 1078
1028=over 4 1079=over 4
1029 1080
1030=item L<AnyEvent::Util> 1081=item L<AnyEvent::Util>
1031 1082
1032Contains various utility functions that replace often-used but blocking 1083Contains various utility functions that replace often-used blocking
1033functions such as C<inet_aton> by event-/callback-based versions. 1084functions such as C<inet_aton> with event/callback-based versions.
1034 1085
1035=item L<AnyEvent::Socket> 1086=item L<AnyEvent::Socket>
1036 1087
1037Provides various utility functions for (internet protocol) sockets, 1088Provides various utility functions for (internet protocol) sockets,
1038addresses and name resolution. Also functions to create non-blocking tcp 1089addresses and name resolution. Also functions to create non-blocking tcp
1040 1091
1041=item L<AnyEvent::Handle> 1092=item L<AnyEvent::Handle>
1042 1093
1043Provide read and write buffers, manages watchers for reads and writes, 1094Provide read and write buffers, manages watchers for reads and writes,
1044supports raw and formatted I/O, I/O queued and fully transparent and 1095supports raw and formatted I/O, I/O queued and fully transparent and
1045non-blocking SSL/TLS (via L<AnyEvent::TLS>. 1096non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1046 1097
1047=item L<AnyEvent::DNS> 1098=item L<AnyEvent::DNS>
1048 1099
1049Provides rich asynchronous DNS resolver capabilities. 1100Provides rich asynchronous DNS resolver capabilities.
1050 1101
1102=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1103
1104Implement event-based interfaces to the protocols of the same name (for
1105the curious, IGS is the International Go Server and FCP is the Freenet
1106Client Protocol).
1107
1108=item L<AnyEvent::Handle::UDP>
1109
1110Here be danger!
1111
1112As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1113there are so many things wrong with AnyEvent::Handle::UDP, most notably
1114its use of a stream-based API with a protocol that isn't streamable, that
1115the only way to improve it is to delete it.
1116
1117It features data corruption (but typically only under load) and general
1118confusion. On top, the author is not only clueless about UDP but also
1119fact-resistant - some gems of his understanding: "connect doesn't work
1120with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1121packets", "I don't need to implement proper error checking as UDP doesn't
1122support error checking" and so on - he doesn't even understand what's
1123wrong with his module when it is explained to him.
1124
1051=item L<AnyEvent::HTTP> 1125=item L<AnyEvent::DBI>
1052 1126
1053A simple-to-use HTTP library that is capable of making a lot of concurrent 1127Executes L<DBI> requests asynchronously in a proxy process for you,
1054HTTP requests. 1128notifying you in an event-based way when the operation is finished.
1129
1130=item L<AnyEvent::AIO>
1131
1132Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1133toolbox of every event programmer. AnyEvent::AIO transparently fuses
1134L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1135file I/O, and much more.
1055 1136
1056=item L<AnyEvent::HTTPD> 1137=item L<AnyEvent::HTTPD>
1057 1138
1058Provides a simple web application server framework. 1139A simple embedded webserver.
1059 1140
1060=item L<AnyEvent::FastPing> 1141=item L<AnyEvent::FastPing>
1061 1142
1062The fastest ping in the west. 1143The fastest ping in the west.
1063
1064=item L<AnyEvent::DBI>
1065
1066Executes L<DBI> requests asynchronously in a proxy process.
1067
1068=item L<AnyEvent::AIO>
1069
1070Truly asynchronous I/O, should be in the toolbox of every event
1071programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1072together.
1073
1074=item L<AnyEvent::BDB>
1075
1076Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1077L<BDB> and AnyEvent together.
1078
1079=item L<AnyEvent::GPSD>
1080
1081A non-blocking interface to gpsd, a daemon delivering GPS information.
1082
1083=item L<AnyEvent::IRC>
1084
1085AnyEvent based IRC client module family (replacing the older Net::IRC3).
1086
1087=item L<AnyEvent::XMPP>
1088
1089AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1090Net::XMPP2>.
1091
1092=item L<AnyEvent::IGS>
1093
1094A non-blocking interface to the Internet Go Server protocol (used by
1095L<App::IGS>).
1096
1097=item L<Net::FCP>
1098
1099AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1100of AnyEvent.
1101
1102=item L<Event::ExecFlow>
1103
1104High level API for event-based execution flow control.
1105 1144
1106=item L<Coro> 1145=item L<Coro>
1107 1146
1108Has special support for AnyEvent via L<Coro::AnyEvent>. 1147Has special support for AnyEvent via L<Coro::AnyEvent>.
1109 1148
1113 1152
1114package AnyEvent; 1153package AnyEvent;
1115 1154
1116# basically a tuned-down version of common::sense 1155# basically a tuned-down version of common::sense
1117sub common_sense { 1156sub common_sense {
1118 # from common:.sense 1.0 1157 # from common:.sense 3.4
1119 ${^WARNING_BITS} = "\xfc\x3f\xf3\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03"; 1158 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1120 # use strict vars subs 1159 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1121 $^H |= 0x00000600; 1160 $^H |= 0x00000600;
1122} 1161}
1123 1162
1124BEGIN { AnyEvent::common_sense } 1163BEGIN { AnyEvent::common_sense }
1125 1164
1126use Carp (); 1165use Carp ();
1127 1166
1128our $VERSION = '5.202'; 1167our $VERSION = '5.34';
1129our $MODEL; 1168our $MODEL;
1130 1169
1131our $AUTOLOAD; 1170our $AUTOLOAD;
1132our @ISA; 1171our @ISA;
1133 1172
1134our @REGISTRY; 1173our @REGISTRY;
1135 1174
1136our $WIN32;
1137
1138our $VERBOSE; 1175our $VERBOSE;
1139 1176
1140BEGIN { 1177BEGIN {
1141 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1178 require "AnyEvent/constants.pl";
1179
1142 eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; 1180 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1143 1181
1144 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1182 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1145 if ${^TAINT}; 1183 if ${^TAINT};
1146 1184
1147 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1185 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1172 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1210 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1173 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1211 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1174 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1212 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1175 [Wx:: => AnyEvent::Impl::POE::], 1213 [Wx:: => AnyEvent::Impl::POE::],
1176 [Prima:: => AnyEvent::Impl::POE::], 1214 [Prima:: => AnyEvent::Impl::POE::],
1177 # IO::Async is just too broken - we would need workarounds for its
1178 # byzantine signal and broken child handling, among others.
1179 # IO::Async is rather hard to detect, as it doesn't have any
1180 # obvious default class.
1181 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1182 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1215 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],
1183 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1216 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1184 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program 1217 [FLTK:: => AnyEvent::Impl::FLTK::],
1185); 1218);
1186 1219
1187our %method = map +($_ => 1), 1220our %method = map +($_ => 1),
1188 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1221 qw(io timer time now now_update signal child idle condvar DESTROY);
1189 1222
1190our @post_detect; 1223our @post_detect;
1191 1224
1192sub post_detect(&) { 1225sub post_detect(&) {
1193 my ($cb) = @_; 1226 my ($cb) = @_;
1194 1227
1195 if ($MODEL) {
1196 $cb->();
1197
1198 undef
1199 } else {
1200 push @post_detect, $cb; 1228 push @post_detect, $cb;
1201 1229
1202 defined wantarray 1230 defined wantarray
1203 ? bless \$cb, "AnyEvent::Util::postdetect" 1231 ? bless \$cb, "AnyEvent::Util::postdetect"
1204 : () 1232 : ()
1205 }
1206} 1233}
1207 1234
1208sub AnyEvent::Util::postdetect::DESTROY { 1235sub AnyEvent::Util::postdetect::DESTROY {
1209 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1236 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1210} 1237}
1211 1238
1212sub detect() { 1239sub detect() {
1240 # free some memory
1241 *detect = sub () { $MODEL };
1242
1243 local $!; # for good measure
1244 local $SIG{__DIE__};
1245
1246 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1247 my $model = "AnyEvent::Impl::$1";
1248 if (eval "require $model") {
1249 $MODEL = $model;
1250 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1251 } else {
1252 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1253 }
1254 }
1255
1256 # check for already loaded models
1213 unless ($MODEL) { 1257 unless ($MODEL) {
1214 local $SIG{__DIE__}; 1258 for (@REGISTRY, @models) {
1215 1259 my ($package, $model) = @$_;
1216 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1260 if (${"$package\::VERSION"} > 0) {
1217 my $model = "AnyEvent::Impl::$1";
1218 if (eval "require $model") { 1261 if (eval "require $model") {
1219 $MODEL = $model; 1262 $MODEL = $model;
1220 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; 1263 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1221 } else { 1264 last;
1222 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1265 }
1223 } 1266 }
1224 } 1267 }
1225 1268
1226 # check for already loaded models
1227 unless ($MODEL) { 1269 unless ($MODEL) {
1270 # try to autoload a model
1228 for (@REGISTRY, @models) { 1271 for (@REGISTRY, @models) {
1229 my ($package, $model) = @$_; 1272 my ($package, $model, $autoload) = @$_;
1273 if (
1274 $autoload
1275 and eval "require $package"
1230 if (${"$package\::VERSION"} > 0) { 1276 and ${"$package\::VERSION"} > 0
1231 if (eval "require $model") { 1277 and eval "require $model"
1278 ) {
1232 $MODEL = $model; 1279 $MODEL = $model;
1233 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1280 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1234 last; 1281 last;
1235 }
1236 } 1282 }
1237 } 1283 }
1238 1284
1239 unless ($MODEL) {
1240 # try to autoload a model
1241 for (@REGISTRY, @models) {
1242 my ($package, $model, $autoload) = @$_;
1243 if (
1244 $autoload
1245 and eval "require $package"
1246 and ${"$package\::VERSION"} > 0
1247 and eval "require $model"
1248 ) {
1249 $MODEL = $model;
1250 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1251 last;
1252 }
1253 }
1254
1255 $MODEL 1285 $MODEL
1256 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1286 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1257 }
1258 } 1287 }
1259
1260 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1261
1262 unshift @ISA, $MODEL;
1263
1264 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1265
1266 (shift @post_detect)->() while @post_detect;
1267 } 1288 }
1289
1290 @models = (); # free probe data
1291
1292 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1293 unshift @ISA, $MODEL;
1294
1295 # now nuke some methods that are overridden by the backend.
1296 # SUPER is not allowed.
1297 for (qw(time signal child idle)) {
1298 undef &{"AnyEvent::Base::$_"}
1299 if defined &{"$MODEL\::$_"};
1300 }
1301
1302 if ($ENV{PERL_ANYEVENT_STRICT}) {
1303 eval { require AnyEvent::Strict };
1304 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1305 if $@ && $VERBOSE;
1306 }
1307
1308 (shift @post_detect)->() while @post_detect;
1309
1310 *post_detect = sub(&) {
1311 shift->();
1312
1313 undef
1314 };
1268 1315
1269 $MODEL 1316 $MODEL
1270} 1317}
1271 1318
1272sub AUTOLOAD { 1319sub AUTOLOAD {
1273 (my $func = $AUTOLOAD) =~ s/.*://; 1320 (my $func = $AUTOLOAD) =~ s/.*://;
1274 1321
1275 $method{$func} 1322 $method{$func}
1276 or Carp::croak "$func: not a valid method for AnyEvent objects"; 1323 or Carp::croak "$func: not a valid AnyEvent class method";
1277 1324
1278 detect unless $MODEL; 1325 detect;
1279 1326
1280 my $class = shift; 1327 my $class = shift;
1281 $class->$func (@_); 1328 $class->$func (@_);
1282} 1329}
1283 1330
1300 1347
1301=head1 SIMPLIFIED AE API 1348=head1 SIMPLIFIED AE API
1302 1349
1303Starting with version 5.0, AnyEvent officially supports a second, much 1350Starting with version 5.0, AnyEvent officially supports a second, much
1304simpler, API that is designed to reduce the calling, typing and memory 1351simpler, API that is designed to reduce the calling, typing and memory
1305overhead. 1352overhead by using function call syntax and a fixed number of parameters.
1306 1353
1307See the L<AE> manpage for details. 1354See the L<AE> manpage for details.
1308 1355
1309=cut 1356=cut
1310 1357
1311package AE; 1358package AE;
1312 1359
1313our $VERSION = $AnyEvent::VERSION; 1360our $VERSION = $AnyEvent::VERSION;
1361
1362# fall back to the main API by default - backends and AnyEvent::Base
1363# implementations can overwrite these.
1314 1364
1315sub io($$$) { 1365sub io($$$) {
1316 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1366 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1317} 1367}
1318 1368
1350 1400
1351package AnyEvent::Base; 1401package AnyEvent::Base;
1352 1402
1353# default implementations for many methods 1403# default implementations for many methods
1354 1404
1355sub _time() { 1405sub time {
1406 eval q{ # poor man's autoloading {}
1356 # probe for availability of Time::HiRes 1407 # probe for availability of Time::HiRes
1357 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1408 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1358 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1409 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1359 *_time = \&Time::HiRes::time; 1410 *AE::time = \&Time::HiRes::time;
1360 # if (eval "use POSIX (); (POSIX::times())... 1411 # if (eval "use POSIX (); (POSIX::times())...
1361 } else { 1412 } else {
1362 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1413 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1363 *_time = sub { time }; # epic fail 1414 *AE::time = sub (){ time }; # epic fail
1415 }
1416
1417 *time = sub { AE::time }; # different prototypes
1364 } 1418 };
1419 die if $@;
1365 1420
1366 &_time 1421 &time
1367} 1422}
1368 1423
1369sub time { _time } 1424*now = \&time;
1370sub now { _time } 1425
1371sub now_update { } 1426sub now_update { }
1372 1427
1373# default implementation for ->condvar 1428# default implementation for ->condvar
1374 1429
1375sub condvar { 1430sub condvar {
1431 eval q{ # poor man's autoloading {}
1432 *condvar = sub {
1376 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1433 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1434 };
1435
1436 *AE::cv = sub (;&) {
1437 bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
1438 };
1439 };
1440 die if $@;
1441
1442 &condvar
1377} 1443}
1378 1444
1379# default implementation for ->signal 1445# default implementation for ->signal
1380 1446
1381our $HAVE_ASYNC_INTERRUPT; 1447our $HAVE_ASYNC_INTERRUPT;
1390 1456
1391our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1457our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1392our (%SIG_ASY, %SIG_ASY_W); 1458our (%SIG_ASY, %SIG_ASY_W);
1393our ($SIG_COUNT, $SIG_TW); 1459our ($SIG_COUNT, $SIG_TW);
1394 1460
1395sub _signal_exec {
1396 $HAVE_ASYNC_INTERRUPT
1397 ? $SIGPIPE_R->drain
1398 : sysread $SIGPIPE_R, (my $dummy), 9;
1399
1400 while (%SIG_EV) {
1401 for (keys %SIG_EV) {
1402 delete $SIG_EV{$_};
1403 $_->() for values %{ $SIG_CB{$_} || {} };
1404 }
1405 }
1406}
1407
1408# install a dummy wakeup watcher to reduce signal catching latency 1461# install a dummy wakeup watcher to reduce signal catching latency
1462# used by Impls
1409sub _sig_add() { 1463sub _sig_add() {
1410 unless ($SIG_COUNT++) { 1464 unless ($SIG_COUNT++) {
1411 # try to align timer on a full-second boundary, if possible 1465 # try to align timer on a full-second boundary, if possible
1412 my $NOW = AE::now; 1466 my $NOW = AE::now;
1413 1467
1423 undef $SIG_TW 1477 undef $SIG_TW
1424 unless --$SIG_COUNT; 1478 unless --$SIG_COUNT;
1425} 1479}
1426 1480
1427our $_sig_name_init; $_sig_name_init = sub { 1481our $_sig_name_init; $_sig_name_init = sub {
1428 eval q{ # poor man's autoloading 1482 eval q{ # poor man's autoloading {}
1429 undef $_sig_name_init; 1483 undef $_sig_name_init;
1430 1484
1431 if (_have_async_interrupt) { 1485 if (_have_async_interrupt) {
1432 *sig2num = \&Async::Interrupt::sig2num; 1486 *sig2num = \&Async::Interrupt::sig2num;
1433 *sig2name = \&Async::Interrupt::sig2name; 1487 *sig2name = \&Async::Interrupt::sig2name;
1465 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1519 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1466 1520
1467 } else { 1521 } else {
1468 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1522 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1469 1523
1470 require Fcntl;
1471
1472 if (AnyEvent::WIN32) { 1524 if (AnyEvent::WIN32) {
1473 require AnyEvent::Util; 1525 require AnyEvent::Util;
1474 1526
1475 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1527 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1476 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R; 1528 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1477 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case 1529 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1478 } else { 1530 } else {
1479 pipe $SIGPIPE_R, $SIGPIPE_W; 1531 pipe $SIGPIPE_R, $SIGPIPE_W;
1480 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; 1532 fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1481 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case 1533 fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1482 1534
1483 # not strictly required, as $^F is normally 2, but let's make sure... 1535 # not strictly required, as $^F is normally 2, but let's make sure...
1484 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; 1536 fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1485 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; 1537 fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1486 } 1538 }
1487 1539
1488 $SIGPIPE_R 1540 $SIGPIPE_R
1489 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1541 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1490 1542
1491 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec; 1543 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1492 } 1544 }
1493 1545
1494 *signal = sub { 1546 *signal = $HAVE_ASYNC_INTERRUPT
1547 ? sub {
1495 my (undef, %arg) = @_; 1548 my (undef, %arg) = @_;
1496 1549
1497 my $signal = uc $arg{signal}
1498 or Carp::croak "required option 'signal' is missing";
1499
1500 if ($HAVE_ASYNC_INTERRUPT) {
1501 # async::interrupt 1550 # async::interrupt
1502
1503 $signal = sig2num $signal; 1551 my $signal = sig2num $arg{signal};
1504 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1552 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1505 1553
1506 $SIG_ASY{$signal} ||= new Async::Interrupt 1554 $SIG_ASY{$signal} ||= new Async::Interrupt
1507 cb => sub { undef $SIG_EV{$signal} }, 1555 cb => sub { undef $SIG_EV{$signal} },
1508 signal => $signal, 1556 signal => $signal,
1509 pipe => [$SIGPIPE_R->filenos], 1557 pipe => [$SIGPIPE_R->filenos],
1510 pipe_autodrain => 0, 1558 pipe_autodrain => 0,
1511 ; 1559 ;
1512 1560
1513 } else { 1561 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1562 }
1563 : sub {
1564 my (undef, %arg) = @_;
1565
1514 # pure perl 1566 # pure perl
1515
1516 # AE::Util has been loaded in signal
1517 $signal = sig2name $signal; 1567 my $signal = sig2name $arg{signal};
1518 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1568 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1519 1569
1520 $SIG{$signal} ||= sub { 1570 $SIG{$signal} ||= sub {
1521 local $!; 1571 local $!;
1522 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1572 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1523 undef $SIG_EV{$signal}; 1573 undef $SIG_EV{$signal};
1524 }; 1574 };
1525 1575
1526 # can't do signal processing without introducing races in pure perl, 1576 # can't do signal processing without introducing races in pure perl,
1527 # so limit the signal latency. 1577 # so limit the signal latency.
1528 _sig_add; 1578 _sig_add;
1529 }
1530 1579
1531 bless [$signal, $arg{cb}], "AnyEvent::Base::signal" 1580 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1581 }
1532 }; 1582 ;
1533 1583
1534 *AnyEvent::Base::signal::DESTROY = sub { 1584 *AnyEvent::Base::signal::DESTROY = sub {
1535 my ($signal, $cb) = @{$_[0]}; 1585 my ($signal, $cb) = @{$_[0]};
1536 1586
1537 _sig_del; 1587 _sig_del;
1544 # print weird messages, or just unconditionally exit 1594 # print weird messages, or just unconditionally exit
1545 # instead of getting the default action. 1595 # instead of getting the default action.
1546 undef $SIG{$signal} 1596 undef $SIG{$signal}
1547 unless keys %{ $SIG_CB{$signal} }; 1597 unless keys %{ $SIG_CB{$signal} };
1548 }; 1598 };
1599
1600 *_signal_exec = sub {
1601 $HAVE_ASYNC_INTERRUPT
1602 ? $SIGPIPE_R->drain
1603 : sysread $SIGPIPE_R, (my $dummy), 9;
1604
1605 while (%SIG_EV) {
1606 for (keys %SIG_EV) {
1607 delete $SIG_EV{$_};
1608 $_->() for values %{ $SIG_CB{$_} || {} };
1609 }
1610 }
1611 };
1549 }; 1612 };
1550 die if $@; 1613 die if $@;
1614
1551 &signal 1615 &signal
1552} 1616}
1553 1617
1554# default implementation for ->child 1618# default implementation for ->child
1555 1619
1556our %PID_CB; 1620our %PID_CB;
1557our $CHLD_W; 1621our $CHLD_W;
1558our $CHLD_DELAY_W; 1622our $CHLD_DELAY_W;
1559our $WNOHANG;
1560 1623
1624# used by many Impl's
1561sub _emit_childstatus($$) { 1625sub _emit_childstatus($$) {
1562 my (undef, $rpid, $rstatus) = @_; 1626 my (undef, $rpid, $rstatus) = @_;
1563 1627
1564 $_->($rpid, $rstatus) 1628 $_->($rpid, $rstatus)
1565 for values %{ $PID_CB{$rpid} || {} }, 1629 for values %{ $PID_CB{$rpid} || {} },
1566 values %{ $PID_CB{0} || {} }; 1630 values %{ $PID_CB{0} || {} };
1567} 1631}
1568 1632
1569sub _sigchld {
1570 my $pid;
1571
1572 AnyEvent->_emit_childstatus ($pid, $?)
1573 while ($pid = waitpid -1, $WNOHANG) > 0;
1574}
1575
1576sub child { 1633sub child {
1634 eval q{ # poor man's autoloading {}
1635 *_sigchld = sub {
1636 my $pid;
1637
1638 AnyEvent->_emit_childstatus ($pid, $?)
1639 while ($pid = waitpid -1, WNOHANG) > 0;
1640 };
1641
1642 *child = sub {
1577 my (undef, %arg) = @_; 1643 my (undef, %arg) = @_;
1578 1644
1579 defined (my $pid = $arg{pid} + 0) 1645 defined (my $pid = $arg{pid} + 0)
1580 or Carp::croak "required option 'pid' is missing"; 1646 or Carp::croak "required option 'pid' is missing";
1581 1647
1582 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1648 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1583 1649
1584 # WNOHANG is almost cetrainly 1 everywhere
1585 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1586 ? 1
1587 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1588
1589 unless ($CHLD_W) { 1650 unless ($CHLD_W) {
1590 $CHLD_W = AE::signal CHLD => \&_sigchld; 1651 $CHLD_W = AE::signal CHLD => \&_sigchld;
1591 # child could be a zombie already, so make at least one round 1652 # child could be a zombie already, so make at least one round
1592 &_sigchld; 1653 &_sigchld;
1593 } 1654 }
1594 1655
1595 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1656 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1596} 1657 };
1597 1658
1598sub AnyEvent::Base::child::DESTROY { 1659 *AnyEvent::Base::child::DESTROY = sub {
1599 my ($pid, $cb) = @{$_[0]}; 1660 my ($pid, $cb) = @{$_[0]};
1600 1661
1601 delete $PID_CB{$pid}{$cb}; 1662 delete $PID_CB{$pid}{$cb};
1602 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1663 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1603 1664
1604 undef $CHLD_W unless keys %PID_CB; 1665 undef $CHLD_W unless keys %PID_CB;
1666 };
1667 };
1668 die if $@;
1669
1670 &child
1605} 1671}
1606 1672
1607# idle emulation is done by simply using a timer, regardless 1673# idle emulation is done by simply using a timer, regardless
1608# of whether the process is idle or not, and not letting 1674# of whether the process is idle or not, and not letting
1609# the callback use more than 50% of the time. 1675# the callback use more than 50% of the time.
1610sub idle { 1676sub idle {
1677 eval q{ # poor man's autoloading {}
1678 *idle = sub {
1611 my (undef, %arg) = @_; 1679 my (undef, %arg) = @_;
1612 1680
1613 my ($cb, $w, $rcb) = $arg{cb}; 1681 my ($cb, $w, $rcb) = $arg{cb};
1614 1682
1615 $rcb = sub { 1683 $rcb = sub {
1616 if ($cb) { 1684 if ($cb) {
1617 $w = _time; 1685 $w = _time;
1618 &$cb; 1686 &$cb;
1619 $w = _time - $w; 1687 $w = _time - $w;
1620 1688
1621 # never use more then 50% of the time for the idle watcher, 1689 # never use more then 50% of the time for the idle watcher,
1622 # within some limits 1690 # within some limits
1623 $w = 0.0001 if $w < 0.0001; 1691 $w = 0.0001 if $w < 0.0001;
1624 $w = 5 if $w > 5; 1692 $w = 5 if $w > 5;
1625 1693
1626 $w = AE::timer $w, 0, $rcb; 1694 $w = AE::timer $w, 0, $rcb;
1627 } else { 1695 } else {
1628 # clean up... 1696 # clean up...
1629 undef $w; 1697 undef $w;
1630 undef $rcb; 1698 undef $rcb;
1699 }
1700 };
1701
1702 $w = AE::timer 0.05, 0, $rcb;
1703
1704 bless \\$cb, "AnyEvent::Base::idle"
1631 } 1705 };
1706
1707 *AnyEvent::Base::idle::DESTROY = sub {
1708 undef $${$_[0]};
1709 };
1632 }; 1710 };
1711 die if $@;
1633 1712
1634 $w = AE::timer 0.05, 0, $rcb; 1713 &idle
1635
1636 bless \\$cb, "AnyEvent::Base::idle"
1637}
1638
1639sub AnyEvent::Base::idle::DESTROY {
1640 undef $${$_[0]};
1641} 1714}
1642 1715
1643package AnyEvent::CondVar; 1716package AnyEvent::CondVar;
1644 1717
1645our @ISA = AnyEvent::CondVar::Base::; 1718our @ISA = AnyEvent::CondVar::Base::;
1719
1720# only to be used for subclassing
1721sub new {
1722 my $class = shift;
1723 bless AnyEvent->condvar (@_), $class
1724}
1646 1725
1647package AnyEvent::CondVar::Base; 1726package AnyEvent::CondVar::Base;
1648 1727
1649#use overload 1728#use overload
1650# '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1729# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1660 1739
1661sub _send { 1740sub _send {
1662 # nop 1741 # nop
1663} 1742}
1664 1743
1744sub _wait {
1745 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1746}
1747
1665sub send { 1748sub send {
1666 my $cv = shift; 1749 my $cv = shift;
1667 $cv->{_ae_sent} = [@_]; 1750 $cv->{_ae_sent} = [@_];
1668 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1751 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1669 $cv->_send; 1752 $cv->_send;
1676 1759
1677sub ready { 1760sub ready {
1678 $_[0]{_ae_sent} 1761 $_[0]{_ae_sent}
1679} 1762}
1680 1763
1681sub _wait {
1682 $WAITING
1683 and !$_[0]{_ae_sent}
1684 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1685
1686 local $WAITING = 1;
1687 AnyEvent->one_event while !$_[0]{_ae_sent};
1688}
1689
1690sub recv { 1764sub recv {
1765 unless ($_[0]{_ae_sent}) {
1766 $WAITING
1767 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1768
1769 local $WAITING = 1;
1691 $_[0]->_wait; 1770 $_[0]->_wait;
1771 }
1692 1772
1693 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1773 $_[0]{_ae_croak}
1694 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1774 and Carp::croak $_[0]{_ae_croak};
1775
1776 wantarray
1777 ? @{ $_[0]{_ae_sent} }
1778 : $_[0]{_ae_sent}[0]
1695} 1779}
1696 1780
1697sub cb { 1781sub cb {
1698 my $cv = shift; 1782 my $cv = shift;
1699 1783
1715 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 1799 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1716} 1800}
1717 1801
1718# undocumented/compatibility with pre-3.4 1802# undocumented/compatibility with pre-3.4
1719*broadcast = \&send; 1803*broadcast = \&send;
1720*wait = \&_wait; 1804*wait = \&recv;
1721 1805
1722=head1 ERROR AND EXCEPTION HANDLING 1806=head1 ERROR AND EXCEPTION HANDLING
1723 1807
1724In general, AnyEvent does not do any error handling - it relies on the 1808In general, AnyEvent does not do any error handling - it relies on the
1725caller to do that if required. The L<AnyEvent::Strict> module (see also 1809caller to do that if required. The L<AnyEvent::Strict> module (see also
1772check the arguments passed to most method calls. If it finds any problems, 1856check the arguments passed to most method calls. If it finds any problems,
1773it will croak. 1857it will croak.
1774 1858
1775In other words, enables "strict" mode. 1859In other words, enables "strict" mode.
1776 1860
1777Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense> 1861Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1778>>, it is definitely recommended to keep it off in production. Keeping 1862>>, it is definitely recommended to keep it off in production. Keeping
1779C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 1863C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1780can be very useful, however. 1864can be very useful, however.
1781 1865
1782=item C<PERL_ANYEVENT_MODEL> 1866=item C<PERL_ANYEVENT_MODEL>
2004 2088
2005The actual code goes further and collects all errors (C<die>s, exceptions) 2089The actual code goes further and collects all errors (C<die>s, exceptions)
2006that occurred during request processing. The C<result> method detects 2090that occurred during request processing. The C<result> method detects
2007whether an exception as thrown (it is stored inside the $txn object) 2091whether an exception as thrown (it is stored inside the $txn object)
2008and just throws the exception, which means connection errors and other 2092and just throws the exception, which means connection errors and other
2009problems get reported tot he code that tries to use the result, not in a 2093problems get reported to the code that tries to use the result, not in a
2010random callback. 2094random callback.
2011 2095
2012All of this enables the following usage styles: 2096All of this enables the following usage styles:
2013 2097
20141. Blocking: 20981. Blocking:
2428 unless defined $SIG{PIPE}; 2512 unless defined $SIG{PIPE};
2429 2513
2430=head1 RECOMMENDED/OPTIONAL MODULES 2514=head1 RECOMMENDED/OPTIONAL MODULES
2431 2515
2432One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and 2516One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2433it's built-in modules) are required to use it. 2517its built-in modules) are required to use it.
2434 2518
2435That does not mean that AnyEvent won't take advantage of some additional 2519That does not mean that AnyEvent won't take advantage of some additional
2436modules if they are installed. 2520modules if they are installed.
2437 2521
2438This section epxlains which additional modules will be used, and how they 2522This section explains which additional modules will be used, and how they
2439affect AnyEvent's operetion. 2523affect AnyEvent's operation.
2440 2524
2441=over 4 2525=over 4
2442 2526
2443=item L<Async::Interrupt> 2527=item L<Async::Interrupt>
2444 2528
2449catch the signals) with some delay (default is 10 seconds, look for 2533catch the signals) with some delay (default is 10 seconds, look for
2450C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2534C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2451 2535
2452If this module is available, then it will be used to implement signal 2536If this module is available, then it will be used to implement signal
2453catching, which means that signals will not be delayed, and the event loop 2537catching, which means that signals will not be delayed, and the event loop
2454will not be interrupted regularly, which is more efficient (And good for 2538will not be interrupted regularly, which is more efficient (and good for
2455battery life on laptops). 2539battery life on laptops).
2456 2540
2457This affects not just the pure-perl event loop, but also other event loops 2541This affects not just the pure-perl event loop, but also other event loops
2458that have no signal handling on their own (e.g. Glib, Tk, Qt). 2542that have no signal handling on their own (e.g. Glib, Tk, Qt).
2459 2543
2471automatic timer adjustments even when no monotonic clock is available, 2555automatic timer adjustments even when no monotonic clock is available,
2472can take avdantage of advanced kernel interfaces such as C<epoll> and 2556can take avdantage of advanced kernel interfaces such as C<epoll> and
2473C<kqueue>, and is the fastest backend I<by far>. You can even embed 2557C<kqueue>, and is the fastest backend I<by far>. You can even embed
2474L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). 2558L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2475 2559
2560If you only use backends that rely on another event loop (e.g. C<Tk>),
2561then this module will do nothing for you.
2562
2476=item L<Guard> 2563=item L<Guard>
2477 2564
2478The guard module, when used, will be used to implement 2565The guard module, when used, will be used to implement
2479C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a 2566C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2480lot less memory), but otherwise doesn't affect guard operation much. It is 2567lot less memory), but otherwise doesn't affect guard operation much. It is
2481purely used for performance. 2568purely used for performance.
2482 2569
2483=item L<JSON> and L<JSON::XS> 2570=item L<JSON> and L<JSON::XS>
2484 2571
2485One of these modules is required when you want to read or write JSON data 2572One of these modules is required when you want to read or write JSON data
2486via L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2573via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2487advantage of the ultra-high-speed L<JSON::XS> module when it is installed. 2574advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2488
2489In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2490installed.
2491 2575
2492=item L<Net::SSLeay> 2576=item L<Net::SSLeay>
2493 2577
2494Implementing TLS/SSL in Perl is certainly interesting, but not very 2578Implementing TLS/SSL in Perl is certainly interesting, but not very
2495worthwhile: If this module is installed, then L<AnyEvent::Handle> (with 2579worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2496the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. 2580the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2497 2581
2498=item L<Time::HiRes> 2582=item L<Time::HiRes>
2499 2583
2500This module is part of perl since release 5.008. It will be used when the 2584This module is part of perl since release 5.008. It will be used when the
2501chosen event library does not come with a timing source on it's own. The 2585chosen event library does not come with a timing source of its own. The
2502pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2586pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2503try to use a monotonic clock for timing stability. 2587try to use a monotonic clock for timing stability.
2504 2588
2505=back 2589=back
2506 2590
2507 2591
2508=head1 FORK 2592=head1 FORK
2509 2593
2510Most event libraries are not fork-safe. The ones who are usually are 2594Most event libraries are not fork-safe. The ones who are usually are
2511because they rely on inefficient but fork-safe C<select> or C<poll> 2595because they rely on inefficient but fork-safe C<select> or C<poll> calls
2512calls. Only L<EV> is fully fork-aware. 2596- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
2597are usually badly thought-out hacks that are incompatible with fork in
2598one way or another. Only L<EV> is fully fork-aware and ensures that you
2599continue event-processing in both parent and child (or both, if you know
2600what you are doing).
2601
2602This means that, in general, you cannot fork and do event processing in
2603the child if the event library was initialised before the fork (which
2604usually happens when the first AnyEvent watcher is created, or the library
2605is loaded).
2513 2606
2514If you have to fork, you must either do so I<before> creating your first 2607If you have to fork, you must either do so I<before> creating your first
2515watcher OR you must not use AnyEvent at all in the child OR you must do 2608watcher OR you must not use AnyEvent at all in the child OR you must do
2516something completely out of the scope of AnyEvent. 2609something completely out of the scope of AnyEvent.
2610
2611The problem of doing event processing in the parent I<and> the child
2612is much more complicated: even for backends that I<are> fork-aware or
2613fork-safe, their behaviour is not usually what you want: fork clones all
2614watchers, that means all timers, I/O watchers etc. are active in both
2615parent and child, which is almost never what you want. USing C<exec>
2616to start worker children from some kind of manage rprocess is usually
2617preferred, because it is much easier and cleaner, at the expense of having
2618to have another binary.
2517 2619
2518 2620
2519=head1 SECURITY CONSIDERATIONS 2621=head1 SECURITY CONSIDERATIONS
2520 2622
2521AnyEvent can be forced to load any event model via 2623AnyEvent can be forced to load any event model via
2551pronounced). 2653pronounced).
2552 2654
2553 2655
2554=head1 SEE ALSO 2656=head1 SEE ALSO
2555 2657
2658Tutorial/Introduction: L<AnyEvent::Intro>.
2659
2660FAQ: L<AnyEvent::FAQ>.
2661
2556Utility functions: L<AnyEvent::Util>. 2662Utility functions: L<AnyEvent::Util>.
2557 2663
2558Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2664Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
2559L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2665L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2560 2666
2566Non-blocking file handles, sockets, TCP clients and 2672Non-blocking file handles, sockets, TCP clients and
2567servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2673servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2568 2674
2569Asynchronous DNS: L<AnyEvent::DNS>. 2675Asynchronous DNS: L<AnyEvent::DNS>.
2570 2676
2571Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, 2677Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2572L<Coro::Event>,
2573 2678
2574Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, 2679Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2575L<AnyEvent::HTTP>. 2680L<AnyEvent::HTTP>.
2576 2681
2577 2682
2578=head1 AUTHOR 2683=head1 AUTHOR
2579 2684

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines