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.272 by root, Thu Aug 6 13:31:01 2009 UTC vs.
Revision 1.358 by root, Sat Aug 13 02:35:32 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
365When this is the case, you can call this method, which will update the 369When this is the case, you can call this method, which will update the
366event loop's idea of "current time". 370event loop's idea of "current time".
371
372A typical example would be a script in a web server (e.g. C<mod_perl>) -
373when mod_perl executes the script, then the event loop will have the wrong
374idea about the "current time" (being potentially far in the past, when the
375script ran the last time). In that case you should arrange a call to C<<
376AnyEvent->now_update >> each time the web server process wakes up again
377(e.g. at the start of your script, or in a handler).
367 378
368Note that updating the time I<might> cause some events to be handled. 379Note that updating the time I<might> cause some events to be handled.
369 380
370=back 381=back
371 382
396 407
397Example: exit on SIGINT 408Example: exit on SIGINT
398 409
399 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 410 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
400 411
412=head3 Restart Behaviour
413
414While restart behaviour is up to the event loop implementation, most will
415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
416pure perl implementation).
417
418=head3 Safe/Unsafe Signals
419
420Perl signals can be either "safe" (synchronous to opcode handling) or
421"unsafe" (asynchronous) - the former might get delayed indefinitely, the
422latter might corrupt your memory.
423
424AnyEvent signal handlers are, in addition, synchronous to the event loop,
425i.e. they will not interrupt your running perl program but will only be
426called as part of the normal event handling (just like timer, I/O etc.
427callbacks, too).
428
401=head3 Signal Races, Delays and Workarounds 429=head3 Signal Races, Delays and Workarounds
402 430
403Many 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
404callbacks 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
405do race-free signal handling in perl, requiring C libraries for 433do race-free signal handling in perl, requiring C libraries for
406this. 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,
407signals 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
408specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This 436specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
409variable can be changed only before the first signal watcher is created, 437variable can be changed only before the first signal watcher is created,
410and should be left alone otherwise. This variable determines how often 438and should be left alone otherwise. This variable determines how often
411AnyEvent 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
413saving. 441saving.
414 442
415All these problems can be avoided by installing the optional 443All these problems can be avoided by installing the optional
416L<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
417work 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>
418(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
419one-second latency). For those, you just have to suffer the delays. 447one-second latency). For those, you just have to suffer the delays.
420 448
421=head2 CHILD PROCESS WATCHERS 449=head2 CHILD PROCESS WATCHERS
422 450
423 $w = AnyEvent->child (pid => <process id>, cb => <callback>); 451 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
424 452
425You 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.
426 454
427The 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,
428using 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
429croak). The watcher will be triggered only when the child process has 457croak). The watcher will be triggered only when the child process has
430finished and an exit status is available, not on any trace events 458finished and an exit status is available, not on any trace events
431(stopped/continued). 459(stopped/continued).
432 460
454thing 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
455watcher before you C<fork> the child (alternatively, you can call 483watcher before you C<fork> the child (alternatively, you can call
456C<AnyEvent::detect>). 484C<AnyEvent::detect>).
457 485
458As 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
459emulated 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
460mentioned in the description of signal watchers apply. 488problems mentioned in the description of signal watchers apply.
461 489
462Example: fork a process and wait for it 490Example: fork a process and wait for it
463 491
464 my $done = AnyEvent->condvar; 492 my $done = AnyEvent->condvar;
465 493
479 507
480=head2 IDLE WATCHERS 508=head2 IDLE WATCHERS
481 509
482 $w = AnyEvent->idle (cb => <callback>); 510 $w = AnyEvent->idle (cb => <callback>);
483 511
484Sometimes there is a need to do something, but it is not so important 512This will repeatedly invoke the callback after the process becomes idle,
485to do it instantly, but only when there is nothing better to do. This 513until either the watcher is destroyed or new events have been detected.
486"nothing better to do" is usually defined to be "no other events need
487attention by the event loop".
488 514
489Idle watchers ideally get invoked when the event loop has nothing 515Idle watchers are useful when there is a need to do something, but it
490better to do, just before it would block the process to wait for new 516is not so important (or wise) to do it instantly. The callback will be
491events. Instead of blocking, the idle watcher is invoked. 517invoked only when there is "nothing better to do", which is usually
518defined as "all outstanding events have been handled and no new events
519have been detected". That means that idle watchers ideally get invoked
520when the event loop has just polled for new events but none have been
521detected. Instead of blocking to wait for more events, the idle watchers
522will be invoked.
492 523
493Most event loops unfortunately do not really support idle watchers (only 524Unfortunately, most event loops do not really support idle watchers (only
494EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent 525EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
495will simply call the callback "from time to time". 526will simply call the callback "from time to time".
496 527
497Example: read lines from STDIN, but only process them when the 528Example: read lines from STDIN, but only process them when the
498program is otherwise idle: 529program is otherwise idle:
526will actively watch for new events and call your callbacks. 557will actively watch for new events and call your callbacks.
527 558
528AnyEvent is slightly different: it expects somebody else to run the event 559AnyEvent is slightly different: it expects somebody else to run the event
529loop 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).
530 561
531The instrument to do that is called a "condition variable", so called 562The tool to do that is called a "condition variable", so called because
532because they represent a condition that must become true. 563they represent a condition that must become true.
533 564
534Now 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.
535 566
536Condition variables can be created by calling the C<< AnyEvent->condvar 567Condition variables can be created by calling the C<< AnyEvent->condvar
537>> method, usually without arguments. The only argument pair allowed is 568>> method, usually without arguments. The only argument pair allowed is
542After creation, the condition variable is "false" until it becomes "true" 573After creation, the condition variable is "false" until it becomes "true"
543by 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
544were 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<<
545->send >> method). 576->send >> method).
546 577
547Condition variables are similar to callbacks, except that you can 578Since condition variables are the most complex part of the AnyEvent API, here are
548optionally 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:
549in time where multiple outstanding events have been processed. And yet 580
550another way to call them is transactions - each condition variable can be 581=over 4
551used to represent a transaction, which finishes at some point and delivers 582
552a 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
553compute/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
554 601
555Condition variables are very useful to signal that something has finished, 602Condition variables are very useful to signal that something has finished,
556for example, if you write a module that does asynchronous http requests, 603for example, if you write a module that does asynchronous http requests,
557then a condition variable would be the ideal candidate to signal the 604then a condition variable would be the ideal candidate to signal the
558availability of results. The user can either act when the callback is 605availability of results. The user can either act when the callback is
571 618
572Condition variables are represented by hash refs in perl, and the keys 619Condition variables are represented by hash refs in perl, and the keys
573used 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
574easy (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
575AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call 622AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
576it's C<new> method in your own C<new> method. 623its C<new> method in your own C<new> method.
577 624
578There are two "sides" to a condition variable - the "producer side" which 625There are two "sides" to a condition variable - the "producer side" which
579eventually calls C<< -> send >>, and the "consumer side", which waits 626eventually calls C<< -> send >>, and the "consumer side", which waits
580for the send to occur. 627for the send to occur.
581 628
582Example: wait for a timer. 629Example: wait for a timer.
583 630
584 # wait till the result is ready 631 # condition: "wait till the timer is fired"
585 my $result_ready = AnyEvent->condvar; 632 my $timer_fired = AnyEvent->condvar;
586 633
587 # do something such as adding a timer 634 # create the timer - we could wait for, say
588 # or socket watcher the calls $result_ready->send 635 # a handle becomign ready, or even an
589 # when the "result" is ready. 636 # AnyEvent::HTTP request to finish, but
590 # in this case, we simply use a timer: 637 # in this case, we simply use a timer:
591 my $w = AnyEvent->timer ( 638 my $w = AnyEvent->timer (
592 after => 1, 639 after => 1,
593 cb => sub { $result_ready->send }, 640 cb => sub { $timer_fired->send },
594 ); 641 );
595 642
596 # this "blocks" (while handling events) till the callback 643 # this "blocks" (while handling events) till the callback
597 # calls -<send 644 # calls ->send
598 $result_ready->recv; 645 $timer_fired->recv;
599 646
600Example: 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
601variables are also callable directly. 648variables are also callable directly.
602 649
603 my $done = AnyEvent->condvar; 650 my $done = AnyEvent->condvar;
646they 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
647C<send>. 694C<send>.
648 695
649=item $cv->croak ($error) 696=item $cv->croak ($error)
650 697
651Similar to send, but causes all call's to C<< ->recv >> to invoke 698Similar to send, but causes all calls to C<< ->recv >> to invoke
652C<Carp::croak> with the given error message/object/scalar. 699C<Carp::croak> with the given error message/object/scalar.
653 700
654This can be used to signal any errors to the condition variable 701This can be used to signal any errors to the condition variable
655user/consumer. Doing it this way instead of calling C<croak> directly 702user/consumer. Doing it this way instead of calling C<croak> directly
656delays the error detetcion, but has the overwhelmign advantage that it 703delays the error detection, but has the overwhelming advantage that it
657diagnoses 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
658deep in some event clalback without connection to the actual code causing 705deep in some event callback with no connection to the actual code causing
659the problem. 706the problem.
660 707
661=item $cv->begin ([group callback]) 708=item $cv->begin ([group callback])
662 709
663=item $cv->end 710=item $cv->end
666one. For example, a function that pings many hosts in parallel might want 713one. For example, a function that pings many hosts in parallel might want
667to use a condition variable for the whole process. 714to use a condition variable for the whole process.
668 715
669Every call to C<< ->begin >> will increment a counter, and every call to 716Every call to C<< ->begin >> will increment a counter, and every call to
670C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 717C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
671>>, the (last) callback passed to C<begin> will be executed. That callback 718>>, the (last) callback passed to C<begin> will be executed, passing the
672is I<supposed> to call C<< ->send >>, but that is not required. If no 719condvar as first argument. That callback is I<supposed> to call C<< ->send
673callback was set, C<send> will be called without any arguments. 720>>, but that is not required. If no group callback was set, C<send> will
721be called without any arguments.
674 722
675You can think of C<< $cv->send >> giving you an OR condition (one call 723You can think of C<< $cv->send >> giving you an OR condition (one call
676sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND 724sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
677condition (all C<begin> calls must be C<end>'ed before the condvar sends). 725condition (all C<begin> calls must be C<end>'ed before the condvar sends).
678 726
700one 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
701sending. 749sending.
702 750
703The ping example mentioned above is slightly more complicated, as the 751The ping example mentioned above is slightly more complicated, as the
704there 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
705begung can potentially be zero: 753begun can potentially be zero:
706 754
707 my $cv = AnyEvent->condvar; 755 my $cv = AnyEvent->condvar;
708 756
709 my %result; 757 my %result;
710 $cv->begin (sub { $cv->send (\%result) }); 758 $cv->begin (sub { shift->send (\%result) });
711 759
712 for my $host (@list_of_hosts) { 760 for my $host (@list_of_hosts) {
713 $cv->begin; 761 $cv->begin;
714 ping_host_then_call_callback $host, sub { 762 ping_host_then_call_callback $host, sub {
715 $result{$host} = ...; 763 $result{$host} = ...;
731to 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
732C<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
733doesn't execute once). 781doesn't execute once).
734 782
735This is the general pattern when you "fan out" into multiple (but 783This is the general pattern when you "fan out" into multiple (but
736potentially 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
737the 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
738subrequest you start, call C<begin> and for each subrequest you finish, 786subrequest you start, call C<begin> and for each subrequest you finish,
739call C<end>. 787call C<end>.
740 788
741=back 789=back
748=over 4 796=over 4
749 797
750=item $cv->recv 798=item $cv->recv
751 799
752Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak 800Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
753>> methods have been called on c<$cv>, while servicing other watchers 801>> methods have been called on C<$cv>, while servicing other watchers
754normally. 802normally.
755 803
756You 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
757will return immediately. 805will return immediately.
758 806
775caller 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
776condition variables with some kind of request results and supporting 824condition variables with some kind of request results and supporting
777callbacks so the caller knows that getting the result will not block, 825callbacks so the caller knows that getting the result will not block,
778while still supporting blocking waits if the caller so desires). 826while still supporting blocking waits if the caller so desires).
779 827
780You 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
781only calling C<< ->recv >> from within that callback (or at a later 829only calling C<< ->recv >> from within that callback (or at a later
782time). 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
783waits otherwise. 831waits otherwise.
784 832
785=item $bool = $cv->ready 833=item $bool = $cv->ready
790=item $cb = $cv->cb ($cb->($cv)) 838=item $cb = $cv->cb ($cb->($cv))
791 839
792This is a mutator function that returns the callback set and optionally 840This is a mutator function that returns the callback set and optionally
793replaces it before doing so. 841replaces it before doing so.
794 842
795The callback will be called when the condition becomes (or already was) 843The callback will be called when the condition becomes "true", i.e. when
796"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
797the 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
798inside the callback or at any later time is guaranteed not to block. 847the callback or at any later time is guaranteed not to block.
799 848
800=back 849=back
801 850
802=head1 SUPPORTED EVENT LOOPS/BACKENDS 851=head1 SUPPORTED EVENT LOOPS/BACKENDS
803 852
806=over 4 855=over 4
807 856
808=item Backends that are autoprobed when no other event loop can be found. 857=item Backends that are autoprobed when no other event loop can be found.
809 858
810EV is the preferred backend when no other event loop seems to be in 859EV is the preferred backend when no other event loop seems to be in
811use. If EV is not installed, then AnyEvent will try Event, and, failing 860use. If EV is not installed, then AnyEvent will fall back to its own
812that, will fall back to its own pure-perl implementation, which is 861pure-perl implementation, which is available everywhere as it comes with
813available everywhere as it comes with AnyEvent itself. 862AnyEvent itself.
814 863
815 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 864 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
816 AnyEvent::Impl::Event based on Event, very stable, few glitches.
817 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 865 AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
818 866
819=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.
820 868
821These 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
822is 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
823them. This means that AnyEvent will automatically pick the right backend 871them. This means that AnyEvent will automatically pick the right backend
824when the main program loads an event module before anything starts to 872when the main program loads an event module before anything starts to
825create watchers. Nothing special needs to be done by the main program. 873create watchers. Nothing special needs to be done by the main program.
826 874
875 AnyEvent::Impl::Event based on Event, very stable, few glitches.
827 AnyEvent::Impl::Glib based on Glib, slow but very stable. 876 AnyEvent::Impl::Glib based on Glib, slow but very stable.
828 AnyEvent::Impl::Tk based on Tk, very broken. 877 AnyEvent::Impl::Tk based on Tk, very broken.
829 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
830 AnyEvent::Impl::POE based on POE, very slow, some limitations. 879 AnyEvent::Impl::POE based on POE, very slow, some limitations.
831 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).
832 884
833=item Backends with special needs. 885=item Backends with special needs.
834 886
835Qt requires the Qt::Application to be instantiated first, but will 887Qt requires the Qt::Application to be instantiated first, but will
836otherwise be picked up automatically. As long as the main program 888otherwise be picked up automatically. As long as the main program
837instantiates the application before any AnyEvent watchers are created, 889instantiates the application before any AnyEvent watchers are created,
838everything should just work. 890everything should just work.
839 891
840 AnyEvent::Impl::Qt based on Qt. 892 AnyEvent::Impl::Qt based on Qt.
841 893
842Support for IO::Async can only be partial, as it is too broken and
843architecturally limited to even support the AnyEvent API. It also
844is the only event loop that needs the loop to be set explicitly, so
845it can only be used by a main program knowing about AnyEvent. See
846L<AnyEvent::Impl::Async> for the gory details.
847
848 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
849
850=item Event loops that are indirectly supported via other backends. 894=item Event loops that are indirectly supported via other backends.
851 895
852Some event loops can be supported via other modules: 896Some event loops can be supported via other modules:
853 897
854There is no direct support for WxWidgets (L<Wx>) or L<Prima>. 898There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
879Contains C<undef> until the first watcher is being created, before the 923Contains C<undef> until the first watcher is being created, before the
880backend has been autodetected. 924backend has been autodetected.
881 925
882Afterwards 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
883name 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
884of 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
885case 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
886will be C<urxvt::anyevent>). 930will be C<urxvt::anyevent>).
887 931
888=item AnyEvent::detect 932=item AnyEvent::detect
889 933
890Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
891if necessary. You should only call this function right before you would 935if necessary. You should only call this function right before you would
892have 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
893runtime, and not e.g. while initialising of your module. 937runtime, and not e.g. during initialisation of your module.
894 938
895If you need to do some initialisation before AnyEvent watchers are 939If you need to do some initialisation before AnyEvent watchers are
896created, use C<post_detect>. 940created, use C<post_detect>.
897 941
898=item $guard = AnyEvent::post_detect { BLOCK } 942=item $guard = AnyEvent::post_detect { BLOCK }
899 943
900Arranges for the code block to be executed as soon as the event model is 944Arranges for the code block to be executed as soon as the event model is
901autodetected (or immediately if this has already happened). 945autodetected (or immediately if that has already happened).
902 946
903The block will be executed I<after> the actual backend has been detected 947The block will be executed I<after> the actual backend has been detected
904(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been 948(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
905created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do 949created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
906other initialisations - see the sources of L<AnyEvent::Strict> or 950other initialisations - see the sources of L<AnyEvent::Strict> or
915that automatically removes the callback again when it is destroyed (or 959that automatically removes the callback again when it is destroyed (or
916C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for 960C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
917a case where this is useful. 961a case where this is useful.
918 962
919Example: Create a watcher for the IO::AIO module and store it in 963Example: Create a watcher for the IO::AIO module and store it in
920C<$WATCHER>. Only do so after the event loop is initialised, though. 964C<$WATCHER>, but do so only do so after the event loop is initialised.
921 965
922 our WATCHER; 966 our WATCHER;
923 967
924 my $guard = AnyEvent::post_detect { 968 my $guard = AnyEvent::post_detect {
925 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb); 969 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
933 $WATCHER ||= $guard; 977 $WATCHER ||= $guard;
934 978
935=item @AnyEvent::post_detect 979=item @AnyEvent::post_detect
936 980
937If there are any code references in this array (you can C<push> to it 981If there are any code references in this array (you can C<push> to it
938before or after loading AnyEvent), then they will called directly after 982before or after loading AnyEvent), then they will be called directly
939the event loop has been chosen. 983after the event loop has been chosen.
940 984
941You should check C<$AnyEvent::MODEL> before adding to this array, though: 985You should check C<$AnyEvent::MODEL> before adding to this array, though:
942if it is defined then the event loop has already been detected, and the 986if it is defined then the event loop has already been detected, and the
943array will be ignored. 987array will be ignored.
944 988
945Best use C<AnyEvent::post_detect { BLOCK }> when your application allows 989Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
946it,as it takes care of these details. 990it, as it takes care of these details.
947 991
948This variable is mainly useful for modules that can do something useful 992This variable is mainly useful for modules that can do something useful
949when AnyEvent is used and thus want to know when it is initialised, but do 993when AnyEvent is used and thus want to know when it is initialised, but do
950not need to even load it by default. This array provides the means to hook 994not need to even load it by default. This array provides the means to hook
951into AnyEvent passively, without loading it. 995into AnyEvent passively, without loading it.
952 996
997Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
998together, you could put this into Coro (this is the actual code used by
999Coro to accomplish this):
1000
1001 if (defined $AnyEvent::MODEL) {
1002 # AnyEvent already initialised, so load Coro::AnyEvent
1003 require Coro::AnyEvent;
1004 } else {
1005 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1006 # as soon as it is
1007 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1008 }
1009
1010=item AnyEvent::postpone { BLOCK }
1011
1012Arranges for the block to be executed as soon as possible, but not before
1013the call itself returns. In practise, the block will be executed just
1014before the event loop polls for new events, or shortly afterwards.
1015
1016This function never returns anything (to make the C<return postpone { ...
1017}> idiom more useful.
1018
1019To understand the usefulness of this function, consider a function that
1020asynchronously does something for you and returns some transaction
1021object or guard to let you cancel the operation. For example,
1022C<AnyEvent::Socket::tcp_connect>:
1023
1024 # start a conenction attempt unless one is active
1025 $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
1026 delete $self->{connect_guard};
1027 ...
1028 };
1029
1030Imagine that this function could instantly call the callback, for
1031example, because it detects an obvious error such as a negative port
1032number. Invoking the callback before the function returns causes problems
1033however: the callback will be called and will try to delete the guard
1034object. But since the function hasn't returned yet, there is nothing to
1035delete. When the function eventually returns it will assign the guard
1036object to C<< $self->{connect_guard} >>, where it will likely never be
1037deleted, so the program thinks it is still trying to connect.
1038
1039This is where C<AnyEvent::postpone> should be used. Instead of calling the
1040callback directly on error:
1041
1042 $cb->(undef), return # signal error to callback, BAD!
1043 if $some_error_condition;
1044
1045It should use C<postpone>:
1046
1047 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1048 if $some_error_condition;
1049
953=back 1050=back
954 1051
955=head1 WHAT TO DO IN A MODULE 1052=head1 WHAT TO DO IN A MODULE
956 1053
957As a module author, you should C<use AnyEvent> and call AnyEvent methods 1054As a module author, you should C<use AnyEvent> and call AnyEvent methods
967because it will stall the whole program, and the whole point of using 1064because it will stall the whole program, and the whole point of using
968events is to stay interactive. 1065events is to stay interactive.
969 1066
970It is fine, however, to call C<< ->recv >> when the user of your module 1067It is fine, however, to call C<< ->recv >> when the user of your module
971requests it (i.e. if you create a http request object ad have a method 1068requests it (i.e. if you create a http request object ad have a method
972called C<results> that returns the results, it should call C<< ->recv >> 1069called C<results> that returns the results, it may call C<< ->recv >>
973freely, as the user of your module knows what she is doing. always). 1070freely, as the user of your module knows what she is doing. Always).
974 1071
975=head1 WHAT TO DO IN THE MAIN PROGRAM 1072=head1 WHAT TO DO IN THE MAIN PROGRAM
976 1073
977There will always be a single main program - the only place that should 1074There will always be a single main program - the only place that should
978dictate which event model to use. 1075dictate which event model to use.
979 1076
980If it doesn't care, it can just "use AnyEvent" and use it itself, or not 1077If the program is not event-based, it need not do anything special, even
981do anything special (it does not need to be event-based) and let AnyEvent 1078when it depends on a module that uses an AnyEvent. If the program itself
982decide which implementation to chose if some module relies on it. 1079uses AnyEvent, but does not care which event loop is used, all it needs
1080to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
1081available loop implementation.
983 1082
984If the main program relies on a specific event model - for example, in 1083If the main program relies on a specific event model - for example, in
985Gtk2 programs you have to rely on the Glib module - you should load the 1084Gtk2 programs you have to rely on the Glib module - you should load the
986event module before loading AnyEvent or any module that uses it: generally 1085event module before loading AnyEvent or any module that uses it: generally
987speaking, you should load it as early as possible. The reason is that 1086speaking, you should load it as early as possible. The reason is that
988modules might create watchers when they are loaded, and AnyEvent will 1087modules might create watchers when they are loaded, and AnyEvent will
989decide on the event model to use as soon as it creates watchers, and it 1088decide on the event model to use as soon as it creates watchers, and it
990might chose the wrong one unless you load the correct one yourself. 1089might choose the wrong one unless you load the correct one yourself.
991 1090
992You can chose to use a pure-perl implementation by loading the 1091You can chose to use a pure-perl implementation by loading the
993C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1092C<AnyEvent::Loop> module, which gives you similar behaviour
994everywhere, but letting AnyEvent chose the model is generally better. 1093everywhere, but letting AnyEvent chose the model is generally better.
995 1094
996=head2 MAINLOOP EMULATION 1095=head2 MAINLOOP EMULATION
997 1096
998Sometimes (often for short test scripts, or even standalone programs who 1097Sometimes (often for short test scripts, or even standalone programs who
1013=head1 OTHER MODULES 1112=head1 OTHER MODULES
1014 1113
1015The following is a non-exhaustive list of additional modules that use 1114The following is a non-exhaustive list of additional modules that use
1016AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1115AnyEvent as a client and can therefore be mixed easily with other AnyEvent
1017modules and other event loops in the same program. Some of the modules 1116modules and other event loops in the same program. Some of the modules
1018come with AnyEvent, most are available via CPAN. 1117come as part of AnyEvent, the others are available via CPAN.
1019 1118
1020=over 4 1119=over 4
1021 1120
1022=item L<AnyEvent::Util> 1121=item L<AnyEvent::Util>
1023 1122
1024Contains various utility functions that replace often-used but blocking 1123Contains various utility functions that replace often-used blocking
1025functions such as C<inet_aton> by event-/callback-based versions. 1124functions such as C<inet_aton> with event/callback-based versions.
1026 1125
1027=item L<AnyEvent::Socket> 1126=item L<AnyEvent::Socket>
1028 1127
1029Provides various utility functions for (internet protocol) sockets, 1128Provides various utility functions for (internet protocol) sockets,
1030addresses and name resolution. Also functions to create non-blocking tcp 1129addresses and name resolution. Also functions to create non-blocking tcp
1032 1131
1033=item L<AnyEvent::Handle> 1132=item L<AnyEvent::Handle>
1034 1133
1035Provide read and write buffers, manages watchers for reads and writes, 1134Provide read and write buffers, manages watchers for reads and writes,
1036supports raw and formatted I/O, I/O queued and fully transparent and 1135supports raw and formatted I/O, I/O queued and fully transparent and
1037non-blocking SSL/TLS (via L<AnyEvent::TLS>. 1136non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1038 1137
1039=item L<AnyEvent::DNS> 1138=item L<AnyEvent::DNS>
1040 1139
1041Provides rich asynchronous DNS resolver capabilities. 1140Provides rich asynchronous DNS resolver capabilities.
1042 1141
1142=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1143
1144Implement event-based interfaces to the protocols of the same name (for
1145the curious, IGS is the International Go Server and FCP is the Freenet
1146Client Protocol).
1147
1148=item L<AnyEvent::Handle::UDP>
1149
1150Here be danger!
1151
1152As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1153there are so many things wrong with AnyEvent::Handle::UDP, most notably
1154its use of a stream-based API with a protocol that isn't streamable, that
1155the only way to improve it is to delete it.
1156
1157It features data corruption (but typically only under load) and general
1158confusion. On top, the author is not only clueless about UDP but also
1159fact-resistant - some gems of his understanding: "connect doesn't work
1160with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1161packets", "I don't need to implement proper error checking as UDP doesn't
1162support error checking" and so on - he doesn't even understand what's
1163wrong with his module when it is explained to him.
1164
1043=item L<AnyEvent::HTTP> 1165=item L<AnyEvent::DBI>
1044 1166
1045A simple-to-use HTTP library that is capable of making a lot of concurrent 1167Executes L<DBI> requests asynchronously in a proxy process for you,
1046HTTP requests. 1168notifying you in an event-based way when the operation is finished.
1169
1170=item L<AnyEvent::AIO>
1171
1172Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1173toolbox of every event programmer. AnyEvent::AIO transparently fuses
1174L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1175file I/O, and much more.
1047 1176
1048=item L<AnyEvent::HTTPD> 1177=item L<AnyEvent::HTTPD>
1049 1178
1050Provides a simple web application server framework. 1179A simple embedded webserver.
1051 1180
1052=item L<AnyEvent::FastPing> 1181=item L<AnyEvent::FastPing>
1053 1182
1054The fastest ping in the west. 1183The fastest ping in the west.
1055
1056=item L<AnyEvent::DBI>
1057
1058Executes L<DBI> requests asynchronously in a proxy process.
1059
1060=item L<AnyEvent::AIO>
1061
1062Truly asynchronous I/O, should be in the toolbox of every event
1063programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1064together.
1065
1066=item L<AnyEvent::BDB>
1067
1068Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1069L<BDB> and AnyEvent together.
1070
1071=item L<AnyEvent::GPSD>
1072
1073A non-blocking interface to gpsd, a daemon delivering GPS information.
1074
1075=item L<AnyEvent::IRC>
1076
1077AnyEvent based IRC client module family (replacing the older Net::IRC3).
1078
1079=item L<AnyEvent::XMPP>
1080
1081AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1082Net::XMPP2>.
1083
1084=item L<AnyEvent::IGS>
1085
1086A non-blocking interface to the Internet Go Server protocol (used by
1087L<App::IGS>).
1088
1089=item L<Net::FCP>
1090
1091AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1092of AnyEvent.
1093
1094=item L<Event::ExecFlow>
1095
1096High level API for event-based execution flow control.
1097 1184
1098=item L<Coro> 1185=item L<Coro>
1099 1186
1100Has special support for AnyEvent via L<Coro::AnyEvent>. 1187Has special support for AnyEvent via L<Coro::AnyEvent>.
1101 1188
1105 1192
1106package AnyEvent; 1193package AnyEvent;
1107 1194
1108# basically a tuned-down version of common::sense 1195# basically a tuned-down version of common::sense
1109sub common_sense { 1196sub common_sense {
1110 # no warnings 1197 # from common:.sense 3.4
1111 ${^WARNING_BITS} ^= ${^WARNING_BITS}; 1198 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1112 # use strict vars subs 1199 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1113 $^H |= 0x00000600; 1200 $^H |= 0x00000600;
1114} 1201}
1115 1202
1116BEGIN { AnyEvent::common_sense } 1203BEGIN { AnyEvent::common_sense }
1117 1204
1118use Carp (); 1205use Carp ();
1119 1206
1120our $VERSION = 4.901; 1207our $VERSION = '5.34';
1121our $MODEL; 1208our $MODEL;
1122 1209
1123our $AUTOLOAD;
1124our @ISA; 1210our @ISA;
1125 1211
1126our @REGISTRY; 1212our @REGISTRY;
1127 1213
1128our $WIN32;
1129
1130our $VERBOSE; 1214our $VERBOSE;
1131 1215
1132BEGIN { 1216BEGIN {
1133 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1217 require "AnyEvent/constants.pl";
1218
1134 eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; 1219 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1135 1220
1136 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1221 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1137 if ${^TAINT}; 1222 if ${^TAINT};
1138 1223
1139 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1224 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1149 $PROTOCOL{$_} = ++$idx 1234 $PROTOCOL{$_} = ++$idx
1150 for reverse split /\s*,\s*/, 1235 for reverse split /\s*,\s*/,
1151 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1236 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1152} 1237}
1153 1238
1239our @post_detect;
1240
1241sub post_detect(&) {
1242 my ($cb) = @_;
1243
1244 push @post_detect, $cb;
1245
1246 defined wantarray
1247 ? bless \$cb, "AnyEvent::Util::postdetect"
1248 : ()
1249}
1250
1251sub AnyEvent::Util::postdetect::DESTROY {
1252 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1253}
1254
1255our $POSTPONE_W;
1256our @POSTPONE;
1257
1258sub _postpone_exec {
1259 undef $POSTPONE_W;
1260
1261 &{ shift @POSTPONE }
1262 while @POSTPONE;
1263}
1264
1265sub postpone(&) {
1266 push @POSTPONE, shift;
1267
1268 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1269
1270 ()
1271}
1272
1154my @models = ( 1273our @models = (
1155 [EV:: => AnyEvent::Impl::EV:: , 1], 1274 [EV:: => AnyEvent::Impl::EV:: , 1],
1275 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1276 # everything below here will not (normally) be autoprobed
1277 # as the pure perl backend should work everywhere
1278 # and is usually faster
1156 [Event:: => AnyEvent::Impl::Event::, 1], 1279 [Event:: => AnyEvent::Impl::Event::, 1],
1157 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1158 # everything below here will not (normally) be autoprobed
1159 # as the pureperl backend should work everywhere
1160 # and is usually faster
1161 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1280 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1162 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1281 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1163 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1282 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1164 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1283 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1165 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1284 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1166 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1285 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1167 [Wx:: => AnyEvent::Impl::POE::], 1286 [Wx:: => AnyEvent::Impl::POE::],
1168 [Prima:: => AnyEvent::Impl::POE::], 1287 [Prima:: => AnyEvent::Impl::POE::],
1169 # IO::Async is just too broken - we would need workarounds for its 1288 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1170 # byzantine signal and broken child handling, among others. 1289 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1171 # IO::Async is rather hard to detect, as it doesn't have any 1290 [FLTK:: => AnyEvent::Impl::FLTK2::],
1172 # obvious default class.
1173# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1174# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1175# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1176); 1291);
1177 1292
1178our %method = map +($_ => 1), 1293# all autoloaded methods reserve the complete glob, not just the method slot.
1294# due to bugs in perls method cache implementation.
1179 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1295our @methods = qw(io timer time now now_update signal child idle condvar);
1180 1296
1181our @post_detect;
1182
1183sub post_detect(&) { 1297sub detect() {
1184 my ($cb) = @_; 1298 local $!; # for good measure
1299 local $SIG{__DIE__}; # we use eval
1185 1300
1186 if ($MODEL) { 1301 # free some memory
1187 $cb->(); 1302 *detect = sub () { $MODEL };
1303 # undef &func doesn't correctly update the method cache. grmbl.
1304 # so we delete the whole glob. grmbl.
1305 # otoh, perl doesn't let me undef an active usb, but it lets me free
1306 # a glob with an active sub. hrm. i hope it works, but perl is
1307 # usually buggy in this department. sigh.
1308 delete @{"AnyEvent::"}{@methods};
1309 undef @methods;
1188 1310
1189 undef 1311 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1312 my $model = $1;
1313 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1314 if (eval "require $model") {
1315 $MODEL = $model;
1316 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1190 } else { 1317 } else {
1191 push @post_detect, $cb; 1318 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1192 1319 }
1193 defined wantarray
1194 ? bless \$cb, "AnyEvent::Util::postdetect"
1195 : ()
1196 } 1320 }
1197}
1198 1321
1199sub AnyEvent::Util::postdetect::DESTROY { 1322 # check for already loaded models
1200 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1201}
1202
1203sub detect() {
1204 unless ($MODEL) { 1323 unless ($MODEL) {
1205 local $SIG{__DIE__}; 1324 for (@REGISTRY, @models) {
1206 1325 my ($package, $model) = @$_;
1207 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1326 if (${"$package\::VERSION"} > 0) {
1208 my $model = "AnyEvent::Impl::$1";
1209 if (eval "require $model") { 1327 if (eval "require $model") {
1210 $MODEL = $model; 1328 $MODEL = $model;
1211 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; 1329 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1212 } else { 1330 last;
1213 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1331 }
1214 } 1332 }
1215 } 1333 }
1216 1334
1217 # check for already loaded models
1218 unless ($MODEL) { 1335 unless ($MODEL) {
1336 # try to autoload a model
1219 for (@REGISTRY, @models) { 1337 for (@REGISTRY, @models) {
1220 my ($package, $model) = @$_; 1338 my ($package, $model, $autoload) = @$_;
1339 if (
1340 $autoload
1341 and eval "require $package"
1221 if (${"$package\::VERSION"} > 0) { 1342 and ${"$package\::VERSION"} > 0
1222 if (eval "require $model") { 1343 and eval "require $model"
1344 ) {
1223 $MODEL = $model; 1345 $MODEL = $model;
1224 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1346 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1225 last; 1347 last;
1226 }
1227 } 1348 }
1228 } 1349 }
1229 1350
1230 unless ($MODEL) {
1231 # try to autoload a model
1232 for (@REGISTRY, @models) {
1233 my ($package, $model, $autoload) = @$_;
1234 if (
1235 $autoload
1236 and eval "require $package"
1237 and ${"$package\::VERSION"} > 0
1238 and eval "require $model"
1239 ) {
1240 $MODEL = $model;
1241 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1242 last;
1243 }
1244 }
1245
1246 $MODEL 1351 $MODEL
1247 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1352 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1248 }
1249 } 1353 }
1250
1251 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1252
1253 unshift @ISA, $MODEL;
1254
1255 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1256
1257 (shift @post_detect)->() while @post_detect;
1258 } 1354 }
1259 1355
1356 # free memory only needed for probing
1357 undef @models;
1358 undef @REGISTRY;
1359
1360 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1361 unshift @ISA, $MODEL;
1362
1363 # now nuke some methods that are overridden by the backend.
1364 # SUPER usage is not allowed in these.
1365 for (qw(time signal child idle)) {
1366 undef &{"AnyEvent::Base::$_"}
1367 if defined &{"$MODEL\::$_"};
1368 }
1369
1370 if ($ENV{PERL_ANYEVENT_STRICT}) {
1371 require AnyEvent::Strict;
1372 }
1373
1374 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1375 require AnyEvent::Debug;
1376 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1377 }
1378
1379 if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1380 require AnyEvent::Socket;
1381 require AnyEvent::Debug;
1382
1383 my ($host, $service) = AnyEvent::Socket::parse_hostport ($ENV{PERL_ANYEVENT_DEBUG_SHELL});
1384 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1385 }
1386
1387 (shift @post_detect)->() while @post_detect;
1388 undef @post_detect;
1389
1390 *post_detect = sub(&) {
1391 shift->();
1392
1393 undef
1394 };
1395
1260 $MODEL 1396 $MODEL
1261} 1397}
1262 1398
1263sub AUTOLOAD { 1399for my $name (@methods) {
1264 (my $func = $AUTOLOAD) =~ s/.*://; 1400 *$name = sub {
1265 1401 detect;
1266 $method{$func} 1402 # we use goto because
1267 or Carp::croak "$func: not a valid method for AnyEvent objects"; 1403 # a) it makes the thunk more transparent
1268 1404 # b) it allows us to delete the thunk later
1269 detect unless $MODEL; 1405 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1270 1406 };
1271 my $class = shift;
1272 $class->$func (@_);
1273} 1407}
1274 1408
1275# utility function to dup a filehandle. this is used by many backends 1409# utility function to dup a filehandle. this is used by many backends
1276# to support binding more than one watcher per filehandle (they usually 1410# to support binding more than one watcher per filehandle (they usually
1277# allow only one watcher per fd, so we dup it to get a different one). 1411# allow only one watcher per fd, so we dup it to get a different one).
1287 # we assume CLOEXEC is already set by perl in all important cases 1421 # we assume CLOEXEC is already set by perl in all important cases
1288 1422
1289 ($fh2, $rw) 1423 ($fh2, $rw)
1290} 1424}
1291 1425
1426=head1 SIMPLIFIED AE API
1427
1428Starting with version 5.0, AnyEvent officially supports a second, much
1429simpler, API that is designed to reduce the calling, typing and memory
1430overhead by using function call syntax and a fixed number of parameters.
1431
1432See the L<AE> manpage for details.
1433
1434=cut
1435
1436package AE;
1437
1438our $VERSION = $AnyEvent::VERSION;
1439
1440sub _reset() {
1441 eval q{
1442 # fall back to the main API by default - backends and AnyEvent::Base
1443 # implementations can overwrite these.
1444
1445 sub io($$$) {
1446 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1447 }
1448
1449 sub timer($$$) {
1450 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1451 }
1452
1453 sub signal($$) {
1454 AnyEvent->signal (signal => $_[0], cb => $_[1])
1455 }
1456
1457 sub child($$) {
1458 AnyEvent->child (pid => $_[0], cb => $_[1])
1459 }
1460
1461 sub idle($) {
1462 AnyEvent->idle (cb => $_[0]);
1463 }
1464
1465 sub cv(;&) {
1466 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1467 }
1468
1469 sub now() {
1470 AnyEvent->now
1471 }
1472
1473 sub now_update() {
1474 AnyEvent->now_update
1475 }
1476
1477 sub time() {
1478 AnyEvent->time
1479 }
1480
1481 *postpone = \&AnyEvent::postpone;
1482 };
1483 die if $@;
1484}
1485
1486BEGIN { _reset }
1487
1292package AnyEvent::Base; 1488package AnyEvent::Base;
1293 1489
1294# default implementations for many methods 1490# default implementations for many methods
1295 1491
1296sub _time { 1492sub time {
1493 eval q{ # poor man's autoloading {}
1297 # probe for availability of Time::HiRes 1494 # probe for availability of Time::HiRes
1298 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1495 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1299 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1496 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1300 *_time = \&Time::HiRes::time; 1497 *AE::time = \&Time::HiRes::time;
1301 # if (eval "use POSIX (); (POSIX::times())... 1498 # if (eval "use POSIX (); (POSIX::times())...
1302 } else { 1499 } else {
1303 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1500 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1304 *_time = sub { time }; # epic fail 1501 *AE::time = sub (){ time }; # epic fail
1502 }
1503
1504 *time = sub { AE::time }; # different prototypes
1305 } 1505 };
1506 die if $@;
1306 1507
1307 &_time 1508 &time
1308} 1509}
1309 1510
1310sub time { _time } 1511*now = \&time;
1311sub now { _time } 1512
1312sub now_update { } 1513sub now_update { }
1313 1514
1515sub _poll {
1516 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1517}
1518
1314# default implementation for ->condvar 1519# default implementation for ->condvar
1520# in fact, the default should not be overwritten
1315 1521
1316sub condvar { 1522sub condvar {
1523 eval q{ # poor man's autoloading {}
1524 *condvar = sub {
1317 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1525 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1526 };
1527
1528 *AE::cv = sub (;&) {
1529 bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
1530 };
1531 };
1532 die if $@;
1533
1534 &condvar
1318} 1535}
1319 1536
1320# default implementation for ->signal 1537# default implementation for ->signal
1321 1538
1322our $HAVE_ASYNC_INTERRUPT; 1539our $HAVE_ASYNC_INTERRUPT;
1323 1540
1324sub _have_async_interrupt() { 1541sub _have_async_interrupt() {
1325 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} 1542 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1326 && eval "use Async::Interrupt 1.0 (); 1") 1543 && eval "use Async::Interrupt 1.02 (); 1")
1327 unless defined $HAVE_ASYNC_INTERRUPT; 1544 unless defined $HAVE_ASYNC_INTERRUPT;
1328 1545
1329 $HAVE_ASYNC_INTERRUPT 1546 $HAVE_ASYNC_INTERRUPT
1330} 1547}
1331 1548
1332our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1549our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1333our (%SIG_ASY, %SIG_ASY_W); 1550our (%SIG_ASY, %SIG_ASY_W);
1334our ($SIG_COUNT, $SIG_TW); 1551our ($SIG_COUNT, $SIG_TW);
1335 1552
1336sub _signal_exec {
1337 $HAVE_ASYNC_INTERRUPT
1338 ? $SIGPIPE_R->drain
1339 : sysread $SIGPIPE_R, my $dummy, 9;
1340
1341 while (%SIG_EV) {
1342 for (keys %SIG_EV) {
1343 delete $SIG_EV{$_};
1344 $_->() for values %{ $SIG_CB{$_} || {} };
1345 }
1346 }
1347}
1348
1349# install a dummy wakeup watcher to reduce signal catching latency 1553# install a dummy wakeup watcher to reduce signal catching latency
1554# used by Impls
1350sub _sig_add() { 1555sub _sig_add() {
1351 unless ($SIG_COUNT++) { 1556 unless ($SIG_COUNT++) {
1352 # try to align timer on a full-second boundary, if possible 1557 # try to align timer on a full-second boundary, if possible
1353 my $NOW = AnyEvent->now; 1558 my $NOW = AE::now;
1354 1559
1355 $SIG_TW = AnyEvent->timer ( 1560 $SIG_TW = AE::timer
1356 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1561 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1357 interval => $MAX_SIGNAL_LATENCY, 1562 $MAX_SIGNAL_LATENCY,
1358 cb => sub { }, # just for the PERL_ASYNC_CHECK 1563 sub { } # just for the PERL_ASYNC_CHECK
1359 ); 1564 ;
1360 } 1565 }
1361} 1566}
1362 1567
1363sub _sig_del { 1568sub _sig_del {
1364 undef $SIG_TW 1569 undef $SIG_TW
1365 unless --$SIG_COUNT; 1570 unless --$SIG_COUNT;
1366} 1571}
1367 1572
1368our $_sig_name_init; $_sig_name_init = sub { 1573our $_sig_name_init; $_sig_name_init = sub {
1369 eval q{ # poor man's autoloading 1574 eval q{ # poor man's autoloading {}
1370 undef $_sig_name_init; 1575 undef $_sig_name_init;
1371 1576
1372 if (_have_async_interrupt) { 1577 if (_have_async_interrupt) {
1373 *sig2num = \&Async::Interrupt::sig2num; 1578 *sig2num = \&Async::Interrupt::sig2num;
1374 *sig2name = \&Async::Interrupt::sig2name; 1579 *sig2name = \&Async::Interrupt::sig2name;
1401 # probe for availability of Async::Interrupt 1606 # probe for availability of Async::Interrupt
1402 if (_have_async_interrupt) { 1607 if (_have_async_interrupt) {
1403 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1608 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1404 1609
1405 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1610 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1406 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); 1611 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1407 1612
1408 } else { 1613 } else {
1409 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1614 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1410
1411 require Fcntl;
1412 1615
1413 if (AnyEvent::WIN32) { 1616 if (AnyEvent::WIN32) {
1414 require AnyEvent::Util; 1617 require AnyEvent::Util;
1415 1618
1416 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1619 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1417 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R; 1620 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1418 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case 1621 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1419 } else { 1622 } else {
1420 pipe $SIGPIPE_R, $SIGPIPE_W; 1623 pipe $SIGPIPE_R, $SIGPIPE_W;
1421 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; 1624 fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1422 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case 1625 fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1423 1626
1424 # not strictly required, as $^F is normally 2, but let's make sure... 1627 # not strictly required, as $^F is normally 2, but let's make sure...
1425 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; 1628 fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1426 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; 1629 fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1427 } 1630 }
1428 1631
1429 $SIGPIPE_R 1632 $SIGPIPE_R
1430 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1633 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1431 1634
1432 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1635 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1433 } 1636 }
1434 1637
1435 *signal = sub { 1638 *signal = $HAVE_ASYNC_INTERRUPT
1639 ? sub {
1436 my (undef, %arg) = @_; 1640 my (undef, %arg) = @_;
1437 1641
1438 my $signal = uc $arg{signal}
1439 or Carp::croak "required option 'signal' is missing";
1440
1441 if ($HAVE_ASYNC_INTERRUPT) {
1442 # async::interrupt 1642 # async::interrupt
1443
1444 $signal = sig2num $signal; 1643 my $signal = sig2num $arg{signal};
1445 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1644 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1446 1645
1447 $SIG_ASY{$signal} ||= new Async::Interrupt 1646 $SIG_ASY{$signal} ||= new Async::Interrupt
1448 cb => sub { undef $SIG_EV{$signal} }, 1647 cb => sub { undef $SIG_EV{$signal} },
1449 signal => $signal, 1648 signal => $signal,
1450 pipe => [$SIGPIPE_R->filenos], 1649 pipe => [$SIGPIPE_R->filenos],
1451 pipe_autodrain => 0, 1650 pipe_autodrain => 0,
1452 ; 1651 ;
1453 1652
1454 } else { 1653 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1654 }
1655 : sub {
1656 my (undef, %arg) = @_;
1657
1455 # pure perl 1658 # pure perl
1456
1457 # AE::Util has been loaded in signal
1458 $signal = sig2name $signal; 1659 my $signal = sig2name $arg{signal};
1459 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1660 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1460 1661
1461 $SIG{$signal} ||= sub { 1662 $SIG{$signal} ||= sub {
1462 local $!; 1663 local $!;
1463 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1664 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1464 undef $SIG_EV{$signal}; 1665 undef $SIG_EV{$signal};
1465 }; 1666 };
1466 1667
1467 # can't do signal processing without introducing races in pure perl, 1668 # can't do signal processing without introducing races in pure perl,
1468 # so limit the signal latency. 1669 # so limit the signal latency.
1469 _sig_add; 1670 _sig_add;
1470 }
1471 1671
1472 bless [$signal, $arg{cb}], "AnyEvent::Base::signal" 1672 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1673 }
1473 }; 1674 ;
1474 1675
1475 *AnyEvent::Base::signal::DESTROY = sub { 1676 *AnyEvent::Base::signal::DESTROY = sub {
1476 my ($signal, $cb) = @{$_[0]}; 1677 my ($signal, $cb) = @{$_[0]};
1477 1678
1478 _sig_del; 1679 _sig_del;
1485 # print weird messages, or just unconditionally exit 1686 # print weird messages, or just unconditionally exit
1486 # instead of getting the default action. 1687 # instead of getting the default action.
1487 undef $SIG{$signal} 1688 undef $SIG{$signal}
1488 unless keys %{ $SIG_CB{$signal} }; 1689 unless keys %{ $SIG_CB{$signal} };
1489 }; 1690 };
1691
1692 *_signal_exec = sub {
1693 $HAVE_ASYNC_INTERRUPT
1694 ? $SIGPIPE_R->drain
1695 : sysread $SIGPIPE_R, (my $dummy), 9;
1696
1697 while (%SIG_EV) {
1698 for (keys %SIG_EV) {
1699 delete $SIG_EV{$_};
1700 &$_ for values %{ $SIG_CB{$_} || {} };
1701 }
1702 }
1703 };
1490 }; 1704 };
1491 die if $@; 1705 die if $@;
1706
1492 &signal 1707 &signal
1493} 1708}
1494 1709
1495# default implementation for ->child 1710# default implementation for ->child
1496 1711
1497our %PID_CB; 1712our %PID_CB;
1498our $CHLD_W; 1713our $CHLD_W;
1499our $CHLD_DELAY_W; 1714our $CHLD_DELAY_W;
1500our $WNOHANG;
1501 1715
1716# used by many Impl's
1502sub _emit_childstatus($$) { 1717sub _emit_childstatus($$) {
1503 my (undef, $rpid, $rstatus) = @_; 1718 my (undef, $rpid, $rstatus) = @_;
1504 1719
1505 $_->($rpid, $rstatus) 1720 $_->($rpid, $rstatus)
1506 for values %{ $PID_CB{$rpid} || {} }, 1721 for values %{ $PID_CB{$rpid} || {} },
1507 values %{ $PID_CB{0} || {} }; 1722 values %{ $PID_CB{0} || {} };
1508} 1723}
1509 1724
1510sub _sigchld {
1511 my $pid;
1512
1513 AnyEvent->_emit_childstatus ($pid, $?)
1514 while ($pid = waitpid -1, $WNOHANG) > 0;
1515}
1516
1517sub child { 1725sub child {
1726 eval q{ # poor man's autoloading {}
1727 *_sigchld = sub {
1728 my $pid;
1729
1730 AnyEvent->_emit_childstatus ($pid, $?)
1731 while ($pid = waitpid -1, WNOHANG) > 0;
1732 };
1733
1734 *child = sub {
1518 my (undef, %arg) = @_; 1735 my (undef, %arg) = @_;
1519 1736
1520 defined (my $pid = $arg{pid} + 0) 1737 my $pid = $arg{pid};
1521 or Carp::croak "required option 'pid' is missing"; 1738 my $cb = $arg{cb};
1522 1739
1523 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1740 $PID_CB{$pid}{$cb+0} = $cb;
1524 1741
1525 # WNOHANG is almost cetrainly 1 everywhere
1526 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1527 ? 1
1528 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1529
1530 unless ($CHLD_W) { 1742 unless ($CHLD_W) {
1531 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1743 $CHLD_W = AE::signal CHLD => \&_sigchld;
1532 # child could be a zombie already, so make at least one round 1744 # child could be a zombie already, so make at least one round
1533 &_sigchld; 1745 &_sigchld;
1534 } 1746 }
1535 1747
1536 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1748 bless [$pid, $cb+0], "AnyEvent::Base::child"
1537} 1749 };
1538 1750
1539sub AnyEvent::Base::child::DESTROY { 1751 *AnyEvent::Base::child::DESTROY = sub {
1540 my ($pid, $cb) = @{$_[0]}; 1752 my ($pid, $icb) = @{$_[0]};
1541 1753
1542 delete $PID_CB{$pid}{$cb}; 1754 delete $PID_CB{$pid}{$icb};
1543 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1755 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1544 1756
1545 undef $CHLD_W unless keys %PID_CB; 1757 undef $CHLD_W unless keys %PID_CB;
1758 };
1759 };
1760 die if $@;
1761
1762 &child
1546} 1763}
1547 1764
1548# idle emulation is done by simply using a timer, regardless 1765# idle emulation is done by simply using a timer, regardless
1549# of whether the process is idle or not, and not letting 1766# of whether the process is idle or not, and not letting
1550# the callback use more than 50% of the time. 1767# the callback use more than 50% of the time.
1551sub idle { 1768sub idle {
1769 eval q{ # poor man's autoloading {}
1770 *idle = sub {
1552 my (undef, %arg) = @_; 1771 my (undef, %arg) = @_;
1553 1772
1554 my ($cb, $w, $rcb) = $arg{cb}; 1773 my ($cb, $w, $rcb) = $arg{cb};
1555 1774
1556 $rcb = sub { 1775 $rcb = sub {
1557 if ($cb) { 1776 if ($cb) {
1558 $w = _time; 1777 $w = AE::time;
1559 &$cb; 1778 &$cb;
1560 $w = _time - $w; 1779 $w = AE::time - $w;
1561 1780
1562 # never use more then 50% of the time for the idle watcher, 1781 # never use more then 50% of the time for the idle watcher,
1563 # within some limits 1782 # within some limits
1564 $w = 0.0001 if $w < 0.0001; 1783 $w = 0.0001 if $w < 0.0001;
1565 $w = 5 if $w > 5; 1784 $w = 5 if $w > 5;
1566 1785
1567 $w = AnyEvent->timer (after => $w, cb => $rcb); 1786 $w = AE::timer $w, 0, $rcb;
1568 } else { 1787 } else {
1569 # clean up... 1788 # clean up...
1570 undef $w; 1789 undef $w;
1571 undef $rcb; 1790 undef $rcb;
1791 }
1792 };
1793
1794 $w = AE::timer 0.05, 0, $rcb;
1795
1796 bless \\$cb, "AnyEvent::Base::idle"
1572 } 1797 };
1798
1799 *AnyEvent::Base::idle::DESTROY = sub {
1800 undef $${$_[0]};
1801 };
1573 }; 1802 };
1803 die if $@;
1574 1804
1575 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1805 &idle
1576
1577 bless \\$cb, "AnyEvent::Base::idle"
1578}
1579
1580sub AnyEvent::Base::idle::DESTROY {
1581 undef $${$_[0]};
1582} 1806}
1583 1807
1584package AnyEvent::CondVar; 1808package AnyEvent::CondVar;
1585 1809
1586our @ISA = AnyEvent::CondVar::Base::; 1810our @ISA = AnyEvent::CondVar::Base::;
1811
1812# only to be used for subclassing
1813sub new {
1814 my $class = shift;
1815 bless AnyEvent->condvar (@_), $class
1816}
1587 1817
1588package AnyEvent::CondVar::Base; 1818package AnyEvent::CondVar::Base;
1589 1819
1590#use overload 1820#use overload
1591# '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1821# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1601 1831
1602sub _send { 1832sub _send {
1603 # nop 1833 # nop
1604} 1834}
1605 1835
1836sub _wait {
1837 AnyEvent->_poll until $_[0]{_ae_sent};
1838}
1839
1606sub send { 1840sub send {
1607 my $cv = shift; 1841 my $cv = shift;
1608 $cv->{_ae_sent} = [@_]; 1842 $cv->{_ae_sent} = [@_];
1609 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1843 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1610 $cv->_send; 1844 $cv->_send;
1617 1851
1618sub ready { 1852sub ready {
1619 $_[0]{_ae_sent} 1853 $_[0]{_ae_sent}
1620} 1854}
1621 1855
1622sub _wait {
1623 $WAITING
1624 and !$_[0]{_ae_sent}
1625 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1626
1627 local $WAITING = 1;
1628 AnyEvent->one_event while !$_[0]{_ae_sent};
1629}
1630
1631sub recv { 1856sub recv {
1857 unless ($_[0]{_ae_sent}) {
1858 $WAITING
1859 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1860
1861 local $WAITING = 1;
1632 $_[0]->_wait; 1862 $_[0]->_wait;
1863 }
1633 1864
1634 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1865 $_[0]{_ae_croak}
1635 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1866 and Carp::croak $_[0]{_ae_croak};
1867
1868 wantarray
1869 ? @{ $_[0]{_ae_sent} }
1870 : $_[0]{_ae_sent}[0]
1636} 1871}
1637 1872
1638sub cb { 1873sub cb {
1639 my $cv = shift; 1874 my $cv = shift;
1640 1875
1656 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 1891 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1657} 1892}
1658 1893
1659# undocumented/compatibility with pre-3.4 1894# undocumented/compatibility with pre-3.4
1660*broadcast = \&send; 1895*broadcast = \&send;
1661*wait = \&_wait; 1896*wait = \&recv;
1662
1663#############################################################################
1664# "new" API, currently only emulation of it
1665#############################################################################
1666
1667package AE;
1668
1669sub io($$$) {
1670 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1671}
1672
1673sub timer($$$) {
1674 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
1675}
1676
1677sub signal($$) {
1678 AnyEvent->signal (signal => $_[0], cb => $_[1]);
1679}
1680
1681sub child($$) {
1682 AnyEvent->child (pid => $_[0], cb => $_[1]);
1683}
1684
1685sub idle($) {
1686 AnyEvent->idle (cb => $_[0]);
1687}
1688
1689sub cv(;&) {
1690 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1691}
1692
1693sub now() {
1694 AnyEvent->now
1695}
1696
1697sub now_update() {
1698 AnyEvent->now_update
1699}
1700
1701sub time() {
1702 AnyEvent->time
1703}
1704 1897
1705=head1 ERROR AND EXCEPTION HANDLING 1898=head1 ERROR AND EXCEPTION HANDLING
1706 1899
1707In general, AnyEvent does not do any error handling - it relies on the 1900In general, AnyEvent does not do any error handling - it relies on the
1708caller to do that if required. The L<AnyEvent::Strict> module (see also 1901caller to do that if required. The L<AnyEvent::Strict> module (see also
1755check the arguments passed to most method calls. If it finds any problems, 1948check the arguments passed to most method calls. If it finds any problems,
1756it will croak. 1949it will croak.
1757 1950
1758In other words, enables "strict" mode. 1951In other words, enables "strict" mode.
1759 1952
1760Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense> 1953Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1761>>, it is definitely recommended to keep it off in production. Keeping 1954>>, it is definitely recommended to keep it off in production. Keeping
1762C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 1955C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1763can be very useful, however. 1956can be very useful, however.
1764 1957
1958=item C<PERL_ANYEVENT_DEBUG_SHELL>
1959
1960If this env variable is set, then its contents will be
1961interpreted by C<AnyEvent::Socket::parse_hostport> and an
1962C<AnyEvent::Debug::shell> is bound on that port. The shell object is saved
1963in C<$AnyEvent::Debug::SHELL>.
1964
1965For example, to bind a debug shell on a unix domain socket in
1966F</tmp/debug.sock>, you could use this:
1967
1968 PERL_ANYEVENT_DEBUG_SHELL=unix/:/tmp/debug.sock perlprog
1969
1970=item C<PERL_ANYEVENT_DEBUG_WRAP>
1971
1972Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
1973debugging purposes. See C<AnyEvent::Debug::wrap> for details.
1974
1765=item C<PERL_ANYEVENT_MODEL> 1975=item C<PERL_ANYEVENT_MODEL>
1766 1976
1767This can be used to specify the event model to be used by AnyEvent, before 1977This can be used to specify the event model to be used by AnyEvent, before
1768auto detection and -probing kicks in. It must be a string consisting 1978auto detection and -probing kicks in.
1769entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 1979
1980It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
1981or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1770and the resulting module name is loaded and if the load was successful, 1982resulting module name is loaded and - if the load was successful - used as
1771used as event model. If it fails to load AnyEvent will proceed with 1983event model backend. If it fails to load then AnyEvent will proceed with
1772auto detection and -probing. 1984auto detection and -probing.
1773 1985
1774This functionality might change in future versions. 1986If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
1987nothing gets prepended and the module name is used as-is (hint: C<::> at
1988the end of a string designates a module name and quotes it appropriately).
1775 1989
1776For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 1990For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1777could start your program like this: 1991could start your program like this:
1778 1992
1779 PERL_ANYEVENT_MODEL=Perl perl ... 1993 PERL_ANYEVENT_MODEL=Perl perl ...
1780 1994
1781=item C<PERL_ANYEVENT_PROTOCOLS> 1995=item C<PERL_ANYEVENT_PROTOCOLS>
1902 warn "read: $input\n"; # output what has been read 2116 warn "read: $input\n"; # output what has been read
1903 $cv->send if $input =~ /^q/i; # quit program if /^q/i 2117 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1904 }, 2118 },
1905 ); 2119 );
1906 2120
1907 my $time_watcher; # can only be used once
1908
1909 sub new_timer {
1910 $timer = AnyEvent->timer (after => 1, cb => sub { 2121 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1911 warn "timeout\n"; # print 'timeout' about every second 2122 warn "timeout\n"; # print 'timeout' at most every second
1912 &new_timer; # and restart the time
1913 }); 2123 });
1914 }
1915
1916 new_timer; # create first timer
1917 2124
1918 $cv->recv; # wait until user enters /^q/i 2125 $cv->recv; # wait until user enters /^q/i
1919 2126
1920=head1 REAL-WORLD EXAMPLE 2127=head1 REAL-WORLD EXAMPLE
1921 2128
1994 2201
1995The actual code goes further and collects all errors (C<die>s, exceptions) 2202The actual code goes further and collects all errors (C<die>s, exceptions)
1996that occurred during request processing. The C<result> method detects 2203that occurred during request processing. The C<result> method detects
1997whether an exception as thrown (it is stored inside the $txn object) 2204whether an exception as thrown (it is stored inside the $txn object)
1998and just throws the exception, which means connection errors and other 2205and just throws the exception, which means connection errors and other
1999problems get reported tot he code that tries to use the result, not in a 2206problems get reported to the code that tries to use the result, not in a
2000random callback. 2207random callback.
2001 2208
2002All of this enables the following usage styles: 2209All of this enables the following usage styles:
2003 2210
20041. Blocking: 22111. Blocking:
2052through AnyEvent. The benchmark creates a lot of timers (with a zero 2259through AnyEvent. The benchmark creates a lot of timers (with a zero
2053timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2260timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
2054which it is), lets them fire exactly once and destroys them again. 2261which it is), lets them fire exactly once and destroys them again.
2055 2262
2056Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2263Source code for this benchmark is found as F<eg/bench> in the AnyEvent
2057distribution. 2264distribution. It uses the L<AE> interface, which makes a real difference
2265for the EV and Perl backends only.
2058 2266
2059=head3 Explanation of the columns 2267=head3 Explanation of the columns
2060 2268
2061I<watcher> is the number of event watchers created/destroyed. Since 2269I<watcher> is the number of event watchers created/destroyed. Since
2062different event models feature vastly different performances, each event 2270different event models feature vastly different performances, each event
2083watcher. 2291watcher.
2084 2292
2085=head3 Results 2293=head3 Results
2086 2294
2087 name watchers bytes create invoke destroy comment 2295 name watchers bytes create invoke destroy comment
2088 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2296 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2089 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2297 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2090 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2298 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2091 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2299 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2092 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2300 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2093 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2301 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2094 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 2302 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2095 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 2303 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2096 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2304 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2097 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2305 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2098 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2306 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2099 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2307 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2100 2308
2101=head3 Discussion 2309=head3 Discussion
2102 2310
2103The benchmark does I<not> measure scalability of the event loop very 2311The benchmark does I<not> measure scalability of the event loop very
2104well. For example, a select-based event loop (such as the pure perl one) 2312well. For example, a select-based event loop (such as the pure perl one)
2116benchmark machine, handling an event takes roughly 1600 CPU cycles with 2324benchmark machine, handling an event takes roughly 1600 CPU cycles with
2117EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2325EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2118cycles with POE. 2326cycles with POE.
2119 2327
2120C<EV> is the sole leader regarding speed and memory use, which are both 2328C<EV> is the sole leader regarding speed and memory use, which are both
2121maximal/minimal, respectively. Even when going through AnyEvent, it uses 2329maximal/minimal, respectively. When using the L<AE> API there is zero
2330overhead (when going through the AnyEvent API create is about 5-6 times
2331slower, with other times being equal, so still uses far less memory than
2122far less memory than any other event loop and is still faster than Event 2332any other event loop and is still faster than Event natively).
2123natively.
2124 2333
2125The pure perl implementation is hit in a few sweet spots (both the 2334The pure perl implementation is hit in a few sweet spots (both the
2126constant timeout and the use of a single fd hit optimisations in the perl 2335constant timeout and the use of a single fd hit optimisations in the perl
2127interpreter and the backend itself). Nevertheless this shows that it 2336interpreter and the backend itself). Nevertheless this shows that it
2128adds very little overhead in itself. Like any select-based backend its 2337adds very little overhead in itself. Like any select-based backend its
2202In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2411In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2203(1%) are active. This mirrors the activity of large servers with many 2412(1%) are active. This mirrors the activity of large servers with many
2204connections, most of which are idle at any one point in time. 2413connections, most of which are idle at any one point in time.
2205 2414
2206Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2415Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2207distribution. 2416distribution. It uses the L<AE> interface, which makes a real difference
2417for the EV and Perl backends only.
2208 2418
2209=head3 Explanation of the columns 2419=head3 Explanation of the columns
2210 2420
2211I<sockets> is the number of sockets, and twice the number of "servers" (as 2421I<sockets> is the number of sockets, and twice the number of "servers" (as
2212each server has a read and write socket end). 2422each server has a read and write socket end).
2220a new one that moves the timeout into the future. 2430a new one that moves the timeout into the future.
2221 2431
2222=head3 Results 2432=head3 Results
2223 2433
2224 name sockets create request 2434 name sockets create request
2225 EV 20000 69.01 11.16 2435 EV 20000 62.66 7.99
2226 Perl 20000 73.32 35.87 2436 Perl 20000 68.32 32.64
2227 IOAsync 20000 157.00 98.14 epoll 2437 IOAsync 20000 174.06 101.15 epoll
2228 IOAsync 20000 159.31 616.06 poll 2438 IOAsync 20000 174.67 610.84 poll
2229 Event 20000 212.62 257.32 2439 Event 20000 202.69 242.91
2230 Glib 20000 651.16 1896.30 2440 Glib 20000 557.01 1689.52
2231 POE 20000 349.67 12317.24 uses POE::Loop::Event 2441 POE 20000 341.54 12086.32 uses POE::Loop::Event
2232 2442
2233=head3 Discussion 2443=head3 Discussion
2234 2444
2235This benchmark I<does> measure scalability and overall performance of the 2445This benchmark I<does> measure scalability and overall performance of the
2236particular event loop. 2446particular event loop.
2362As you can see, the AnyEvent + EV combination even beats the 2572As you can see, the AnyEvent + EV combination even beats the
2363hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2573hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2364backend easily beats IO::Lambda and POE. 2574backend easily beats IO::Lambda and POE.
2365 2575
2366And even the 100% non-blocking version written using the high-level (and 2576And even the 100% non-blocking version written using the high-level (and
2367slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2577slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2368large margin, even though it does all of DNS, tcp-connect and socket I/O 2578higher level ("unoptimised") abstractions by a large margin, even though
2369in a non-blocking way. 2579it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2370 2580
2371The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2581The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2372F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2582F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2373part of the IO::lambda distribution and were used without any changes. 2583part of the IO::Lambda distribution and were used without any changes.
2374 2584
2375 2585
2376=head1 SIGNALS 2586=head1 SIGNALS
2377 2587
2378AnyEvent currently installs handlers for these signals: 2588AnyEvent currently installs handlers for these signals:
2415 unless defined $SIG{PIPE}; 2625 unless defined $SIG{PIPE};
2416 2626
2417=head1 RECOMMENDED/OPTIONAL MODULES 2627=head1 RECOMMENDED/OPTIONAL MODULES
2418 2628
2419One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and 2629One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2420it's built-in modules) are required to use it. 2630its built-in modules) are required to use it.
2421 2631
2422That does not mean that AnyEvent won't take advantage of some additional 2632That does not mean that AnyEvent won't take advantage of some additional
2423modules if they are installed. 2633modules if they are installed.
2424 2634
2425This section epxlains which additional modules will be used, and how they 2635This section explains which additional modules will be used, and how they
2426affect AnyEvent's operetion. 2636affect AnyEvent's operation.
2427 2637
2428=over 4 2638=over 4
2429 2639
2430=item L<Async::Interrupt> 2640=item L<Async::Interrupt>
2431 2641
2436catch the signals) with some delay (default is 10 seconds, look for 2646catch the signals) with some delay (default is 10 seconds, look for
2437C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2647C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2438 2648
2439If this module is available, then it will be used to implement signal 2649If this module is available, then it will be used to implement signal
2440catching, which means that signals will not be delayed, and the event loop 2650catching, which means that signals will not be delayed, and the event loop
2441will not be interrupted regularly, which is more efficient (And good for 2651will not be interrupted regularly, which is more efficient (and good for
2442battery life on laptops). 2652battery life on laptops).
2443 2653
2444This affects not just the pure-perl event loop, but also other event loops 2654This affects not just the pure-perl event loop, but also other event loops
2445that have no signal handling on their own (e.g. Glib, Tk, Qt). 2655that have no signal handling on their own (e.g. Glib, Tk, Qt).
2446 2656
2458automatic timer adjustments even when no monotonic clock is available, 2668automatic timer adjustments even when no monotonic clock is available,
2459can take avdantage of advanced kernel interfaces such as C<epoll> and 2669can take avdantage of advanced kernel interfaces such as C<epoll> and
2460C<kqueue>, and is the fastest backend I<by far>. You can even embed 2670C<kqueue>, and is the fastest backend I<by far>. You can even embed
2461L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). 2671L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2462 2672
2673If you only use backends that rely on another event loop (e.g. C<Tk>),
2674then this module will do nothing for you.
2675
2463=item L<Guard> 2676=item L<Guard>
2464 2677
2465The guard module, when used, will be used to implement 2678The guard module, when used, will be used to implement
2466C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a 2679C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2467lot less memory), but otherwise doesn't affect guard operation much. It is 2680lot less memory), but otherwise doesn't affect guard operation much. It is
2468purely used for performance. 2681purely used for performance.
2469 2682
2470=item L<JSON> and L<JSON::XS> 2683=item L<JSON> and L<JSON::XS>
2471 2684
2472This module is required when you want to read or write JSON data via 2685One of these modules is required when you want to read or write JSON data
2473L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2686via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2474advantage of the ultra-high-speed L<JSON::XS> module when it is installed. 2687advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2475
2476In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2477installed.
2478 2688
2479=item L<Net::SSLeay> 2689=item L<Net::SSLeay>
2480 2690
2481Implementing TLS/SSL in Perl is certainly interesting, but not very 2691Implementing TLS/SSL in Perl is certainly interesting, but not very
2482worthwhile: If this module is installed, then L<AnyEvent::Handle> (with 2692worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2483the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. 2693the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2484 2694
2485=item L<Time::HiRes> 2695=item L<Time::HiRes>
2486 2696
2487This module is part of perl since release 5.008. It will be used when the 2697This module is part of perl since release 5.008. It will be used when the
2488chosen event library does not come with a timing source on it's own. The 2698chosen event library does not come with a timing source of its own. The
2489pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2699pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2490try to use a monotonic clock for timing stability. 2700try to use a monotonic clock for timing stability.
2491 2701
2492=back 2702=back
2493 2703
2494 2704
2495=head1 FORK 2705=head1 FORK
2496 2706
2497Most event libraries are not fork-safe. The ones who are usually are 2707Most event libraries are not fork-safe. The ones who are usually are
2498because they rely on inefficient but fork-safe C<select> or C<poll> 2708because they rely on inefficient but fork-safe C<select> or C<poll> calls
2499calls. Only L<EV> is fully fork-aware. 2709- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
2710are usually badly thought-out hacks that are incompatible with fork in
2711one way or another. Only L<EV> is fully fork-aware and ensures that you
2712continue event-processing in both parent and child (or both, if you know
2713what you are doing).
2714
2715This means that, in general, you cannot fork and do event processing in
2716the child if the event library was initialised before the fork (which
2717usually happens when the first AnyEvent watcher is created, or the library
2718is loaded).
2500 2719
2501If you have to fork, you must either do so I<before> creating your first 2720If you have to fork, you must either do so I<before> creating your first
2502watcher OR you must not use AnyEvent at all in the child OR you must do 2721watcher OR you must not use AnyEvent at all in the child OR you must do
2503something completely out of the scope of AnyEvent. 2722something completely out of the scope of AnyEvent.
2723
2724The problem of doing event processing in the parent I<and> the child
2725is much more complicated: even for backends that I<are> fork-aware or
2726fork-safe, their behaviour is not usually what you want: fork clones all
2727watchers, that means all timers, I/O watchers etc. are active in both
2728parent and child, which is almost never what you want. USing C<exec>
2729to start worker children from some kind of manage rprocess is usually
2730preferred, because it is much easier and cleaner, at the expense of having
2731to have another binary.
2504 2732
2505 2733
2506=head1 SECURITY CONSIDERATIONS 2734=head1 SECURITY CONSIDERATIONS
2507 2735
2508AnyEvent can be forced to load any event model via 2736AnyEvent can be forced to load any event model via
2538pronounced). 2766pronounced).
2539 2767
2540 2768
2541=head1 SEE ALSO 2769=head1 SEE ALSO
2542 2770
2771Tutorial/Introduction: L<AnyEvent::Intro>.
2772
2773FAQ: L<AnyEvent::FAQ>.
2774
2543Utility functions: L<AnyEvent::Util>. 2775Utility functions: L<AnyEvent::Util>.
2544 2776
2545Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2777Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,
2546L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2778L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2547 2779
2548Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2780Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2549L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2781L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2550L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2782L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2551L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2783L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2553Non-blocking file handles, sockets, TCP clients and 2785Non-blocking file handles, sockets, TCP clients and
2554servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2786servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2555 2787
2556Asynchronous DNS: L<AnyEvent::DNS>. 2788Asynchronous DNS: L<AnyEvent::DNS>.
2557 2789
2558Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, 2790Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2559L<Coro::Event>,
2560 2791
2561Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, 2792Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2562L<AnyEvent::HTTP>. 2793L<AnyEvent::HTTP>.
2563 2794
2564 2795
2565=head1 AUTHOR 2796=head1 AUTHOR
2566 2797

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines