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.224 by root, Fri Jul 3 21:44:14 2009 UTC vs.
Revision 1.420 by root, Fri Sep 5 22:17:26 2014 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - the DBI of event loop programming
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported 5EV, Event, Glib, Tk, UV, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async,
6event loops. 6Qt, FLTK and POE are various supported event loops/environments.
7 7
8=head1 SYNOPSIS 8=head1 SYNOPSIS
9 9
10 use AnyEvent; 10 use AnyEvent;
11 11
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
40=head1 INTRODUCTION/TUTORIAL 43=head1 INTRODUCTION/TUTORIAL
41 44
42This manpage is mainly a reference manual. If you are interested 45This manpage is mainly a reference manual. If you are interested
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.
48
49=head1 SUPPORT
50
51An FAQ document is available as L<AnyEvent::FAQ>.
52
53There also is a mailinglist for discussing all things AnyEvent, and an IRC
54channel, too.
55
56See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
57Repository>, at L<http://anyevent.schmorp.de>, for more info.
45 58
46=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 59=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
47 60
48Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 61Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
49nowadays. So what is different about AnyEvent? 62nowadays. So what is different about AnyEvent?
65module 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
66model you use. 79model you use.
67 80
68For 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
69actually 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
70like 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
71cannot use anything else, as they are simply incompatible to everything 84cannot use anything else, as they are simply incompatible to everything
72that 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
73module 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.
74 87
75AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 88AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
76fine. 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
77with 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
78your 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
79too. But if your module uses AnyEvent, it works transparently with all 92your module uses AnyEvent, it works transparently with all event models it
80event 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
81use 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,
82to AnyEvent, too, so it is future-proof). 95so it is future-proof).
83 96
84In 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
85model>, 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
86modules, 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
87follow. 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
88offering 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
89technically possible. 102technically possible.
90 103
91Of course, AnyEvent comes with a big (and fully optional!) toolbox 104Of course, AnyEvent comes with a big (and fully optional!) toolbox
92of useful functionality, such as an asynchronous DNS resolver, 100% 105of useful functionality, such as an asynchronous DNS resolver, 100%
98useful) 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
99model, you should I<not> use this module. 112model, you should I<not> use this module.
100 113
101=head1 DESCRIPTION 114=head1 DESCRIPTION
102 115
103L<AnyEvent> provides an identical interface to multiple event loops. This 116L<AnyEvent> provides a uniform interface to various event loops. This
104allows module authors to utilise an event loop without forcing module 117allows module authors to use event loop functionality without forcing
105users 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
106peacefully at any one time). 119than one event loop cannot coexist peacefully).
107 120
108The 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>
109module. 122module.
110 123
111During the first call of any watcher-creation method, the module tries 124During the first call of any watcher-creation method, the module tries
112to 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
113following modules is already loaded: L<EV>, 126following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
114L<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
115L<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
116to 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
117adaptor should always succeed) in the order given. The first one that can 130available, the pure-perl L<AnyEvent::Loop> should always work, so
118be successfully loaded will be used. If, after this, still none could be 131the other two are not normally tried.
119found, AnyEvent will fall back to a pure-perl event loop, which is not
120very efficient, but should work everywhere.
121 132
122Because AnyEvent first checks for modules that are already loaded, loading 133Because AnyEvent first checks for modules that are already loaded, loading
123an event model explicitly before first using AnyEvent will likely make 134an event model explicitly before first using AnyEvent will likely make
124that model the default. For example: 135that model the default. For example:
125 136
127 use AnyEvent; 138 use AnyEvent;
128 139
129 # .. AnyEvent will likely default to Tk 140 # .. AnyEvent will likely default to Tk
130 141
131The 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
132starts 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,
133use AnyEvent so their modules work together with others seamlessly... 144as very few modules hardcode event loops without announcing this very
145loudly.
134 146
135The pure-perl implementation of AnyEvent is called 147The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
136C<AnyEvent::Impl::Perl>. Like other event modules you can load it 148other event modules you can load it explicitly and enjoy the high
137explicitly and enjoy the high availability of that event loop :) 149availability of that event loop :)
138 150
139=head1 WATCHERS 151=head1 WATCHERS
140 152
141AnyEvent 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
142stores 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
147callback when the event occurs (of course, only when the event model 159callback when the event occurs (of course, only when the event model
148is in control). 160is in control).
149 161
150Note that B<callbacks must not permanently change global variables> 162Note that B<callbacks must not permanently change global variables>
151potentially 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<<
152callbacks must not C<die> >>. The former is good programming practise in 164callbacks must not C<die> >>. The former is good programming practice in
153Perl and the latter stems from the fact that exception handling differs 165Perl and the latter stems from the fact that exception handling differs
154widely between event loops. 166widely between event loops.
155 167
156To 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
157variable 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
158to it). 170to it).
159 171
160All 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.
161 173
162Many watchers either are used with "recursion" (repeating timers for 174Many watchers either are used with "recursion" (repeating timers for
163example), or need to refer to their watcher object in other ways. 175example), or need to refer to their watcher object in other ways.
164 176
165An any way to achieve that is this pattern: 177One way to achieve that is this pattern:
166 178
167 my $w; $w = AnyEvent->type (arg => value ..., cb => sub { 179 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
168 # you can use $w here, for example to undef it 180 # you can use $w here, for example to undef it
169 undef $w; 181 undef $w;
170 }); 182 });
173my variables are only visible after the statement in which they are 185my variables are only visible after the statement in which they are
174declared. 186declared.
175 187
176=head2 I/O WATCHERS 188=head2 I/O WATCHERS
177 189
190 $w = AnyEvent->io (
191 fh => <filehandle_or_fileno>,
192 poll => <"r" or "w">,
193 cb => <callback>,
194 );
195
178You 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
179with the following mandatory key-value pairs as arguments: 197with the following mandatory key-value pairs as arguments:
180 198
181C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch 199C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
182for events (AnyEvent might or might not keep a reference to this file 200for events (AnyEvent might or might not keep a reference to this file
183handle). Note that only file handles pointing to things for which 201handle). Note that only file handles pointing to things for which
184non-blocking operation makes sense are allowed. This includes sockets, 202non-blocking operation makes sense are allowed. This includes sockets,
185most character devices, pipes, fifos and so on, but not for example files 203most character devices, pipes, fifos and so on, but not for example files
186or block devices. 204or block devices.
196 214
197The 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.
198You 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
199underlying file descriptor. 217underlying file descriptor.
200 218
201Some event loops issue spurious readyness notifications, so you should 219Some event loops issue spurious readiness notifications, so you should
202always use non-blocking calls when reading/writing from/to your file 220always use non-blocking calls when reading/writing from/to your file
203handles. 221handles.
204 222
205Example: 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
206watcher. 224watcher.
211 undef $w; 229 undef $w;
212 }); 230 });
213 231
214=head2 TIME WATCHERS 232=head2 TIME WATCHERS
215 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
216You can create a time watcher by calling the C<< AnyEvent->timer >> 242You can create a time watcher by calling the C<< AnyEvent->timer >>
217method with the following mandatory arguments: 243method with the following mandatory arguments:
218 244
219C<after> specifies after how many seconds (fractional values are 245C<after> specifies after how many seconds (fractional values are
220supported) 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
222 248
223Although the callback might get passed parameters, their value and 249Although the callback might get passed parameters, their value and
224presence is undefined and you cannot rely on them. Portable AnyEvent 250presence is undefined and you cannot rely on them. Portable AnyEvent
225callbacks cannot use arguments passed to time watcher callbacks. 251callbacks cannot use arguments passed to time watcher callbacks.
226 252
227The callback will normally be invoked once only. If you specify another 253The callback will normally be invoked only once. If you specify another
228parameter, C<interval>, as a strictly positive number (> 0), then the 254parameter, C<interval>, as a strictly positive number (> 0), then the
229callback will be invoked regularly at that interval (in fractional 255callback will be invoked regularly at that interval (in fractional
230seconds) after the first invocation. If C<interval> is specified with a 256seconds) after the first invocation. If C<interval> is specified with a
231false value, then it is treated as if it were missing. 257false value, then it is treated as if it were not specified at all.
232 258
233The callback will be rescheduled before invoking the callback, but no 259The callback will be rescheduled before invoking the callback, but no
234attempt 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
235only approximate. 261only approximate.
236 262
237Example: fire an event after 7.7 seconds. 263Example: fire an event after 7.7 seconds.
238 264
239 my $w = AnyEvent->timer (after => 7.7, cb => sub { 265 my $w = AnyEvent->timer (after => 7.7, cb => sub {
245 271
246Example 2: fire an event after 0.5 seconds, then roughly every second. 272Example 2: fire an event after 0.5 seconds, then roughly every second.
247 273
248 my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub { 274 my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
249 warn "timeout\n"; 275 warn "timeout\n";
250 }; 276 });
251 277
252=head3 TIMING ISSUES 278=head3 TIMING ISSUES
253 279
254There are two ways to handle timers: based on real time (relative, "fire 280There are two ways to handle timers: based on real time (relative, "fire
255in 10 seconds") and based on wallclock time (absolute, "fire at 12 281in 10 seconds") and based on wallclock time (absolute, "fire at 12
257 283
258While 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
259use absolute time internally. This makes a difference when your clock 285use absolute time internally. This makes a difference when your clock
260"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
261the 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
262fire "after" a second might actually take six years to finally fire. 288fire "after a second" might actually take six years to finally fire.
263 289
264AnyEvent cannot compensate for this. The only event loop that is conscious 290AnyEvent cannot compensate for this. The only event loop that is conscious
265about 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
266on true relative time) and absolute (ev_periodic, based on wallclock time) 292on true relative time) and absolute (ev_periodic, based on wallclock time)
267timers. 293timers.
268 294
269AnyEvent always prefers relative timers, if available, matching the 295AnyEvent always prefers relative timers, if available, matching the
270AnyEvent API. 296AnyEvent API.
292I<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
293function to call when you want to know the current time.> 319function to call when you want to know the current time.>
294 320
295This function is also often faster then C<< AnyEvent->time >>, and 321This function is also often faster then C<< AnyEvent->time >>, and
296thus the preferred method if you want some timestamp (for example, 322thus the preferred method if you want some timestamp (for example,
297L<AnyEvent::Handle> uses this to update it's activity timeouts). 323L<AnyEvent::Handle> uses this to update its activity timeouts).
298 324
299The 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
300with your timing, you can skip it without bad conscience. 326with your timing; you can skip it without a bad conscience.
301 327
302For 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>
303and L<EV> and the following set-up: 329and L<EV> and the following set-up:
304 330
305The 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
306time=500 (assume no other callbacks delay processing). In your callback, 332time=500 (assume no other callbacks delay processing). In your callback,
307you 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
308second) 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
309after three seconds. 335after three seconds.
310 336
330difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
331account. 357account.
332 358
333=item AnyEvent->now_update 359=item AnyEvent->now_update
334 360
335Some 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
336the current time for each loop iteration (see the discussion of L<< 362time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
337AnyEvent->now >>, above). 363above).
338 364
339When 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
340this "current" time will differ substantially from the real time, which 366this "current" time will differ substantially from the real time, which
341might affect timers and time-outs. 367might affect timers and time-outs.
342 368
343When 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
344event loop's idea of "current time". 370event loop's idea of "current time".
345 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
346Note 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.
347 380
348=back 381=back
349 382
350=head2 SIGNAL WATCHERS 383=head2 SIGNAL WATCHERS
384
385 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
351 386
352You 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
353I<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
354callback to be invoked whenever a signal occurs. 389callback to be invoked whenever a signal occurs.
355 390
361invocation, and callback invocation will be synchronous. Synchronous means 396invocation, and callback invocation will be synchronous. Synchronous means
362that it might take a while until the signal gets handled by the process, 397that it might take a while until the signal gets handled by the process,
363but it is guaranteed not to interrupt any other callbacks. 398but it is guaranteed not to interrupt any other callbacks.
364 399
365The main advantage of using these watchers is that you can share a signal 400The main advantage of using these watchers is that you can share a signal
366between multiple watchers. 401between multiple watchers, and AnyEvent will ensure that signals will not
402interrupt your program at bad times.
367 403
368This watcher might use C<%SIG>, so programs overwriting those signals 404This watcher might use C<%SIG> (depending on the event loop used),
369directly will likely not work correctly. 405so programs overwriting those signals directly will likely not work
406correctly.
370 407
371Example: exit on SIGINT 408Example: exit on SIGINT
372 409
373 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 410 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
374 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)
421or "unsafe" (asynchronous) - the former might delay signal delivery
422indefinitely, the latter 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
429=head3 Signal Races, Delays and Workarounds
430
431Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support
432attaching callbacks to signals in a generic way, which is a pity,
433as you cannot do race-free signal handling in perl, requiring
434C libraries for this. AnyEvent will try to do its best, which
435means in some cases, signals will be delayed. The maximum time
436a signal might be delayed is 10 seconds by default, but can
437be overriden via C<$ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY}> or
438C<$AnyEvent::MAX_SIGNAL_LATENCY> - see the L<ENVIRONMENT VARIABLES>
439section for details.
440
441All these problems can be avoided by installing the optional
442L<Async::Interrupt> module, which works with most event loops. It will not
443work with inherently broken event loops such as L<Event> or L<Event::Lib>
444(and not with L<POE> currently). For those, you just have to suffer the
445delays.
446
375=head2 CHILD PROCESS WATCHERS 447=head2 CHILD PROCESS WATCHERS
376 448
449 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
450
377You can also watch on a child process exit and catch its exit status. 451You can also watch for a child process exit and catch its exit status.
378 452
379The child process is specified by the C<pid> argument (if set to C<0>, it 453The child process is specified by the C<pid> argument (on some backends,
380watches for any child process exit). The watcher will triggered only when 454using C<0> watches for any child process exit, on others this will
381the child process has finished and an exit status is available, not on 455croak). The watcher will be triggered only when the child process has
382any trace events (stopped/continued). 456finished and an exit status is available, not on any trace events
457(stopped/continued).
383 458
384The callback will be called with the pid and exit status (as returned by 459The callback will be called with the pid and exit status (as returned by
385waitpid), so unlike other watcher types, you I<can> rely on child watcher 460waitpid), so unlike other watcher types, you I<can> rely on child watcher
386callback arguments. 461callback arguments.
387 462
404This means you cannot create a child watcher as the very first 479This means you cannot create a child watcher as the very first
405thing in an AnyEvent program, you I<have> to create at least one 480thing in an AnyEvent program, you I<have> to create at least one
406watcher before you C<fork> the child (alternatively, you can call 481watcher before you C<fork> the child (alternatively, you can call
407C<AnyEvent::detect>). 482C<AnyEvent::detect>).
408 483
484As most event loops do not support waiting for child events, they will be
485emulated by AnyEvent in most cases, in which case the latency and race
486problems mentioned in the description of signal watchers apply.
487
409Example: fork a process and wait for it 488Example: fork a process and wait for it
410 489
411 my $done = AnyEvent->condvar; 490 my $done = AnyEvent->condvar;
412 491
492 # this forks and immediately calls exit in the child. this
493 # normally has all sorts of bad consequences for your parent,
494 # so take this as an example only. always fork and exec,
495 # or call POSIX::_exit, in real code.
413 my $pid = fork or exit 5; 496 my $pid = fork or exit 5;
414 497
415 my $w = AnyEvent->child ( 498 my $w = AnyEvent->child (
416 pid => $pid, 499 pid => $pid,
417 cb => sub { 500 cb => sub {
424 # do something else, then wait for process exit 507 # do something else, then wait for process exit
425 $done->recv; 508 $done->recv;
426 509
427=head2 IDLE WATCHERS 510=head2 IDLE WATCHERS
428 511
429Sometimes there is a need to do something, but it is not so important 512 $w = AnyEvent->idle (cb => <callback>);
430to do it instantly, but only when there is nothing better to do. This
431"nothing better to do" is usually defined to be "no other events need
432attention by the event loop".
433 513
434Idle watchers ideally get invoked when the event loop has nothing 514This will repeatedly invoke the callback after the process becomes idle,
435better to do, just before it would block the process to wait for new 515until either the watcher is destroyed or new events have been detected.
436events. Instead of blocking, the idle watcher is invoked.
437 516
438Most event loops unfortunately do not really support idle watchers (only 517Idle watchers are useful when there is a need to do something, but it
518is not so important (or wise) to do it instantly. The callback will be
519invoked only when there is "nothing better to do", which is usually
520defined as "all outstanding events have been handled and no new events
521have been detected". That means that idle watchers ideally get invoked
522when the event loop has just polled for new events but none have been
523detected. Instead of blocking to wait for more events, the idle watchers
524will be invoked.
525
526Unfortunately, most event loops do not really support idle watchers (only
439EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent 527EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
440will simply call the callback "from time to time". 528will simply call the callback "from time to time".
441 529
442Example: read lines from STDIN, but only process them when the 530Example: read lines from STDIN, but only process them when the
443program is otherwise idle: 531program is otherwise idle:
459 }); 547 });
460 }); 548 });
461 549
462=head2 CONDITION VARIABLES 550=head2 CONDITION VARIABLES
463 551
552 $cv = AnyEvent->condvar;
553
554 $cv->send (<list>);
555 my @res = $cv->recv;
556
464If you are familiar with some event loops you will know that all of them 557If you are familiar with some event loops you will know that all of them
465require you to run some blocking "loop", "run" or similar function that 558require you to run some blocking "loop", "run" or similar function that
466will actively watch for new events and call your callbacks. 559will actively watch for new events and call your callbacks.
467 560
468AnyEvent is different, it expects somebody else to run the event loop and 561AnyEvent is slightly different: it expects somebody else to run the event
469will only block when necessary (usually when told by the user). 562loop and will only block when necessary (usually when told by the user).
470 563
471The instrument to do that is called a "condition variable", so called 564The tool to do that is called a "condition variable", so called because
472because they represent a condition that must become true. 565they represent a condition that must become true.
566
567Now is probably a good time to look at the examples further below.
473 568
474Condition variables can be created by calling the C<< AnyEvent->condvar 569Condition variables can be created by calling the C<< AnyEvent->condvar
475>> method, usually without arguments. The only argument pair allowed is 570>> method, usually without arguments. The only argument pair allowed is
476
477C<cb>, which specifies a callback to be called when the condition variable 571C<cb>, which specifies a callback to be called when the condition variable
478becomes true, with the condition variable as the first argument (but not 572becomes true, with the condition variable as the first argument (but not
479the results). 573the results).
480 574
481After creation, the condition variable is "false" until it becomes "true" 575After creation, the condition variable is "false" until it becomes "true"
482by calling the C<send> method (or calling the condition variable as if it 576by calling the C<send> method (or calling the condition variable as if it
483were a callback, read about the caveats in the description for the C<< 577were a callback, read about the caveats in the description for the C<<
484->send >> method). 578->send >> method).
485 579
486Condition variables are similar to callbacks, except that you can 580Since condition variables are the most complex part of the AnyEvent API, here are
487optionally wait for them. They can also be called merge points - points 581some different mental models of what they are - pick the ones you can connect to:
488in time where multiple outstanding events have been processed. And yet 582
489another way to call them is transactions - each condition variable can be 583=over 4
490used to represent a transaction, which finishes at some point and delivers 584
491a result. 585=item * Condition variables are like callbacks - you can call them (and pass them instead
586of callbacks). Unlike callbacks however, you can also wait for them to be called.
587
588=item * Condition variables are signals - one side can emit or send them,
589the other side can wait for them, or install a handler that is called when
590the signal fires.
591
592=item * Condition variables are like "Merge Points" - points in your program
593where you merge multiple independent results/control flows into one.
594
595=item * Condition variables represent a transaction - functions that start
596some kind of transaction can return them, leaving the caller the choice
597between waiting in a blocking fashion, or setting a callback.
598
599=item * Condition variables represent future values, or promises to deliver
600some result, long before the result is available.
601
602=back
492 603
493Condition variables are very useful to signal that something has finished, 604Condition variables are very useful to signal that something has finished,
494for example, if you write a module that does asynchronous http requests, 605for example, if you write a module that does asynchronous http requests,
495then a condition variable would be the ideal candidate to signal the 606then a condition variable would be the ideal candidate to signal the
496availability of results. The user can either act when the callback is 607availability of results. The user can either act when the callback is
509 620
510Condition variables are represented by hash refs in perl, and the keys 621Condition variables are represented by hash refs in perl, and the keys
511used by AnyEvent itself are all named C<_ae_XXX> to make subclassing 622used by AnyEvent itself are all named C<_ae_XXX> to make subclassing
512easy (it is often useful to build your own transaction class on top of 623easy (it is often useful to build your own transaction class on top of
513AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call 624AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
514it's C<new> method in your own C<new> method. 625its C<new> method in your own C<new> method.
515 626
516There are two "sides" to a condition variable - the "producer side" which 627There are two "sides" to a condition variable - the "producer side" which
517eventually calls C<< -> send >>, and the "consumer side", which waits 628eventually calls C<< -> send >>, and the "consumer side", which waits
518for the send to occur. 629for the send to occur.
519 630
520Example: wait for a timer. 631Example: wait for a timer.
521 632
522 # wait till the result is ready 633 # condition: "wait till the timer is fired"
523 my $result_ready = AnyEvent->condvar; 634 my $timer_fired = AnyEvent->condvar;
524 635
525 # do something such as adding a timer 636 # create the timer - we could wait for, say
526 # or socket watcher the calls $result_ready->send 637 # a handle becomign ready, or even an
527 # when the "result" is ready. 638 # AnyEvent::HTTP request to finish, but
528 # in this case, we simply use a timer: 639 # in this case, we simply use a timer:
529 my $w = AnyEvent->timer ( 640 my $w = AnyEvent->timer (
530 after => 1, 641 after => 1,
531 cb => sub { $result_ready->send }, 642 cb => sub { $timer_fired->send },
532 ); 643 );
533 644
534 # this "blocks" (while handling events) till the callback 645 # this "blocks" (while handling events) till the callback
535 # calls send 646 # calls ->send
536 $result_ready->recv; 647 $timer_fired->recv;
537 648
538Example: wait for a timer, but take advantage of the fact that 649Example: wait for a timer, but take advantage of the fact that condition
539condition variables are also code references. 650variables are also callable directly.
540 651
541 my $done = AnyEvent->condvar; 652 my $done = AnyEvent->condvar;
542 my $delay = AnyEvent->timer (after => 5, cb => $done); 653 my $delay = AnyEvent->timer (after => 5, cb => $done);
543 $done->recv; 654 $done->recv;
544 655
550 661
551 ... 662 ...
552 663
553 my @info = $couchdb->info->recv; 664 my @info = $couchdb->info->recv;
554 665
555And this is how you would just ste a callback to be called whenever the 666And this is how you would just set a callback to be called whenever the
556results are available: 667results are available:
557 668
558 $couchdb->info->cb (sub { 669 $couchdb->info->cb (sub {
559 my @info = $_[0]->recv; 670 my @info = $_[0]->recv;
560 }); 671 });
578immediately from within send. 689immediately from within send.
579 690
580Any arguments passed to the C<send> call will be returned by all 691Any arguments passed to the C<send> call will be returned by all
581future C<< ->recv >> calls. 692future C<< ->recv >> calls.
582 693
583Condition variables are overloaded so one can call them directly 694Condition variables are overloaded so one can call them directly (as if
584(as a code reference). Calling them directly is the same as calling 695they were a code reference). Calling them directly is the same as calling
585C<send>. Note, however, that many C-based event loops do not handle 696C<send>.
586overloading, so as tempting as it may be, passing a condition variable
587instead of a callback does not work. Both the pure perl and EV loops
588support overloading, however, as well as all functions that use perl to
589invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
590example).
591 697
592=item $cv->croak ($error) 698=item $cv->croak ($error)
593 699
594Similar to send, but causes all call's to C<< ->recv >> to invoke 700Similar to send, but causes all calls to C<< ->recv >> to invoke
595C<Carp::croak> with the given error message/object/scalar. 701C<Carp::croak> with the given error message/object/scalar.
596 702
597This can be used to signal any errors to the condition variable 703This can be used to signal any errors to the condition variable
598user/consumer. 704user/consumer. Doing it this way instead of calling C<croak> directly
705delays the error detection, but has the overwhelming advantage that it
706diagnoses the error at the place where the result is expected, and not
707deep in some event callback with no connection to the actual code causing
708the problem.
599 709
600=item $cv->begin ([group callback]) 710=item $cv->begin ([group callback])
601 711
602=item $cv->end 712=item $cv->end
603 713
605one. For example, a function that pings many hosts in parallel might want 715one. For example, a function that pings many hosts in parallel might want
606to use a condition variable for the whole process. 716to use a condition variable for the whole process.
607 717
608Every call to C<< ->begin >> will increment a counter, and every call to 718Every call to C<< ->begin >> will increment a counter, and every call to
609C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 719C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
610>>, the (last) callback passed to C<begin> will be executed. That callback 720>>, the (last) callback passed to C<begin> will be executed, passing the
611is I<supposed> to call C<< ->send >>, but that is not required. If no 721condvar as first argument. That callback is I<supposed> to call C<< ->send
612callback was set, C<send> will be called without any arguments. 722>>, but that is not required. If no group callback was set, C<send> will
723be called without any arguments.
613 724
614You can think of C<< $cv->send >> giving you an OR condition (one call 725You can think of C<< $cv->send >> giving you an OR condition (one call
615sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND 726sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
616condition (all C<begin> calls must be C<end>'ed before the condvar sends). 727condition (all C<begin> calls must be C<end>'ed before the condvar sends).
617 728
638This works because for every event source (EOF on file handle), there is 749This works because for every event source (EOF on file handle), there is
639one call to C<begin>, so the condvar waits for all calls to C<end> before 750one call to C<begin>, so the condvar waits for all calls to C<end> before
640sending. 751sending.
641 752
642The ping example mentioned above is slightly more complicated, as the 753The ping example mentioned above is slightly more complicated, as the
643there are results to be passwd back, and the number of tasks that are 754there are results to be passed back, and the number of tasks that are
644begung can potentially be zero: 755begun can potentially be zero:
645 756
646 my $cv = AnyEvent->condvar; 757 my $cv = AnyEvent->condvar;
647 758
648 my %result; 759 my %result;
649 $cv->begin (sub { $cv->send (\%result) }); 760 $cv->begin (sub { shift->send (\%result) });
650 761
651 for my $host (@list_of_hosts) { 762 for my $host (@list_of_hosts) {
652 $cv->begin; 763 $cv->begin;
653 ping_host_then_call_callback $host, sub { 764 ping_host_then_call_callback $host, sub {
654 $result{$host} = ...; 765 $result{$host} = ...;
656 }; 767 };
657 } 768 }
658 769
659 $cv->end; 770 $cv->end;
660 771
772 ...
773
774 my $results = $cv->recv;
775
661This code fragment supposedly pings a number of hosts and calls 776This code fragment supposedly pings a number of hosts and calls
662C<send> after results for all then have have been gathered - in any 777C<send> after results for all then have have been gathered - in any
663order. To achieve this, the code issues a call to C<begin> when it starts 778order. To achieve this, the code issues a call to C<begin> when it starts
664each ping request and calls C<end> when it has received some result for 779each ping request and calls C<end> when it has received some result for
665it. Since C<begin> and C<end> only maintain a counter, the order in which 780it. Since C<begin> and C<end> only maintain a counter, the order in which
670to be called once the counter reaches C<0>, and second, it ensures that 785to be called once the counter reaches C<0>, and second, it ensures that
671C<send> is called even when C<no> hosts are being pinged (the loop 786C<send> is called even when C<no> hosts are being pinged (the loop
672doesn't execute once). 787doesn't execute once).
673 788
674This is the general pattern when you "fan out" into multiple (but 789This is the general pattern when you "fan out" into multiple (but
675potentially none) subrequests: use an outer C<begin>/C<end> pair to set 790potentially zero) subrequests: use an outer C<begin>/C<end> pair to set
676the callback and ensure C<end> is called at least once, and then, for each 791the callback and ensure C<end> is called at least once, and then, for each
677subrequest you start, call C<begin> and for each subrequest you finish, 792subrequest you start, call C<begin> and for each subrequest you finish,
678call C<end>. 793call C<end>.
679 794
680=back 795=back
687=over 4 802=over 4
688 803
689=item $cv->recv 804=item $cv->recv
690 805
691Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak 806Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
692>> methods have been called on c<$cv>, while servicing other watchers 807>> methods have been called on C<$cv>, while servicing other watchers
693normally. 808normally.
694 809
695You can only wait once on a condition - additional calls are valid but 810You can only wait once on a condition - additional calls are valid but
696will return immediately. 811will return immediately.
697 812
699function will call C<croak>. 814function will call C<croak>.
700 815
701In list context, all parameters passed to C<send> will be returned, 816In list context, all parameters passed to C<send> will be returned,
702in scalar context only the first one will be returned. 817in scalar context only the first one will be returned.
703 818
819Note that doing a blocking wait in a callback is not supported by any
820event loop, that is, recursive invocation of a blocking C<< ->recv >> is
821not allowed and the C<recv> call will C<croak> if such a condition is
822detected. This requirement can be dropped by relying on L<Coro::AnyEvent>
823, which allows you to do a blocking C<< ->recv >> from any thread
824that doesn't run the event loop itself. L<Coro::AnyEvent> is loaded
825automatically when L<Coro> is used with L<AnyEvent>, so code does not need
826to do anything special to take advantage of that: any code that would
827normally block your program because it calls C<recv>, be executed in an
828C<async> thread instead without blocking other threads.
829
704Not all event models support a blocking wait - some die in that case 830Not all event models support a blocking wait - some die in that case
705(programs might want to do that to stay interactive), so I<if you are 831(programs might want to do that to stay interactive), so I<if you are
706using this from a module, never require a blocking wait>, but let the 832using this from a module, never require a blocking wait>. Instead, let the
707caller decide whether the call will block or not (for example, by coupling 833caller decide whether the call will block or not (for example, by coupling
708condition variables with some kind of request results and supporting 834condition variables with some kind of request results and supporting
709callbacks so the caller knows that getting the result will not block, 835callbacks so the caller knows that getting the result will not block,
710while still supporting blocking waits if the caller so desires). 836while still supporting blocking waits if the caller so desires).
711 837
712Another reason I<never> to C<< ->recv >> in a module is that you cannot
713sensibly have two C<< ->recv >>'s in parallel, as that would require
714multiple interpreters or coroutines/threads, none of which C<AnyEvent>
715can supply.
716
717The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
718fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
719versions and also integrates coroutines into AnyEvent, making blocking
720C<< ->recv >> calls perfectly safe as long as they are done from another
721coroutine (one that doesn't run the event loop).
722
723You can ensure that C<< -recv >> never blocks by setting a callback and 838You can ensure that C<< ->recv >> never blocks by setting a callback and
724only calling C<< ->recv >> from within that callback (or at a later 839only calling C<< ->recv >> from within that callback (or at a later
725time). This will work even when the event loop does not support blocking 840time). This will work even when the event loop does not support blocking
726waits otherwise. 841waits otherwise.
727 842
728=item $bool = $cv->ready 843=item $bool = $cv->ready
734 849
735This is a mutator function that returns the callback set and optionally 850This is a mutator function that returns the callback set and optionally
736replaces it before doing so. 851replaces it before doing so.
737 852
738The callback will be called when the condition becomes "true", i.e. when 853The callback will be called when the condition becomes "true", i.e. when
739C<send> or C<croak> are called, with the only argument being the condition 854C<send> or C<croak> are called, with the only argument being the
740variable itself. Calling C<recv> inside the callback or at any later time 855condition variable itself. If the condition is already true, the
741is guaranteed not to block. 856callback is called immediately when it is set. Calling C<recv> inside
857the callback or at any later time is guaranteed not to block.
742 858
743=back 859=back
744 860
861=head1 SUPPORTED EVENT LOOPS/BACKENDS
862
863The available backend classes are (every class has its own manpage):
864
865=over 4
866
867=item Backends that are autoprobed when no other event loop can be found.
868
869EV is the preferred backend when no other event loop seems to be in
870use. If EV is not installed, then AnyEvent will fall back to its own
871pure-perl implementation, which is available everywhere as it comes with
872AnyEvent itself.
873
874 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
875 AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
876
877=item Backends that are transparently being picked up when they are used.
878
879These will be used if they are already loaded when the first watcher
880is created, in which case it is assumed that the application is using
881them. This means that AnyEvent will automatically pick the right backend
882when the main program loads an event module before anything starts to
883create watchers. Nothing special needs to be done by the main program.
884
885 AnyEvent::Impl::Event based on Event, very stable, few glitches.
886 AnyEvent::Impl::Glib based on Glib, slow but very stable.
887 AnyEvent::Impl::Tk based on Tk, very broken.
888 AnyEvent::Impl::UV based on UV, innovated square wheels.
889 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
890 AnyEvent::Impl::POE based on POE, very slow, some limitations.
891 AnyEvent::Impl::Irssi used when running within irssi.
892 AnyEvent::Impl::IOAsync based on IO::Async.
893 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
894 AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
895
896=item Backends with special needs.
897
898Qt requires the Qt::Application to be instantiated first, but will
899otherwise be picked up automatically. As long as the main program
900instantiates the application before any AnyEvent watchers are created,
901everything should just work.
902
903 AnyEvent::Impl::Qt based on Qt.
904
905=item Event loops that are indirectly supported via other backends.
906
907Some event loops can be supported via other modules:
908
909There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
910
911B<WxWidgets> has no support for watching file handles. However, you can
912use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
913polls 20 times per second, which was considered to be too horrible to even
914consider for AnyEvent.
915
916B<Prima> is not supported as nobody seems to be using it, but it has a POE
917backend, so it can be supported through POE.
918
919AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
920load L<POE> when detecting them, in the hope that POE will pick them up,
921in which case everything will be automatic.
922
923=back
924
745=head1 GLOBAL VARIABLES AND FUNCTIONS 925=head1 GLOBAL VARIABLES AND FUNCTIONS
746 926
927These are not normally required to use AnyEvent, but can be useful to
928write AnyEvent extension modules.
929
747=over 4 930=over 4
748 931
749=item $AnyEvent::MODEL 932=item $AnyEvent::MODEL
750 933
751Contains C<undef> until the first watcher is being created. Then it 934Contains C<undef> until the first watcher is being created, before the
935backend has been autodetected.
936
752contains the event model that is being used, which is the name of the 937Afterwards it contains the event model that is being used, which is the
753Perl class implementing the model. This class is usually one of the 938name of the Perl class implementing the model. This class is usually one
754C<AnyEvent::Impl:xxx> modules, but can be any other class in the case 939of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
755AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). 940case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
756 941will be C<urxvt::anyevent>).
757The known classes so far are:
758
759 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
760 AnyEvent::Impl::Event based on Event, second best choice.
761 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
762 AnyEvent::Impl::Glib based on Glib, third-best choice.
763 AnyEvent::Impl::Tk based on Tk, very bad choice.
764 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
765 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
766 AnyEvent::Impl::POE based on POE, not generic enough for full support.
767
768 # warning, support for IO::Async is only partial, as it is too broken
769 # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
770 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
771
772There is no support for WxWidgets, as WxWidgets has no support for
773watching file handles. However, you can use WxWidgets through the
774POE Adaptor, as POE has a Wx backend that simply polls 20 times per
775second, which was considered to be too horrible to even consider for
776AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
777it's adaptor.
778
779AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
780autodetecting them.
781 942
782=item AnyEvent::detect 943=item AnyEvent::detect
783 944
784Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 945Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
785if necessary. You should only call this function right before you would 946if necessary. You should only call this function right before you would
786have created an AnyEvent watcher anyway, that is, as late as possible at 947have created an AnyEvent watcher anyway, that is, as late as possible at
787runtime. 948runtime, and not e.g. during initialisation of your module.
949
950The effect of calling this function is as if a watcher had been created
951(specifically, actions that happen "when the first watcher is created"
952happen when calling detetc as well).
953
954If you need to do some initialisation before AnyEvent watchers are
955created, use C<post_detect>.
788 956
789=item $guard = AnyEvent::post_detect { BLOCK } 957=item $guard = AnyEvent::post_detect { BLOCK }
790 958
791Arranges for the code block to be executed as soon as the event model is 959Arranges for the code block to be executed as soon as the event model is
792autodetected (or immediately if this has already happened). 960autodetected (or immediately if that has already happened).
961
962The block will be executed I<after> the actual backend has been detected
963(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
964created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
965other initialisations - see the sources of L<AnyEvent::Strict> or
966L<AnyEvent::AIO> to see how this is used.
967
968The most common usage is to create some global watchers, without forcing
969event module detection too early, for example, L<AnyEvent::AIO> creates
970and installs the global L<IO::AIO> watcher in a C<post_detect> block to
971avoid autodetecting the event module at load time.
793 972
794If called in scalar or list context, then it creates and returns an object 973If called in scalar or list context, then it creates and returns an object
795that automatically removes the callback again when it is destroyed. See 974that automatically removes the callback again when it is destroyed (or
975C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
796L<Coro::BDB> for a case where this is useful. 976a case where this is useful.
977
978Example: Create a watcher for the IO::AIO module and store it in
979C<$WATCHER>, but do so only do so after the event loop is initialised.
980
981 our WATCHER;
982
983 my $guard = AnyEvent::post_detect {
984 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
985 };
986
987 # the ||= is important in case post_detect immediately runs the block,
988 # as to not clobber the newly-created watcher. assigning both watcher and
989 # post_detect guard to the same variable has the advantage of users being
990 # able to just C<undef $WATCHER> if the watcher causes them grief.
991
992 $WATCHER ||= $guard;
797 993
798=item @AnyEvent::post_detect 994=item @AnyEvent::post_detect
799 995
800If there are any code references in this array (you can C<push> to it 996If there are any code references in this array (you can C<push> to it
801before or after loading AnyEvent), then they will called directly after 997before or after loading AnyEvent), then they will be called directly
802the event loop has been chosen. 998after the event loop has been chosen.
803 999
804You should check C<$AnyEvent::MODEL> before adding to this array, though: 1000You should check C<$AnyEvent::MODEL> before adding to this array, though:
805if it contains a true value then the event loop has already been detected, 1001if it is defined then the event loop has already been detected, and the
806and the array will be ignored. 1002array will be ignored.
807 1003
808Best use C<AnyEvent::post_detect { BLOCK }> instead. 1004Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
1005it, as it takes care of these details.
1006
1007This variable is mainly useful for modules that can do something useful
1008when AnyEvent is used and thus want to know when it is initialised, but do
1009not need to even load it by default. This array provides the means to hook
1010into AnyEvent passively, without loading it.
1011
1012Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
1013together, you could put this into Coro (this is the actual code used by
1014Coro to accomplish this):
1015
1016 if (defined $AnyEvent::MODEL) {
1017 # AnyEvent already initialised, so load Coro::AnyEvent
1018 require Coro::AnyEvent;
1019 } else {
1020 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1021 # as soon as it is
1022 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1023 }
1024
1025=item AnyEvent::postpone { BLOCK }
1026
1027Arranges for the block to be executed as soon as possible, but not before
1028the call itself returns. In practise, the block will be executed just
1029before the event loop polls for new events, or shortly afterwards.
1030
1031This function never returns anything (to make the C<return postpone { ...
1032}> idiom more useful.
1033
1034To understand the usefulness of this function, consider a function that
1035asynchronously does something for you and returns some transaction
1036object or guard to let you cancel the operation. For example,
1037C<AnyEvent::Socket::tcp_connect>:
1038
1039 # start a connection attempt unless one is active
1040 $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
1041 delete $self->{connect_guard};
1042 ...
1043 };
1044
1045Imagine that this function could instantly call the callback, for
1046example, because it detects an obvious error such as a negative port
1047number. Invoking the callback before the function returns causes problems
1048however: the callback will be called and will try to delete the guard
1049object. But since the function hasn't returned yet, there is nothing to
1050delete. When the function eventually returns it will assign the guard
1051object to C<< $self->{connect_guard} >>, where it will likely never be
1052deleted, so the program thinks it is still trying to connect.
1053
1054This is where C<AnyEvent::postpone> should be used. Instead of calling the
1055callback directly on error:
1056
1057 $cb->(undef), return # signal error to callback, BAD!
1058 if $some_error_condition;
1059
1060It should use C<postpone>:
1061
1062 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1063 if $some_error_condition;
1064
1065=item AnyEvent::log $level, $msg[, @args]
1066
1067Log the given C<$msg> at the given C<$level>.
1068
1069If L<AnyEvent::Log> is not loaded then this function makes a simple test
1070to see whether the message will be logged. If the test succeeds it will
1071load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
1072the L<AnyEvent::Log> documentation for details.
1073
1074If the test fails it will simply return. Right now this happens when a
1075numerical loglevel is used and it is larger than the level specified via
1076C<$ENV{PERL_ANYEVENT_VERBOSE}>.
1077
1078If you want to sprinkle loads of logging calls around your code, consider
1079creating a logger callback with the C<AnyEvent::Log::logger> function,
1080which can reduce typing, codesize and can reduce the logging overhead
1081enourmously.
809 1082
810=back 1083=back
811 1084
812=head1 WHAT TO DO IN A MODULE 1085=head1 WHAT TO DO IN A MODULE
813 1086
824because it will stall the whole program, and the whole point of using 1097because it will stall the whole program, and the whole point of using
825events is to stay interactive. 1098events is to stay interactive.
826 1099
827It is fine, however, to call C<< ->recv >> when the user of your module 1100It is fine, however, to call C<< ->recv >> when the user of your module
828requests it (i.e. if you create a http request object ad have a method 1101requests it (i.e. if you create a http request object ad have a method
829called C<results> that returns the results, it should call C<< ->recv >> 1102called C<results> that returns the results, it may call C<< ->recv >>
830freely, as the user of your module knows what she is doing. always). 1103freely, as the user of your module knows what she is doing. Always).
831 1104
832=head1 WHAT TO DO IN THE MAIN PROGRAM 1105=head1 WHAT TO DO IN THE MAIN PROGRAM
833 1106
834There will always be a single main program - the only place that should 1107There will always be a single main program - the only place that should
835dictate which event model to use. 1108dictate which event model to use.
836 1109
837If it doesn't care, it can just "use AnyEvent" and use it itself, or not 1110If the program is not event-based, it need not do anything special, even
838do anything special (it does not need to be event-based) and let AnyEvent 1111when it depends on a module that uses an AnyEvent. If the program itself
839decide which implementation to chose if some module relies on it. 1112uses AnyEvent, but does not care which event loop is used, all it needs
1113to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
1114available loop implementation.
840 1115
841If the main program relies on a specific event model - for example, in 1116If the main program relies on a specific event model - for example, in
842Gtk2 programs you have to rely on the Glib module - you should load the 1117Gtk2 programs you have to rely on the Glib module - you should load the
843event module before loading AnyEvent or any module that uses it: generally 1118event module before loading AnyEvent or any module that uses it: generally
844speaking, you should load it as early as possible. The reason is that 1119speaking, you should load it as early as possible. The reason is that
845modules might create watchers when they are loaded, and AnyEvent will 1120modules might create watchers when they are loaded, and AnyEvent will
846decide on the event model to use as soon as it creates watchers, and it 1121decide on the event model to use as soon as it creates watchers, and it
847might chose the wrong one unless you load the correct one yourself. 1122might choose the wrong one unless you load the correct one yourself.
848 1123
849You can chose to use a pure-perl implementation by loading the 1124You can chose to use a pure-perl implementation by loading the
850C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1125C<AnyEvent::Loop> module, which gives you similar behaviour
851everywhere, but letting AnyEvent chose the model is generally better. 1126everywhere, but letting AnyEvent chose the model is generally better.
852 1127
853=head2 MAINLOOP EMULATION 1128=head2 MAINLOOP EMULATION
854 1129
855Sometimes (often for short test scripts, or even standalone programs who 1130Sometimes (often for short test scripts, or even standalone programs who
868 1143
869 1144
870=head1 OTHER MODULES 1145=head1 OTHER MODULES
871 1146
872The following is a non-exhaustive list of additional modules that use 1147The following is a non-exhaustive list of additional modules that use
873AnyEvent and can therefore be mixed easily with other AnyEvent modules 1148AnyEvent as a client and can therefore be mixed easily with other
874in the same program. Some of the modules come with AnyEvent, some are 1149AnyEvent modules and other event loops in the same program. Some of the
875available via CPAN. 1150modules come as part of AnyEvent, the others are available via CPAN (see
1151L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
1152a longer non-exhaustive list), and the list is heavily biased towards
1153modules of the AnyEvent author himself :)
876 1154
877=over 4 1155=over 4
878 1156
879=item L<AnyEvent::Util> 1157=item L<AnyEvent::Util> (part of the AnyEvent distribution)
880 1158
881Contains various utility functions that replace often-used but blocking 1159Contains various utility functions that replace often-used blocking
882functions such as C<inet_aton> by event-/callback-based versions. 1160functions such as C<inet_aton> with event/callback-based versions.
883 1161
884=item L<AnyEvent::Socket> 1162=item L<AnyEvent::Socket> (part of the AnyEvent distribution)
885 1163
886Provides various utility functions for (internet protocol) sockets, 1164Provides various utility functions for (internet protocol) sockets,
887addresses and name resolution. Also functions to create non-blocking tcp 1165addresses and name resolution. Also functions to create non-blocking tcp
888connections or tcp servers, with IPv6 and SRV record support and more. 1166connections or tcp servers, with IPv6 and SRV record support and more.
889 1167
890=item L<AnyEvent::Handle> 1168=item L<AnyEvent::Handle> (part of the AnyEvent distribution)
891 1169
892Provide read and write buffers, manages watchers for reads and writes, 1170Provide read and write buffers, manages watchers for reads and writes,
893supports raw and formatted I/O, I/O queued and fully transparent and 1171supports raw and formatted I/O, I/O queued and fully transparent and
894non-blocking SSL/TLS. 1172non-blocking SSL/TLS (via L<AnyEvent::TLS>).
895 1173
896=item L<AnyEvent::DNS> 1174=item L<AnyEvent::DNS> (part of the AnyEvent distribution)
897 1175
898Provides rich asynchronous DNS resolver capabilities. 1176Provides rich asynchronous DNS resolver capabilities.
899 1177
900=item L<AnyEvent::HTTP> 1178=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
901 1179
902A simple-to-use HTTP library that is capable of making a lot of concurrent 1180Implement event-based interfaces to the protocols of the same name (for
903HTTP requests. 1181the curious, IGS is the International Go Server and FCP is the Freenet
1182Client Protocol).
904 1183
1184=item L<AnyEvent::AIO> (part of the AnyEvent distribution)
1185
1186Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1187toolbox of every event programmer. AnyEvent::AIO transparently fuses
1188L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1189file I/O, and much more.
1190
1191=item L<AnyEvent::Fork>, L<AnyEvent::Fork::RPC>, L<AnyEvent::Fork::Pool>, L<AnyEvent::Fork::Remote>
1192
1193These let you safely fork new subprocesses, either locally or
1194remotely (e.g.v ia ssh), using some RPC protocol or not, without
1195the limitations normally imposed by fork (AnyEvent works fine for
1196example). Dynamically-resized worker pools are obviously included as well.
1197
1198And they are quite tiny and fast as well - "abusing" L<AnyEvent::Fork>
1199just to exec external programs can easily beat using C<fork> and C<exec>
1200(or even C<system>) in most programs.
1201
1202=item L<AnyEvent::Filesys::Notify>
1203
1204AnyEvent is good for non-blocking stuff, but it can't detect file or
1205path changes (e.g. "watch this directory for new files", "watch this
1206file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
1207do just that in a portbale fashion, supporting inotify on GNU/Linux and
1208some weird, without doubt broken, stuff on OS X to monitor files. It can
1209fall back to blocking scans at regular intervals transparently on other
1210platforms, so it's about as portable as it gets.
1211
1212(I haven't used it myself, but it seems the biggest problem with it is
1213it quite bad performance).
1214
905=item L<AnyEvent::HTTPD> 1215=item L<AnyEvent::DBI>
906 1216
907Provides a simple web application server framework. 1217Executes L<DBI> requests asynchronously in a proxy process for you,
1218notifying you in an event-based way when the operation is finished.
908 1219
909=item L<AnyEvent::FastPing> 1220=item L<AnyEvent::FastPing>
910 1221
911The fastest ping in the west. 1222The fastest ping in the west.
912 1223
913=item L<AnyEvent::DBI>
914
915Executes L<DBI> requests asynchronously in a proxy process.
916
917=item L<AnyEvent::AIO>
918
919Truly asynchronous I/O, should be in the toolbox of every event
920programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
921together.
922
923=item L<AnyEvent::BDB>
924
925Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
926L<BDB> and AnyEvent together.
927
928=item L<AnyEvent::GPSD>
929
930A non-blocking interface to gpsd, a daemon delivering GPS information.
931
932=item L<AnyEvent::IGS>
933
934A non-blocking interface to the Internet Go Server protocol (used by
935L<App::IGS>).
936
937=item L<AnyEvent::IRC>
938
939AnyEvent based IRC client module family (replacing the older Net::IRC3).
940
941=item L<Net::XMPP2>
942
943AnyEvent based XMPP (Jabber protocol) module family.
944
945=item L<Net::FCP>
946
947AnyEvent-based implementation of the Freenet Client Protocol, birthplace
948of AnyEvent.
949
950=item L<Event::ExecFlow>
951
952High level API for event-based execution flow control.
953
954=item L<Coro> 1224=item L<Coro>
955 1225
956Has special support for AnyEvent via L<Coro::AnyEvent>. 1226Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
1227to simply invert the flow control - don't call us, we will call you:
957 1228
958=item L<IO::Lambda> 1229 async {
1230 Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
1231 print "5 seconds later!\n";
959 1232
960The lambda approach to I/O - don't ask, look there. Can use AnyEvent. 1233 Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
1234 my $line = <STDIN>; # works for ttys
1235
1236 AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
1237 my ($body, $hdr) = Coro::rouse_wait;
1238 };
961 1239
962=back 1240=back
963 1241
964=cut 1242=cut
965 1243
966package AnyEvent; 1244package AnyEvent;
967 1245
968no warnings; 1246BEGIN {
969use strict qw(vars subs); 1247 require "AnyEvent/constants.pl";
1248 &AnyEvent::common_sense;
1249}
970 1250
971use Carp; 1251use Carp ();
972 1252
973our $VERSION = 4.452; 1253our $VERSION = '7.07';
974our $MODEL; 1254our $MODEL;
975
976our $AUTOLOAD;
977our @ISA; 1255our @ISA;
978
979our @REGISTRY; 1256our @REGISTRY;
980 1257our $VERBOSE;
981our $WIN32; 1258our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1259our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} || 10; # executes after the BEGIN block below (tainting!)
982 1260
983BEGIN { 1261BEGIN {
984 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
985 eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; 1262 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
986 1263
987 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1264 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
988 if ${^TAINT}; 1265 if ${^TAINT};
989}
990 1266
991our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1267 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1268 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
992 1269
993our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1270 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1271 if ${^TAINT};
994 1272
995{ 1273 # $ENV{PERL_ANYEVENT_xxx} now valid
1274
1275 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1276
996 my $idx; 1277 my $idx;
997 $PROTOCOL{$_} = ++$idx 1278 $PROTOCOL{$_} = ++$idx
998 for reverse split /\s*,\s*/, 1279 for reverse split /\s*,\s*/,
999 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1280 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1000} 1281}
1001 1282
1283our @post_detect;
1284
1285sub post_detect(&) {
1286 my ($cb) = @_;
1287
1288 push @post_detect, $cb;
1289
1290 defined wantarray
1291 ? bless \$cb, "AnyEvent::Util::postdetect"
1292 : ()
1293}
1294
1295sub AnyEvent::Util::postdetect::DESTROY {
1296 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1297}
1298
1299our $POSTPONE_W;
1300our @POSTPONE;
1301
1302sub _postpone_exec {
1303 undef $POSTPONE_W;
1304
1305 &{ shift @POSTPONE }
1306 while @POSTPONE;
1307}
1308
1309sub postpone(&) {
1310 push @POSTPONE, shift;
1311
1312 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1313
1314 ()
1315}
1316
1317sub log($$;@) {
1318 # only load the big bloated module when we actually are about to log something
1319 if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal
1320 local ($!, $@);
1321 require AnyEvent::Log; # among other things, sets $VERBOSE to 9
1322 # AnyEvent::Log overwrites this function
1323 goto &log;
1324 }
1325
1326 0 # not logged
1327}
1328
1329sub _logger($;$) {
1330 my ($level, $renabled) = @_;
1331
1332 $$renabled = $level <= $VERBOSE;
1333
1334 my $logger = [(caller)[0], $level, $renabled];
1335
1336 $AnyEvent::Log::LOGGER{$logger+0} = $logger;
1337
1338# return unless defined wantarray;
1339#
1340# require AnyEvent::Util;
1341# my $guard = AnyEvent::Util::guard (sub {
1342# # "clean up"
1343# delete $LOGGER{$logger+0};
1344# });
1345#
1346# sub {
1347# return 0 unless $$renabled;
1348#
1349# $guard if 0; # keep guard alive, but don't cause runtime overhead
1350# require AnyEvent::Log unless $AnyEvent::Log::VERSION;
1351# package AnyEvent::Log;
1352# _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
1353# }
1354}
1355
1356if (length $ENV{PERL_ANYEVENT_LOG}) {
1357 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1358}
1359
1002my @models = ( 1360our @models = (
1003 [EV:: => AnyEvent::Impl::EV::], 1361 [EV:: => AnyEvent::Impl::EV::],
1004 [Event:: => AnyEvent::Impl::Event::],
1005 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1362 [AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1006 # everything below here will not be autoprobed 1363 # everything below here will not (normally) be autoprobed
1007 # as the pureperl backend should work everywhere 1364 # as the pure perl backend should work everywhere
1008 # and is usually faster 1365 # and is usually faster
1366 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
1367 [Event:: => AnyEvent::Impl::Event::], # slow, stable
1368 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1369 # everything below here should not be autoloaded
1370 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1009 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1371 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1010 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1372 [UV:: => AnyEvent::Impl::UV::], # switched from libev, added back all bugs imaginable
1011 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1012 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1373 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1013 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1374 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1014 [Wx:: => AnyEvent::Impl::POE::], 1375 [Wx:: => AnyEvent::Impl::POE::],
1015 [Prima:: => AnyEvent::Impl::POE::], 1376 [Prima:: => AnyEvent::Impl::POE::],
1016 # IO::Async is just too broken - we would need workaorunds for its 1377 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1017 # byzantine signal and broken child handling, among others. 1378 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1018 # IO::Async is rather hard to detect, as it doesn't have any 1379 [FLTK:: => AnyEvent::Impl::FLTK::],
1019 # obvious default class.
1020# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1021# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1022# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1023); 1380);
1024 1381
1025our %method = map +($_ => 1), 1382our @isa_hook;
1383
1384sub _isa_set {
1385 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1386
1387 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1388 for 1 .. $#pkg;
1389
1390 grep $_ && $_->[1], @isa_hook
1391 and AE::_reset ();
1392}
1393
1394# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1395sub _isa_hook($$;$) {
1396 my ($i, $pkg, $reset_ae) = @_;
1397
1398 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1399
1400 _isa_set;
1401}
1402
1403# all autoloaded methods reserve the complete glob, not just the method slot.
1404# due to bugs in perls method cache implementation.
1026 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1405our @methods = qw(io timer time now now_update signal child idle condvar);
1027 1406
1028our @post_detect;
1029
1030sub post_detect(&) { 1407sub detect() {
1031 my ($cb) = @_; 1408 return $MODEL if $MODEL; # some programs keep references to detect
1032 1409
1033 if ($MODEL) { 1410 # IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
1034 $cb->(); 1411 # the author knows about the problems and what it does to AnyEvent as a whole
1412 # (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
1413 # anyway.
1414 AnyEvent::log fatal => "IO::Async::Loop::AnyEvent detected - that module is broken by\n"
1415 . "design, abuses internals and breaks AnyEvent - will not continue."
1416 if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
1035 1417
1036 1 1418 local $!; # for good measure
1419 local $SIG{__DIE__}; # we use eval
1420
1421 # free some memory
1422 *detect = sub () { $MODEL };
1423 # undef &func doesn't correctly update the method cache. grmbl.
1424 # so we delete the whole glob. grmbl.
1425 # otoh, perl doesn't let me undef an active usb, but it lets me free
1426 # a glob with an active sub. hrm. i hope it works, but perl is
1427 # usually buggy in this department. sigh.
1428 delete @{"AnyEvent::"}{@methods};
1429 undef @methods;
1430
1431 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1432 my $model = $1;
1433 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1434 if (eval "require $model") {
1435 AnyEvent::log 7 => "Loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1436 $MODEL = $model;
1037 } else { 1437 } else {
1038 push @post_detect, $cb; 1438 AnyEvent::log 4 => "Unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1039 1439 }
1040 defined wantarray
1041 ? bless \$cb, "AnyEvent::Util::postdetect"
1042 : ()
1043 } 1440 }
1044}
1045 1441
1046sub AnyEvent::Util::postdetect::DESTROY { 1442 # check for already loaded models
1047 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1048}
1049
1050sub detect() {
1051 unless ($MODEL) { 1443 unless ($MODEL) {
1052 no strict 'refs'; 1444 for (@REGISTRY, @models) {
1053 local $SIG{__DIE__}; 1445 my ($package, $model) = @$_;
1054 1446 if (${"$package\::VERSION"} > 0) {
1055 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1056 my $model = "AnyEvent::Impl::$1";
1057 if (eval "require $model") { 1447 if (eval "require $model") {
1448 AnyEvent::log 7 => "Autodetected model '$model', using it.";
1058 $MODEL = $model; 1449 $MODEL = $model;
1059 warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; 1450 last;
1060 } else { 1451 } else {
1061 warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; 1452 AnyEvent::log 8 => "Detected event loop $package, but cannot load '$model', skipping: $@";
1453 }
1062 } 1454 }
1063 } 1455 }
1064 1456
1065 # check for already loaded models
1066 unless ($MODEL) { 1457 unless ($MODEL) {
1458 # try to autoload a model
1067 for (@REGISTRY, @models) { 1459 for (@REGISTRY, @models) {
1068 my ($package, $model) = @$_; 1460 my ($package, $model) = @$_;
1461 if (
1462 eval "require $package"
1069 if (${"$package\::VERSION"} > 0) { 1463 and ${"$package\::VERSION"} > 0
1070 if (eval "require $model") { 1464 and eval "require $model"
1465 ) {
1466 AnyEvent::log 7 => "Autoloaded model '$model', using it.";
1071 $MODEL = $model; 1467 $MODEL = $model;
1072 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;
1073 last; 1468 last;
1074 }
1075 } 1469 }
1076 } 1470 }
1077 1471
1078 unless ($MODEL) {
1079 # try to load a model
1080
1081 for (@REGISTRY, @models) {
1082 my ($package, $model) = @$_;
1083 if (eval "require $package"
1084 and ${"$package\::VERSION"} > 0
1085 and eval "require $model") {
1086 $MODEL = $model;
1087 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;
1088 last;
1089 }
1090 }
1091
1092 $MODEL 1472 $MODEL
1093 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1473 or AnyEvent::log fatal => "Backend autodetection failed - did you properly install AnyEvent?";
1094 }
1095 } 1474 }
1096
1097 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1098
1099 unshift @ISA, $MODEL;
1100
1101 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1102
1103 (shift @post_detect)->() while @post_detect;
1104 } 1475 }
1105 1476
1477 # free memory only needed for probing
1478 undef @models;
1479 undef @REGISTRY;
1480
1481 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1482
1483 # now nuke some methods that are overridden by the backend.
1484 # SUPER usage is not allowed in these.
1485 for (qw(time signal child idle)) {
1486 undef &{"AnyEvent::Base::$_"}
1487 if defined &{"$MODEL\::$_"};
1488 }
1489
1490 _isa_set;
1491
1492 # we're officially open!
1493
1494 if ($ENV{PERL_ANYEVENT_STRICT}) {
1495 require AnyEvent::Strict;
1496 }
1497
1498 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1499 require AnyEvent::Debug;
1500 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1501 }
1502
1503 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1504 require AnyEvent::Socket;
1505 require AnyEvent::Debug;
1506
1507 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1508 $shell =~ s/\$\$/$$/g;
1509
1510 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1511 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1512 }
1513
1514 # now the anyevent environment is set up as the user told us to, so
1515 # call the actual user code - post detects
1516
1517 (shift @post_detect)->() while @post_detect;
1518 undef @post_detect;
1519
1520 *post_detect = sub(&) {
1521 shift->();
1522
1523 undef
1524 };
1525
1106 $MODEL 1526 $MODEL
1107} 1527}
1108 1528
1109sub AUTOLOAD { 1529for my $name (@methods) {
1110 (my $func = $AUTOLOAD) =~ s/.*://; 1530 *$name = sub {
1111 1531 detect;
1112 $method{$func} 1532 # we use goto because
1113 or croak "$func: not a valid method for AnyEvent objects"; 1533 # a) it makes the thunk more transparent
1114 1534 # b) it allows us to delete the thunk later
1115 detect unless $MODEL; 1535 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1116 1536 };
1117 my $class = shift;
1118 $class->$func (@_);
1119} 1537}
1120 1538
1121# utility function to dup a filehandle. this is used by many backends 1539# utility function to dup a filehandle. this is used by many backends
1122# to support binding more than one watcher per filehandle (they usually 1540# to support binding more than one watcher per filehandle (they usually
1123# allow only one watcher per fd, so we dup it to get a different one). 1541# allow only one watcher per fd, so we dup it to get a different one).
1124sub _dupfh($$;$$) { 1542sub _dupfh($$;$$) {
1125 my ($poll, $fh, $r, $w) = @_; 1543 my ($poll, $fh, $r, $w) = @_;
1126 1544
1127 # cygwin requires the fh mode to be matching, unix doesn't 1545 # cygwin requires the fh mode to be matching, unix doesn't
1128 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1546 my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1129 : $poll eq "w" ? ($w, ">")
1130 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1131 1547
1132 open my $fh2, "$mode&" . fileno $fh 1548 open my $fh2, $mode, $fh
1133 or die "cannot dup() filehandle: $!,"; 1549 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1134 1550
1135 # we assume CLOEXEC is already set by perl in all important cases 1551 # we assume CLOEXEC is already set by perl in all important cases
1136 1552
1137 ($fh2, $rw) 1553 ($fh2, $rw)
1138} 1554}
1139 1555
1556=head1 SIMPLIFIED AE API
1557
1558Starting with version 5.0, AnyEvent officially supports a second, much
1559simpler, API that is designed to reduce the calling, typing and memory
1560overhead by using function call syntax and a fixed number of parameters.
1561
1562See the L<AE> manpage for details.
1563
1564=cut
1565
1566package AE;
1567
1568our $VERSION = $AnyEvent::VERSION;
1569
1570sub _reset() {
1571 eval q{
1572 # fall back to the main API by default - backends and AnyEvent::Base
1573 # implementations can overwrite these.
1574
1575 sub io($$$) {
1576 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1577 }
1578
1579 sub timer($$$) {
1580 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1581 }
1582
1583 sub signal($$) {
1584 AnyEvent->signal (signal => $_[0], cb => $_[1])
1585 }
1586
1587 sub child($$) {
1588 AnyEvent->child (pid => $_[0], cb => $_[1])
1589 }
1590
1591 sub idle($) {
1592 AnyEvent->idle (cb => $_[0]);
1593 }
1594
1595 sub cv(;&) {
1596 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1597 }
1598
1599 sub now() {
1600 AnyEvent->now
1601 }
1602
1603 sub now_update() {
1604 AnyEvent->now_update
1605 }
1606
1607 sub time() {
1608 AnyEvent->time
1609 }
1610
1611 *postpone = \&AnyEvent::postpone;
1612 *log = \&AnyEvent::log;
1613 };
1614 die if $@;
1615}
1616
1617BEGIN { _reset }
1618
1140package AnyEvent::Base; 1619package AnyEvent::Base;
1141 1620
1142# default implementations for many methods 1621# default implementations for many methods
1143 1622
1144BEGIN { 1623sub time {
1624 eval q{ # poor man's autoloading {}
1625 # probe for availability of Time::HiRes
1145 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1626 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1627 *time = sub { Time::HiRes::time () };
1146 *_time = \&Time::HiRes::time; 1628 *AE::time = \& Time::HiRes::time ;
1629 *now = \&time;
1630 AnyEvent::log 8 => "using Time::HiRes for sub-second timing accuracy.";
1147 # if (eval "use POSIX (); (POSIX::times())... 1631 # if (eval "use POSIX (); (POSIX::times())...
1148 } else { 1632 } else {
1149 *_time = sub { time }; # epic fail 1633 *time = sub { CORE::time };
1634 *AE::time = sub (){ CORE::time };
1635 *now = \&time;
1636 AnyEvent::log 3 => "Using built-in time(), no sub-second resolution!";
1637 }
1638 };
1639 die if $@;
1640
1641 &time
1642}
1643
1644*now = \&time;
1645sub now_update { }
1646
1647sub _poll {
1648 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1649}
1650
1651# default implementation for ->condvar
1652# in fact, the default should not be overwritten
1653
1654sub condvar {
1655 eval q{ # poor man's autoloading {}
1656 *condvar = sub {
1657 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1658 };
1659
1660 *AE::cv = sub (;&) {
1661 bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
1662 };
1663 };
1664 die if $@;
1665
1666 &condvar
1667}
1668
1669# default implementation for ->signal
1670
1671our $HAVE_ASYNC_INTERRUPT;
1672
1673sub _have_async_interrupt() {
1674 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1675 && eval "use Async::Interrupt 1.02 (); 1")
1676 unless defined $HAVE_ASYNC_INTERRUPT;
1677
1678 $HAVE_ASYNC_INTERRUPT
1679}
1680
1681our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1682our (%SIG_ASY, %SIG_ASY_W);
1683our ($SIG_COUNT, $SIG_TW);
1684
1685# install a dummy wakeup watcher to reduce signal catching latency
1686# used by Impls
1687sub _sig_add() {
1688 unless ($SIG_COUNT++) {
1689 # try to align timer on a full-second boundary, if possible
1690 my $NOW = AE::now;
1691
1692 $SIG_TW = AE::timer
1693 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1694 $MAX_SIGNAL_LATENCY,
1695 sub { } # just for the PERL_ASYNC_CHECK
1696 ;
1150 } 1697 }
1151} 1698}
1152 1699
1153sub time { _time } 1700sub _sig_del {
1154sub now { _time } 1701 undef $SIG_TW
1155sub now_update { } 1702 unless --$SIG_COUNT;
1156
1157# default implementation for ->condvar
1158
1159sub condvar {
1160 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1161} 1703}
1162 1704
1163# default implementation for ->signal 1705our $_sig_name_init; $_sig_name_init = sub {
1706 eval q{ # poor man's autoloading {}
1707 undef $_sig_name_init;
1164 1708
1165our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1709 if (_have_async_interrupt) {
1710 *sig2num = \&Async::Interrupt::sig2num;
1711 *sig2name = \&Async::Interrupt::sig2name;
1712 } else {
1713 require Config;
1166 1714
1167sub _signal_exec { 1715 my %signame2num;
1168 sysread $SIGPIPE_R, my $dummy, 4; 1716 @signame2num{ split ' ', $Config::Config{sig_name} }
1717 = split ' ', $Config::Config{sig_num};
1169 1718
1170 while (%SIG_EV) { 1719 my @signum2name;
1171 for (keys %SIG_EV) { 1720 @signum2name[values %signame2num] = keys %signame2num;
1172 delete $SIG_EV{$_}; 1721
1173 $_->() for values %{ $SIG_CB{$_} || {} }; 1722 *sig2num = sub($) {
1723 $_[0] > 0 ? shift : $signame2num{+shift}
1724 };
1725 *sig2name = sub ($) {
1726 $_[0] > 0 ? $signum2name[+shift] : shift
1727 };
1174 } 1728 }
1175 } 1729 };
1176} 1730 die if $@;
1731};
1732
1733sub sig2num ($) { &$_sig_name_init; &sig2num }
1734sub sig2name($) { &$_sig_name_init; &sig2name }
1177 1735
1178sub signal { 1736sub signal {
1179 my (undef, %arg) = @_; 1737 eval q{ # poor man's autoloading {}
1738 # probe for availability of Async::Interrupt
1739 if (_have_async_interrupt) {
1740 AnyEvent::log 8 => "Using Async::Interrupt for race-free signal handling.";
1180 1741
1181 unless ($SIGPIPE_R) { 1742 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1182 require Fcntl; 1743 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1183 1744
1184 if (AnyEvent::WIN32) {
1185 require AnyEvent::Util;
1186
1187 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1188 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1189 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1190 } else { 1745 } else {
1746 AnyEvent::log 8 => "Using emulated perl signal handling with latency timer.";
1747
1748 if (AnyEvent::WIN32) {
1749 require AnyEvent::Util;
1750
1751 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1752 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1753 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1754 } else {
1191 pipe $SIGPIPE_R, $SIGPIPE_W; 1755 pipe $SIGPIPE_R, $SIGPIPE_W;
1192 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; 1756 fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1193 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case 1757 fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1194 1758
1195 # not strictly required, as $^F is normally 2, but let's make sure... 1759 # not strictly required, as $^F is normally 2, but let's make sure...
1196 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; 1760 fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1197 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; 1761 fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1762 }
1763
1764 $SIGPIPE_R
1765 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1766
1767 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1198 } 1768 }
1199 1769
1200 $SIGPIPE_R 1770 *signal = $HAVE_ASYNC_INTERRUPT
1201 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1771 ? sub {
1772 my (undef, %arg) = @_;
1202 1773
1203 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1774 # async::interrupt
1204 }
1205
1206 my $signal = uc $arg{signal} 1775 my $signal = sig2num $arg{signal};
1207 or Carp::croak "required option 'signal' is missing";
1208
1209 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1776 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1777
1778 $SIG_ASY{$signal} ||= new Async::Interrupt
1779 cb => sub { undef $SIG_EV{$signal} },
1780 signal => $signal,
1781 pipe => [$SIGPIPE_R->filenos],
1782 pipe_autodrain => 0,
1783 ;
1784
1785 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1786 }
1787 : sub {
1788 my (undef, %arg) = @_;
1789
1790 # pure perl
1791 my $signal = sig2name $arg{signal};
1792 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1793
1210 $SIG{$signal} ||= sub { 1794 $SIG{$signal} ||= sub {
1211 local $!; 1795 local $!;
1212 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1796 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1213 undef $SIG_EV{$signal}; 1797 undef $SIG_EV{$signal};
1798 };
1799
1800 # can't do signal processing without introducing races in pure perl,
1801 # so limit the signal latency.
1802 _sig_add;
1803
1804 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1805 }
1806 ;
1807
1808 *AnyEvent::Base::signal::DESTROY = sub {
1809 my ($signal, $cb) = @{$_[0]};
1810
1811 _sig_del;
1812
1813 delete $SIG_CB{$signal}{$cb};
1814
1815 $HAVE_ASYNC_INTERRUPT
1816 ? delete $SIG_ASY{$signal}
1817 : # delete doesn't work with older perls - they then
1818 # print weird messages, or just unconditionally exit
1819 # instead of getting the default action.
1820 undef $SIG{$signal}
1821 unless keys %{ $SIG_CB{$signal} };
1822 };
1823
1824 *_signal_exec = sub {
1825 $HAVE_ASYNC_INTERRUPT
1826 ? $SIGPIPE_R->drain
1827 : sysread $SIGPIPE_R, (my $dummy), 9;
1828
1829 while (%SIG_EV) {
1830 for (keys %SIG_EV) {
1831 delete $SIG_EV{$_};
1832 &$_ for values %{ $SIG_CB{$_} || {} };
1833 }
1834 }
1835 };
1214 }; 1836 };
1837 die if $@;
1215 1838
1216 bless [$signal, $arg{cb}], "AnyEvent::Base::signal" 1839 &signal
1217}
1218
1219sub AnyEvent::Base::signal::DESTROY {
1220 my ($signal, $cb) = @{$_[0]};
1221
1222 delete $SIG_CB{$signal}{$cb};
1223
1224 # delete doesn't work with older perls - they then
1225 # print weird messages, or just unconditionally exit
1226 # instead of getting the default action.
1227 undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1228} 1840}
1229 1841
1230# default implementation for ->child 1842# default implementation for ->child
1231 1843
1232our %PID_CB; 1844our %PID_CB;
1233our $CHLD_W; 1845our $CHLD_W;
1234our $CHLD_DELAY_W; 1846our $CHLD_DELAY_W;
1235our $WNOHANG;
1236 1847
1237sub _sigchld { 1848# used by many Impl's
1238 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1849sub _emit_childstatus($$) {
1850 my (undef, $rpid, $rstatus) = @_;
1851
1852 $_->($rpid, $rstatus)
1239 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1853 for values %{ $PID_CB{$rpid} || {} },
1240 (values %{ $PID_CB{0} || {} }); 1854 values %{ $PID_CB{0} || {} };
1241 }
1242} 1855}
1243 1856
1244sub child { 1857sub child {
1858 eval q{ # poor man's autoloading {}
1859 *_sigchld = sub {
1860 my $pid;
1861
1862 AnyEvent->_emit_childstatus ($pid, $?)
1863 while ($pid = waitpid -1, WNOHANG) > 0;
1864 };
1865
1866 *child = sub {
1245 my (undef, %arg) = @_; 1867 my (undef, %arg) = @_;
1246 1868
1247 defined (my $pid = $arg{pid} + 0) 1869 my $pid = $arg{pid};
1248 or Carp::croak "required option 'pid' is missing"; 1870 my $cb = $arg{cb};
1249 1871
1250 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1872 $PID_CB{$pid}{$cb+0} = $cb;
1251 1873
1252 $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1253
1254 unless ($CHLD_W) { 1874 unless ($CHLD_W) {
1255 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1875 $CHLD_W = AE::signal CHLD => \&_sigchld;
1256 # child could be a zombie already, so make at least one round 1876 # child could be a zombie already, so make at least one round
1257 &_sigchld; 1877 &_sigchld;
1258 } 1878 }
1259 1879
1260 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1880 bless [$pid, $cb+0], "AnyEvent::Base::child"
1261} 1881 };
1262 1882
1263sub AnyEvent::Base::child::DESTROY { 1883 *AnyEvent::Base::child::DESTROY = sub {
1264 my ($pid, $cb) = @{$_[0]}; 1884 my ($pid, $icb) = @{$_[0]};
1265 1885
1266 delete $PID_CB{$pid}{$cb}; 1886 delete $PID_CB{$pid}{$icb};
1267 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1887 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1268 1888
1269 undef $CHLD_W unless keys %PID_CB; 1889 undef $CHLD_W unless keys %PID_CB;
1890 };
1891 };
1892 die if $@;
1893
1894 &child
1270} 1895}
1271 1896
1272# idle emulation is done by simply using a timer, regardless 1897# idle emulation is done by simply using a timer, regardless
1273# of whether the process is idle or not, and not letting 1898# of whether the process is idle or not, and not letting
1274# the callback use more than 50% of the time. 1899# the callback use more than 50% of the time.
1275sub idle { 1900sub idle {
1901 eval q{ # poor man's autoloading {}
1902 *idle = sub {
1276 my (undef, %arg) = @_; 1903 my (undef, %arg) = @_;
1277 1904
1278 my ($cb, $w, $rcb) = $arg{cb}; 1905 my ($cb, $w, $rcb) = $arg{cb};
1279 1906
1280 $rcb = sub { 1907 $rcb = sub {
1281 if ($cb) { 1908 if ($cb) {
1282 $w = _time; 1909 $w = AE::time;
1283 &$cb; 1910 &$cb;
1284 $w = _time - $w; 1911 $w = AE::time - $w;
1285 1912
1286 # never use more then 50% of the time for the idle watcher, 1913 # never use more then 50% of the time for the idle watcher,
1287 # within some limits 1914 # within some limits
1288 $w = 0.0001 if $w < 0.0001; 1915 $w = 0.0001 if $w < 0.0001;
1289 $w = 5 if $w > 5; 1916 $w = 5 if $w > 5;
1290 1917
1291 $w = AnyEvent->timer (after => $w, cb => $rcb); 1918 $w = AE::timer $w, 0, $rcb;
1292 } else { 1919 } else {
1293 # clean up... 1920 # clean up...
1294 undef $w; 1921 undef $w;
1295 undef $rcb; 1922 undef $rcb;
1923 }
1924 };
1925
1926 $w = AE::timer 0.05, 0, $rcb;
1927
1928 bless \\$cb, "AnyEvent::Base::idle"
1296 } 1929 };
1930
1931 *AnyEvent::Base::idle::DESTROY = sub {
1932 undef $${$_[0]};
1933 };
1297 }; 1934 };
1935 die if $@;
1298 1936
1299 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1937 &idle
1300
1301 bless \\$cb, "AnyEvent::Base::idle"
1302}
1303
1304sub AnyEvent::Base::idle::DESTROY {
1305 undef $${$_[0]};
1306} 1938}
1307 1939
1308package AnyEvent::CondVar; 1940package AnyEvent::CondVar;
1309 1941
1310our @ISA = AnyEvent::CondVar::Base::; 1942our @ISA = AnyEvent::CondVar::Base::;
1311 1943
1944# only to be used for subclassing
1945sub new {
1946 my $class = shift;
1947 bless AnyEvent->condvar (@_), $class
1948}
1949
1312package AnyEvent::CondVar::Base; 1950package AnyEvent::CondVar::Base;
1313 1951
1314use overload 1952#use overload
1315 '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1953# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1316 fallback => 1; 1954# fallback => 1;
1955
1956# save 300+ kilobytes by dirtily hardcoding overloading
1957${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
1958*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
1959*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
1960${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1961
1962our $WAITING;
1317 1963
1318sub _send { 1964sub _send {
1319 # nop 1965 # nop
1966}
1967
1968sub _wait {
1969 AnyEvent->_poll until $_[0]{_ae_sent};
1320} 1970}
1321 1971
1322sub send { 1972sub send {
1323 my $cv = shift; 1973 my $cv = shift;
1324 $cv->{_ae_sent} = [@_]; 1974 $cv->{_ae_sent} = [@_];
1333 1983
1334sub ready { 1984sub ready {
1335 $_[0]{_ae_sent} 1985 $_[0]{_ae_sent}
1336} 1986}
1337 1987
1338sub _wait {
1339 AnyEvent->one_event while !$_[0]{_ae_sent};
1340}
1341
1342sub recv { 1988sub recv {
1989 unless ($_[0]{_ae_sent}) {
1990 $WAITING
1991 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1992
1993 local $WAITING = 1;
1343 $_[0]->_wait; 1994 $_[0]->_wait;
1995 }
1344 1996
1345 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1997 $_[0]{_ae_croak}
1346 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1998 and Carp::croak $_[0]{_ae_croak};
1999
2000 wantarray
2001 ? @{ $_[0]{_ae_sent} }
2002 : $_[0]{_ae_sent}[0]
1347} 2003}
1348 2004
1349sub cb { 2005sub cb {
1350 $_[0]{_ae_cb} = $_[1] if @_ > 1; 2006 my $cv = shift;
2007
2008 @_
2009 and $cv->{_ae_cb} = shift
2010 and $cv->{_ae_sent}
2011 and (delete $cv->{_ae_cb})->($cv);
2012
1351 $_[0]{_ae_cb} 2013 $cv->{_ae_cb}
1352} 2014}
1353 2015
1354sub begin { 2016sub begin {
1355 ++$_[0]{_ae_counter}; 2017 ++$_[0]{_ae_counter};
1356 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 2018 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1361 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 2023 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1362} 2024}
1363 2025
1364# undocumented/compatibility with pre-3.4 2026# undocumented/compatibility with pre-3.4
1365*broadcast = \&send; 2027*broadcast = \&send;
1366*wait = \&_wait; 2028*wait = \&recv;
1367 2029
1368=head1 ERROR AND EXCEPTION HANDLING 2030=head1 ERROR AND EXCEPTION HANDLING
1369 2031
1370In general, AnyEvent does not do any error handling - it relies on the 2032In general, AnyEvent does not do any error handling - it relies on the
1371caller to do that if required. The L<AnyEvent::Strict> module (see also 2033caller to do that if required. The L<AnyEvent::Strict> module (see also
1383$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 2045$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1384so on. 2046so on.
1385 2047
1386=head1 ENVIRONMENT VARIABLES 2048=head1 ENVIRONMENT VARIABLES
1387 2049
1388The following environment variables are used by this module or its 2050AnyEvent supports a number of environment variables that tune the
1389submodules. 2051runtime behaviour. They are usually evaluated when AnyEvent is
2052loaded, initialised, or a submodule that uses them is loaded. Many of
2053them also cause AnyEvent to load additional modules - for example,
2054C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
2055loaded.
1390 2056
1391Note that AnyEvent will remove I<all> environment variables starting with 2057All the environment variables documented here start with
1392C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 2058C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1393enabled. 2059namespace. Other modules are encouraged (but by no means required) to use
2060C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
2061namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
2062be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
2063variables starting with C<AE_>, see below).
2064
2065All variables can also be set via the C<AE_> prefix, that is, instead
2066of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
2067case there is a clash btween anyevent and another program that uses
2068C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
2069variable to the empty string, as those variables take precedence.
2070
2071When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
2072to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
2073exists. If taint mode is on, then AnyEvent will remove I<all> environment
2074variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
2075with C<undef> or the empty string, if the corresaponding C<AE_> variable
2076is set).
2077
2078The exact algorithm is currently:
2079
2080 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
2081 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
2082 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
2083
2084This ensures that child processes will not see the C<AE_> variables.
2085
2086The following environment variables are currently known to AnyEvent:
1394 2087
1395=over 4 2088=over 4
1396 2089
1397=item C<PERL_ANYEVENT_VERBOSE> 2090=item C<PERL_ANYEVENT_VERBOSE>
1398 2091
1399By default, AnyEvent will be completely silent except in fatal 2092By default, AnyEvent will log messages with loglevel C<4> (C<error>) or
1400conditions. You can set this environment variable to make AnyEvent more 2093higher (see L<AnyEvent::Log>). You can set this environment variable to a
1401talkative. 2094numerical loglevel to make AnyEvent more (or less) talkative.
1402 2095
2096If you want to do more than just set the global logging level
2097you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2098complex specifications.
2099
2100When set to C<0> (C<off>), then no messages whatsoever will be logged with
2101everything else at defaults.
2102
1403When set to C<1> or higher, causes AnyEvent to warn about unexpected 2103When set to C<5> or higher (C<warn>), AnyEvent warns about unexpected
1404conditions, such as not being able to load the event model specified by 2104conditions, such as not being able to load the event model specified by
1405C<PERL_ANYEVENT_MODEL>. 2105C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this
2106is the minimum recommended level for use during development.
1406 2107
1407When set to C<2> or higher, cause AnyEvent to report to STDERR which event 2108When set to C<7> or higher (info), AnyEvent reports which event model it
1408model it chooses. 2109chooses.
2110
2111When set to C<8> or higher (debug), then AnyEvent will report extra
2112information on which optional modules it loads and how it implements
2113certain features.
2114
2115=item C<PERL_ANYEVENT_LOG>
2116
2117Accepts rather complex logging specifications. For example, you could log
2118all C<debug> messages of some module to stderr, warnings and above to
2119stderr, and errors and above to syslog, with:
2120
2121 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
2122
2123For the rather extensive details, see L<AnyEvent::Log>.
2124
2125This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2126so will take effect even before AnyEvent has initialised itself.
2127
2128Note that specifying this environment variable causes the L<AnyEvent::Log>
2129module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2130using the latter saves a few hundred kB of memory unless a module
2131explicitly needs the extra features of AnyEvent::Log.
1409 2132
1410=item C<PERL_ANYEVENT_STRICT> 2133=item C<PERL_ANYEVENT_STRICT>
1411 2134
1412AnyEvent does not do much argument checking by default, as thorough 2135AnyEvent does not do much argument checking by default, as thorough
1413argument checking is very costly. Setting this variable to a true value 2136argument checking is very costly. Setting this variable to a true value
1415check the arguments passed to most method calls. If it finds any problems, 2138check the arguments passed to most method calls. If it finds any problems,
1416it will croak. 2139it will croak.
1417 2140
1418In other words, enables "strict" mode. 2141In other words, enables "strict" mode.
1419 2142
1420Unlike C<use strict>, it is definitely recommended to keep it off in 2143Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1421production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while 2144>>, it is definitely recommended to keep it off in production. Keeping
1422developing programs can be very useful, however. 2145C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
2146can be very useful, however.
2147
2148=item C<PERL_ANYEVENT_DEBUG_SHELL>
2149
2150If this env variable is nonempty, then its contents will be interpreted by
2151C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
2152replacing every occurance of C<$$> by the process pid). The shell object
2153is saved in C<$AnyEvent::Debug::SHELL>.
2154
2155This happens when the first watcher is created.
2156
2157For example, to bind a debug shell on a unix domain socket in
2158F<< /tmp/debug<pid>.sock >>, you could use this:
2159
2160 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2161 # connect with e.g.: socat readline /tmp/debug123.sock
2162
2163Or to bind to tcp port 4545 on localhost:
2164
2165 PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
2166 # connect with e.g.: telnet localhost 4545
2167
2168Note that creating sockets in F</tmp> or on localhost is very unsafe on
2169multiuser systems.
2170
2171=item C<PERL_ANYEVENT_DEBUG_WRAP>
2172
2173Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2174debugging purposes. See C<AnyEvent::Debug::wrap> for details.
1423 2175
1424=item C<PERL_ANYEVENT_MODEL> 2176=item C<PERL_ANYEVENT_MODEL>
1425 2177
1426This can be used to specify the event model to be used by AnyEvent, before 2178This can be used to specify the event model to be used by AnyEvent, before
1427auto detection and -probing kicks in. It must be a string consisting 2179auto detection and -probing kicks in.
1428entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2180
2181It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2182or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1429and the resulting module name is loaded and if the load was successful, 2183resulting module name is loaded and - if the load was successful - used as
1430used as event model. If it fails to load AnyEvent will proceed with 2184event model backend. If it fails to load then AnyEvent will proceed with
1431auto detection and -probing. 2185auto detection and -probing.
1432 2186
1433This functionality might change in future versions. 2187If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2188nothing gets prepended and the module name is used as-is (hint: C<::> at
2189the end of a string designates a module name and quotes it appropriately).
1434 2190
1435For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 2191For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1436could start your program like this: 2192could start your program like this:
1437 2193
1438 PERL_ANYEVENT_MODEL=Perl perl ... 2194 PERL_ANYEVENT_MODEL=Perl perl ...
2195
2196=item C<PERL_ANYEVENT_IO_MODEL>
2197
2198The current file I/O model - see L<AnyEvent::IO> for more info.
2199
2200At the moment, only C<Perl> (small, pure-perl, synchronous) and
2201C<IOAIO> (truly asynchronous) are supported. The default is C<IOAIO> if
2202L<AnyEvent::AIO> can be loaded, otherwise it is C<Perl>.
1439 2203
1440=item C<PERL_ANYEVENT_PROTOCOLS> 2204=item C<PERL_ANYEVENT_PROTOCOLS>
1441 2205
1442Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences 2206Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1443for IPv4 or IPv6. The default is unspecified (and might change, or be the result 2207for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1448used, and preference will be given to protocols mentioned earlier in the 2212used, and preference will be given to protocols mentioned earlier in the
1449list. 2213list.
1450 2214
1451This variable can effectively be used for denial-of-service attacks 2215This variable can effectively be used for denial-of-service attacks
1452against local programs (e.g. when setuid), although the impact is likely 2216against local programs (e.g. when setuid), although the impact is likely
1453small, as the program has to handle conenction and other failures anyways. 2217small, as the program has to handle connection and other failures anyways.
1454 2218
1455Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, 2219Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1456but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 2220but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1457- only support IPv4, never try to resolve or contact IPv6 2221- only support IPv4, never try to resolve or contact IPv6
1458addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2222addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1459IPv6, but prefer IPv6 over IPv4. 2223IPv6, but prefer IPv6 over IPv4.
1460 2224
2225=item C<PERL_ANYEVENT_HOSTS>
2226
2227This variable, if specified, overrides the F</etc/hosts> file used by
2228L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2229from that file instead.
2230
1461=item C<PERL_ANYEVENT_EDNS0> 2231=item C<PERL_ANYEVENT_EDNS0>
1462 2232
1463Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension 2233Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1464for DNS. This extension is generally useful to reduce DNS traffic, but 2234DNS. This extension is generally useful to reduce DNS traffic, especially
1465some (broken) firewalls drop such DNS packets, which is why it is off by 2235when DNSSEC is involved, but some (broken) firewalls drop such DNS
1466default. 2236packets, which is why it is off by default.
1467 2237
1468Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce 2238Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1469EDNS0 in its DNS requests. 2239EDNS0 in its DNS requests.
1470 2240
1471=item C<PERL_ANYEVENT_MAX_FORKS> 2241=item C<PERL_ANYEVENT_MAX_FORKS>
1472 2242
1473The maximum number of child processes that C<AnyEvent::Util::fork_call> 2243The maximum number of child processes that C<AnyEvent::Util::fork_call>
1474will create in parallel. 2244will create in parallel.
2245
2246=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
2247
2248The default value for the C<max_outstanding> parameter for the default DNS
2249resolver - this is the maximum number of parallel DNS requests that are
2250sent to the DNS server.
2251
2252=item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY>
2253
2254Perl has inherently racy signal handling (you can basically choose between
2255losing signals and memory corruption) - pure perl event loops (including
2256C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore
2257have to poll regularly to avoid losing signals.
2258
2259Some event loops are racy, but don't poll regularly, and some event loops
2260are written in C but are still racy. For those event loops, AnyEvent
2261installs a timer that regularly wakes up the event loop.
2262
2263By default, the interval for this timer is C<10> seconds, but you can
2264override this delay with this environment variable (or by setting
2265the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal
2266watchers).
2267
2268Lower values increase CPU (and energy) usage, higher values can introduce
2269long delays when reaping children or waiting for signals.
2270
2271The L<AnyEvent::Async> module, if available, will be used to avoid this
2272polling (with most event loops).
2273
2274=item C<PERL_ANYEVENT_RESOLV_CONF>
2275
2276The absolute path to a F<resolv.conf>-style file to use instead of
2277F</etc/resolv.conf> (or the OS-specific configuration) in the default
2278resolver, or the empty string to select the default configuration.
2279
2280=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
2281
2282When neither C<ca_file> nor C<ca_path> was specified during
2283L<AnyEvent::TLS> context creation, and either of these environment
2284variables are nonempty, they will be used to specify CA certificate
2285locations instead of a system-dependent default.
2286
2287=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
2288
2289When these are set to C<1>, then the respective modules are not
2290loaded. Mostly good for testing AnyEvent itself.
1475 2291
1476=back 2292=back
1477 2293
1478=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 2294=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1479 2295
1537 warn "read: $input\n"; # output what has been read 2353 warn "read: $input\n"; # output what has been read
1538 $cv->send if $input =~ /^q/i; # quit program if /^q/i 2354 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1539 }, 2355 },
1540 ); 2356 );
1541 2357
1542 my $time_watcher; # can only be used once
1543
1544 sub new_timer {
1545 $timer = AnyEvent->timer (after => 1, cb => sub { 2358 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1546 warn "timeout\n"; # print 'timeout' about every second 2359 warn "timeout\n"; # print 'timeout' at most every second
1547 &new_timer; # and restart the time
1548 }); 2360 });
1549 }
1550
1551 new_timer; # create first timer
1552 2361
1553 $cv->recv; # wait until user enters /^q/i 2362 $cv->recv; # wait until user enters /^q/i
1554 2363
1555=head1 REAL-WORLD EXAMPLE 2364=head1 REAL-WORLD EXAMPLE
1556 2365
1629 2438
1630The actual code goes further and collects all errors (C<die>s, exceptions) 2439The actual code goes further and collects all errors (C<die>s, exceptions)
1631that occurred during request processing. The C<result> method detects 2440that occurred during request processing. The C<result> method detects
1632whether an exception as thrown (it is stored inside the $txn object) 2441whether an exception as thrown (it is stored inside the $txn object)
1633and just throws the exception, which means connection errors and other 2442and just throws the exception, which means connection errors and other
1634problems get reported tot he code that tries to use the result, not in a 2443problems get reported to the code that tries to use the result, not in a
1635random callback. 2444random callback.
1636 2445
1637All of this enables the following usage styles: 2446All of this enables the following usage styles:
1638 2447
16391. Blocking: 24481. Blocking:
1687through AnyEvent. The benchmark creates a lot of timers (with a zero 2496through AnyEvent. The benchmark creates a lot of timers (with a zero
1688timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2497timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1689which it is), lets them fire exactly once and destroys them again. 2498which it is), lets them fire exactly once and destroys them again.
1690 2499
1691Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2500Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1692distribution. 2501distribution. It uses the L<AE> interface, which makes a real difference
2502for the EV and Perl backends only.
1693 2503
1694=head3 Explanation of the columns 2504=head3 Explanation of the columns
1695 2505
1696I<watcher> is the number of event watchers created/destroyed. Since 2506I<watcher> is the number of event watchers created/destroyed. Since
1697different event models feature vastly different performances, each event 2507different event models feature vastly different performances, each event
1718watcher. 2528watcher.
1719 2529
1720=head3 Results 2530=head3 Results
1721 2531
1722 name watchers bytes create invoke destroy comment 2532 name watchers bytes create invoke destroy comment
1723 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2533 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1724 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2534 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1725 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2535 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1726 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2536 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1727 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2537 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1728 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2538 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1729 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 2539 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1730 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 2540 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1731 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2541 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1732 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2542 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1733 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2543 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1734 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2544 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1735 2545
1736=head3 Discussion 2546=head3 Discussion
1737 2547
1738The benchmark does I<not> measure scalability of the event loop very 2548The benchmark does I<not> measure scalability of the event loop very
1739well. For example, a select-based event loop (such as the pure perl one) 2549well. For example, a select-based event loop (such as the pure perl one)
1751benchmark machine, handling an event takes roughly 1600 CPU cycles with 2561benchmark machine, handling an event takes roughly 1600 CPU cycles with
1752EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2562EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1753cycles with POE. 2563cycles with POE.
1754 2564
1755C<EV> is the sole leader regarding speed and memory use, which are both 2565C<EV> is the sole leader regarding speed and memory use, which are both
1756maximal/minimal, respectively. Even when going through AnyEvent, it uses 2566maximal/minimal, respectively. When using the L<AE> API there is zero
2567overhead (when going through the AnyEvent API create is about 5-6 times
2568slower, with other times being equal, so still uses far less memory than
1757far less memory than any other event loop and is still faster than Event 2569any other event loop and is still faster than Event natively).
1758natively.
1759 2570
1760The pure perl implementation is hit in a few sweet spots (both the 2571The pure perl implementation is hit in a few sweet spots (both the
1761constant timeout and the use of a single fd hit optimisations in the perl 2572constant timeout and the use of a single fd hit optimisations in the perl
1762interpreter and the backend itself). Nevertheless this shows that it 2573interpreter and the backend itself). Nevertheless this shows that it
1763adds very little overhead in itself. Like any select-based backend its 2574adds very little overhead in itself. Like any select-based backend its
1811(even when used without AnyEvent), but most event loops have acceptable 2622(even when used without AnyEvent), but most event loops have acceptable
1812performance with or without AnyEvent. 2623performance with or without AnyEvent.
1813 2624
1814=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2625=item * The overhead AnyEvent adds is usually much smaller than the overhead of
1815the actual event loop, only with extremely fast event loops such as EV 2626the actual event loop, only with extremely fast event loops such as EV
1816adds AnyEvent significant overhead. 2627does AnyEvent add significant overhead.
1817 2628
1818=item * You should avoid POE like the plague if you want performance or 2629=item * You should avoid POE like the plague if you want performance or
1819reasonable memory usage. 2630reasonable memory usage.
1820 2631
1821=back 2632=back
1837In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2648In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1838(1%) are active. This mirrors the activity of large servers with many 2649(1%) are active. This mirrors the activity of large servers with many
1839connections, most of which are idle at any one point in time. 2650connections, most of which are idle at any one point in time.
1840 2651
1841Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2652Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1842distribution. 2653distribution. It uses the L<AE> interface, which makes a real difference
2654for the EV and Perl backends only.
1843 2655
1844=head3 Explanation of the columns 2656=head3 Explanation of the columns
1845 2657
1846I<sockets> is the number of sockets, and twice the number of "servers" (as 2658I<sockets> is the number of sockets, and twice the number of "servers" (as
1847each server has a read and write socket end). 2659each server has a read and write socket end).
1855a new one that moves the timeout into the future. 2667a new one that moves the timeout into the future.
1856 2668
1857=head3 Results 2669=head3 Results
1858 2670
1859 name sockets create request 2671 name sockets create request
1860 EV 20000 69.01 11.16 2672 EV 20000 62.66 7.99
1861 Perl 20000 73.32 35.87 2673 Perl 20000 68.32 32.64
1862 IOAsync 20000 157.00 98.14 epoll 2674 IOAsync 20000 174.06 101.15 epoll
1863 IOAsync 20000 159.31 616.06 poll 2675 IOAsync 20000 174.67 610.84 poll
1864 Event 20000 212.62 257.32 2676 Event 20000 202.69 242.91
1865 Glib 20000 651.16 1896.30 2677 Glib 20000 557.01 1689.52
1866 POE 20000 349.67 12317.24 uses POE::Loop::Event 2678 POE 20000 341.54 12086.32 uses POE::Loop::Event
1867 2679
1868=head3 Discussion 2680=head3 Discussion
1869 2681
1870This benchmark I<does> measure scalability and overall performance of the 2682This benchmark I<does> measure scalability and overall performance of the
1871particular event loop. 2683particular event loop.
1997As you can see, the AnyEvent + EV combination even beats the 2809As you can see, the AnyEvent + EV combination even beats the
1998hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2810hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
1999backend easily beats IO::Lambda and POE. 2811backend easily beats IO::Lambda and POE.
2000 2812
2001And even the 100% non-blocking version written using the high-level (and 2813And even the 100% non-blocking version written using the high-level (and
2002slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2814slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2003large margin, even though it does all of DNS, tcp-connect and socket I/O 2815higher level ("unoptimised") abstractions by a large margin, even though
2004in a non-blocking way. 2816it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2005 2817
2006The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2818The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2007F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2819F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2008part of the IO::lambda distribution and were used without any changes. 2820part of the IO::Lambda distribution and were used without any changes.
2009 2821
2010 2822
2011=head1 SIGNALS 2823=head1 SIGNALS
2012 2824
2013AnyEvent currently installs handlers for these signals: 2825AnyEvent currently installs handlers for these signals:
2018 2830
2019A handler for C<SIGCHLD> is installed by AnyEvent's child watcher 2831A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2020emulation for event loops that do not support them natively. Also, some 2832emulation for event loops that do not support them natively. Also, some
2021event loops install a similar handler. 2833event loops install a similar handler.
2022 2834
2023If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will 2835Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2024reset it to default, to avoid losing child exit statuses. 2836AnyEvent will reset it to default, to avoid losing child exit statuses.
2025 2837
2026=item SIGPIPE 2838=item SIGPIPE
2027 2839
2028A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> 2840A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2029when AnyEvent gets loaded. 2841when AnyEvent gets loaded.
2047 if $SIG{CHLD} eq 'IGNORE'; 2859 if $SIG{CHLD} eq 'IGNORE';
2048 2860
2049$SIG{PIPE} = sub { } 2861$SIG{PIPE} = sub { }
2050 unless defined $SIG{PIPE}; 2862 unless defined $SIG{PIPE};
2051 2863
2864=head1 RECOMMENDED/OPTIONAL MODULES
2865
2866One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2867its built-in modules) are required to use it.
2868
2869That does not mean that AnyEvent won't take advantage of some additional
2870modules if they are installed.
2871
2872This section explains which additional modules will be used, and how they
2873affect AnyEvent's operation.
2874
2875=over 4
2876
2877=item L<Async::Interrupt>
2878
2879This slightly arcane module is used to implement fast signal handling: To
2880my knowledge, there is no way to do completely race-free and quick
2881signal handling in pure perl. To ensure that signals still get
2882delivered, AnyEvent will start an interval timer to wake up perl (and
2883catch the signals) with some delay (default is 10 seconds, look for
2884C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2885
2886If this module is available, then it will be used to implement signal
2887catching, which means that signals will not be delayed, and the event loop
2888will not be interrupted regularly, which is more efficient (and good for
2889battery life on laptops).
2890
2891This affects not just the pure-perl event loop, but also other event loops
2892that have no signal handling on their own (e.g. Glib, Tk, Qt).
2893
2894Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
2895and either employ their own workarounds (POE) or use AnyEvent's workaround
2896(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
2897does nothing for those backends.
2898
2899=item L<EV>
2900
2901This module isn't really "optional", as it is simply one of the backend
2902event loops that AnyEvent can use. However, it is simply the best event
2903loop available in terms of features, speed and stability: It supports
2904the AnyEvent API optimally, implements all the watcher types in XS, does
2905automatic timer adjustments even when no monotonic clock is available,
2906can take avdantage of advanced kernel interfaces such as C<epoll> and
2907C<kqueue>, and is the fastest backend I<by far>. You can even embed
2908L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2909
2910If you only use backends that rely on another event loop (e.g. C<Tk>),
2911then this module will do nothing for you.
2912
2913=item L<Guard>
2914
2915The guard module, when used, will be used to implement
2916C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2917lot less memory), but otherwise doesn't affect guard operation much. It is
2918purely used for performance.
2919
2920=item L<JSON> and L<JSON::XS>
2921
2922One of these modules is required when you want to read or write JSON data
2923via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2924advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2925
2926=item L<Net::SSLeay>
2927
2928Implementing TLS/SSL in Perl is certainly interesting, but not very
2929worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2930the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2931
2932=item L<Time::HiRes>
2933
2934This module is part of perl since release 5.008. It will be used when the
2935chosen event library does not come with a timing source of its own. The
2936pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2937try to use a monotonic clock for timing stability.
2938
2939=item L<AnyEvent::AIO> (and L<IO::AIO>)
2940
2941The default implementation of L<AnyEvent::IO> is to do I/O synchronously,
2942stopping programs while they access the disk, which is fine for a lot of
2943programs.
2944
2945Installing AnyEvent::AIO (and its IO::AIO dependency) makes it switch to
2946a true asynchronous implementation, so event processing can continue even
2947while waiting for disk I/O.
2948
2949=back
2950
2951
2052=head1 FORK 2952=head1 FORK
2053 2953
2054Most event libraries are not fork-safe. The ones who are usually are 2954Most event libraries are not fork-safe. The ones who are usually are
2055because they rely on inefficient but fork-safe C<select> or C<poll> 2955because they rely on inefficient but fork-safe C<select> or C<poll> calls
2056calls. Only L<EV> is fully fork-aware. 2956- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
2957are usually badly thought-out hacks that are incompatible with fork in
2958one way or another. Only L<EV> is fully fork-aware and ensures that you
2959continue event-processing in both parent and child (or both, if you know
2960what you are doing).
2961
2962This means that, in general, you cannot fork and do event processing in
2963the child if the event library was initialised before the fork (which
2964usually happens when the first AnyEvent watcher is created, or the library
2965is loaded).
2057 2966
2058If you have to fork, you must either do so I<before> creating your first 2967If you have to fork, you must either do so I<before> creating your first
2059watcher OR you must not use AnyEvent at all in the child. 2968watcher OR you must not use AnyEvent at all in the child OR you must do
2969something completely out of the scope of AnyEvent (see below).
2970
2971The problem of doing event processing in the parent I<and> the child
2972is much more complicated: even for backends that I<are> fork-aware or
2973fork-safe, their behaviour is not usually what you want: fork clones all
2974watchers, that means all timers, I/O watchers etc. are active in both
2975parent and child, which is almost never what you want. Using C<exec>
2976to start worker children from some kind of manage prrocess is usually
2977preferred, because it is much easier and cleaner, at the expense of having
2978to have another binary.
2979
2980In addition to logical problems with fork, there are also implementation
2981problems. For example, on POSIX systems, you cannot fork at all in Perl
2982code if a thread (I am talking of pthreads here) was ever created in the
2983process, and this is just the tip of the iceberg. In general, using fork
2984from Perl is difficult, and attempting to use fork without an exec to
2985implement some kind of parallel processing is almost certainly doomed.
2986
2987To safely fork and exec, you should use a module such as
2988L<Proc::FastSpawn> that let's you safely fork and exec new processes.
2989
2990If you want to do multiprocessing using processes, you can
2991look at the L<AnyEvent::Fork> module (and some related modules
2992such as L<AnyEvent::Fork::RPC>, L<AnyEvent::Fork::Pool> and
2993L<AnyEvent::Fork::Remote>). This module allows you to safely create
2994subprocesses without any limitations - you can use X11 toolkits or
2995AnyEvent in the children created by L<AnyEvent::Fork> safely and without
2996any special precautions.
2060 2997
2061 2998
2062=head1 SECURITY CONSIDERATIONS 2999=head1 SECURITY CONSIDERATIONS
2063 3000
2064AnyEvent can be forced to load any event model via 3001AnyEvent can be forced to load any event model via
2094pronounced). 3031pronounced).
2095 3032
2096 3033
2097=head1 SEE ALSO 3034=head1 SEE ALSO
2098 3035
2099Utility functions: L<AnyEvent::Util>. 3036Tutorial/Introduction: L<AnyEvent::Intro>.
2100 3037
2101Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 3038FAQ: L<AnyEvent::FAQ>.
2102L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 3039
3040Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
3041(simply logging).
3042
3043Development/Debugging: L<AnyEvent::Strict> (stricter checking),
3044L<AnyEvent::Debug> (interactive shell, watcher tracing).
3045
3046Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
3047L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
3048L<Qt>, L<POE>, L<FLTK>.
2103 3049
2104Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 3050Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2105L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 3051L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2106L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 3052L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
3053L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
2107L<AnyEvent::Impl::POE>. 3054L<AnyEvent::Impl::FLTK>.
2108 3055
2109Non-blocking file handles, sockets, TCP clients and 3056Non-blocking handles, pipes, stream sockets, TCP clients and
2110servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. 3057servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
3058
3059Asynchronous File I/O: L<AnyEvent::IO>.
2111 3060
2112Asynchronous DNS: L<AnyEvent::DNS>. 3061Asynchronous DNS: L<AnyEvent::DNS>.
2113 3062
2114Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 3063Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2115 3064
2116Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 3065Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
3066L<AnyEvent::HTTP>.
2117 3067
2118 3068
2119=head1 AUTHOR 3069=head1 AUTHOR
2120 3070
2121 Marc Lehmann <schmorp@schmorp.de> 3071 Marc Lehmann <schmorp@schmorp.de>
2122 http://home.schmorp.de/ 3072 http://anyevent.schmorp.de
2123 3073
2124=cut 3074=cut
2125 3075
21261 30761
2127 3077

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines