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.264 by root, Wed Jul 29 12:42:09 2009 UTC vs.
Revision 1.356 by root, Fri Aug 12 18:41:25 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 });
180Note that C<my $w; $w => combination. This is necessary because in Perl, 184Note that C<my $w; $w => combination. This is necessary because in Perl,
181my variables are only visible after the statement in which they are 185my variables are only visible after the statement in which they are
182declared. 186declared.
183 187
184=head2 I/O WATCHERS 188=head2 I/O WATCHERS
189
190 $w = AnyEvent->io (
191 fh => <filehandle_or_fileno>,
192 poll => <"r" or "w">,
193 cb => <callback>,
194 );
185 195
186You can create an I/O watcher by calling the C<< AnyEvent->io >> method 196You can create an I/O watcher by calling the C<< AnyEvent->io >> method
187with the following mandatory key-value pairs as arguments: 197with the following mandatory key-value pairs as arguments:
188 198
189C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch 199C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
204 214
205The 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.
206You 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
207underlying file descriptor. 217underlying file descriptor.
208 218
209Some event loops issue spurious readyness notifications, so you should 219Some event loops issue spurious readiness notifications, so you should
210always use non-blocking calls when reading/writing from/to your file 220always use non-blocking calls when reading/writing from/to your file
211handles. 221handles.
212 222
213Example: 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
214watcher. 224watcher.
219 undef $w; 229 undef $w;
220 }); 230 });
221 231
222=head2 TIME WATCHERS 232=head2 TIME WATCHERS
223 233
234 $w = AnyEvent->timer (after => <seconds>, cb => <callback>);
235
236 $w = AnyEvent->timer (
237 after => <fractional_seconds>,
238 interval => <fractional_seconds>,
239 cb => <callback>,
240 );
241
224You can create a time watcher by calling the C<< AnyEvent->timer >> 242You can create a time watcher by calling the C<< AnyEvent->timer >>
225method with the following mandatory arguments: 243method with the following mandatory arguments:
226 244
227C<after> specifies after how many seconds (fractional values are 245C<after> specifies after how many seconds (fractional values are
228supported) the callback should be invoked. C<cb> is the callback to invoke 246supported) the callback should be invoked. C<cb> is the callback to invoke
230 248
231Although the callback might get passed parameters, their value and 249Although the callback might get passed parameters, their value and
232presence is undefined and you cannot rely on them. Portable AnyEvent 250presence is undefined and you cannot rely on them. Portable AnyEvent
233callbacks cannot use arguments passed to time watcher callbacks. 251callbacks cannot use arguments passed to time watcher callbacks.
234 252
235The callback will normally be invoked once only. If you specify another 253The callback will normally be invoked only once. If you specify another
236parameter, C<interval>, as a strictly positive number (> 0), then the 254parameter, C<interval>, as a strictly positive number (> 0), then the
237callback will be invoked regularly at that interval (in fractional 255callback will be invoked regularly at that interval (in fractional
238seconds) after the first invocation. If C<interval> is specified with a 256seconds) after the first invocation. If C<interval> is specified with a
239false value, then it is treated as if it were missing. 257false value, then it is treated as if it were not specified at all.
240 258
241The callback will be rescheduled before invoking the callback, but no 259The callback will be rescheduled before invoking the callback, but no
242attempt 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
243only approximate. 261only approximate.
244 262
245Example: fire an event after 7.7 seconds. 263Example: fire an event after 7.7 seconds.
246 264
247 my $w = AnyEvent->timer (after => 7.7, cb => sub { 265 my $w = AnyEvent->timer (after => 7.7, cb => sub {
265 283
266While 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
267use absolute time internally. This makes a difference when your clock 285use absolute time internally. This makes a difference when your clock
268"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
269the 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
270fire "after" a second might actually take six years to finally fire. 288fire "after a second" might actually take six years to finally fire.
271 289
272AnyEvent cannot compensate for this. The only event loop that is conscious 290AnyEvent cannot compensate for this. The only event loop that is conscious
273about 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
274on true relative time) and absolute (ev_periodic, based on wallclock time) 292on true relative time) and absolute (ev_periodic, based on wallclock time)
275timers. 293timers.
276 294
277AnyEvent always prefers relative timers, if available, matching the 295AnyEvent always prefers relative timers, if available, matching the
278AnyEvent API. 296AnyEvent API.
300I<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
301function to call when you want to know the current time.> 319function to call when you want to know the current time.>
302 320
303This function is also often faster then C<< AnyEvent->time >>, and 321This function is also often faster then C<< AnyEvent->time >>, and
304thus the preferred method if you want some timestamp (for example, 322thus the preferred method if you want some timestamp (for example,
305L<AnyEvent::Handle> uses this to update it's activity timeouts). 323L<AnyEvent::Handle> uses this to update its activity timeouts).
306 324
307The 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
308with your timing, you can skip it without bad conscience. 326with your timing; you can skip it without a bad conscience.
309 327
310For 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>
311and L<EV> and the following set-up: 329and L<EV> and the following set-up:
312 330
313The 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
314time=500 (assume no other callbacks delay processing). In your callback, 332time=500 (assume no other callbacks delay processing). In your callback,
315you 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
316second) 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
317after three seconds. 335after three seconds.
318 336
338difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
339account. 357account.
340 358
341=item AnyEvent->now_update 359=item AnyEvent->now_update
342 360
343Some 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
344the current time for each loop iteration (see the discussion of L<< 362time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
345AnyEvent->now >>, above). 363above).
346 364
347When 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
348this "current" time will differ substantially from the real time, which 366this "current" time will differ substantially from the real time, which
349might affect timers and time-outs. 367might affect timers and time-outs.
350 368
351When 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
352event loop's idea of "current time". 370event loop's idea of "current time".
353 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).
378
354Note 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.
355 380
356=back 381=back
357 382
358=head2 SIGNAL WATCHERS 383=head2 SIGNAL WATCHERS
384
385 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
359 386
360You can watch for signals using a signal watcher, C<signal> is the signal 387You can watch for signals using a signal watcher, C<signal> is the signal
361I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl 388I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
362callback to be invoked whenever a signal occurs. 389callback to be invoked whenever a signal occurs.
363 390
380 407
381Example: exit on SIGINT 408Example: exit on SIGINT
382 409
383 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 410 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384 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
385=head3 Signal Races, Delays and Workarounds 429=head3 Signal Races, Delays and Workarounds
386 430
387Many 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
388callbacks to signals in a generic way, which is a pity, as you cannot do 432callbacks to signals in a generic way, which is a pity, as you cannot
389race-free signal handling in perl. AnyEvent will try to do it's best, but 433do race-free signal handling in perl, requiring C libraries for
434this. AnyEvent will try to do its best, which means in some cases,
390in some cases, signals will be delayed. The maximum time a signal might 435signals will be delayed. The maximum time a signal might be delayed is
391be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 436specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392seconds). This variable can be changed only before the first signal 437variable can be changed only before the first signal watcher is created,
393watcher is created, and should be left alone otherwise. Higher values 438and should be left alone otherwise. This variable determines how often
439AnyEvent polls for signals (in case a wake-up was missed). Higher values
394will cause fewer spurious wake-ups, which is better for power and CPU 440will cause fewer spurious wake-ups, which is better for power and CPU
441saving.
442
395saving. All these problems can be avoided by installing the optional 443All these problems can be avoided by installing the optional
396L<Async::Interrupt> module. This will not work with inherently broken 444L<Async::Interrupt> module, which works with most event loops. It will not
397event loops such as L<Event> or L<Event::Lib> (and not with L<POE> 445work with inherently broken event loops such as L<Event> or L<Event::Lib>
398currently, as POE does it's own workaround with one-second latency). With 446(and not with L<POE> currently, as POE does its own workaround with
399those, you just have to suffer the delays. 447one-second latency). For those, you just have to suffer the delays.
400 448
401=head2 CHILD PROCESS WATCHERS 449=head2 CHILD PROCESS WATCHERS
402 450
451 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
452
403You 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.
404 454
405The 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,
406using 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
407croak). The watcher will be triggered only when the child process has 457croak). The watcher will be triggered only when the child process has
408finished and an exit status is available, not on any trace events 458finished and an exit status is available, not on any trace events
409(stopped/continued). 459(stopped/continued).
410 460
432thing 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
433watcher before you C<fork> the child (alternatively, you can call 483watcher before you C<fork> the child (alternatively, you can call
434C<AnyEvent::detect>). 484C<AnyEvent::detect>).
435 485
436As 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
437emulated 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
438mentioned in the description of signal watchers apply. 488problems mentioned in the description of signal watchers apply.
439 489
440Example: fork a process and wait for it 490Example: fork a process and wait for it
441 491
442 my $done = AnyEvent->condvar; 492 my $done = AnyEvent->condvar;
443 493
455 # do something else, then wait for process exit 505 # do something else, then wait for process exit
456 $done->recv; 506 $done->recv;
457 507
458=head2 IDLE WATCHERS 508=head2 IDLE WATCHERS
459 509
460Sometimes there is a need to do something, but it is not so important 510 $w = AnyEvent->idle (cb => <callback>);
461to do it instantly, but only when there is nothing better to do. This
462"nothing better to do" is usually defined to be "no other events need
463attention by the event loop".
464 511
465Idle watchers ideally get invoked when the event loop has nothing 512This will repeatedly invoke the callback after the process becomes idle,
466better to do, just before it would block the process to wait for new 513until either the watcher is destroyed or new events have been detected.
467events. Instead of blocking, the idle watcher is invoked.
468 514
469Most event loops unfortunately do not really support idle watchers (only 515Idle watchers are useful when there is a need to do something, but it
516is not so important (or wise) to do it instantly. The callback will be
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.
523
524Unfortunately, most event loops do not really support idle watchers (only
470EV, 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
471will simply call the callback "from time to time". 526will simply call the callback "from time to time".
472 527
473Example: read lines from STDIN, but only process them when the 528Example: read lines from STDIN, but only process them when the
474program is otherwise idle: 529program is otherwise idle:
490 }); 545 });
491 }); 546 });
492 547
493=head2 CONDITION VARIABLES 548=head2 CONDITION VARIABLES
494 549
550 $cv = AnyEvent->condvar;
551
552 $cv->send (<list>);
553 my @res = $cv->recv;
554
495If you are familiar with some event loops you will know that all of them 555If you are familiar with some event loops you will know that all of them
496require you to run some blocking "loop", "run" or similar function that 556require you to run some blocking "loop", "run" or similar function that
497will actively watch for new events and call your callbacks. 557will actively watch for new events and call your callbacks.
498 558
499AnyEvent is slightly different: it expects somebody else to run the event 559AnyEvent is slightly different: it expects somebody else to run the event
500loop 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).
501 561
502The instrument to do that is called a "condition variable", so called 562The tool to do that is called a "condition variable", so called because
503because they represent a condition that must become true. 563they represent a condition that must become true.
504 564
505Now 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.
506 566
507Condition variables can be created by calling the C<< AnyEvent->condvar 567Condition variables can be created by calling the C<< AnyEvent->condvar
508>> method, usually without arguments. The only argument pair allowed is 568>> method, usually without arguments. The only argument pair allowed is
513After creation, the condition variable is "false" until it becomes "true" 573After creation, the condition variable is "false" until it becomes "true"
514by 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
515were 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<<
516->send >> method). 576->send >> method).
517 577
518Condition variables are similar to callbacks, except that you can 578Since condition variables are the most complex part of the AnyEvent API, here are
519optionally 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:
520in time where multiple outstanding events have been processed. And yet 580
521another way to call them is transactions - each condition variable can be 581=over 4
522used to represent a transaction, which finishes at some point and delivers 582
523a 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
524compute/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
525 601
526Condition variables are very useful to signal that something has finished, 602Condition variables are very useful to signal that something has finished,
527for example, if you write a module that does asynchronous http requests, 603for example, if you write a module that does asynchronous http requests,
528then a condition variable would be the ideal candidate to signal the 604then a condition variable would be the ideal candidate to signal the
529availability of results. The user can either act when the callback is 605availability of results. The user can either act when the callback is
542 618
543Condition variables are represented by hash refs in perl, and the keys 619Condition variables are represented by hash refs in perl, and the keys
544used 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
545easy (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
546AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call 622AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
547it's C<new> method in your own C<new> method. 623its C<new> method in your own C<new> method.
548 624
549There are two "sides" to a condition variable - the "producer side" which 625There are two "sides" to a condition variable - the "producer side" which
550eventually calls C<< -> send >>, and the "consumer side", which waits 626eventually calls C<< -> send >>, and the "consumer side", which waits
551for the send to occur. 627for the send to occur.
552 628
553Example: wait for a timer. 629Example: wait for a timer.
554 630
555 # wait till the result is ready 631 # condition: "wait till the timer is fired"
556 my $result_ready = AnyEvent->condvar; 632 my $timer_fired = AnyEvent->condvar;
557 633
558 # do something such as adding a timer 634 # create the timer - we could wait for, say
559 # or socket watcher the calls $result_ready->send 635 # a handle becomign ready, or even an
560 # when the "result" is ready. 636 # AnyEvent::HTTP request to finish, but
561 # in this case, we simply use a timer: 637 # in this case, we simply use a timer:
562 my $w = AnyEvent->timer ( 638 my $w = AnyEvent->timer (
563 after => 1, 639 after => 1,
564 cb => sub { $result_ready->send }, 640 cb => sub { $timer_fired->send },
565 ); 641 );
566 642
567 # this "blocks" (while handling events) till the callback 643 # this "blocks" (while handling events) till the callback
568 # calls -<send 644 # calls ->send
569 $result_ready->recv; 645 $timer_fired->recv;
570 646
571Example: 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
572variables are also callable directly. 648variables are also callable directly.
573 649
574 my $done = AnyEvent->condvar; 650 my $done = AnyEvent->condvar;
617they 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
618C<send>. 694C<send>.
619 695
620=item $cv->croak ($error) 696=item $cv->croak ($error)
621 697
622Similar to send, but causes all call's to C<< ->recv >> to invoke 698Similar to send, but causes all calls to C<< ->recv >> to invoke
623C<Carp::croak> with the given error message/object/scalar. 699C<Carp::croak> with the given error message/object/scalar.
624 700
625This can be used to signal any errors to the condition variable 701This can be used to signal any errors to the condition variable
626user/consumer. Doing it this way instead of calling C<croak> directly 702user/consumer. Doing it this way instead of calling C<croak> directly
627delays the error detetcion, but has the overwhelmign advantage that it 703delays the error detection, but has the overwhelming advantage that it
628diagnoses 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
629deep in some event clalback without connection to the actual code causing 705deep in some event callback with no connection to the actual code causing
630the problem. 706the problem.
631 707
632=item $cv->begin ([group callback]) 708=item $cv->begin ([group callback])
633 709
634=item $cv->end 710=item $cv->end
637one. 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
638to use a condition variable for the whole process. 714to use a condition variable for the whole process.
639 715
640Every 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
641C<< ->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
642>>, 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
643is 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
644callback 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.
645 722
646You 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
647sends), 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
648condition (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).
649 726
671one 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
672sending. 749sending.
673 750
674The ping example mentioned above is slightly more complicated, as the 751The ping example mentioned above is slightly more complicated, as the
675there 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
676begung can potentially be zero: 753begun can potentially be zero:
677 754
678 my $cv = AnyEvent->condvar; 755 my $cv = AnyEvent->condvar;
679 756
680 my %result; 757 my %result;
681 $cv->begin (sub { $cv->send (\%result) }); 758 $cv->begin (sub { shift->send (\%result) });
682 759
683 for my $host (@list_of_hosts) { 760 for my $host (@list_of_hosts) {
684 $cv->begin; 761 $cv->begin;
685 ping_host_then_call_callback $host, sub { 762 ping_host_then_call_callback $host, sub {
686 $result{$host} = ...; 763 $result{$host} = ...;
702to 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
703C<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
704doesn't execute once). 781doesn't execute once).
705 782
706This is the general pattern when you "fan out" into multiple (but 783This is the general pattern when you "fan out" into multiple (but
707potentially 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
708the 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
709subrequest you start, call C<begin> and for each subrequest you finish, 786subrequest you start, call C<begin> and for each subrequest you finish,
710call C<end>. 787call C<end>.
711 788
712=back 789=back
719=over 4 796=over 4
720 797
721=item $cv->recv 798=item $cv->recv
722 799
723Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak 800Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
724>> methods have been called on c<$cv>, while servicing other watchers 801>> methods have been called on C<$cv>, while servicing other watchers
725normally. 802normally.
726 803
727You 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
728will return immediately. 805will return immediately.
729 806
746caller 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
747condition variables with some kind of request results and supporting 824condition variables with some kind of request results and supporting
748callbacks so the caller knows that getting the result will not block, 825callbacks so the caller knows that getting the result will not block,
749while still supporting blocking waits if the caller so desires). 826while still supporting blocking waits if the caller so desires).
750 827
751You 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
752only calling C<< ->recv >> from within that callback (or at a later 829only calling C<< ->recv >> from within that callback (or at a later
753time). 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
754waits otherwise. 831waits otherwise.
755 832
756=item $bool = $cv->ready 833=item $bool = $cv->ready
762 839
763This is a mutator function that returns the callback set and optionally 840This is a mutator function that returns the callback set and optionally
764replaces it before doing so. 841replaces it before doing so.
765 842
766The callback will be called when the condition becomes "true", i.e. when 843The callback will be called when the condition becomes "true", i.e. when
767C<send> or C<croak> are called, with the only argument being the condition 844C<send> or C<croak> are called, with the only argument being the
768variable itself. Calling C<recv> inside the callback or at any later time 845condition variable itself. If the condition is already true, the
769is guaranteed not to block. 846callback is called immediately when it is set. Calling C<recv> inside
847the callback or at any later time is guaranteed not to block.
770 848
771=back 849=back
772 850
773=head1 SUPPORTED EVENT LOOPS/BACKENDS 851=head1 SUPPORTED EVENT LOOPS/BACKENDS
774 852
777=over 4 855=over 4
778 856
779=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.
780 858
781EV 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
782use. 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
783that, will fall back to its own pure-perl implementation, which is 861pure-perl implementation, which is available everywhere as it comes with
784available everywhere as it comes with AnyEvent itself. 862AnyEvent itself.
785 863
786 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 864 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
787 AnyEvent::Impl::Event based on Event, very stable, few glitches.
788 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 865 AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
789 866
790=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.
791 868
792These 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
793is 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
794them. This means that AnyEvent will automatically pick the right backend 871them. This means that AnyEvent will automatically pick the right backend
795when the main program loads an event module before anything starts to 872when the main program loads an event module before anything starts to
796create watchers. Nothing special needs to be done by the main program. 873create watchers. Nothing special needs to be done by the main program.
797 874
875 AnyEvent::Impl::Event based on Event, very stable, few glitches.
798 AnyEvent::Impl::Glib based on Glib, slow but very stable. 876 AnyEvent::Impl::Glib based on Glib, slow but very stable.
799 AnyEvent::Impl::Tk based on Tk, very broken. 877 AnyEvent::Impl::Tk based on Tk, very broken.
800 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
801 AnyEvent::Impl::POE based on POE, very slow, some limitations. 879 AnyEvent::Impl::POE based on POE, very slow, some limitations.
802 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).
803 884
804=item Backends with special needs. 885=item Backends with special needs.
805 886
806Qt requires the Qt::Application to be instantiated first, but will 887Qt requires the Qt::Application to be instantiated first, but will
807otherwise be picked up automatically. As long as the main program 888otherwise be picked up automatically. As long as the main program
808instantiates the application before any AnyEvent watchers are created, 889instantiates the application before any AnyEvent watchers are created,
809everything should just work. 890everything should just work.
810 891
811 AnyEvent::Impl::Qt based on Qt. 892 AnyEvent::Impl::Qt based on Qt.
812 893
813Support for IO::Async can only be partial, as it is too broken and
814architecturally limited to even support the AnyEvent API. It also
815is the only event loop that needs the loop to be set explicitly, so
816it can only be used by a main program knowing about AnyEvent. See
817L<AnyEvent::Impl::Async> for the gory details.
818
819 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
820
821=item Event loops that are indirectly supported via other backends. 894=item Event loops that are indirectly supported via other backends.
822 895
823Some event loops can be supported via other modules: 896Some event loops can be supported via other modules:
824 897
825There is no direct support for WxWidgets (L<Wx>) or L<Prima>. 898There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
850Contains C<undef> until the first watcher is being created, before the 923Contains C<undef> until the first watcher is being created, before the
851backend has been autodetected. 924backend has been autodetected.
852 925
853Afterwards 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
854name 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
855of 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
856case 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
857will be C<urxvt::anyevent>). 930will be C<urxvt::anyevent>).
858 931
859=item AnyEvent::detect 932=item AnyEvent::detect
860 933
861Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
862if necessary. You should only call this function right before you would 935if necessary. You should only call this function right before you would
863have 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
864runtime, and not e.g. while initialising of your module. 937runtime, and not e.g. during initialisation of your module.
865 938
866If you need to do some initialisation before AnyEvent watchers are 939If you need to do some initialisation before AnyEvent watchers are
867created, use C<post_detect>. 940created, use C<post_detect>.
868 941
869=item $guard = AnyEvent::post_detect { BLOCK } 942=item $guard = AnyEvent::post_detect { BLOCK }
870 943
871Arranges 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
872autodetected (or immediately if this has already happened). 945autodetected (or immediately if that has already happened).
873 946
874The 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
875(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
876created, 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
877other initialisations - see the sources of L<AnyEvent::Strict> or 950other initialisations - see the sources of L<AnyEvent::Strict> or
886that automatically removes the callback again when it is destroyed (or 959that automatically removes the callback again when it is destroyed (or
887C<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
888a case where this is useful. 961a case where this is useful.
889 962
890Example: 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
891C<$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.
892 965
893 our WATCHER; 966 our WATCHER;
894 967
895 my $guard = AnyEvent::post_detect { 968 my $guard = AnyEvent::post_detect {
896 $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);
904 $WATCHER ||= $guard; 977 $WATCHER ||= $guard;
905 978
906=item @AnyEvent::post_detect 979=item @AnyEvent::post_detect
907 980
908If 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
909before or after loading AnyEvent), then they will called directly after 982before or after loading AnyEvent), then they will be called directly
910the event loop has been chosen. 983after the event loop has been chosen.
911 984
912You should check C<$AnyEvent::MODEL> before adding to this array, though: 985You should check C<$AnyEvent::MODEL> before adding to this array, though:
913if 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
914array will be ignored. 987array will be ignored.
915 988
916Best use C<AnyEvent::post_detect { BLOCK }> when your application allows 989Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
917it,as it takes care of these details. 990it, as it takes care of these details.
918 991
919This variable is mainly useful for modules that can do something useful 992This variable is mainly useful for modules that can do something useful
920when 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
921not 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
922into AnyEvent passively, without loading it. 995into AnyEvent passively, without loading it.
923 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
924=back 1050=back
925 1051
926=head1 WHAT TO DO IN A MODULE 1052=head1 WHAT TO DO IN A MODULE
927 1053
928As 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
938because 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
939events is to stay interactive. 1065events is to stay interactive.
940 1066
941It 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
942requests 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
943called C<results> that returns the results, it should call C<< ->recv >> 1069called C<results> that returns the results, it may call C<< ->recv >>
944freely, 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).
945 1071
946=head1 WHAT TO DO IN THE MAIN PROGRAM 1072=head1 WHAT TO DO IN THE MAIN PROGRAM
947 1073
948There 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
949dictate which event model to use. 1075dictate which event model to use.
950 1076
951If 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
952do 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
953decide 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.
954 1082
955If 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
956Gtk2 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
957event module before loading AnyEvent or any module that uses it: generally 1085event module before loading AnyEvent or any module that uses it: generally
958speaking, 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
959modules might create watchers when they are loaded, and AnyEvent will 1087modules might create watchers when they are loaded, and AnyEvent will
960decide 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
961might chose the wrong one unless you load the correct one yourself. 1089might choose the wrong one unless you load the correct one yourself.
962 1090
963You can chose to use a pure-perl implementation by loading the 1091You can chose to use a pure-perl implementation by loading the
964C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1092C<AnyEvent::Loop> module, which gives you similar behaviour
965everywhere, but letting AnyEvent chose the model is generally better. 1093everywhere, but letting AnyEvent chose the model is generally better.
966 1094
967=head2 MAINLOOP EMULATION 1095=head2 MAINLOOP EMULATION
968 1096
969Sometimes (often for short test scripts, or even standalone programs who 1097Sometimes (often for short test scripts, or even standalone programs who
984=head1 OTHER MODULES 1112=head1 OTHER MODULES
985 1113
986The following is a non-exhaustive list of additional modules that use 1114The following is a non-exhaustive list of additional modules that use
987AnyEvent 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
988modules 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
989come with AnyEvent, most are available via CPAN. 1117come as part of AnyEvent, the others are available via CPAN.
990 1118
991=over 4 1119=over 4
992 1120
993=item L<AnyEvent::Util> 1121=item L<AnyEvent::Util>
994 1122
995Contains various utility functions that replace often-used but blocking 1123Contains various utility functions that replace often-used blocking
996functions such as C<inet_aton> by event-/callback-based versions. 1124functions such as C<inet_aton> with event/callback-based versions.
997 1125
998=item L<AnyEvent::Socket> 1126=item L<AnyEvent::Socket>
999 1127
1000Provides various utility functions for (internet protocol) sockets, 1128Provides various utility functions for (internet protocol) sockets,
1001addresses and name resolution. Also functions to create non-blocking tcp 1129addresses and name resolution. Also functions to create non-blocking tcp
1003 1131
1004=item L<AnyEvent::Handle> 1132=item L<AnyEvent::Handle>
1005 1133
1006Provide read and write buffers, manages watchers for reads and writes, 1134Provide read and write buffers, manages watchers for reads and writes,
1007supports 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
1008non-blocking SSL/TLS (via L<AnyEvent::TLS>. 1136non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1009 1137
1010=item L<AnyEvent::DNS> 1138=item L<AnyEvent::DNS>
1011 1139
1012Provides rich asynchronous DNS resolver capabilities. 1140Provides rich asynchronous DNS resolver capabilities.
1013 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
1014=item L<AnyEvent::HTTP> 1165=item L<AnyEvent::DBI>
1015 1166
1016A 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,
1017HTTP 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.
1018 1176
1019=item L<AnyEvent::HTTPD> 1177=item L<AnyEvent::HTTPD>
1020 1178
1021Provides a simple web application server framework. 1179A simple embedded webserver.
1022 1180
1023=item L<AnyEvent::FastPing> 1181=item L<AnyEvent::FastPing>
1024 1182
1025The fastest ping in the west. 1183The fastest ping in the west.
1026
1027=item L<AnyEvent::DBI>
1028
1029Executes L<DBI> requests asynchronously in a proxy process.
1030
1031=item L<AnyEvent::AIO>
1032
1033Truly asynchronous I/O, should be in the toolbox of every event
1034programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1035together.
1036
1037=item L<AnyEvent::BDB>
1038
1039Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1040L<BDB> and AnyEvent together.
1041
1042=item L<AnyEvent::GPSD>
1043
1044A non-blocking interface to gpsd, a daemon delivering GPS information.
1045
1046=item L<AnyEvent::IRC>
1047
1048AnyEvent based IRC client module family (replacing the older Net::IRC3).
1049
1050=item L<AnyEvent::XMPP>
1051
1052AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1053Net::XMPP2>.
1054
1055=item L<AnyEvent::IGS>
1056
1057A non-blocking interface to the Internet Go Server protocol (used by
1058L<App::IGS>).
1059
1060=item L<Net::FCP>
1061
1062AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1063of AnyEvent.
1064
1065=item L<Event::ExecFlow>
1066
1067High level API for event-based execution flow control.
1068 1184
1069=item L<Coro> 1185=item L<Coro>
1070 1186
1071Has special support for AnyEvent via L<Coro::AnyEvent>. 1187Has special support for AnyEvent via L<Coro::AnyEvent>.
1072 1188
1076 1192
1077package AnyEvent; 1193package AnyEvent;
1078 1194
1079# basically a tuned-down version of common::sense 1195# basically a tuned-down version of common::sense
1080sub common_sense { 1196sub common_sense {
1081 # no warnings 1197 # from common:.sense 3.4
1082 ${^WARNING_BITS} ^= ${^WARNING_BITS}; 1198 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1083 # use strict vars subs 1199 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1084 $^H |= 0x00000600; 1200 $^H |= 0x00000600;
1085} 1201}
1086 1202
1087BEGIN { AnyEvent::common_sense } 1203BEGIN { AnyEvent::common_sense }
1088 1204
1089use Carp (); 1205use Carp ();
1090 1206
1091our $VERSION = 4.881; 1207our $VERSION = '5.34';
1092our $MODEL; 1208our $MODEL;
1093 1209
1094our $AUTOLOAD; 1210our $AUTOLOAD;
1095our @ISA; 1211our @ISA;
1096 1212
1097our @REGISTRY; 1213our @REGISTRY;
1098 1214
1099our $WIN32;
1100
1101our $VERBOSE; 1215our $VERBOSE;
1102 1216
1103BEGIN { 1217BEGIN {
1104 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1218 require "AnyEvent/constants.pl";
1219
1105 eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; 1220 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1106 1221
1107 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1222 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1108 if ${^TAINT}; 1223 if ${^TAINT};
1109 1224
1110 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1225 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1120 $PROTOCOL{$_} = ++$idx 1235 $PROTOCOL{$_} = ++$idx
1121 for reverse split /\s*,\s*/, 1236 for reverse split /\s*,\s*/,
1122 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1237 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1123} 1238}
1124 1239
1240our @post_detect;
1241
1242sub post_detect(&) {
1243 my ($cb) = @_;
1244
1245 push @post_detect, $cb;
1246
1247 defined wantarray
1248 ? bless \$cb, "AnyEvent::Util::postdetect"
1249 : ()
1250}
1251
1252sub AnyEvent::Util::postdetect::DESTROY {
1253 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1254}
1255
1256our $POSTPONE_W;
1257our @POSTPONE;
1258
1259sub _postpone_exec {
1260 undef $POSTPONE_W;
1261
1262 &{ shift @POSTPONE }
1263 while @POSTPONE;
1264}
1265
1266sub postpone(&) {
1267 push @POSTPONE, shift;
1268
1269 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1270
1271 ()
1272}
1273
1125my @models = ( 1274our @models = (
1126 [EV:: => AnyEvent::Impl::EV:: , 1], 1275 [EV:: => AnyEvent::Impl::EV:: , 1],
1276 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1277 # everything below here will not (normally) be autoprobed
1278 # as the pure perl backend should work everywhere
1279 # and is usually faster
1127 [Event:: => AnyEvent::Impl::Event::, 1], 1280 [Event:: => AnyEvent::Impl::Event::, 1],
1128 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1129 # everything below here will not (normally) be autoprobed
1130 # as the pureperl backend should work everywhere
1131 # and is usually faster
1132 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1281 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1133 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1282 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1134 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1283 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1135 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1284 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1136 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1285 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1137 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1286 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1138 [Wx:: => AnyEvent::Impl::POE::], 1287 [Wx:: => AnyEvent::Impl::POE::],
1139 [Prima:: => AnyEvent::Impl::POE::], 1288 [Prima:: => AnyEvent::Impl::POE::],
1140 # IO::Async is just too broken - we would need workarounds for its 1289 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1141 # byzantine signal and broken child handling, among others. 1290 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1142 # IO::Async is rather hard to detect, as it doesn't have any 1291 [FLTK:: => AnyEvent::Impl::FLTK2::],
1143 # obvious default class.
1144# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1145# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1146# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1147); 1292);
1148 1293
1149our %method = map +($_ => 1),
1150 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1151
1152our @post_detect;
1153
1154sub post_detect(&) { 1294sub detect() {
1155 my ($cb) = @_; 1295 # free some memory
1296 *detect = sub () { $MODEL };
1156 1297
1157 if ($MODEL) { 1298 local $!; # for good measure
1158 $cb->(); 1299 local $SIG{__DIE__};
1159 1300
1160 undef 1301 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1302 my $model = $1;
1303 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1304 if (eval "require $model") {
1305 $MODEL = $model;
1306 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1161 } else { 1307 } else {
1162 push @post_detect, $cb; 1308 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1163 1309 }
1164 defined wantarray
1165 ? bless \$cb, "AnyEvent::Util::postdetect"
1166 : ()
1167 } 1310 }
1168}
1169 1311
1170sub AnyEvent::Util::postdetect::DESTROY { 1312 # check for already loaded models
1171 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1172}
1173
1174sub detect() {
1175 unless ($MODEL) { 1313 unless ($MODEL) {
1176 local $SIG{__DIE__}; 1314 for (@REGISTRY, @models) {
1177 1315 my ($package, $model) = @$_;
1178 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1316 if (${"$package\::VERSION"} > 0) {
1179 my $model = "AnyEvent::Impl::$1";
1180 if (eval "require $model") { 1317 if (eval "require $model") {
1181 $MODEL = $model; 1318 $MODEL = $model;
1182 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; 1319 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1183 } else { 1320 last;
1184 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1321 }
1185 } 1322 }
1186 } 1323 }
1187 1324
1188 # check for already loaded models
1189 unless ($MODEL) { 1325 unless ($MODEL) {
1326 # try to autoload a model
1190 for (@REGISTRY, @models) { 1327 for (@REGISTRY, @models) {
1191 my ($package, $model) = @$_; 1328 my ($package, $model, $autoload) = @$_;
1329 if (
1330 $autoload
1331 and eval "require $package"
1192 if (${"$package\::VERSION"} > 0) { 1332 and ${"$package\::VERSION"} > 0
1193 if (eval "require $model") { 1333 and eval "require $model"
1334 ) {
1194 $MODEL = $model; 1335 $MODEL = $model;
1195 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1336 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1196 last; 1337 last;
1197 }
1198 } 1338 }
1199 } 1339 }
1200 1340
1201 unless ($MODEL) {
1202 # try to autoload a model
1203 for (@REGISTRY, @models) {
1204 my ($package, $model, $autoload) = @$_;
1205 if (
1206 $autoload
1207 and eval "require $package"
1208 and ${"$package\::VERSION"} > 0
1209 and eval "require $model"
1210 ) {
1211 $MODEL = $model;
1212 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1213 last;
1214 }
1215 }
1216
1217 $MODEL 1341 $MODEL
1218 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1342 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1219 }
1220 } 1343 }
1221
1222 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1223
1224 unshift @ISA, $MODEL;
1225
1226 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1227
1228 (shift @post_detect)->() while @post_detect;
1229 } 1344 }
1230 1345
1346 # free memory only needed for probing
1347 undef @models;
1348 undef @REGISTRY;
1349
1350 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1351 unshift @ISA, $MODEL;
1352
1353 # now nuke some methods that are overridden by the backend.
1354 # SUPER usage is not allowed in these.
1355 for (qw(time signal child idle)) {
1356 undef &{"AnyEvent::Base::$_"}
1357 if defined &{"$MODEL\::$_"};
1358 }
1359
1360 if ($ENV{PERL_ANYEVENT_STRICT}) {
1361 eval { require AnyEvent::Strict };
1362 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1363 if $@ && $VERBOSE;
1364 }
1365
1366 (shift @post_detect)->() while @post_detect;
1367 undef @post_detect;
1368
1369 *post_detect = sub(&) {
1370 shift->();
1371
1372 undef
1373 };
1374
1375 # recover a few more bytes
1376 postpone {
1377 undef &AUTOLOAD;
1378 };
1379
1231 $MODEL 1380 $MODEL
1232} 1381}
1382
1383our %method = map +($_ => 1),
1384 qw(io timer time now now_update signal child idle condvar DESTROY);
1233 1385
1234sub AUTOLOAD { 1386sub AUTOLOAD {
1235 (my $func = $AUTOLOAD) =~ s/.*://; 1387 (my $func = $AUTOLOAD) =~ s/.*://;
1236 1388
1237 $method{$func} 1389 $method{$func}
1238 or Carp::croak "$func: not a valid method for AnyEvent objects"; 1390 or Carp::croak "$func: not a valid AnyEvent class method";
1239 1391
1240 detect unless $MODEL; 1392 # free some memory
1393 undef %method;
1394
1395 detect;
1241 1396
1242 my $class = shift; 1397 my $class = shift;
1243 $class->$func (@_); 1398 $class->$func (@_);
1244} 1399}
1245 1400
1258 # we assume CLOEXEC is already set by perl in all important cases 1413 # we assume CLOEXEC is already set by perl in all important cases
1259 1414
1260 ($fh2, $rw) 1415 ($fh2, $rw)
1261} 1416}
1262 1417
1418=head1 SIMPLIFIED AE API
1419
1420Starting with version 5.0, AnyEvent officially supports a second, much
1421simpler, API that is designed to reduce the calling, typing and memory
1422overhead by using function call syntax and a fixed number of parameters.
1423
1424See the L<AE> manpage for details.
1425
1426=cut
1427
1428package AE;
1429
1430our $VERSION = $AnyEvent::VERSION;
1431
1432
1433sub _reset() {
1434 eval q{
1435 # fall back to the main API by default - backends and AnyEvent::Base
1436 # implementations can overwrite these.
1437
1438 sub io($$$) {
1439 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1440 }
1441
1442 sub timer($$$) {
1443 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1444 }
1445
1446 sub signal($$) {
1447 AnyEvent->signal (signal => $_[0], cb => $_[1])
1448 }
1449
1450 sub child($$) {
1451 AnyEvent->child (pid => $_[0], cb => $_[1])
1452 }
1453
1454 sub idle($) {
1455 AnyEvent->idle (cb => $_[0])
1456 }
1457
1458 sub cv(;&) {
1459 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1460 }
1461
1462 sub now() {
1463 AnyEvent->now
1464 }
1465
1466 sub now_update() {
1467 AnyEvent->now_update
1468 }
1469
1470 sub time() {
1471 AnyEvent->time
1472 }
1473
1474 *postpone = \&AnyEvent::postpone;
1475 };
1476 die if $@;
1477}
1478
1479BEGIN { _reset }
1480
1263package AnyEvent::Base; 1481package AnyEvent::Base;
1264 1482
1265# default implementations for many methods 1483# default implementations for many methods
1266 1484
1267sub _time { 1485sub time {
1486 eval q{ # poor man's autoloading {}
1268 # probe for availability of Time::HiRes 1487 # probe for availability of Time::HiRes
1269 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1488 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1270 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1489 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1271 *_time = \&Time::HiRes::time; 1490 *AE::time = \&Time::HiRes::time;
1272 # if (eval "use POSIX (); (POSIX::times())... 1491 # if (eval "use POSIX (); (POSIX::times())...
1273 } else { 1492 } else {
1274 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1493 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1275 *_time = sub { time }; # epic fail 1494 *AE::time = sub (){ time }; # epic fail
1495 }
1496
1497 *time = sub { AE::time }; # different prototypes
1276 } 1498 };
1499 die if $@;
1277 1500
1278 &_time 1501 &time
1279} 1502}
1280 1503
1281sub time { _time } 1504*now = \&time;
1282sub now { _time } 1505
1283sub now_update { } 1506sub now_update { }
1284 1507
1508sub _poll {
1509 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1510}
1511
1285# default implementation for ->condvar 1512# default implementation for ->condvar
1513# in fact, the default should not be overwritten
1286 1514
1287sub condvar { 1515sub condvar {
1516 eval q{ # poor man's autoloading {}
1517 *condvar = sub {
1288 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1518 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1519 };
1520
1521 *AE::cv = sub (;&) {
1522 bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
1523 };
1524 };
1525 die if $@;
1526
1527 &condvar
1289} 1528}
1290 1529
1291# default implementation for ->signal 1530# default implementation for ->signal
1292 1531
1293our $HAVE_ASYNC_INTERRUPT; 1532our $HAVE_ASYNC_INTERRUPT;
1294 1533
1295sub _have_async_interrupt() { 1534sub _have_async_interrupt() {
1296 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} 1535 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1297 && eval "use Async::Interrupt 1.0 (); 1") 1536 && eval "use Async::Interrupt 1.02 (); 1")
1298 unless defined $HAVE_ASYNC_INTERRUPT; 1537 unless defined $HAVE_ASYNC_INTERRUPT;
1299 1538
1300 $HAVE_ASYNC_INTERRUPT 1539 $HAVE_ASYNC_INTERRUPT
1301} 1540}
1302 1541
1303our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1542our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1304our (%SIG_ASY, %SIG_ASY_W); 1543our (%SIG_ASY, %SIG_ASY_W);
1305our ($SIG_COUNT, $SIG_TW); 1544our ($SIG_COUNT, $SIG_TW);
1306 1545
1307sub _signal_exec {
1308 $HAVE_ASYNC_INTERRUPT
1309 ? $SIGPIPE_R->drain
1310 : sysread $SIGPIPE_R, my $dummy, 9;
1311
1312 while (%SIG_EV) {
1313 for (keys %SIG_EV) {
1314 delete $SIG_EV{$_};
1315 $_->() for values %{ $SIG_CB{$_} || {} };
1316 }
1317 }
1318}
1319
1320# install a dummy wakeup watcher to reduce signal catching latency 1546# install a dummy wakeup watcher to reduce signal catching latency
1547# used by Impls
1321sub _sig_add() { 1548sub _sig_add() {
1322 unless ($SIG_COUNT++) { 1549 unless ($SIG_COUNT++) {
1323 # try to align timer on a full-second boundary, if possible 1550 # try to align timer on a full-second boundary, if possible
1324 my $NOW = AnyEvent->now; 1551 my $NOW = AE::now;
1325 1552
1326 $SIG_TW = AnyEvent->timer ( 1553 $SIG_TW = AE::timer
1327 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1554 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1328 interval => $MAX_SIGNAL_LATENCY, 1555 $MAX_SIGNAL_LATENCY,
1329 cb => sub { }, # just for the PERL_ASYNC_CHECK 1556 sub { } # just for the PERL_ASYNC_CHECK
1330 ); 1557 ;
1331 } 1558 }
1332} 1559}
1333 1560
1334sub _sig_del { 1561sub _sig_del {
1335 undef $SIG_TW 1562 undef $SIG_TW
1336 unless --$SIG_COUNT; 1563 unless --$SIG_COUNT;
1337} 1564}
1338 1565
1339our $_sig_name_init; $_sig_name_init = sub { 1566our $_sig_name_init; $_sig_name_init = sub {
1567 eval q{ # poor man's autoloading {}
1340 undef $_sig_name_init; 1568 undef $_sig_name_init;
1341 1569
1342 if (_have_async_interrupt) { 1570 if (_have_async_interrupt) {
1343 *sig2num = \&Async::Interrupt::sig2num; 1571 *sig2num = \&Async::Interrupt::sig2num;
1344 *sig2name = \&Async::Interrupt::sig2name; 1572 *sig2name = \&Async::Interrupt::sig2name;
1345 } else { 1573 } else {
1346 require Config; 1574 require Config;
1347 1575
1348 my %signame2num; 1576 my %signame2num;
1349 @signame2num{ split ' ', $Config::Config{sig_name} } 1577 @signame2num{ split ' ', $Config::Config{sig_name} }
1350 = split ' ', $Config::Config{sig_num}; 1578 = split ' ', $Config::Config{sig_num};
1351 1579
1352 my @signum2name; 1580 my @signum2name;
1353 @signum2name[values %signame2num] = keys %signame2num; 1581 @signum2name[values %signame2num] = keys %signame2num;
1354 1582
1355 *sig2num = sub($) { 1583 *sig2num = sub($) {
1356 $_[0] > 0 ? shift : $signame2num{+shift} 1584 $_[0] > 0 ? shift : $signame2num{+shift}
1357 }; 1585 };
1358 *sig2name = sub ($) { 1586 *sig2name = sub ($) {
1359 $_[0] > 0 ? $signum2name[+shift] : shift 1587 $_[0] > 0 ? $signum2name[+shift] : shift
1588 };
1360 }; 1589 }
1361 } 1590 };
1591 die if $@;
1362}; 1592};
1363 1593
1364sub sig2num ($) { &$_sig_name_init; &sig2num } 1594sub sig2num ($) { &$_sig_name_init; &sig2num }
1365sub sig2name($) { &$_sig_name_init; &sig2name } 1595sub sig2name($) { &$_sig_name_init; &sig2name }
1366 1596
1367sub _signal { 1597sub signal {
1598 eval q{ # poor man's autoloading {}
1599 # probe for availability of Async::Interrupt
1600 if (_have_async_interrupt) {
1601 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1602
1603 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1604 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1605
1606 } else {
1607 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1608
1609 if (AnyEvent::WIN32) {
1610 require AnyEvent::Util;
1611
1612 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1613 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1614 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1615 } else {
1616 pipe $SIGPIPE_R, $SIGPIPE_W;
1617 fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1618 fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1619
1620 # not strictly required, as $^F is normally 2, but let's make sure...
1621 fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1622 fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1623 }
1624
1625 $SIGPIPE_R
1626 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1627
1628 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1629 }
1630
1631 *signal = $HAVE_ASYNC_INTERRUPT
1632 ? sub {
1368 my (undef, %arg) = @_; 1633 my (undef, %arg) = @_;
1369 1634
1370 my $signal = uc $arg{signal}
1371 or Carp::croak "required option 'signal' is missing";
1372
1373 if ($HAVE_ASYNC_INTERRUPT) {
1374 # async::interrupt 1635 # async::interrupt
1375
1376 $signal = sig2num $signal; 1636 my $signal = sig2num $arg{signal};
1377 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1637 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1378 1638
1379 $SIG_ASY{$signal} ||= new Async::Interrupt 1639 $SIG_ASY{$signal} ||= new Async::Interrupt
1380 cb => sub { undef $SIG_EV{$signal} }, 1640 cb => sub { undef $SIG_EV{$signal} },
1381 signal => $signal, 1641 signal => $signal,
1382 pipe => [$SIGPIPE_R->filenos], 1642 pipe => [$SIGPIPE_R->filenos],
1383 pipe_autodrain => 0, 1643 pipe_autodrain => 0,
1644 ;
1645
1646 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1647 }
1648 : sub {
1649 my (undef, %arg) = @_;
1650
1651 # pure perl
1652 my $signal = sig2name $arg{signal};
1653 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1654
1655 $SIG{$signal} ||= sub {
1656 local $!;
1657 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1658 undef $SIG_EV{$signal};
1659 };
1660
1661 # can't do signal processing without introducing races in pure perl,
1662 # so limit the signal latency.
1663 _sig_add;
1664
1665 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1666 }
1384 ; 1667 ;
1385 1668
1386 } else { 1669 *AnyEvent::Base::signal::DESTROY = sub {
1387 # pure perl 1670 my ($signal, $cb) = @{$_[0]};
1388 1671
1389 # AE::Util has been loaded in signal 1672 _sig_del;
1390 $signal = sig2name $signal;
1391 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1392 1673
1393 $SIG{$signal} ||= sub { 1674 delete $SIG_CB{$signal}{$cb};
1394 local $!; 1675
1395 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1676 $HAVE_ASYNC_INTERRUPT
1677 ? delete $SIG_ASY{$signal}
1678 : # delete doesn't work with older perls - they then
1679 # print weird messages, or just unconditionally exit
1680 # instead of getting the default action.
1396 undef $SIG_EV{$signal}; 1681 undef $SIG{$signal}
1682 unless keys %{ $SIG_CB{$signal} };
1397 }; 1683 };
1398 1684
1399 # can't do signal processing without introducing races in pure perl, 1685 *_signal_exec = sub {
1400 # so limit the signal latency. 1686 $HAVE_ASYNC_INTERRUPT
1401 _sig_add; 1687 ? $SIGPIPE_R->drain
1402 } 1688 : sysread $SIGPIPE_R, (my $dummy), 9;
1403 1689
1404 bless [$signal, $arg{cb}], "AnyEvent::Base::signal" 1690 while (%SIG_EV) {
1405} 1691 for (keys %SIG_EV) {
1406 1692 delete $SIG_EV{$_};
1407sub signal { 1693 &$_ for values %{ $SIG_CB{$_} || {} };
1408 # probe for availability of Async::Interrupt 1694 }
1409 if (_have_async_interrupt) { 1695 }
1410 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1411
1412 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1413 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1414
1415 } else {
1416 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1417
1418 require Fcntl;
1419
1420 if (AnyEvent::WIN32) {
1421 require AnyEvent::Util;
1422
1423 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1424 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1425 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1426 } else {
1427 pipe $SIGPIPE_R, $SIGPIPE_W;
1428 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1429 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1430
1431 # not strictly required, as $^F is normally 2, but let's make sure...
1432 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1433 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1434 } 1696 };
1435
1436 $SIGPIPE_R
1437 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1438
1439 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1440 } 1697 };
1698 die if $@;
1441 1699
1442 *signal = \&_signal;
1443 &signal 1700 &signal
1444}
1445
1446sub AnyEvent::Base::signal::DESTROY {
1447 my ($signal, $cb) = @{$_[0]};
1448
1449 _sig_del;
1450
1451 delete $SIG_CB{$signal}{$cb};
1452
1453 $HAVE_ASYNC_INTERRUPT
1454 ? delete $SIG_ASY{$signal}
1455 : # delete doesn't work with older perls - they then
1456 # print weird messages, or just unconditionally exit
1457 # instead of getting the default action.
1458 undef $SIG{$signal}
1459 unless keys %{ $SIG_CB{$signal} };
1460} 1701}
1461 1702
1462# default implementation for ->child 1703# default implementation for ->child
1463 1704
1464our %PID_CB; 1705our %PID_CB;
1465our $CHLD_W; 1706our $CHLD_W;
1466our $CHLD_DELAY_W; 1707our $CHLD_DELAY_W;
1467our $WNOHANG;
1468 1708
1709# used by many Impl's
1469sub _emit_childstatus($$) { 1710sub _emit_childstatus($$) {
1470 my (undef, $rpid, $rstatus) = @_; 1711 my (undef, $rpid, $rstatus) = @_;
1471 1712
1472 $_->($rpid, $rstatus) 1713 $_->($rpid, $rstatus)
1473 for values %{ $PID_CB{$rpid} || {} }, 1714 for values %{ $PID_CB{$rpid} || {} },
1474 values %{ $PID_CB{0} || {} }; 1715 values %{ $PID_CB{0} || {} };
1475} 1716}
1476 1717
1477sub _sigchld {
1478 my $pid;
1479
1480 AnyEvent->_emit_childstatus ($pid, $?)
1481 while ($pid = waitpid -1, $WNOHANG) > 0;
1482}
1483
1484sub child { 1718sub child {
1719 eval q{ # poor man's autoloading {}
1720 *_sigchld = sub {
1721 my $pid;
1722
1723 AnyEvent->_emit_childstatus ($pid, $?)
1724 while ($pid = waitpid -1, WNOHANG) > 0;
1725 };
1726
1727 *child = sub {
1485 my (undef, %arg) = @_; 1728 my (undef, %arg) = @_;
1486 1729
1487 defined (my $pid = $arg{pid} + 0) 1730 my $pid = $arg{pid};
1488 or Carp::croak "required option 'pid' is missing"; 1731 my $cb = $arg{cb};
1489 1732
1490 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1733 $PID_CB{$pid}{$cb+0} = $cb;
1491 1734
1492 # WNOHANG is almost cetrainly 1 everywhere
1493 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1494 ? 1
1495 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1496
1497 unless ($CHLD_W) { 1735 unless ($CHLD_W) {
1498 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1736 $CHLD_W = AE::signal CHLD => \&_sigchld;
1499 # child could be a zombie already, so make at least one round 1737 # child could be a zombie already, so make at least one round
1500 &_sigchld; 1738 &_sigchld;
1501 } 1739 }
1502 1740
1503 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1741 bless [$pid, $cb+0], "AnyEvent::Base::child"
1504} 1742 };
1505 1743
1506sub AnyEvent::Base::child::DESTROY { 1744 *AnyEvent::Base::child::DESTROY = sub {
1507 my ($pid, $cb) = @{$_[0]}; 1745 my ($pid, $icb) = @{$_[0]};
1508 1746
1509 delete $PID_CB{$pid}{$cb}; 1747 delete $PID_CB{$pid}{$icb};
1510 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1748 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1511 1749
1512 undef $CHLD_W unless keys %PID_CB; 1750 undef $CHLD_W unless keys %PID_CB;
1751 };
1752 };
1753 die if $@;
1754
1755 &child
1513} 1756}
1514 1757
1515# idle emulation is done by simply using a timer, regardless 1758# idle emulation is done by simply using a timer, regardless
1516# of whether the process is idle or not, and not letting 1759# of whether the process is idle or not, and not letting
1517# the callback use more than 50% of the time. 1760# the callback use more than 50% of the time.
1518sub idle { 1761sub idle {
1762 eval q{ # poor man's autoloading {}
1763 *idle = sub {
1519 my (undef, %arg) = @_; 1764 my (undef, %arg) = @_;
1520 1765
1521 my ($cb, $w, $rcb) = $arg{cb}; 1766 my ($cb, $w, $rcb) = $arg{cb};
1522 1767
1523 $rcb = sub { 1768 $rcb = sub {
1524 if ($cb) { 1769 if ($cb) {
1525 $w = _time; 1770 $w = AE::time;
1526 &$cb; 1771 &$cb;
1527 $w = _time - $w; 1772 $w = AE::time - $w;
1528 1773
1529 # never use more then 50% of the time for the idle watcher, 1774 # never use more then 50% of the time for the idle watcher,
1530 # within some limits 1775 # within some limits
1531 $w = 0.0001 if $w < 0.0001; 1776 $w = 0.0001 if $w < 0.0001;
1532 $w = 5 if $w > 5; 1777 $w = 5 if $w > 5;
1533 1778
1534 $w = AnyEvent->timer (after => $w, cb => $rcb); 1779 $w = AE::timer $w, 0, $rcb;
1535 } else { 1780 } else {
1536 # clean up... 1781 # clean up...
1537 undef $w; 1782 undef $w;
1538 undef $rcb; 1783 undef $rcb;
1784 }
1785 };
1786
1787 $w = AE::timer 0.05, 0, $rcb;
1788
1789 bless \\$cb, "AnyEvent::Base::idle"
1539 } 1790 };
1791
1792 *AnyEvent::Base::idle::DESTROY = sub {
1793 undef $${$_[0]};
1794 };
1540 }; 1795 };
1796 die if $@;
1541 1797
1542 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1798 &idle
1543
1544 bless \\$cb, "AnyEvent::Base::idle"
1545}
1546
1547sub AnyEvent::Base::idle::DESTROY {
1548 undef $${$_[0]};
1549} 1799}
1550 1800
1551package AnyEvent::CondVar; 1801package AnyEvent::CondVar;
1552 1802
1553our @ISA = AnyEvent::CondVar::Base::; 1803our @ISA = AnyEvent::CondVar::Base::;
1804
1805# only to be used for subclassing
1806sub new {
1807 my $class = shift;
1808 bless AnyEvent->condvar (@_), $class
1809}
1554 1810
1555package AnyEvent::CondVar::Base; 1811package AnyEvent::CondVar::Base;
1556 1812
1557#use overload 1813#use overload
1558# '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1814# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1568 1824
1569sub _send { 1825sub _send {
1570 # nop 1826 # nop
1571} 1827}
1572 1828
1829sub _wait {
1830 AnyEvent->_poll until $_[0]{_ae_sent};
1831}
1832
1573sub send { 1833sub send {
1574 my $cv = shift; 1834 my $cv = shift;
1575 $cv->{_ae_sent} = [@_]; 1835 $cv->{_ae_sent} = [@_];
1576 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1836 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1577 $cv->_send; 1837 $cv->_send;
1584 1844
1585sub ready { 1845sub ready {
1586 $_[0]{_ae_sent} 1846 $_[0]{_ae_sent}
1587} 1847}
1588 1848
1589sub _wait {
1590 $WAITING
1591 and !$_[0]{_ae_sent}
1592 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1593
1594 local $WAITING = 1;
1595 AnyEvent->one_event while !$_[0]{_ae_sent};
1596}
1597
1598sub recv { 1849sub recv {
1850 unless ($_[0]{_ae_sent}) {
1851 $WAITING
1852 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1853
1854 local $WAITING = 1;
1599 $_[0]->_wait; 1855 $_[0]->_wait;
1856 }
1600 1857
1601 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1858 $_[0]{_ae_croak}
1602 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1859 and Carp::croak $_[0]{_ae_croak};
1860
1861 wantarray
1862 ? @{ $_[0]{_ae_sent} }
1863 : $_[0]{_ae_sent}[0]
1603} 1864}
1604 1865
1605sub cb { 1866sub cb {
1606 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1867 my $cv = shift;
1868
1869 @_
1870 and $cv->{_ae_cb} = shift
1871 and $cv->{_ae_sent}
1872 and (delete $cv->{_ae_cb})->($cv);
1873
1607 $_[0]{_ae_cb} 1874 $cv->{_ae_cb}
1608} 1875}
1609 1876
1610sub begin { 1877sub begin {
1611 ++$_[0]{_ae_counter}; 1878 ++$_[0]{_ae_counter};
1612 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1879 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1617 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 1884 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1618} 1885}
1619 1886
1620# undocumented/compatibility with pre-3.4 1887# undocumented/compatibility with pre-3.4
1621*broadcast = \&send; 1888*broadcast = \&send;
1622*wait = \&_wait; 1889*wait = \&recv;
1623 1890
1624=head1 ERROR AND EXCEPTION HANDLING 1891=head1 ERROR AND EXCEPTION HANDLING
1625 1892
1626In general, AnyEvent does not do any error handling - it relies on the 1893In general, AnyEvent does not do any error handling - it relies on the
1627caller to do that if required. The L<AnyEvent::Strict> module (see also 1894caller to do that if required. The L<AnyEvent::Strict> module (see also
1674check the arguments passed to most method calls. If it finds any problems, 1941check the arguments passed to most method calls. If it finds any problems,
1675it will croak. 1942it will croak.
1676 1943
1677In other words, enables "strict" mode. 1944In other words, enables "strict" mode.
1678 1945
1679Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense> 1946Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1680>>, it is definitely recommended to keep it off in production. Keeping 1947>>, it is definitely recommended to keep it off in production. Keeping
1681C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 1948C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1682can be very useful, however. 1949can be very useful, however.
1683 1950
1684=item C<PERL_ANYEVENT_MODEL> 1951=item C<PERL_ANYEVENT_MODEL>
1685 1952
1686This can be used to specify the event model to be used by AnyEvent, before 1953This can be used to specify the event model to be used by AnyEvent, before
1687auto detection and -probing kicks in. It must be a string consisting 1954auto detection and -probing kicks in.
1688entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 1955
1956It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
1957or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1689and the resulting module name is loaded and if the load was successful, 1958resulting module name is loaded and - if the load was successful - used as
1690used as event model. If it fails to load AnyEvent will proceed with 1959event model backend. If it fails to load then AnyEvent will proceed with
1691auto detection and -probing. 1960auto detection and -probing.
1692 1961
1693This functionality might change in future versions. 1962If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
1963nothing gets prepended and the module name is used as-is (hint: C<::> at
1964the end of a string designates a module name and quotes it appropriately).
1694 1965
1695For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 1966For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1696could start your program like this: 1967could start your program like this:
1697 1968
1698 PERL_ANYEVENT_MODEL=Perl perl ... 1969 PERL_ANYEVENT_MODEL=Perl perl ...
1699 1970
1700=item C<PERL_ANYEVENT_PROTOCOLS> 1971=item C<PERL_ANYEVENT_PROTOCOLS>
1821 warn "read: $input\n"; # output what has been read 2092 warn "read: $input\n"; # output what has been read
1822 $cv->send if $input =~ /^q/i; # quit program if /^q/i 2093 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1823 }, 2094 },
1824 ); 2095 );
1825 2096
1826 my $time_watcher; # can only be used once
1827
1828 sub new_timer {
1829 $timer = AnyEvent->timer (after => 1, cb => sub { 2097 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1830 warn "timeout\n"; # print 'timeout' about every second 2098 warn "timeout\n"; # print 'timeout' at most every second
1831 &new_timer; # and restart the time
1832 }); 2099 });
1833 }
1834
1835 new_timer; # create first timer
1836 2100
1837 $cv->recv; # wait until user enters /^q/i 2101 $cv->recv; # wait until user enters /^q/i
1838 2102
1839=head1 REAL-WORLD EXAMPLE 2103=head1 REAL-WORLD EXAMPLE
1840 2104
1913 2177
1914The actual code goes further and collects all errors (C<die>s, exceptions) 2178The actual code goes further and collects all errors (C<die>s, exceptions)
1915that occurred during request processing. The C<result> method detects 2179that occurred during request processing. The C<result> method detects
1916whether an exception as thrown (it is stored inside the $txn object) 2180whether an exception as thrown (it is stored inside the $txn object)
1917and just throws the exception, which means connection errors and other 2181and just throws the exception, which means connection errors and other
1918problems get reported tot he code that tries to use the result, not in a 2182problems get reported to the code that tries to use the result, not in a
1919random callback. 2183random callback.
1920 2184
1921All of this enables the following usage styles: 2185All of this enables the following usage styles:
1922 2186
19231. Blocking: 21871. Blocking:
1971through AnyEvent. The benchmark creates a lot of timers (with a zero 2235through AnyEvent. The benchmark creates a lot of timers (with a zero
1972timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2236timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1973which it is), lets them fire exactly once and destroys them again. 2237which it is), lets them fire exactly once and destroys them again.
1974 2238
1975Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2239Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1976distribution. 2240distribution. It uses the L<AE> interface, which makes a real difference
2241for the EV and Perl backends only.
1977 2242
1978=head3 Explanation of the columns 2243=head3 Explanation of the columns
1979 2244
1980I<watcher> is the number of event watchers created/destroyed. Since 2245I<watcher> is the number of event watchers created/destroyed. Since
1981different event models feature vastly different performances, each event 2246different event models feature vastly different performances, each event
2002watcher. 2267watcher.
2003 2268
2004=head3 Results 2269=head3 Results
2005 2270
2006 name watchers bytes create invoke destroy comment 2271 name watchers bytes create invoke destroy comment
2007 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2272 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2008 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2273 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2009 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2274 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2010 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2275 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2011 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2276 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2012 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2277 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2013 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 2278 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2014 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 2279 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2015 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2280 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2016 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2281 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2017 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2282 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2018 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2283 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2019 2284
2020=head3 Discussion 2285=head3 Discussion
2021 2286
2022The benchmark does I<not> measure scalability of the event loop very 2287The benchmark does I<not> measure scalability of the event loop very
2023well. For example, a select-based event loop (such as the pure perl one) 2288well. For example, a select-based event loop (such as the pure perl one)
2035benchmark machine, handling an event takes roughly 1600 CPU cycles with 2300benchmark machine, handling an event takes roughly 1600 CPU cycles with
2036EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2301EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2037cycles with POE. 2302cycles with POE.
2038 2303
2039C<EV> is the sole leader regarding speed and memory use, which are both 2304C<EV> is the sole leader regarding speed and memory use, which are both
2040maximal/minimal, respectively. Even when going through AnyEvent, it uses 2305maximal/minimal, respectively. When using the L<AE> API there is zero
2306overhead (when going through the AnyEvent API create is about 5-6 times
2307slower, with other times being equal, so still uses far less memory than
2041far less memory than any other event loop and is still faster than Event 2308any other event loop and is still faster than Event natively).
2042natively.
2043 2309
2044The pure perl implementation is hit in a few sweet spots (both the 2310The pure perl implementation is hit in a few sweet spots (both the
2045constant timeout and the use of a single fd hit optimisations in the perl 2311constant timeout and the use of a single fd hit optimisations in the perl
2046interpreter and the backend itself). Nevertheless this shows that it 2312interpreter and the backend itself). Nevertheless this shows that it
2047adds very little overhead in itself. Like any select-based backend its 2313adds very little overhead in itself. Like any select-based backend its
2121In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2387In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2122(1%) are active. This mirrors the activity of large servers with many 2388(1%) are active. This mirrors the activity of large servers with many
2123connections, most of which are idle at any one point in time. 2389connections, most of which are idle at any one point in time.
2124 2390
2125Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2391Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2126distribution. 2392distribution. It uses the L<AE> interface, which makes a real difference
2393for the EV and Perl backends only.
2127 2394
2128=head3 Explanation of the columns 2395=head3 Explanation of the columns
2129 2396
2130I<sockets> is the number of sockets, and twice the number of "servers" (as 2397I<sockets> is the number of sockets, and twice the number of "servers" (as
2131each server has a read and write socket end). 2398each server has a read and write socket end).
2139a new one that moves the timeout into the future. 2406a new one that moves the timeout into the future.
2140 2407
2141=head3 Results 2408=head3 Results
2142 2409
2143 name sockets create request 2410 name sockets create request
2144 EV 20000 69.01 11.16 2411 EV 20000 62.66 7.99
2145 Perl 20000 73.32 35.87 2412 Perl 20000 68.32 32.64
2146 IOAsync 20000 157.00 98.14 epoll 2413 IOAsync 20000 174.06 101.15 epoll
2147 IOAsync 20000 159.31 616.06 poll 2414 IOAsync 20000 174.67 610.84 poll
2148 Event 20000 212.62 257.32 2415 Event 20000 202.69 242.91
2149 Glib 20000 651.16 1896.30 2416 Glib 20000 557.01 1689.52
2150 POE 20000 349.67 12317.24 uses POE::Loop::Event 2417 POE 20000 341.54 12086.32 uses POE::Loop::Event
2151 2418
2152=head3 Discussion 2419=head3 Discussion
2153 2420
2154This benchmark I<does> measure scalability and overall performance of the 2421This benchmark I<does> measure scalability and overall performance of the
2155particular event loop. 2422particular event loop.
2281As you can see, the AnyEvent + EV combination even beats the 2548As you can see, the AnyEvent + EV combination even beats the
2282hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2549hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2283backend easily beats IO::Lambda and POE. 2550backend easily beats IO::Lambda and POE.
2284 2551
2285And even the 100% non-blocking version written using the high-level (and 2552And even the 100% non-blocking version written using the high-level (and
2286slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2553slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2287large margin, even though it does all of DNS, tcp-connect and socket I/O 2554higher level ("unoptimised") abstractions by a large margin, even though
2288in a non-blocking way. 2555it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2289 2556
2290The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2557The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2291F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2558F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2292part of the IO::lambda distribution and were used without any changes. 2559part of the IO::Lambda distribution and were used without any changes.
2293 2560
2294 2561
2295=head1 SIGNALS 2562=head1 SIGNALS
2296 2563
2297AnyEvent currently installs handlers for these signals: 2564AnyEvent currently installs handlers for these signals:
2334 unless defined $SIG{PIPE}; 2601 unless defined $SIG{PIPE};
2335 2602
2336=head1 RECOMMENDED/OPTIONAL MODULES 2603=head1 RECOMMENDED/OPTIONAL MODULES
2337 2604
2338One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and 2605One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2339it's built-in modules) are required to use it. 2606its built-in modules) are required to use it.
2340 2607
2341That does not mean that AnyEvent won't take advantage of some additional 2608That does not mean that AnyEvent won't take advantage of some additional
2342modules if they are installed. 2609modules if they are installed.
2343 2610
2344This section epxlains which additional modules will be used, and how they 2611This section explains which additional modules will be used, and how they
2345affect AnyEvent's operetion. 2612affect AnyEvent's operation.
2346 2613
2347=over 4 2614=over 4
2348 2615
2349=item L<Async::Interrupt> 2616=item L<Async::Interrupt>
2350 2617
2355catch the signals) with some delay (default is 10 seconds, look for 2622catch the signals) with some delay (default is 10 seconds, look for
2356C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2623C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2357 2624
2358If this module is available, then it will be used to implement signal 2625If this module is available, then it will be used to implement signal
2359catching, which means that signals will not be delayed, and the event loop 2626catching, which means that signals will not be delayed, and the event loop
2360will not be interrupted regularly, which is more efficient (And good for 2627will not be interrupted regularly, which is more efficient (and good for
2361battery life on laptops). 2628battery life on laptops).
2362 2629
2363This affects not just the pure-perl event loop, but also other event loops 2630This affects not just the pure-perl event loop, but also other event loops
2364that have no signal handling on their own (e.g. Glib, Tk, Qt). 2631that have no signal handling on their own (e.g. Glib, Tk, Qt).
2365 2632
2377automatic timer adjustments even when no monotonic clock is available, 2644automatic timer adjustments even when no monotonic clock is available,
2378can take avdantage of advanced kernel interfaces such as C<epoll> and 2645can take avdantage of advanced kernel interfaces such as C<epoll> and
2379C<kqueue>, and is the fastest backend I<by far>. You can even embed 2646C<kqueue>, and is the fastest backend I<by far>. You can even embed
2380L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). 2647L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2381 2648
2649If you only use backends that rely on another event loop (e.g. C<Tk>),
2650then this module will do nothing for you.
2651
2382=item L<Guard> 2652=item L<Guard>
2383 2653
2384The guard module, when used, will be used to implement 2654The guard module, when used, will be used to implement
2385C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a 2655C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2386lot less memory), but otherwise doesn't affect guard operation much. It is 2656lot less memory), but otherwise doesn't affect guard operation much. It is
2387purely used for performance. 2657purely used for performance.
2388 2658
2389=item L<JSON> and L<JSON::XS> 2659=item L<JSON> and L<JSON::XS>
2390 2660
2391This module is required when you want to read or write JSON data via 2661One of these modules is required when you want to read or write JSON data
2392L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2662via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2393advantage of the ultra-high-speed L<JSON::XS> module when it is installed. 2663advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2394
2395In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2396installed.
2397 2664
2398=item L<Net::SSLeay> 2665=item L<Net::SSLeay>
2399 2666
2400Implementing TLS/SSL in Perl is certainly interesting, but not very 2667Implementing TLS/SSL in Perl is certainly interesting, but not very
2401worthwhile: If this module is installed, then L<AnyEvent::Handle> (with 2668worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2402the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. 2669the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2403 2670
2404=item L<Time::HiRes> 2671=item L<Time::HiRes>
2405 2672
2406This module is part of perl since release 5.008. It will be used when the 2673This module is part of perl since release 5.008. It will be used when the
2407chosen event library does not come with a timing source on it's own. The 2674chosen event library does not come with a timing source of its own. The
2408pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2675pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2409try to use a monotonic clock for timing stability. 2676try to use a monotonic clock for timing stability.
2410 2677
2411=back 2678=back
2412 2679
2413 2680
2414=head1 FORK 2681=head1 FORK
2415 2682
2416Most event libraries are not fork-safe. The ones who are usually are 2683Most event libraries are not fork-safe. The ones who are usually are
2417because they rely on inefficient but fork-safe C<select> or C<poll> 2684because they rely on inefficient but fork-safe C<select> or C<poll> calls
2418calls. Only L<EV> is fully fork-aware. 2685- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
2686are usually badly thought-out hacks that are incompatible with fork in
2687one way or another. Only L<EV> is fully fork-aware and ensures that you
2688continue event-processing in both parent and child (or both, if you know
2689what you are doing).
2690
2691This means that, in general, you cannot fork and do event processing in
2692the child if the event library was initialised before the fork (which
2693usually happens when the first AnyEvent watcher is created, or the library
2694is loaded).
2419 2695
2420If you have to fork, you must either do so I<before> creating your first 2696If you have to fork, you must either do so I<before> creating your first
2421watcher OR you must not use AnyEvent at all in the child OR you must do 2697watcher OR you must not use AnyEvent at all in the child OR you must do
2422something completely out of the scope of AnyEvent. 2698something completely out of the scope of AnyEvent.
2699
2700The problem of doing event processing in the parent I<and> the child
2701is much more complicated: even for backends that I<are> fork-aware or
2702fork-safe, their behaviour is not usually what you want: fork clones all
2703watchers, that means all timers, I/O watchers etc. are active in both
2704parent and child, which is almost never what you want. USing C<exec>
2705to start worker children from some kind of manage rprocess is usually
2706preferred, because it is much easier and cleaner, at the expense of having
2707to have another binary.
2423 2708
2424 2709
2425=head1 SECURITY CONSIDERATIONS 2710=head1 SECURITY CONSIDERATIONS
2426 2711
2427AnyEvent can be forced to load any event model via 2712AnyEvent can be forced to load any event model via
2457pronounced). 2742pronounced).
2458 2743
2459 2744
2460=head1 SEE ALSO 2745=head1 SEE ALSO
2461 2746
2747Tutorial/Introduction: L<AnyEvent::Intro>.
2748
2749FAQ: L<AnyEvent::FAQ>.
2750
2462Utility functions: L<AnyEvent::Util>. 2751Utility functions: L<AnyEvent::Util>.
2463 2752
2464Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2753Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,
2465L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2754L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2466 2755
2467Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2756Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2468L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2757L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2469L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2758L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2470L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2759L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2472Non-blocking file handles, sockets, TCP clients and 2761Non-blocking file handles, sockets, TCP clients and
2473servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2762servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2474 2763
2475Asynchronous DNS: L<AnyEvent::DNS>. 2764Asynchronous DNS: L<AnyEvent::DNS>.
2476 2765
2477Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, 2766Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2478L<Coro::Event>,
2479 2767
2480Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, 2768Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2481L<AnyEvent::HTTP>. 2769L<AnyEvent::HTTP>.
2482 2770
2483 2771
2484=head1 AUTHOR 2772=head1 AUTHOR
2485 2773

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines