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.316 by root, Mon Mar 15 18:51:30 2010 UTC vs.
Revision 1.367 by root, Wed Aug 17 02:14:17 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::Loop>,
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::Loop> 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 C<AnyEvent::Loop>. Like
144C<AnyEvent::Impl::Perl>. Like other event modules you can load it 148other event modules you can load it explicitly and enjoy the high
145explicitly and enjoy the high availability of that event loop :) 149availability of that event loop :)
146 150
147=head1 WATCHERS 151=head1 WATCHERS
148 152
149AnyEvent 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
150stores 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
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
352difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
353account. 357account.
354 358
355=item AnyEvent->now_update 359=item AnyEvent->now_update
356 360
357Some 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
358the current time for each loop iteration (see the discussion of L<< 362time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
359AnyEvent->now >>, above). 363above).
360 364
361When 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
362this "current" time will differ substantially from the real time, which 366this "current" time will differ substantially from the real time, which
363might affect timers and time-outs. 367might affect timers and time-outs.
364 368
425=head3 Signal Races, Delays and Workarounds 429=head3 Signal Races, Delays and Workarounds
426 430
427Many 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
428callbacks 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
429do race-free signal handling in perl, requiring C libraries for 433do race-free signal handling in perl, requiring C libraries for
430this. 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,
431signals 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
432specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This 436specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
433variable can be changed only before the first signal watcher is created, 437variable can be changed only before the first signal watcher is created,
434and should be left alone otherwise. This variable determines how often 438and should be left alone otherwise. This variable determines how often
435AnyEvent 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
437saving. 441saving.
438 442
439All these problems can be avoided by installing the optional 443All these problems can be avoided by installing the optional
440L<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
441work 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>
442(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
443one-second latency). For those, you just have to suffer the delays. 447one-second latency). For those, you just have to suffer the delays.
444 448
445=head2 CHILD PROCESS WATCHERS 449=head2 CHILD PROCESS WATCHERS
446 450
447 $w = AnyEvent->child (pid => <process id>, cb => <callback>); 451 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
448 452
449You 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.
450 454
451The 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,
452using 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
453croak). The watcher will be triggered only when the child process has 457croak). The watcher will be triggered only when the child process has
454finished and an exit status is available, not on any trace events 458finished and an exit status is available, not on any trace events
455(stopped/continued). 459(stopped/continued).
456 460
478thing 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
479watcher before you C<fork> the child (alternatively, you can call 483watcher before you C<fork> the child (alternatively, you can call
480C<AnyEvent::detect>). 484C<AnyEvent::detect>).
481 485
482As 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
483emulated 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
484mentioned in the description of signal watchers apply. 488problems mentioned in the description of signal watchers apply.
485 489
486Example: fork a process and wait for it 490Example: fork a process and wait for it
487 491
488 my $done = AnyEvent->condvar; 492 my $done = AnyEvent->condvar;
489 493
503 507
504=head2 IDLE WATCHERS 508=head2 IDLE WATCHERS
505 509
506 $w = AnyEvent->idle (cb => <callback>); 510 $w = AnyEvent->idle (cb => <callback>);
507 511
508Repeatedly invoke the callback after the process becomes idle, until 512This will repeatedly invoke the callback after the process becomes idle,
509either the watcher is destroyed or new events have been detected. 513until either the watcher is destroyed or new events have been detected.
510 514
511Idle 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
512is 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
513invoked only when there is "nothing better to do", which is usually 517invoked only when there is "nothing better to do", which is usually
514defined as "all outstanding events have been handled and no new events 518defined as "all outstanding events have been handled and no new events
553will actively watch for new events and call your callbacks. 557will actively watch for new events and call your callbacks.
554 558
555AnyEvent is slightly different: it expects somebody else to run the event 559AnyEvent is slightly different: it expects somebody else to run the event
556loop 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).
557 561
558The instrument to do that is called a "condition variable", so called 562The tool to do that is called a "condition variable", so called because
559because they represent a condition that must become true. 563they represent a condition that must become true.
560 564
561Now 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.
562 566
563Condition variables can be created by calling the C<< AnyEvent->condvar 567Condition variables can be created by calling the C<< AnyEvent->condvar
564>> method, usually without arguments. The only argument pair allowed is 568>> method, usually without arguments. The only argument pair allowed is
569After creation, the condition variable is "false" until it becomes "true" 573After creation, the condition variable is "false" until it becomes "true"
570by 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
571were 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<<
572->send >> method). 576->send >> method).
573 577
574Condition variables are similar to callbacks, except that you can 578Since condition variables are the most complex part of the AnyEvent API, here are
575optionally 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:
576in time where multiple outstanding events have been processed. And yet 580
577another way to call them is transactions - each condition variable can be 581=over 4
578used to represent a transaction, which finishes at some point and delivers 582
579a 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
580compute/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
581 601
582Condition variables are very useful to signal that something has finished, 602Condition variables are very useful to signal that something has finished,
583for example, if you write a module that does asynchronous http requests, 603for example, if you write a module that does asynchronous http requests,
584then a condition variable would be the ideal candidate to signal the 604then a condition variable would be the ideal candidate to signal the
585availability of results. The user can either act when the callback is 605availability of results. The user can either act when the callback is
598 618
599Condition variables are represented by hash refs in perl, and the keys 619Condition variables are represented by hash refs in perl, and the keys
600used 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
601easy (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
602AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call 622AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
603it's C<new> method in your own C<new> method. 623its C<new> method in your own C<new> method.
604 624
605There are two "sides" to a condition variable - the "producer side" which 625There are two "sides" to a condition variable - the "producer side" which
606eventually calls C<< -> send >>, and the "consumer side", which waits 626eventually calls C<< -> send >>, and the "consumer side", which waits
607for the send to occur. 627for the send to occur.
608 628
609Example: wait for a timer. 629Example: wait for a timer.
610 630
611 # wait till the result is ready 631 # condition: "wait till the timer is fired"
612 my $result_ready = AnyEvent->condvar; 632 my $timer_fired = AnyEvent->condvar;
613 633
614 # do something such as adding a timer 634 # create the timer - we could wait for, say
615 # or socket watcher the calls $result_ready->send 635 # a handle becomign ready, or even an
616 # when the "result" is ready. 636 # AnyEvent::HTTP request to finish, but
617 # in this case, we simply use a timer: 637 # in this case, we simply use a timer:
618 my $w = AnyEvent->timer ( 638 my $w = AnyEvent->timer (
619 after => 1, 639 after => 1,
620 cb => sub { $result_ready->send }, 640 cb => sub { $timer_fired->send },
621 ); 641 );
622 642
623 # this "blocks" (while handling events) till the callback 643 # this "blocks" (while handling events) till the callback
624 # calls ->send 644 # calls ->send
625 $result_ready->recv; 645 $timer_fired->recv;
626 646
627Example: 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
628variables are also callable directly. 648variables are also callable directly.
629 649
630 my $done = AnyEvent->condvar; 650 my $done = AnyEvent->condvar;
673they 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
674C<send>. 694C<send>.
675 695
676=item $cv->croak ($error) 696=item $cv->croak ($error)
677 697
678Similar to send, but causes all call's to C<< ->recv >> to invoke 698Similar to send, but causes all calls to C<< ->recv >> to invoke
679C<Carp::croak> with the given error message/object/scalar. 699C<Carp::croak> with the given error message/object/scalar.
680 700
681This can be used to signal any errors to the condition variable 701This can be used to signal any errors to the condition variable
682user/consumer. Doing it this way instead of calling C<croak> directly 702user/consumer. Doing it this way instead of calling C<croak> directly
683delays the error detetcion, but has the overwhelmign advantage that it 703delays the error detection, but has the overwhelming advantage that it
684diagnoses 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
685deep in some event clalback without connection to the actual code causing 705deep in some event callback with no connection to the actual code causing
686the problem. 706the problem.
687 707
688=item $cv->begin ([group callback]) 708=item $cv->begin ([group callback])
689 709
690=item $cv->end 710=item $cv->end
728one 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
729sending. 749sending.
730 750
731The ping example mentioned above is slightly more complicated, as the 751The ping example mentioned above is slightly more complicated, as the
732there 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
733begung can potentially be zero: 753begun can potentially be zero:
734 754
735 my $cv = AnyEvent->condvar; 755 my $cv = AnyEvent->condvar;
736 756
737 my %result; 757 my %result;
738 $cv->begin (sub { shift->send (\%result) }); 758 $cv->begin (sub { shift->send (\%result) });
759to 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
760C<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
761doesn't execute once). 781doesn't execute once).
762 782
763This is the general pattern when you "fan out" into multiple (but 783This is the general pattern when you "fan out" into multiple (but
764potentially 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
765the 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
766subrequest you start, call C<begin> and for each subrequest you finish, 786subrequest you start, call C<begin> and for each subrequest you finish,
767call C<end>. 787call C<end>.
768 788
769=back 789=back
776=over 4 796=over 4
777 797
778=item $cv->recv 798=item $cv->recv
779 799
780Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak 800Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
781>> methods have been called on c<$cv>, while servicing other watchers 801>> methods have been called on C<$cv>, while servicing other watchers
782normally. 802normally.
783 803
784You 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
785will return immediately. 805will return immediately.
786 806
803caller 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
804condition variables with some kind of request results and supporting 824condition variables with some kind of request results and supporting
805callbacks so the caller knows that getting the result will not block, 825callbacks so the caller knows that getting the result will not block,
806while still supporting blocking waits if the caller so desires). 826while still supporting blocking waits if the caller so desires).
807 827
808You 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
809only calling C<< ->recv >> from within that callback (or at a later 829only calling C<< ->recv >> from within that callback (or at a later
810time). 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
811waits otherwise. 831waits otherwise.
812 832
813=item $bool = $cv->ready 833=item $bool = $cv->ready
818=item $cb = $cv->cb ($cb->($cv)) 838=item $cb = $cv->cb ($cb->($cv))
819 839
820This is a mutator function that returns the callback set and optionally 840This is a mutator function that returns the callback set and optionally
821replaces it before doing so. 841replaces it before doing so.
822 842
823The callback will be called when the condition becomes (or already was) 843The callback will be called when the condition becomes "true", i.e. when
824"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
825the 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
826inside the callback or at any later time is guaranteed not to block. 847the callback or at any later time is guaranteed not to block.
827 848
828=back 849=back
829 850
830=head1 SUPPORTED EVENT LOOPS/BACKENDS 851=head1 SUPPORTED EVENT LOOPS/BACKENDS
831 852
839use. 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
840pure-perl implementation, which is available everywhere as it comes with 861pure-perl implementation, which is available everywhere as it comes with
841AnyEvent itself. 862AnyEvent itself.
842 863
843 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 864 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
844 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 865 AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
845 866
846=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.
847 868
848These 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
849is 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
850them. This means that AnyEvent will automatically pick the right backend 871them. This means that AnyEvent will automatically pick the right backend
851when the main program loads an event module before anything starts to 872when the main program loads an event module before anything starts to
852create watchers. Nothing special needs to be done by the main program. 873create watchers. Nothing special needs to be done by the main program.
853 874
855 AnyEvent::Impl::Glib based on Glib, slow but very stable. 876 AnyEvent::Impl::Glib based on Glib, slow but very stable.
856 AnyEvent::Impl::Tk based on Tk, very broken. 877 AnyEvent::Impl::Tk based on Tk, very broken.
857 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
858 AnyEvent::Impl::POE based on POE, very slow, some limitations. 879 AnyEvent::Impl::POE based on POE, very slow, some limitations.
859 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::FLTK2 based on FLTK (fltk 2 binding).
860 884
861=item Backends with special needs. 885=item Backends with special needs.
862 886
863Qt requires the Qt::Application to be instantiated first, but will 887Qt requires the Qt::Application to be instantiated first, but will
864otherwise be picked up automatically. As long as the main program 888otherwise be picked up automatically. As long as the main program
865instantiates the application before any AnyEvent watchers are created, 889instantiates the application before any AnyEvent watchers are created,
866everything should just work. 890everything should just work.
867 891
868 AnyEvent::Impl::Qt based on Qt. 892 AnyEvent::Impl::Qt based on Qt.
869 893
870Support for IO::Async can only be partial, as it is too broken and
871architecturally limited to even support the AnyEvent API. It also
872is the only event loop that needs the loop to be set explicitly, so
873it can only be used by a main program knowing about AnyEvent. See
874L<AnyEvent::Impl::Async> for the gory details.
875
876 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
877
878=item Event loops that are indirectly supported via other backends. 894=item Event loops that are indirectly supported via other backends.
879 895
880Some event loops can be supported via other modules: 896Some event loops can be supported via other modules:
881 897
882There is no direct support for WxWidgets (L<Wx>) or L<Prima>. 898There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
907Contains C<undef> until the first watcher is being created, before the 923Contains C<undef> until the first watcher is being created, before the
908backend has been autodetected. 924backend has been autodetected.
909 925
910Afterwards 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
911name 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
912of 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
913case 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
914will be C<urxvt::anyevent>). 930will be C<urxvt::anyevent>).
915 931
916=item AnyEvent::detect 932=item AnyEvent::detect
917 933
918Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
919if necessary. You should only call this function right before you would 935if necessary. You should only call this function right before you would
920have 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
921runtime, 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).
922 942
923If you need to do some initialisation before AnyEvent watchers are 943If you need to do some initialisation before AnyEvent watchers are
924created, use C<post_detect>. 944created, use C<post_detect>.
925 945
926=item $guard = AnyEvent::post_detect { BLOCK } 946=item $guard = AnyEvent::post_detect { BLOCK }
927 947
928Arranges 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
929autodetected (or immediately if this has already happened). 949autodetected (or immediately if that has already happened).
930 950
931The 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
932(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
933created, 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
934other initialisations - see the sources of L<AnyEvent::Strict> or 954other initialisations - see the sources of L<AnyEvent::Strict> or
943that automatically removes the callback again when it is destroyed (or 963that automatically removes the callback again when it is destroyed (or
944C<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
945a case where this is useful. 965a case where this is useful.
946 966
947Example: 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
948C<$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.
949 969
950 our WATCHER; 970 our WATCHER;
951 971
952 my $guard = AnyEvent::post_detect { 972 my $guard = AnyEvent::post_detect {
953 $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);
961 $WATCHER ||= $guard; 981 $WATCHER ||= $guard;
962 982
963=item @AnyEvent::post_detect 983=item @AnyEvent::post_detect
964 984
965If 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
966before or after loading AnyEvent), then they will called directly after 986before or after loading AnyEvent), then they will be called directly
967the event loop has been chosen. 987after the event loop has been chosen.
968 988
969You should check C<$AnyEvent::MODEL> before adding to this array, though: 989You should check C<$AnyEvent::MODEL> before adding to this array, though:
970if 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
971array will be ignored. 991array will be ignored.
972 992
989 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent 1009 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
990 # as soon as it is 1010 # as soon as it is
991 push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; 1011 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
992 } 1012 }
993 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
1058Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> -
1059consequently, look at the L<AnyEvent::Log> documentation for details.
1060
1061If you want to sprinkle loads of logging calls around your code, consider
1062creating a logger callback with the C<AnyEvent::Log::logger< function.
1063
994=back 1064=back
995 1065
996=head1 WHAT TO DO IN A MODULE 1066=head1 WHAT TO DO IN A MODULE
997 1067
998As a module author, you should C<use AnyEvent> and call AnyEvent methods 1068As a module author, you should C<use AnyEvent> and call AnyEvent methods
1008because it will stall the whole program, and the whole point of using 1078because it will stall the whole program, and the whole point of using
1009events is to stay interactive. 1079events is to stay interactive.
1010 1080
1011It is fine, however, to call C<< ->recv >> when the user of your module 1081It is fine, however, to call C<< ->recv >> when the user of your module
1012requests it (i.e. if you create a http request object ad have a method 1082requests it (i.e. if you create a http request object ad have a method
1013called C<results> that returns the results, it should call C<< ->recv >> 1083called C<results> that returns the results, it may call C<< ->recv >>
1014freely, as the user of your module knows what she is doing. always). 1084freely, as the user of your module knows what she is doing. Always).
1015 1085
1016=head1 WHAT TO DO IN THE MAIN PROGRAM 1086=head1 WHAT TO DO IN THE MAIN PROGRAM
1017 1087
1018There will always be a single main program - the only place that should 1088There will always be a single main program - the only place that should
1019dictate which event model to use. 1089dictate which event model to use.
1020 1090
1021If it doesn't care, it can just "use AnyEvent" and use it itself, or not 1091If the program is not event-based, it need not do anything special, even
1022do anything special (it does not need to be event-based) and let AnyEvent 1092when it depends on a module that uses an AnyEvent. If the program itself
1023decide which implementation to chose if some module relies on it. 1093uses AnyEvent, but does not care which event loop is used, all it needs
1094to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
1095available loop implementation.
1024 1096
1025If the main program relies on a specific event model - for example, in 1097If the main program relies on a specific event model - for example, in
1026Gtk2 programs you have to rely on the Glib module - you should load the 1098Gtk2 programs you have to rely on the Glib module - you should load the
1027event module before loading AnyEvent or any module that uses it: generally 1099event module before loading AnyEvent or any module that uses it: generally
1028speaking, you should load it as early as possible. The reason is that 1100speaking, you should load it as early as possible. The reason is that
1029modules might create watchers when they are loaded, and AnyEvent will 1101modules might create watchers when they are loaded, and AnyEvent will
1030decide on the event model to use as soon as it creates watchers, and it 1102decide on the event model to use as soon as it creates watchers, and it
1031might chose the wrong one unless you load the correct one yourself. 1103might choose the wrong one unless you load the correct one yourself.
1032 1104
1033You can chose to use a pure-perl implementation by loading the 1105You can chose to use a pure-perl implementation by loading the
1034C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1106C<AnyEvent::Loop> module, which gives you similar behaviour
1035everywhere, but letting AnyEvent chose the model is generally better. 1107everywhere, but letting AnyEvent chose the model is generally better.
1036 1108
1037=head2 MAINLOOP EMULATION 1109=head2 MAINLOOP EMULATION
1038 1110
1039Sometimes (often for short test scripts, or even standalone programs who 1111Sometimes (often for short test scripts, or even standalone programs who
1054=head1 OTHER MODULES 1126=head1 OTHER MODULES
1055 1127
1056The following is a non-exhaustive list of additional modules that use 1128The following is a non-exhaustive list of additional modules that use
1057AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1129AnyEvent as a client and can therefore be mixed easily with other AnyEvent
1058modules and other event loops in the same program. Some of the modules 1130modules and other event loops in the same program. Some of the modules
1059come with AnyEvent, most are available via CPAN. 1131come as part of AnyEvent, the others are available via CPAN.
1060 1132
1061=over 4 1133=over 4
1062 1134
1063=item L<AnyEvent::Util> 1135=item L<AnyEvent::Util>
1064 1136
1065Contains various utility functions that replace often-used but blocking 1137Contains various utility functions that replace often-used blocking
1066functions such as C<inet_aton> by event-/callback-based versions. 1138functions such as C<inet_aton> with event/callback-based versions.
1067 1139
1068=item L<AnyEvent::Socket> 1140=item L<AnyEvent::Socket>
1069 1141
1070Provides various utility functions for (internet protocol) sockets, 1142Provides various utility functions for (internet protocol) sockets,
1071addresses and name resolution. Also functions to create non-blocking tcp 1143addresses and name resolution. Also functions to create non-blocking tcp
1073 1145
1074=item L<AnyEvent::Handle> 1146=item L<AnyEvent::Handle>
1075 1147
1076Provide read and write buffers, manages watchers for reads and writes, 1148Provide read and write buffers, manages watchers for reads and writes,
1077supports raw and formatted I/O, I/O queued and fully transparent and 1149supports raw and formatted I/O, I/O queued and fully transparent and
1078non-blocking SSL/TLS (via L<AnyEvent::TLS>. 1150non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1079 1151
1080=item L<AnyEvent::DNS> 1152=item L<AnyEvent::DNS>
1081 1153
1082Provides rich asynchronous DNS resolver capabilities. 1154Provides rich asynchronous DNS resolver capabilities.
1083 1155
1156=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1157
1158Implement event-based interfaces to the protocols of the same name (for
1159the curious, IGS is the International Go Server and FCP is the Freenet
1160Client Protocol).
1161
1162=item L<AnyEvent::Handle::UDP>
1163
1164Here be danger!
1165
1166As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1167there are so many things wrong with AnyEvent::Handle::UDP, most notably
1168its use of a stream-based API with a protocol that isn't streamable, that
1169the only way to improve it is to delete it.
1170
1171It features data corruption (but typically only under load) and general
1172confusion. On top, the author is not only clueless about UDP but also
1173fact-resistant - some gems of his understanding: "connect doesn't work
1174with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1175packets", "I don't need to implement proper error checking as UDP doesn't
1176support error checking" and so on - he doesn't even understand what's
1177wrong with his module when it is explained to him.
1178
1084=item L<AnyEvent::HTTP> 1179=item L<AnyEvent::DBI>
1085 1180
1086A simple-to-use HTTP library that is capable of making a lot of concurrent 1181Executes L<DBI> requests asynchronously in a proxy process for you,
1087HTTP requests. 1182notifying you in an event-based way when the operation is finished.
1183
1184=item L<AnyEvent::AIO>
1185
1186Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1187toolbox of every event programmer. AnyEvent::AIO transparently fuses
1188L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1189file I/O, and much more.
1088 1190
1089=item L<AnyEvent::HTTPD> 1191=item L<AnyEvent::HTTPD>
1090 1192
1091Provides a simple web application server framework. 1193A simple embedded webserver.
1092 1194
1093=item L<AnyEvent::FastPing> 1195=item L<AnyEvent::FastPing>
1094 1196
1095The fastest ping in the west. 1197The fastest ping in the west.
1096
1097=item L<AnyEvent::DBI>
1098
1099Executes L<DBI> requests asynchronously in a proxy process.
1100
1101=item L<AnyEvent::AIO>
1102
1103Truly asynchronous I/O, should be in the toolbox of every event
1104programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1105together.
1106
1107=item L<AnyEvent::BDB>
1108
1109Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1110L<BDB> and AnyEvent together.
1111
1112=item L<AnyEvent::GPSD>
1113
1114A non-blocking interface to gpsd, a daemon delivering GPS information.
1115
1116=item L<AnyEvent::IRC>
1117
1118AnyEvent based IRC client module family (replacing the older Net::IRC3).
1119
1120=item L<AnyEvent::XMPP>
1121
1122AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1123Net::XMPP2>.
1124
1125=item L<AnyEvent::IGS>
1126
1127A non-blocking interface to the Internet Go Server protocol (used by
1128L<App::IGS>).
1129
1130=item L<Net::FCP>
1131
1132AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1133of AnyEvent.
1134
1135=item L<Event::ExecFlow>
1136
1137High level API for event-based execution flow control.
1138 1198
1139=item L<Coro> 1199=item L<Coro>
1140 1200
1141Has special support for AnyEvent via L<Coro::AnyEvent>. 1201Has special support for AnyEvent via L<Coro::AnyEvent>.
1142 1202
1146 1206
1147package AnyEvent; 1207package AnyEvent;
1148 1208
1149# basically a tuned-down version of common::sense 1209# basically a tuned-down version of common::sense
1150sub common_sense { 1210sub common_sense {
1151 # from common:.sense 1.0 1211 # from common:.sense 3.4
1152 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00"; 1212 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1153 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) 1213 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1154 $^H |= 0x00000600; 1214 $^H |= 0x00000600;
1155} 1215}
1156 1216
1157BEGIN { AnyEvent::common_sense } 1217BEGIN { AnyEvent::common_sense }
1158 1218
1159use Carp (); 1219use Carp ();
1160 1220
1161our $VERSION = '5.251'; 1221our $VERSION = '6.01';
1162our $MODEL; 1222our $MODEL;
1163 1223
1164our $AUTOLOAD;
1165our @ISA; 1224our @ISA;
1166 1225
1167our @REGISTRY; 1226our @REGISTRY;
1168 1227
1169our $VERBOSE; 1228our $VERBOSE;
1170 1229
1171BEGIN { 1230BEGIN {
1172 require "AnyEvent/constants.pl"; 1231 require "AnyEvent/constants.pl";
1173 1232
1174 eval "sub TAINT (){" . (${^TAINT} *1) . "}"; 1233 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1175 1234
1176 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1235 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1177 if ${^TAINT}; 1236 if ${^TAINT};
1178 1237
1179 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1238 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1180
1181} 1239}
1182 1240
1183our $MAX_SIGNAL_LATENCY = 10; 1241our $MAX_SIGNAL_LATENCY = 10;
1184 1242
1185our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1243our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1189 $PROTOCOL{$_} = ++$idx 1247 $PROTOCOL{$_} = ++$idx
1190 for reverse split /\s*,\s*/, 1248 for reverse split /\s*,\s*/,
1191 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1249 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1192} 1250}
1193 1251
1252our @post_detect;
1253
1254sub post_detect(&) {
1255 my ($cb) = @_;
1256
1257 push @post_detect, $cb;
1258
1259 defined wantarray
1260 ? bless \$cb, "AnyEvent::Util::postdetect"
1261 : ()
1262}
1263
1264sub AnyEvent::Util::postdetect::DESTROY {
1265 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1266}
1267
1268our $POSTPONE_W;
1269our @POSTPONE;
1270
1271sub _postpone_exec {
1272 undef $POSTPONE_W;
1273
1274 &{ shift @POSTPONE }
1275 while @POSTPONE;
1276}
1277
1278sub postpone(&) {
1279 push @POSTPONE, shift;
1280
1281 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1282
1283 ()
1284}
1285
1286sub log($$;@) {
1287 require AnyEvent::Log;
1288 # AnyEvent::Log overwrites this function
1289 goto &log;
1290}
1291
1194my @models = ( 1292our @models = (
1195 [EV:: => AnyEvent::Impl::EV:: , 1], 1293 [EV:: => AnyEvent::Impl::EV:: , 1],
1196 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1294 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1197 # everything below here will not (normally) be autoprobed 1295 # everything below here will not (normally) be autoprobed
1198 # as the pureperl backend should work everywhere 1296 # as the pure perl backend should work everywhere
1199 # and is usually faster 1297 # and is usually faster
1200 [Event:: => AnyEvent::Impl::Event::, 1], 1298 [Event:: => AnyEvent::Impl::Event::, 1],
1201 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1299 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1202 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1300 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1203 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1301 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1204 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1302 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1205 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1303 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1206 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1304 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1207 [Wx:: => AnyEvent::Impl::POE::], 1305 [Wx:: => AnyEvent::Impl::POE::],
1208 [Prima:: => AnyEvent::Impl::POE::], 1306 [Prima:: => AnyEvent::Impl::POE::],
1209 # IO::Async is just too broken - we would need workarounds for its 1307 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1210 # byzantine signal and broken child handling, among others. 1308 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1211 # IO::Async is rather hard to detect, as it doesn't have any 1309 [FLTK:: => AnyEvent::Impl::FLTK2::],
1212 # obvious default class.
1213 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1214 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1215 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1216 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1217); 1310);
1218 1311
1219our %method = map +($_ => 1), 1312our @isa_hook;
1313
1314sub _isa_set {
1315 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1316
1317 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1318 for 1 .. $#pkg;
1319
1320 grep $_ && $_->[1], @isa_hook
1321 and AE::_reset ();
1322}
1323
1324# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1325sub _isa_hook($$;$) {
1326 my ($i, $pkg, $reset_ae) = @_;
1327
1328 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1329
1330 _isa_set;
1331}
1332
1333# all autoloaded methods reserve the complete glob, not just the method slot.
1334# due to bugs in perls method cache implementation.
1220 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1335our @methods = qw(io timer time now now_update signal child idle condvar);
1221
1222our @post_detect;
1223
1224sub post_detect(&) {
1225 my ($cb) = @_;
1226
1227 if ($MODEL) {
1228 $cb->();
1229
1230 undef
1231 } else {
1232 push @post_detect, $cb;
1233
1234 defined wantarray
1235 ? bless \$cb, "AnyEvent::Util::postdetect"
1236 : ()
1237 }
1238}
1239
1240sub AnyEvent::Util::postdetect::DESTROY {
1241 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1242}
1243 1336
1244sub detect() { 1337sub detect() {
1338 return $MODEL if $MODEL; # some programs keep references to detect
1339
1340 local $!; # for good measure
1341 local $SIG{__DIE__}; # we use eval
1342
1245 # free some memory 1343 # free some memory
1246 *detect = sub () { $MODEL }; 1344 *detect = sub () { $MODEL };
1345 # undef &func doesn't correctly update the method cache. grmbl.
1346 # so we delete the whole glob. grmbl.
1347 # otoh, perl doesn't let me undef an active usb, but it lets me free
1348 # a glob with an active sub. hrm. i hope it works, but perl is
1349 # usually buggy in this department. sigh.
1350 delete @{"AnyEvent::"}{@methods};
1351 undef @methods;
1247 1352
1248 local $!; # for good measure
1249 local $SIG{__DIE__};
1250
1251 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1353 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1252 my $model = "AnyEvent::Impl::$1"; 1354 my $model = $1;
1355 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1253 if (eval "require $model") { 1356 if (eval "require $model") {
1254 $MODEL = $model; 1357 $MODEL = $model;
1255 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; 1358 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."
1359 if $VERBOSE >= 7;
1256 } else { 1360 } else {
1257 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1361 AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1258 } 1362 }
1259 } 1363 }
1260 1364
1261 # check for already loaded models 1365 # check for already loaded models
1262 unless ($MODEL) { 1366 unless ($MODEL) {
1263 for (@REGISTRY, @models) { 1367 for (@REGISTRY, @models) {
1264 my ($package, $model) = @$_; 1368 my ($package, $model) = @$_;
1265 if (${"$package\::VERSION"} > 0) { 1369 if (${"$package\::VERSION"} > 0) {
1266 if (eval "require $model") { 1370 if (eval "require $model") {
1267 $MODEL = $model; 1371 $MODEL = $model;
1268 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1372 AnyEvent::log 7 => "autodetected model '$model', using it."
1373 if $VERBOSE >= 7;
1269 last; 1374 last;
1270 } 1375 }
1271 } 1376 }
1272 } 1377 }
1273 1378
1280 and eval "require $package" 1385 and eval "require $package"
1281 and ${"$package\::VERSION"} > 0 1386 and ${"$package\::VERSION"} > 0
1282 and eval "require $model" 1387 and eval "require $model"
1283 ) { 1388 ) {
1284 $MODEL = $model; 1389 $MODEL = $model;
1285 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; 1390 AnyEvent::log 7 => "autoloaded model '$model', using it."
1391 if $VERBOSE >= 7;
1286 last; 1392 last;
1287 } 1393 }
1288 } 1394 }
1289 1395
1290 $MODEL 1396 $MODEL
1291 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1397 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1292 } 1398 }
1293 } 1399 }
1294 1400
1295 @models = (); # free probe data 1401 # free memory only needed for probing
1402 undef @models;
1403 undef @REGISTRY;
1296 1404
1297 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1405 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1298 unshift @ISA, $MODEL;
1299 1406
1300 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; 1407 # now nuke some methods that are overridden by the backend.
1408 # SUPER usage is not allowed in these.
1409 for (qw(time signal child idle)) {
1410 undef &{"AnyEvent::Base::$_"}
1411 if defined &{"$MODEL\::$_"};
1412 }
1413
1414 _isa_set;
1415
1416 # we're officially open!
1417
1418 if ($ENV{PERL_ANYEVENT_STRICT}) {
1419 require AnyEvent::Strict;
1420 }
1421
1422 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1423 require AnyEvent::Debug;
1424 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1425 }
1426
1427 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1428 require AnyEvent::Socket;
1429 require AnyEvent::Debug;
1430
1431 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1432 $shell =~ s/\$\$/$$/g;
1433
1434 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1435 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1436 }
1437
1438 # now the anyevent environment is set up as the user told us to, so
1439 # call the actual user code - post detects
1301 1440
1302 (shift @post_detect)->() while @post_detect; 1441 (shift @post_detect)->() while @post_detect;
1442 undef @post_detect;
1443
1444 *post_detect = sub(&) {
1445 shift->();
1446
1447 undef
1448 };
1303 1449
1304 $MODEL 1450 $MODEL
1305} 1451}
1306 1452
1307sub AUTOLOAD { 1453for my $name (@methods) {
1308 (my $func = $AUTOLOAD) =~ s/.*://; 1454 *$name = sub {
1309
1310 $method{$func}
1311 or Carp::croak "$func: not a valid AnyEvent class method";
1312
1313 detect; 1455 detect;
1314 1456 # we use goto because
1315 my $class = shift; 1457 # a) it makes the thunk more transparent
1316 $class->$func (@_); 1458 # b) it allows us to delete the thunk later
1459 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1460 };
1317} 1461}
1318 1462
1319# utility function to dup a filehandle. this is used by many backends 1463# utility function to dup a filehandle. this is used by many backends
1320# to support binding more than one watcher per filehandle (they usually 1464# to support binding more than one watcher per filehandle (they usually
1321# allow only one watcher per fd, so we dup it to get a different one). 1465# allow only one watcher per fd, so we dup it to get a different one).
1335 1479
1336=head1 SIMPLIFIED AE API 1480=head1 SIMPLIFIED AE API
1337 1481
1338Starting with version 5.0, AnyEvent officially supports a second, much 1482Starting with version 5.0, AnyEvent officially supports a second, much
1339simpler, API that is designed to reduce the calling, typing and memory 1483simpler, API that is designed to reduce the calling, typing and memory
1340overhead. 1484overhead by using function call syntax and a fixed number of parameters.
1341 1485
1342See the L<AE> manpage for details. 1486See the L<AE> manpage for details.
1343 1487
1344=cut 1488=cut
1345 1489
1346package AE; 1490package AE;
1347 1491
1348our $VERSION = $AnyEvent::VERSION; 1492our $VERSION = $AnyEvent::VERSION;
1349 1493
1494sub _reset() {
1495 eval q{
1496 # fall back to the main API by default - backends and AnyEvent::Base
1497 # implementations can overwrite these.
1498
1350sub io($$$) { 1499 sub io($$$) {
1351 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1500 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1352} 1501 }
1353 1502
1354sub timer($$$) { 1503 sub timer($$$) {
1355 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1504 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1356} 1505 }
1357 1506
1358sub signal($$) { 1507 sub signal($$) {
1359 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1508 AnyEvent->signal (signal => $_[0], cb => $_[1])
1360} 1509 }
1361 1510
1362sub child($$) { 1511 sub child($$) {
1363 AnyEvent->child (pid => $_[0], cb => $_[1]) 1512 AnyEvent->child (pid => $_[0], cb => $_[1])
1364} 1513 }
1365 1514
1366sub idle($) { 1515 sub idle($) {
1367 AnyEvent->idle (cb => $_[0]) 1516 AnyEvent->idle (cb => $_[0]);
1368} 1517 }
1369 1518
1370sub cv(;&) { 1519 sub cv(;&) {
1371 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1520 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1372} 1521 }
1373 1522
1374sub now() { 1523 sub now() {
1375 AnyEvent->now 1524 AnyEvent->now
1376} 1525 }
1377 1526
1378sub now_update() { 1527 sub now_update() {
1379 AnyEvent->now_update 1528 AnyEvent->now_update
1380} 1529 }
1381 1530
1382sub time() { 1531 sub time() {
1383 AnyEvent->time 1532 AnyEvent->time
1533 }
1534
1535 *postpone = \&AnyEvent::postpone;
1536 *log = \&AnyEvent::log;
1537 };
1538 die if $@;
1384} 1539}
1540
1541BEGIN { _reset }
1385 1542
1386package AnyEvent::Base; 1543package AnyEvent::Base;
1387 1544
1388# default implementations for many methods 1545# default implementations for many methods
1389 1546
1390sub _time() { 1547sub time {
1391 eval q{ # poor man's autoloading 1548 eval q{ # poor man's autoloading {}
1392 # probe for availability of Time::HiRes 1549 # probe for availability of Time::HiRes
1393 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1550 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1394 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1551 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."
1552 if $AnyEvent::VERBOSE >= 8;
1553 *time = sub { Time::HiRes::time () };
1395 *_time = \&Time::HiRes::time; 1554 *AE::time = \& Time::HiRes::time ;
1396 # if (eval "use POSIX (); (POSIX::times())... 1555 # if (eval "use POSIX (); (POSIX::times())...
1397 } else { 1556 } else {
1398 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1557 AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
1399 *_time = sub (){ time }; # epic fail 1558 *time = sub { CORE::time };
1559 *AE::time = sub (){ CORE::time };
1400 } 1560 }
1561
1562 *now = \&time;
1401 }; 1563 };
1402 die if $@; 1564 die if $@;
1403 1565
1404 &_time 1566 &time
1405} 1567}
1406 1568
1407sub time { _time } 1569*now = \&time;
1408sub now { _time }
1409sub now_update { } 1570sub now_update { }
1410 1571
1572sub _poll {
1573 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1574}
1575
1411# default implementation for ->condvar 1576# default implementation for ->condvar
1577# in fact, the default should not be overwritten
1412 1578
1413sub condvar { 1579sub condvar {
1580 eval q{ # poor man's autoloading {}
1581 *condvar = sub {
1414 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1582 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1583 };
1584
1585 *AE::cv = sub (;&) {
1586 bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
1587 };
1588 };
1589 die if $@;
1590
1591 &condvar
1415} 1592}
1416 1593
1417# default implementation for ->signal 1594# default implementation for ->signal
1418 1595
1419our $HAVE_ASYNC_INTERRUPT; 1596our $HAVE_ASYNC_INTERRUPT;
1449 undef $SIG_TW 1626 undef $SIG_TW
1450 unless --$SIG_COUNT; 1627 unless --$SIG_COUNT;
1451} 1628}
1452 1629
1453our $_sig_name_init; $_sig_name_init = sub { 1630our $_sig_name_init; $_sig_name_init = sub {
1454 eval q{ # poor man's autoloading 1631 eval q{ # poor man's autoloading {}
1455 undef $_sig_name_init; 1632 undef $_sig_name_init;
1456 1633
1457 if (_have_async_interrupt) { 1634 if (_have_async_interrupt) {
1458 *sig2num = \&Async::Interrupt::sig2num; 1635 *sig2num = \&Async::Interrupt::sig2num;
1459 *sig2name = \&Async::Interrupt::sig2name; 1636 *sig2name = \&Async::Interrupt::sig2name;
1483 1660
1484sub signal { 1661sub signal {
1485 eval q{ # poor man's autoloading {} 1662 eval q{ # poor man's autoloading {}
1486 # probe for availability of Async::Interrupt 1663 # probe for availability of Async::Interrupt
1487 if (_have_async_interrupt) { 1664 if (_have_async_interrupt) {
1488 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1665 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."
1666 if $AnyEvent::VERBOSE >= 8;
1489 1667
1490 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1668 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1491 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1669 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1492 1670
1493 } else { 1671 } else {
1494 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1672 AnyEvent::log 8 => "using emulated perl signal handling with latency timer."
1673 if $AnyEvent::VERBOSE >= 8;
1495 1674
1496 if (AnyEvent::WIN32) { 1675 if (AnyEvent::WIN32) {
1497 require AnyEvent::Util; 1676 require AnyEvent::Util;
1498 1677
1499 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1678 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1513 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1692 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1514 1693
1515 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec; 1694 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1516 } 1695 }
1517 1696
1518 *signal = sub { 1697 *signal = $HAVE_ASYNC_INTERRUPT
1698 ? sub {
1519 my (undef, %arg) = @_; 1699 my (undef, %arg) = @_;
1520 1700
1521 my $signal = uc $arg{signal}
1522 or Carp::croak "required option 'signal' is missing";
1523
1524 if ($HAVE_ASYNC_INTERRUPT) {
1525 # async::interrupt 1701 # async::interrupt
1526
1527 $signal = sig2num $signal; 1702 my $signal = sig2num $arg{signal};
1528 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1703 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1529 1704
1530 $SIG_ASY{$signal} ||= new Async::Interrupt 1705 $SIG_ASY{$signal} ||= new Async::Interrupt
1531 cb => sub { undef $SIG_EV{$signal} }, 1706 cb => sub { undef $SIG_EV{$signal} },
1532 signal => $signal, 1707 signal => $signal,
1533 pipe => [$SIGPIPE_R->filenos], 1708 pipe => [$SIGPIPE_R->filenos],
1534 pipe_autodrain => 0, 1709 pipe_autodrain => 0,
1535 ; 1710 ;
1536 1711
1537 } else { 1712 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1713 }
1714 : sub {
1715 my (undef, %arg) = @_;
1716
1538 # pure perl 1717 # pure perl
1539
1540 # AE::Util has been loaded in signal
1541 $signal = sig2name $signal; 1718 my $signal = sig2name $arg{signal};
1542 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1719 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1543 1720
1544 $SIG{$signal} ||= sub { 1721 $SIG{$signal} ||= sub {
1545 local $!; 1722 local $!;
1546 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1723 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1547 undef $SIG_EV{$signal}; 1724 undef $SIG_EV{$signal};
1548 }; 1725 };
1549 1726
1550 # can't do signal processing without introducing races in pure perl, 1727 # can't do signal processing without introducing races in pure perl,
1551 # so limit the signal latency. 1728 # so limit the signal latency.
1552 _sig_add; 1729 _sig_add;
1553 }
1554 1730
1555 bless [$signal, $arg{cb}], "AnyEvent::Base::signal" 1731 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1732 }
1556 }; 1733 ;
1557 1734
1558 *AnyEvent::Base::signal::DESTROY = sub { 1735 *AnyEvent::Base::signal::DESTROY = sub {
1559 my ($signal, $cb) = @{$_[0]}; 1736 my ($signal, $cb) = @{$_[0]};
1560 1737
1561 _sig_del; 1738 _sig_del;
1577 : sysread $SIGPIPE_R, (my $dummy), 9; 1754 : sysread $SIGPIPE_R, (my $dummy), 9;
1578 1755
1579 while (%SIG_EV) { 1756 while (%SIG_EV) {
1580 for (keys %SIG_EV) { 1757 for (keys %SIG_EV) {
1581 delete $SIG_EV{$_}; 1758 delete $SIG_EV{$_};
1582 $_->() for values %{ $SIG_CB{$_} || {} }; 1759 &$_ for values %{ $SIG_CB{$_} || {} };
1583 } 1760 }
1584 } 1761 }
1585 }; 1762 };
1586 }; 1763 };
1587 die if $@; 1764 die if $@;
1592# default implementation for ->child 1769# default implementation for ->child
1593 1770
1594our %PID_CB; 1771our %PID_CB;
1595our $CHLD_W; 1772our $CHLD_W;
1596our $CHLD_DELAY_W; 1773our $CHLD_DELAY_W;
1597our $WNOHANG;
1598 1774
1599# used by many Impl's 1775# used by many Impl's
1600sub _emit_childstatus($$) { 1776sub _emit_childstatus($$) {
1601 my (undef, $rpid, $rstatus) = @_; 1777 my (undef, $rpid, $rstatus) = @_;
1602 1778
1609 eval q{ # poor man's autoloading {} 1785 eval q{ # poor man's autoloading {}
1610 *_sigchld = sub { 1786 *_sigchld = sub {
1611 my $pid; 1787 my $pid;
1612 1788
1613 AnyEvent->_emit_childstatus ($pid, $?) 1789 AnyEvent->_emit_childstatus ($pid, $?)
1614 while ($pid = waitpid -1, $WNOHANG) > 0; 1790 while ($pid = waitpid -1, WNOHANG) > 0;
1615 }; 1791 };
1616 1792
1617 *child = sub { 1793 *child = sub {
1618 my (undef, %arg) = @_; 1794 my (undef, %arg) = @_;
1619 1795
1620 defined (my $pid = $arg{pid} + 0) 1796 my $pid = $arg{pid};
1621 or Carp::croak "required option 'pid' is missing"; 1797 my $cb = $arg{cb};
1622 1798
1623 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1799 $PID_CB{$pid}{$cb+0} = $cb;
1624
1625 # WNOHANG is almost cetrainly 1 everywhere
1626 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1627 ? 1
1628 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1629 1800
1630 unless ($CHLD_W) { 1801 unless ($CHLD_W) {
1631 $CHLD_W = AE::signal CHLD => \&_sigchld; 1802 $CHLD_W = AE::signal CHLD => \&_sigchld;
1632 # child could be a zombie already, so make at least one round 1803 # child could be a zombie already, so make at least one round
1633 &_sigchld; 1804 &_sigchld;
1634 } 1805 }
1635 1806
1636 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1807 bless [$pid, $cb+0], "AnyEvent::Base::child"
1637 }; 1808 };
1638 1809
1639 *AnyEvent::Base::child::DESTROY = sub { 1810 *AnyEvent::Base::child::DESTROY = sub {
1640 my ($pid, $cb) = @{$_[0]}; 1811 my ($pid, $icb) = @{$_[0]};
1641 1812
1642 delete $PID_CB{$pid}{$cb}; 1813 delete $PID_CB{$pid}{$icb};
1643 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1814 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1644 1815
1645 undef $CHLD_W unless keys %PID_CB; 1816 undef $CHLD_W unless keys %PID_CB;
1646 }; 1817 };
1647 }; 1818 };
1660 1831
1661 my ($cb, $w, $rcb) = $arg{cb}; 1832 my ($cb, $w, $rcb) = $arg{cb};
1662 1833
1663 $rcb = sub { 1834 $rcb = sub {
1664 if ($cb) { 1835 if ($cb) {
1665 $w = _time; 1836 $w = AE::time;
1666 &$cb; 1837 &$cb;
1667 $w = _time - $w; 1838 $w = AE::time - $w;
1668 1839
1669 # never use more then 50% of the time for the idle watcher, 1840 # never use more then 50% of the time for the idle watcher,
1670 # within some limits 1841 # within some limits
1671 $w = 0.0001 if $w < 0.0001; 1842 $w = 0.0001 if $w < 0.0001;
1672 $w = 5 if $w > 5; 1843 $w = 5 if $w > 5;
1695 1866
1696package AnyEvent::CondVar; 1867package AnyEvent::CondVar;
1697 1868
1698our @ISA = AnyEvent::CondVar::Base::; 1869our @ISA = AnyEvent::CondVar::Base::;
1699 1870
1871# only to be used for subclassing
1872sub new {
1873 my $class = shift;
1874 bless AnyEvent->condvar (@_), $class
1875}
1876
1700package AnyEvent::CondVar::Base; 1877package AnyEvent::CondVar::Base;
1701 1878
1702#use overload 1879#use overload
1703# '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1880# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1704# fallback => 1; 1881# fallback => 1;
1713 1890
1714sub _send { 1891sub _send {
1715 # nop 1892 # nop
1716} 1893}
1717 1894
1895sub _wait {
1896 AnyEvent->_poll until $_[0]{_ae_sent};
1897}
1898
1718sub send { 1899sub send {
1719 my $cv = shift; 1900 my $cv = shift;
1720 $cv->{_ae_sent} = [@_]; 1901 $cv->{_ae_sent} = [@_];
1721 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1902 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1722 $cv->_send; 1903 $cv->_send;
1729 1910
1730sub ready { 1911sub ready {
1731 $_[0]{_ae_sent} 1912 $_[0]{_ae_sent}
1732} 1913}
1733 1914
1734sub _wait {
1735 $WAITING
1736 and !$_[0]{_ae_sent}
1737 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1738
1739 local $WAITING = 1;
1740 AnyEvent->one_event while !$_[0]{_ae_sent};
1741}
1742
1743sub recv { 1915sub recv {
1916 unless ($_[0]{_ae_sent}) {
1917 $WAITING
1918 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1919
1920 local $WAITING = 1;
1744 $_[0]->_wait; 1921 $_[0]->_wait;
1922 }
1745 1923
1746 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1924 $_[0]{_ae_croak}
1747 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1925 and Carp::croak $_[0]{_ae_croak};
1926
1927 wantarray
1928 ? @{ $_[0]{_ae_sent} }
1929 : $_[0]{_ae_sent}[0]
1748} 1930}
1749 1931
1750sub cb { 1932sub cb {
1751 my $cv = shift; 1933 my $cv = shift;
1752 1934
1768 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 1950 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1769} 1951}
1770 1952
1771# undocumented/compatibility with pre-3.4 1953# undocumented/compatibility with pre-3.4
1772*broadcast = \&send; 1954*broadcast = \&send;
1773*wait = \&_wait; 1955*wait = \&recv;
1774 1956
1775=head1 ERROR AND EXCEPTION HANDLING 1957=head1 ERROR AND EXCEPTION HANDLING
1776 1958
1777In general, AnyEvent does not do any error handling - it relies on the 1959In general, AnyEvent does not do any error handling - it relies on the
1778caller to do that if required. The L<AnyEvent::Strict> module (see also 1960caller to do that if required. The L<AnyEvent::Strict> module (see also
1805 1987
1806By default, AnyEvent will be completely silent except in fatal 1988By default, AnyEvent will be completely silent except in fatal
1807conditions. You can set this environment variable to make AnyEvent more 1989conditions. You can set this environment variable to make AnyEvent more
1808talkative. 1990talkative.
1809 1991
1810When set to C<1> or higher, causes AnyEvent to warn about unexpected 1992When set to C<5> or higher, causes AnyEvent to warn about unexpected
1811conditions, such as not being able to load the event model specified by 1993conditions, such as not being able to load the event model specified by
1812C<PERL_ANYEVENT_MODEL>. 1994C<PERL_ANYEVENT_MODEL>.
1813 1995
1814When set to C<2> or higher, cause AnyEvent to report to STDERR which event 1996When set to C<7> or higher, cause AnyEvent to report to STDERR which event
1815model it chooses. 1997model it chooses.
1816 1998
1817When set to C<8> or higher, then AnyEvent will report extra information on 1999When set to C<8> or higher, then AnyEvent will report extra information on
1818which optional modules it loads and how it implements certain features. 2000which optional modules it loads and how it implements certain features.
1819 2001
1825check the arguments passed to most method calls. If it finds any problems, 2007check the arguments passed to most method calls. If it finds any problems,
1826it will croak. 2008it will croak.
1827 2009
1828In other words, enables "strict" mode. 2010In other words, enables "strict" mode.
1829 2011
1830Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense> 2012Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1831>>, it is definitely recommended to keep it off in production. Keeping 2013>>, it is definitely recommended to keep it off in production. Keeping
1832C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2014C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1833can be very useful, however. 2015can be very useful, however.
1834 2016
2017=item C<PERL_ANYEVENT_DEBUG_SHELL>
2018
2019If this env variable is set, then its contents will be interpreted by
2020C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
2021C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
2022that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
2023
2024This takes place when the first watcher is created.
2025
2026For example, to bind a debug shell on a unix domain socket in
2027F<< /tmp/debug<pid>.sock >>, you could use this:
2028
2029 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2030
2031Note that creating sockets in F</tmp> is very unsafe on multiuser
2032systems.
2033
2034=item C<PERL_ANYEVENT_DEBUG_WRAP>
2035
2036Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2037debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2038
1835=item C<PERL_ANYEVENT_MODEL> 2039=item C<PERL_ANYEVENT_MODEL>
1836 2040
1837This can be used to specify the event model to be used by AnyEvent, before 2041This can be used to specify the event model to be used by AnyEvent, before
1838auto detection and -probing kicks in. It must be a string consisting 2042auto detection and -probing kicks in.
1839entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2043
2044It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2045or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1840and the resulting module name is loaded and if the load was successful, 2046resulting module name is loaded and - if the load was successful - used as
1841used as event model. If it fails to load AnyEvent will proceed with 2047event model backend. If it fails to load then AnyEvent will proceed with
1842auto detection and -probing. 2048auto detection and -probing.
1843 2049
1844This functionality might change in future versions. 2050If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2051nothing gets prepended and the module name is used as-is (hint: C<::> at
2052the end of a string designates a module name and quotes it appropriately).
1845 2053
1846For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 2054For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1847could start your program like this: 2055could start your program like this:
1848 2056
1849 PERL_ANYEVENT_MODEL=Perl perl ... 2057 PERL_ANYEVENT_MODEL=Perl perl ...
1850 2058
1851=item C<PERL_ANYEVENT_PROTOCOLS> 2059=item C<PERL_ANYEVENT_PROTOCOLS>
2057 2265
2058The actual code goes further and collects all errors (C<die>s, exceptions) 2266The actual code goes further and collects all errors (C<die>s, exceptions)
2059that occurred during request processing. The C<result> method detects 2267that occurred during request processing. The C<result> method detects
2060whether an exception as thrown (it is stored inside the $txn object) 2268whether an exception as thrown (it is stored inside the $txn object)
2061and just throws the exception, which means connection errors and other 2269and just throws the exception, which means connection errors and other
2062problems get reported tot he code that tries to use the result, not in a 2270problems get reported to the code that tries to use the result, not in a
2063random callback. 2271random callback.
2064 2272
2065All of this enables the following usage styles: 2273All of this enables the following usage styles:
2066 2274
20671. Blocking: 22751. Blocking:
2241(even when used without AnyEvent), but most event loops have acceptable 2449(even when used without AnyEvent), but most event loops have acceptable
2242performance with or without AnyEvent. 2450performance with or without AnyEvent.
2243 2451
2244=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2452=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2245the actual event loop, only with extremely fast event loops such as EV 2453the actual event loop, only with extremely fast event loops such as EV
2246adds AnyEvent significant overhead. 2454does AnyEvent add significant overhead.
2247 2455
2248=item * You should avoid POE like the plague if you want performance or 2456=item * You should avoid POE like the plague if you want performance or
2249reasonable memory usage. 2457reasonable memory usage.
2250 2458
2251=back 2459=back
2481 unless defined $SIG{PIPE}; 2689 unless defined $SIG{PIPE};
2482 2690
2483=head1 RECOMMENDED/OPTIONAL MODULES 2691=head1 RECOMMENDED/OPTIONAL MODULES
2484 2692
2485One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and 2693One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2486it's built-in modules) are required to use it. 2694its built-in modules) are required to use it.
2487 2695
2488That does not mean that AnyEvent won't take advantage of some additional 2696That does not mean that AnyEvent won't take advantage of some additional
2489modules if they are installed. 2697modules if they are installed.
2490 2698
2491This section explains which additional modules will be used, and how they 2699This section explains which additional modules will be used, and how they
2549the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. 2757the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2550 2758
2551=item L<Time::HiRes> 2759=item L<Time::HiRes>
2552 2760
2553This module is part of perl since release 5.008. It will be used when the 2761This module is part of perl since release 5.008. It will be used when the
2554chosen event library does not come with a timing source on it's own. The 2762chosen event library does not come with a timing source of its own. The
2555pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2763pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2556try to use a monotonic clock for timing stability. 2764try to use a monotonic clock for timing stability.
2557 2765
2558=back 2766=back
2559 2767
2560 2768
2622pronounced). 2830pronounced).
2623 2831
2624 2832
2625=head1 SEE ALSO 2833=head1 SEE ALSO
2626 2834
2627Utility functions: L<AnyEvent::Util>. 2835Tutorial/Introduction: L<AnyEvent::Intro>.
2628 2836
2629Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2837FAQ: L<AnyEvent::FAQ>.
2630L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2838
2839Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2840(simply logging).
2841
2842Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2843L<AnyEvent::Debug> (interactive shell, watcher tracing).
2844
2845Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2846L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
2847L<Qt>, L<POE>, L<FLTK>.
2631 2848
2632Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2849Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2633L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2850L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2634L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2851L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2635L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2852L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
2853L<AnyEvent::Impl::FLTK>.
2636 2854
2637Non-blocking file handles, sockets, TCP clients and 2855Non-blocking handles, pipes, stream sockets, TCP clients and
2638servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2856servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2639 2857
2640Asynchronous DNS: L<AnyEvent::DNS>. 2858Asynchronous DNS: L<AnyEvent::DNS>.
2641 2859
2642Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, 2860Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2643L<Coro::Event>,
2644 2861
2645Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, 2862Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2646L<AnyEvent::HTTP>. 2863L<AnyEvent::HTTP>.
2647 2864
2648 2865
2649=head1 AUTHOR 2866=head1 AUTHOR
2650 2867

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines