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.156 by root, Fri Jun 6 10:23:50 2008 UTC vs.
Revision 1.329 by root, Sun Jul 11 05:44:22 2010 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, POE - various supported event loops 5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6and POE are various supported event loops/environments.
6 7
7=head1 SYNOPSIS 8=head1 SYNOPSIS
8 9
9 use AnyEvent; 10 use AnyEvent;
10 11
12 # if you prefer function calls, look at the AE manpage for
13 # an alternative API.
14
15 # file handle or descriptor readable
11 my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { 16 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
17
18 # one-shot or repeating timers
19 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
20 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
21
22 print AnyEvent->now; # prints current event loop time
23 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
24
25 # POSIX signal
26 my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
27
28 # child process exit
29 my $w = AnyEvent->child (pid => $pid, cb => sub {
30 my ($pid, $status) = @_;
12 ... 31 ...
13 }); 32 });
14 33
15 my $w = AnyEvent->timer (after => $seconds, cb => sub { 34 # called when event loop idle (if applicable)
16 ... 35 my $w = AnyEvent->idle (cb => sub { ... });
17 });
18 36
19 my $w = AnyEvent->condvar; # stores whether a condition was flagged 37 my $w = AnyEvent->condvar; # stores whether a condition was flagged
20 $w->send; # wake up current and all future recv's 38 $w->send; # wake up current and all future recv's
21 $w->recv; # enters "main loop" till $condvar gets ->send 39 $w->recv; # enters "main loop" till $condvar gets ->send
40 # use a condvar in callback mode:
41 $w->cb (sub { $_[0]->recv });
22 42
23=head1 INTRODUCTION/TUTORIAL 43=head1 INTRODUCTION/TUTORIAL
24 44
25This manpage is mainly a reference manual. If you are interested 45This manpage is mainly a reference manual. If you are interested
26in a tutorial or some gentle introduction, have a look at the 46in a tutorial or some gentle introduction, have a look at the
27L<AnyEvent::Intro> manpage. 47L<AnyEvent::Intro> manpage.
28 48
49=head1 SUPPORT
50
51There is a mailinglist for discussing all things AnyEvent, and an IRC
52channel, too.
53
54See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
55Repository>, at L<http://anyevent.schmorp.de>, for more info.
56
29=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 57=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
30 58
31Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 59Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
32nowadays. So what is different about AnyEvent? 60nowadays. So what is different about AnyEvent?
33 61
34Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of 62Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
35policy> and AnyEvent is I<small and efficient>. 63policy> and AnyEvent is I<small and efficient>.
36 64
37First and foremost, I<AnyEvent is not an event model> itself, it only 65First and foremost, I<AnyEvent is not an event model> itself, it only
38interfaces to whatever event model the main program happens to use in a 66interfaces to whatever event model the main program happens to use, in a
39pragmatic way. For event models and certain classes of immortals alike, 67pragmatic way. For event models and certain classes of immortals alike,
40the statement "there can only be one" is a bitter reality: In general, 68the statement "there can only be one" is a bitter reality: In general,
41only one event loop can be active at the same time in a process. AnyEvent 69only one event loop can be active at the same time in a process. AnyEvent
42helps hiding the differences between those event loops. 70cannot change this, but it can hide the differences between those event
71loops.
43 72
44The goal of AnyEvent is to offer module authors the ability to do event 73The goal of AnyEvent is to offer module authors the ability to do event
45programming (waiting for I/O or timer events) without subscribing to a 74programming (waiting for I/O or timer events) without subscribing to a
46religion, a way of living, and most importantly: without forcing your 75religion, a way of living, and most importantly: without forcing your
47module users into the same thing by forcing them to use the same event 76module users into the same thing by forcing them to use the same event
48model you use. 77model you use.
49 78
50For modules like POE or IO::Async (which is a total misnomer as it is 79For modules like POE or IO::Async (which is a total misnomer as it is
51actually doing all I/O I<synchronously>...), using them in your module is 80actually doing all I/O I<synchronously>...), using them in your module is
52like joining a cult: After you joined, you are dependent on them and you 81like joining a cult: After you joined, you are dependent on them and you
53cannot use anything else, as it is simply incompatible to everything that 82cannot use anything else, as they are simply incompatible to everything
54isn't itself. What's worse, all the potential users of your module are 83that isn't them. What's worse, all the potential users of your
55I<also> forced to use the same event loop you use. 84module are I<also> forced to use the same event loop you use.
56 85
57AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 86AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
58fine. AnyEvent + Tk works fine etc. etc. but none of these work together 87fine. AnyEvent + Tk works fine etc. etc. but none of these work together
59with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if 88with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
60your module uses one of those, every user of your module has to use it, 89your module uses one of those, every user of your module has to use it,
61too. But if your module uses AnyEvent, it works transparently with all 90too. But if your module uses AnyEvent, it works transparently with all
62event models it supports (including stuff like POE and IO::Async, as long 91event models it supports (including stuff like IO::Async, as long as those
63as those use one of the supported event loops. It is trivial to add new 92use one of the supported event loops. It is trivial to add new event loops
64event loops to AnyEvent, too, so it is future-proof). 93to AnyEvent, too, so it is future-proof).
65 94
66In addition to being free of having to use I<the one and only true event 95In addition to being free of having to use I<the one and only true event
67model>, AnyEvent also is free of bloat and policy: with POE or similar 96model>, AnyEvent also is free of bloat and policy: with POE or similar
68modules, you get an enormous amount of code and strict rules you have to 97modules, you get an enormous amount of code and strict rules you have to
69follow. AnyEvent, on the other hand, is lean and up to the point, by only 98follow. AnyEvent, on the other hand, is lean and up to the point, by only
109 use AnyEvent; 138 use AnyEvent;
110 139
111 # .. AnyEvent will likely default to Tk 140 # .. AnyEvent will likely default to Tk
112 141
113The 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
114starts 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,
115use AnyEvent so their modules work together with others seamlessly... 144as very few modules hardcode event loops without announcing this very
145loudly.
116 146
117The pure-perl implementation of AnyEvent is called 147The pure-perl implementation of AnyEvent is called
118C<AnyEvent::Impl::Perl>. Like other event modules you can load it 148C<AnyEvent::Impl::Perl>. Like other event modules you can load it
119explicitly and enjoy the high availability of that event loop :) 149explicitly and enjoy the high availability of that event loop :)
120 150
127These watchers are normal Perl objects with normal Perl lifetime. After 157These watchers are normal Perl objects with normal Perl lifetime. After
128creating a watcher it will immediately "watch" for events and invoke the 158creating a watcher it will immediately "watch" for events and invoke the
129callback when the event occurs (of course, only when the event model 159callback when the event occurs (of course, only when the event model
130is in control). 160is in control).
131 161
162Note that B<callbacks must not permanently change global variables>
163potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
164callbacks must not C<die> >>. The former is good programming practise in
165Perl and the latter stems from the fact that exception handling differs
166widely between event loops.
167
132To disable the watcher you have to destroy it (e.g. by setting the 168To disable the watcher you have to destroy it (e.g. by setting the
133variable 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
134to it). 170to it).
135 171
136All 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.
149my variables are only visible after the statement in which they are 185my variables are only visible after the statement in which they are
150declared. 186declared.
151 187
152=head2 I/O WATCHERS 188=head2 I/O WATCHERS
153 189
190 $w = AnyEvent->io (
191 fh => <filehandle_or_fileno>,
192 poll => <"r" or "w">,
193 cb => <callback>,
194 );
195
154You 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
155with the following mandatory key-value pairs as arguments: 197with the following mandatory key-value pairs as arguments:
156 198
157C<fh> 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
200for events (AnyEvent might or might not keep a reference to this file
201handle). Note that only file handles pointing to things for which
202non-blocking operation makes sense are allowed. This includes sockets,
203most character devices, pipes, fifos and so on, but not for example files
204or block devices.
205
158for events. C<poll> must be a string that is either C<r> or C<w>, 206C<poll> must be a string that is either C<r> or C<w>, which creates a
159which creates a watcher waiting for "r"eadable or "w"ritable events, 207watcher waiting for "r"eadable or "w"ritable events, respectively.
208
160respectively. C<cb> is the callback to invoke each time the file handle 209C<cb> is the callback to invoke each time the file handle becomes ready.
161becomes ready.
162 210
163Although the callback might get passed parameters, their value and 211Although the callback might get passed parameters, their value and
164presence is undefined and you cannot rely on them. Portable AnyEvent 212presence is undefined and you cannot rely on them. Portable AnyEvent
165callbacks cannot use arguments passed to I/O watcher callbacks. 213callbacks cannot use arguments passed to I/O watcher callbacks.
166 214
170 218
171Some event loops issue spurious readyness notifications, so you should 219Some event loops issue spurious readyness notifications, so you should
172always use non-blocking calls when reading/writing from/to your file 220always use non-blocking calls when reading/writing from/to your file
173handles. 221handles.
174 222
175Example:
176
177 # wait for readability of STDIN, then read a line and disable the watcher 223Example: wait for readability of STDIN, then read a line and disable the
224watcher.
225
178 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { 226 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
179 chomp (my $input = <STDIN>); 227 chomp (my $input = <STDIN>);
180 warn "read: $input\n"; 228 warn "read: $input\n";
181 undef $w; 229 undef $w;
182 }); 230 });
183 231
184=head2 TIME WATCHERS 232=head2 TIME WATCHERS
185 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
186You can create a time watcher by calling the C<< AnyEvent->timer >> 242You can create a time watcher by calling the C<< AnyEvent->timer >>
187method with the following mandatory arguments: 243method with the following mandatory arguments:
188 244
189C<after> specifies after how many seconds (fractional values are 245C<after> specifies after how many seconds (fractional values are
190supported) 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
192 248
193Although the callback might get passed parameters, their value and 249Although the callback might get passed parameters, their value and
194presence is undefined and you cannot rely on them. Portable AnyEvent 250presence is undefined and you cannot rely on them. Portable AnyEvent
195callbacks cannot use arguments passed to time watcher callbacks. 251callbacks cannot use arguments passed to time watcher callbacks.
196 252
197The timer callback will be invoked at most once: if you want a repeating 253The callback will normally be invoked once only. If you specify another
198timer you have to create a new watcher (this is a limitation by both Tk 254parameter, C<interval>, as a strictly positive number (> 0), then the
199and Glib). 255callback will be invoked regularly at that interval (in fractional
256seconds) after the first invocation. If C<interval> is specified with a
257false value, then it is treated as if it were missing.
200 258
201Example: 259The callback will be rescheduled before invoking the callback, but no
260attempt is done to avoid timer drift in most backends, so the interval is
261only approximate.
202 262
203 # fire an event after 7.7 seconds 263Example: fire an event after 7.7 seconds.
264
204 my $w = AnyEvent->timer (after => 7.7, cb => sub { 265 my $w = AnyEvent->timer (after => 7.7, cb => sub {
205 warn "timeout\n"; 266 warn "timeout\n";
206 }); 267 });
207 268
208 # to cancel the timer: 269 # to cancel the timer:
209 undef $w; 270 undef $w;
210 271
211Example 2:
212
213 # fire an event after 0.5 seconds, then roughly every second 272Example 2: fire an event after 0.5 seconds, then roughly every second.
214 my $w;
215 273
216 my $cb = sub {
217 # cancel the old timer while creating a new one
218 $w = AnyEvent->timer (after => 1, cb => $cb); 274 my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
275 warn "timeout\n";
219 }; 276 };
220
221 # start the "loop" by creating the first watcher
222 $w = AnyEvent->timer (after => 0.5, cb => $cb);
223 277
224=head3 TIMING ISSUES 278=head3 TIMING ISSUES
225 279
226There 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
227in 10 seconds") and based on wallclock time (absolute, "fire at 12 281in 10 seconds") and based on wallclock time (absolute, "fire at 12
300In either case, if you care (and in most cases, you don't), then you 354In either case, if you care (and in most cases, you don't), then you
301can get whatever behaviour you want with any event loop, by taking the 355can get whatever behaviour you want with any event loop, by taking the
302difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
303account. 357account.
304 358
359=item AnyEvent->now_update
360
361Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
362the current time for each loop iteration (see the discussion of L<<
363AnyEvent->now >>, above).
364
365When a callback runs for a long time (or when the process sleeps), then
366this "current" time will differ substantially from the real time, which
367might affect timers and time-outs.
368
369When this is the case, you can call this method, which will update the
370event loop's idea of "current time".
371
372A typical example would be a script in a web server (e.g. C<mod_perl>) -
373when mod_perl executes the script, then the event loop will have the wrong
374idea about the "current time" (being potentially far in the past, when the
375script ran the last time). In that case you should arrange a call to C<<
376AnyEvent->now_update >> each time the web server process wakes up again
377(e.g. at the start of your script, or in a handler).
378
379Note that updating the time I<might> cause some events to be handled.
380
305=back 381=back
306 382
307=head2 SIGNAL WATCHERS 383=head2 SIGNAL WATCHERS
308 384
385 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
386
309You 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
310I<name> without any C<SIG> prefix, C<cb> is the Perl callback to 388I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
311be invoked whenever a signal occurs. 389callback to be invoked whenever a signal occurs.
312 390
313Although the callback might get passed parameters, their value and 391Although the callback might get passed parameters, their value and
314presence is undefined and you cannot rely on them. Portable AnyEvent 392presence is undefined and you cannot rely on them. Portable AnyEvent
315callbacks cannot use arguments passed to signal watcher callbacks. 393callbacks cannot use arguments passed to signal watcher callbacks.
316 394
318invocation, and callback invocation will be synchronous. Synchronous means 396invocation, and callback invocation will be synchronous. Synchronous means
319that 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,
320but it is guaranteed not to interrupt any other callbacks. 398but it is guaranteed not to interrupt any other callbacks.
321 399
322The 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
323between multiple watchers. 401between multiple watchers, and AnyEvent will ensure that signals will not
402interrupt your program at bad times.
324 403
325This watcher might use C<%SIG>, so programs overwriting those signals 404This watcher might use C<%SIG> (depending on the event loop used),
326directly will likely not work correctly. 405so programs overwriting those signals directly will likely not work
406correctly.
327 407
328Example: exit on SIGINT 408Example: exit on SIGINT
329 409
330 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 410 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
331 411
412=head3 Restart Behaviour
413
414While restart behaviour is up to the event loop implementation, most will
415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
416pure perl implementation).
417
418=head3 Safe/Unsafe Signals
419
420Perl signals can be either "safe" (synchronous to opcode handling) or
421"unsafe" (asynchronous) - the former might get delayed indefinitely, the
422latter might corrupt your memory.
423
424AnyEvent signal handlers are, in addition, synchronous to the event loop,
425i.e. they will not interrupt your running perl program but will only be
426called as part of the normal event handling (just like timer, I/O etc.
427callbacks, too).
428
429=head3 Signal Races, Delays and Workarounds
430
431Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
432callbacks to signals in a generic way, which is a pity, as you cannot
433do race-free signal handling in perl, requiring C libraries for
434this. AnyEvent will try to do it's best, which means in some cases,
435signals will be delayed. The maximum time a signal might be delayed is
436specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
437variable can be changed only before the first signal watcher is created,
438and should be left alone otherwise. This variable determines how often
439AnyEvent polls for signals (in case a wake-up was missed). Higher values
440will cause fewer spurious wake-ups, which is better for power and CPU
441saving.
442
443All these problems can be avoided by installing the optional
444L<Async::Interrupt> module, which works with most event loops. It will not
445work with inherently broken event loops such as L<Event> or L<Event::Lib>
446(and not with L<POE> currently, as POE does it's own workaround with
447one-second latency). For those, you just have to suffer the delays.
448
332=head2 CHILD PROCESS WATCHERS 449=head2 CHILD PROCESS WATCHERS
333 450
451 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
452
334You can also watch on a child process exit and catch its exit status. 453You can also watch on a child process exit and catch its exit status.
335 454
336The child process is specified by the C<pid> argument (if set to C<0>, it 455The child process is specified by the C<pid> argument (one some backends,
337watches for any child process exit). The watcher will trigger as often 456using C<0> watches for any child process exit, on others this will
338as status change for the child are received. This works by installing a 457croak). The watcher will be triggered only when the child process has
339signal handler for C<SIGCHLD>. The callback will be called with the pid 458finished and an exit status is available, not on any trace events
340and exit status (as returned by waitpid), so unlike other watcher types, 459(stopped/continued).
341you I<can> rely on child watcher callback arguments. 460
461The callback will be called with the pid and exit status (as returned by
462waitpid), so unlike other watcher types, you I<can> rely on child watcher
463callback arguments.
464
465This watcher type works by installing a signal handler for C<SIGCHLD>,
466and since it cannot be shared, nothing else should use SIGCHLD or reap
467random child processes (waiting for specific child processes, e.g. inside
468C<system>, is just fine).
342 469
343There is a slight catch to child watchers, however: you usually start them 470There is a slight catch to child watchers, however: you usually start them
344I<after> the child process was created, and this means the process could 471I<after> the child process was created, and this means the process could
345have exited already (and no SIGCHLD will be sent anymore). 472have exited already (and no SIGCHLD will be sent anymore).
346 473
347Not all event models handle this correctly (POE doesn't), but even for 474Not all event models handle this correctly (neither POE nor IO::Async do,
475see their AnyEvent::Impl manpages for details), but even for event models
348event models that I<do> handle this correctly, they usually need to be 476that I<do> handle this correctly, they usually need to be loaded before
349loaded before the process exits (i.e. before you fork in the first place). 477the process exits (i.e. before you fork in the first place). AnyEvent's
478pure perl event loop handles all cases correctly regardless of when you
479start the watcher.
350 480
351This means you cannot create a child watcher as the very first thing in an 481This means you cannot create a child watcher as the very first
352AnyEvent program, you I<have> to create at least one watcher before you 482thing in an AnyEvent program, you I<have> to create at least one
353C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 483watcher before you C<fork> the child (alternatively, you can call
484C<AnyEvent::detect>).
485
486As most event loops do not support waiting for child events, they will be
487emulated by AnyEvent in most cases, in which the latency and race problems
488mentioned in the description of signal watchers apply.
354 489
355Example: fork a process and wait for it 490Example: fork a process and wait for it
356 491
357 my $done = AnyEvent->condvar; 492 my $done = AnyEvent->condvar;
358 493
368 ); 503 );
369 504
370 # do something else, then wait for process exit 505 # do something else, then wait for process exit
371 $done->recv; 506 $done->recv;
372 507
508=head2 IDLE WATCHERS
509
510 $w = AnyEvent->idle (cb => <callback>);
511
512Repeatedly invoke the callback after the process becomes idle, until
513either the watcher is destroyed or new events have been detected.
514
515Idle watchers are useful when there is a need to do something, but it
516is not so important (or wise) to do it instantly. The callback will be
517invoked only when there is "nothing better to do", which is usually
518defined as "all outstanding events have been handled and no new events
519have been detected". That means that idle watchers ideally get invoked
520when the event loop has just polled for new events but none have been
521detected. Instead of blocking to wait for more events, the idle watchers
522will be invoked.
523
524Unfortunately, most event loops do not really support idle watchers (only
525EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
526will simply call the callback "from time to time".
527
528Example: read lines from STDIN, but only process them when the
529program is otherwise idle:
530
531 my @lines; # read data
532 my $idle_w;
533 my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
534 push @lines, scalar <STDIN>;
535
536 # start an idle watcher, if not already done
537 $idle_w ||= AnyEvent->idle (cb => sub {
538 # handle only one line, when there are lines left
539 if (my $line = shift @lines) {
540 print "handled when idle: $line";
541 } else {
542 # otherwise disable the idle watcher again
543 undef $idle_w;
544 }
545 });
546 });
547
373=head2 CONDITION VARIABLES 548=head2 CONDITION VARIABLES
549
550 $cv = AnyEvent->condvar;
551
552 $cv->send (<list>);
553 my @res = $cv->recv;
374 554
375If you are familiar with some event loops you will know that all of them 555If you are familiar with some event loops you will know that all of them
376require you to run some blocking "loop", "run" or similar function that 556require you to run some blocking "loop", "run" or similar function that
377will actively watch for new events and call your callbacks. 557will actively watch for new events and call your callbacks.
378 558
379AnyEvent is different, it expects somebody else to run the event loop and 559AnyEvent is slightly different: it expects somebody else to run the event
380will only block when necessary (usually when told by the user). 560loop and will only block when necessary (usually when told by the user).
381 561
382The instrument to do that is called a "condition variable", so called 562The tool to do that is called a "condition variable", so called because
383because they represent a condition that must become true. 563they represent a condition that must become true.
564
565Now is probably a good time to look at the examples further below.
384 566
385Condition variables can be created by calling the C<< AnyEvent->condvar 567Condition variables can be created by calling the C<< AnyEvent->condvar
386>> method, usually without arguments. The only argument pair allowed is 568>> method, usually without arguments. The only argument pair allowed is
387C<cb>, which specifies a callback to be called when the condition variable 569C<cb>, which specifies a callback to be called when the condition variable
388becomes true. 570becomes true, with the condition variable as the first argument (but not
571the results).
389 572
390After creation, the condition variable is "false" until it becomes "true" 573After creation, the condition variable is "false" until it becomes "true"
391by calling the C<send> method (or calling the condition variable as if it 574by calling the C<send> method (or calling the condition variable as if it
392were a callback, read about the caveats in the description for the C<< 575were a callback, read about the caveats in the description for the C<<
393->send >> method). 576->send >> method).
394 577
395Condition variables are similar to callbacks, except that you can 578Since condition variables are the most complex part of the AnyEvent API, here are
396optionally wait for them. They can also be called merge points - points 579some different mental models of what they are - pick the ones you can connect to:
397in time where multiple outstanding events have been processed. And yet 580
398another way to call them is transactions - each condition variable can be 581=over 4
399used to represent a transaction, which finishes at some point and delivers 582
400a result. 583=item * Condition variables are like callbacks - you can call them (and pass them instead
584of callbacks). Unlike callbacks however, you can also wait for them to be called.
585
586=item * Condition variables are signals - one side can emit or send them,
587the other side can wait for them, or install a handler that is called when
588the signal fires.
589
590=item * Condition variables are like "Merge Points" - points in your program
591where you merge multiple independent results/control flows into one.
592
593=item * Condition variables represent a transaction - function that start
594some kind of transaction can return them, leaving the caller the choice
595between waiting in a blocking fashion, or setting a callback.
596
597=item * Condition variables represent future values, or promises to deliver
598some result, long before the result is available.
599
600=back
401 601
402Condition variables are very useful to signal that something has finished, 602Condition variables are very useful to signal that something has finished,
403for example, if you write a module that does asynchronous http requests, 603for example, if you write a module that does asynchronous http requests,
404then a condition variable would be the ideal candidate to signal the 604then a condition variable would be the ideal candidate to signal the
405availability of results. The user can either act when the callback is 605availability of results. The user can either act when the callback is
426eventually calls C<< -> send >>, and the "consumer side", which waits 626eventually calls C<< -> send >>, and the "consumer side", which waits
427for the send to occur. 627for the send to occur.
428 628
429Example: wait for a timer. 629Example: wait for a timer.
430 630
431 # wait till the result is ready 631 # condition: "wait till the timer is fired"
432 my $result_ready = AnyEvent->condvar; 632 my $timer_fired = AnyEvent->condvar;
433 633
434 # do something such as adding a timer 634 # create the timer - we could wait for, say
435 # or socket watcher the calls $result_ready->send 635 # a handle becomign ready, or even an
436 # when the "result" is ready. 636 # AnyEvent::HTTP request to finish, but
437 # in this case, we simply use a timer: 637 # in this case, we simply use a timer:
438 my $w = AnyEvent->timer ( 638 my $w = AnyEvent->timer (
439 after => 1, 639 after => 1,
440 cb => sub { $result_ready->send }, 640 cb => sub { $timer_fired->send },
441 ); 641 );
442 642
443 # this "blocks" (while handling events) till the callback 643 # this "blocks" (while handling events) till the callback
444 # calls send 644 # calls ->send
445 $result_ready->recv; 645 $timer_fired->recv;
446 646
447Example: wait for a timer, but take advantage of the fact that 647Example: wait for a timer, but take advantage of the fact that condition
448condition variables are also code references. 648variables are also callable directly.
449 649
450 my $done = AnyEvent->condvar; 650 my $done = AnyEvent->condvar;
451 my $delay = AnyEvent->timer (after => 5, cb => $done); 651 my $delay = AnyEvent->timer (after => 5, cb => $done);
452 $done->recv; 652 $done->recv;
653
654Example: Imagine an API that returns a condvar and doesn't support
655callbacks. This is how you make a synchronous call, for example from
656the main program:
657
658 use AnyEvent::CouchDB;
659
660 ...
661
662 my @info = $couchdb->info->recv;
663
664And this is how you would just set a callback to be called whenever the
665results are available:
666
667 $couchdb->info->cb (sub {
668 my @info = $_[0]->recv;
669 });
453 670
454=head3 METHODS FOR PRODUCERS 671=head3 METHODS FOR PRODUCERS
455 672
456These methods should only be used by the producing side, i.e. the 673These methods should only be used by the producing side, i.e. the
457code/module that eventually sends the signal. Note that it is also 674code/module that eventually sends the signal. Note that it is also
470immediately from within send. 687immediately from within send.
471 688
472Any arguments passed to the C<send> call will be returned by all 689Any arguments passed to the C<send> call will be returned by all
473future C<< ->recv >> calls. 690future C<< ->recv >> calls.
474 691
475Condition variables are overloaded so one can call them directly 692Condition variables are overloaded so one can call them directly (as if
476(as a code reference). Calling them directly is the same as calling 693they were a code reference). Calling them directly is the same as calling
477C<send>. Note, however, that many C-based event loops do not handle 694C<send>.
478overloading, so as tempting as it may be, passing a condition variable
479instead of a callback does not work. Both the pure perl and EV loops
480support overloading, however, as well as all functions that use perl to
481invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
482example).
483 695
484=item $cv->croak ($error) 696=item $cv->croak ($error)
485 697
486Similar to send, but causes all call's to C<< ->recv >> to invoke 698Similar to send, but causes all call's to C<< ->recv >> to invoke
487C<Carp::croak> with the given error message/object/scalar. 699C<Carp::croak> with the given error message/object/scalar.
488 700
489This can be used to signal any errors to the condition variable 701This can be used to signal any errors to the condition variable
490user/consumer. 702user/consumer. Doing it this way instead of calling C<croak> directly
703delays the error detetcion, but has the overwhelmign advantage that it
704diagnoses the error at the place where the result is expected, and not
705deep in some event clalback without connection to the actual code causing
706the problem.
491 707
492=item $cv->begin ([group callback]) 708=item $cv->begin ([group callback])
493 709
494=item $cv->end 710=item $cv->end
495
496These two methods are EXPERIMENTAL and MIGHT CHANGE.
497 711
498These two methods can be used to combine many transactions/events into 712These two methods can be used to combine many transactions/events into
499one. For example, a function that pings many hosts in parallel might want 713one. For example, a function that pings many hosts in parallel might want
500to use a condition variable for the whole process. 714to use a condition variable for the whole process.
501 715
502Every call to C<< ->begin >> will increment a counter, and every call to 716Every call to C<< ->begin >> will increment a counter, and every call to
503C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 717C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
504>>, the (last) callback passed to C<begin> will be executed. That callback 718>>, the (last) callback passed to C<begin> will be executed, passing the
505is I<supposed> to call C<< ->send >>, but that is not required. If no 719condvar as first argument. That callback is I<supposed> to call C<< ->send
506callback was set, C<send> will be called without any arguments. 720>>, but that is not required. If no group callback was set, C<send> will
721be called without any arguments.
507 722
508Let's clarify this with the ping example: 723You can think of C<< $cv->send >> giving you an OR condition (one call
724sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
725condition (all C<begin> calls must be C<end>'ed before the condvar sends).
726
727Let's start with a simple example: you have two I/O watchers (for example,
728STDOUT and STDERR for a program), and you want to wait for both streams to
729close before activating a condvar:
509 730
510 my $cv = AnyEvent->condvar; 731 my $cv = AnyEvent->condvar;
511 732
733 $cv->begin; # first watcher
734 my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
735 defined sysread $fh1, my $buf, 4096
736 or $cv->end;
737 });
738
739 $cv->begin; # second watcher
740 my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
741 defined sysread $fh2, my $buf, 4096
742 or $cv->end;
743 });
744
745 $cv->recv;
746
747This works because for every event source (EOF on file handle), there is
748one call to C<begin>, so the condvar waits for all calls to C<end> before
749sending.
750
751The ping example mentioned above is slightly more complicated, as the
752there are results to be passwd back, and the number of tasks that are
753begung can potentially be zero:
754
755 my $cv = AnyEvent->condvar;
756
512 my %result; 757 my %result;
513 $cv->begin (sub { $cv->send (\%result) }); 758 $cv->begin (sub { shift->send (\%result) });
514 759
515 for my $host (@list_of_hosts) { 760 for my $host (@list_of_hosts) {
516 $cv->begin; 761 $cv->begin;
517 ping_host_then_call_callback $host, sub { 762 ping_host_then_call_callback $host, sub {
518 $result{$host} = ...; 763 $result{$host} = ...;
533loop, which serves two important purposes: first, it sets the callback 778loop, which serves two important purposes: first, it sets the callback
534to be called once the counter reaches C<0>, and second, it ensures that 779to be called once the counter reaches C<0>, and second, it ensures that
535C<send> is called even when C<no> hosts are being pinged (the loop 780C<send> is called even when C<no> hosts are being pinged (the loop
536doesn't execute once). 781doesn't execute once).
537 782
538This is the general pattern when you "fan out" into multiple subrequests: 783This is the general pattern when you "fan out" into multiple (but
539use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 784potentially none) subrequests: use an outer C<begin>/C<end> pair to set
540is called at least once, and then, for each subrequest you start, call 785the callback and ensure C<end> is called at least once, and then, for each
541C<begin> and for each subrequest you finish, call C<end>. 786subrequest you start, call C<begin> and for each subrequest you finish,
787call C<end>.
542 788
543=back 789=back
544 790
545=head3 METHODS FOR CONSUMERS 791=head3 METHODS FOR CONSUMERS
546 792
562function will call C<croak>. 808function will call C<croak>.
563 809
564In list context, all parameters passed to C<send> will be returned, 810In list context, all parameters passed to C<send> will be returned,
565in scalar context only the first one will be returned. 811in scalar context only the first one will be returned.
566 812
813Note that doing a blocking wait in a callback is not supported by any
814event loop, that is, recursive invocation of a blocking C<< ->recv
815>> is not allowed, and the C<recv> call will C<croak> if such a
816condition is detected. This condition can be slightly loosened by using
817L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
818any thread that doesn't run the event loop itself.
819
567Not all event models support a blocking wait - some die in that case 820Not all event models support a blocking wait - some die in that case
568(programs might want to do that to stay interactive), so I<if you are 821(programs might want to do that to stay interactive), so I<if you are
569using this from a module, never require a blocking wait>, but let the 822using this from a module, never require a blocking wait>. Instead, let the
570caller decide whether the call will block or not (for example, by coupling 823caller decide whether the call will block or not (for example, by coupling
571condition variables with some kind of request results and supporting 824condition variables with some kind of request results and supporting
572callbacks so the caller knows that getting the result will not block, 825callbacks so the caller knows that getting the result will not block,
573while still supporting blocking waits if the caller so desires). 826while still supporting blocking waits if the caller so desires).
574 827
575Another reason I<never> to C<< ->recv >> in a module is that you cannot
576sensibly have two C<< ->recv >>'s in parallel, as that would require
577multiple interpreters or coroutines/threads, none of which C<AnyEvent>
578can supply.
579
580The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
581fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
582versions and also integrates coroutines into AnyEvent, making blocking
583C<< ->recv >> calls perfectly safe as long as they are done from another
584coroutine (one that doesn't run the event loop).
585
586You can ensure that C<< -recv >> never blocks by setting a callback and 828You can ensure that C<< -recv >> never blocks by setting a callback and
587only calling C<< ->recv >> from within that callback (or at a later 829only calling C<< ->recv >> from within that callback (or at a later
588time). This will work even when the event loop does not support blocking 830time). This will work even when the event loop does not support blocking
589waits otherwise. 831waits otherwise.
590 832
591=item $bool = $cv->ready 833=item $bool = $cv->ready
592 834
593Returns true when the condition is "true", i.e. whether C<send> or 835Returns true when the condition is "true", i.e. whether C<send> or
594C<croak> have been called. 836C<croak> have been called.
595 837
596=item $cb = $cv->cb ([new callback]) 838=item $cb = $cv->cb ($cb->($cv))
597 839
598This is a mutator function that returns the callback set and optionally 840This is a mutator function that returns the callback set and optionally
599replaces it before doing so. 841replaces it before doing so.
600 842
601The callback will be called when the condition becomes "true", i.e. when 843The callback will be called when the condition becomes (or already was)
602C<send> or C<croak> are called, with the only argument being the condition 844"true", i.e. when C<send> or C<croak> are called (or were called), with
603variable itself. Calling C<recv> inside the callback or at any later time 845the only argument being the condition variable itself. Calling C<recv>
604is guaranteed not to block. 846inside the callback or at any later time is guaranteed not to block.
605 847
606=back 848=back
607 849
850=head1 SUPPORTED EVENT LOOPS/BACKENDS
851
852The available backend classes are (every class has its own manpage):
853
854=over 4
855
856=item Backends that are autoprobed when no other event loop can be found.
857
858EV is the preferred backend when no other event loop seems to be in
859use. If EV is not installed, then AnyEvent will fall back to its own
860pure-perl implementation, which is available everywhere as it comes with
861AnyEvent itself.
862
863 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
864 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
865
866=item Backends that are transparently being picked up when they are used.
867
868These will be used when they are currently loaded when the first watcher
869is created, in which case it is assumed that the application is using
870them. This means that AnyEvent will automatically pick the right backend
871when the main program loads an event module before anything starts to
872create watchers. Nothing special needs to be done by the main program.
873
874 AnyEvent::Impl::Event based on Event, very stable, few glitches.
875 AnyEvent::Impl::Glib based on Glib, slow but very stable.
876 AnyEvent::Impl::Tk based on Tk, very broken.
877 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
878 AnyEvent::Impl::POE based on POE, very slow, some limitations.
879 AnyEvent::Impl::Irssi used when running within irssi.
880
881=item Backends with special needs.
882
883Qt requires the Qt::Application to be instantiated first, but will
884otherwise be picked up automatically. As long as the main program
885instantiates the application before any AnyEvent watchers are created,
886everything should just work.
887
888 AnyEvent::Impl::Qt based on Qt.
889
890Support for IO::Async can only be partial, as it is too broken and
891architecturally limited to even support the AnyEvent API. It also
892is the only event loop that needs the loop to be set explicitly, so
893it can only be used by a main program knowing about AnyEvent. See
894L<AnyEvent::Impl::Async> for the gory details.
895
896 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
897
898=item Event loops that are indirectly supported via other backends.
899
900Some event loops can be supported via other modules:
901
902There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
903
904B<WxWidgets> has no support for watching file handles. However, you can
905use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
906polls 20 times per second, which was considered to be too horrible to even
907consider for AnyEvent.
908
909B<Prima> is not supported as nobody seems to be using it, but it has a POE
910backend, so it can be supported through POE.
911
912AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
913load L<POE> when detecting them, in the hope that POE will pick them up,
914in which case everything will be automatic.
915
916=back
917
608=head1 GLOBAL VARIABLES AND FUNCTIONS 918=head1 GLOBAL VARIABLES AND FUNCTIONS
609 919
920These are not normally required to use AnyEvent, but can be useful to
921write AnyEvent extension modules.
922
610=over 4 923=over 4
611 924
612=item $AnyEvent::MODEL 925=item $AnyEvent::MODEL
613 926
614Contains C<undef> until the first watcher is being created. Then it 927Contains C<undef> until the first watcher is being created, before the
928backend has been autodetected.
929
615contains the event model that is being used, which is the name of the 930Afterwards it contains the event model that is being used, which is the
616Perl class implementing the model. This class is usually one of the 931name of the Perl class implementing the model. This class is usually one
617C<AnyEvent::Impl:xxx> modules, but can be any other class in the case 932of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
618AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). 933case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
619 934will be C<urxvt::anyevent>).
620The known classes so far are:
621
622 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
623 AnyEvent::Impl::Event based on Event, second best choice.
624 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
625 AnyEvent::Impl::Glib based on Glib, third-best choice.
626 AnyEvent::Impl::Tk based on Tk, very bad choice.
627 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
628 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
629 AnyEvent::Impl::POE based on POE, not generic enough for full support.
630
631There is no support for WxWidgets, as WxWidgets has no support for
632watching file handles. However, you can use WxWidgets through the
633POE Adaptor, as POE has a Wx backend that simply polls 20 times per
634second, which was considered to be too horrible to even consider for
635AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
636it's adaptor.
637
638AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
639autodetecting them.
640 935
641=item AnyEvent::detect 936=item AnyEvent::detect
642 937
643Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 938Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
644if necessary. You should only call this function right before you would 939if necessary. You should only call this function right before you would
645have created an AnyEvent watcher anyway, that is, as late as possible at 940have created an AnyEvent watcher anyway, that is, as late as possible at
646runtime. 941runtime, and not e.g. while initialising of your module.
942
943If you need to do some initialisation before AnyEvent watchers are
944created, use C<post_detect>.
647 945
648=item $guard = AnyEvent::post_detect { BLOCK } 946=item $guard = AnyEvent::post_detect { BLOCK }
649 947
650Arranges for the code block to be executed as soon as the event model is 948Arranges for the code block to be executed as soon as the event model is
651autodetected (or immediately if this has already happened). 949autodetected (or immediately if this has already happened).
652 950
951The block will be executed I<after> the actual backend has been detected
952(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
953created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
954other initialisations - see the sources of L<AnyEvent::Strict> or
955L<AnyEvent::AIO> to see how this is used.
956
957The most common usage is to create some global watchers, without forcing
958event module detection too early, for example, L<AnyEvent::AIO> creates
959and installs the global L<IO::AIO> watcher in a C<post_detect> block to
960avoid autodetecting the event module at load time.
961
653If called in scalar or list context, then it creates and returns an object 962If called in scalar or list context, then it creates and returns an object
654that automatically removes the callback again when it is destroyed. See 963that automatically removes the callback again when it is destroyed (or
964C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
655L<Coro::BDB> for a case where this is useful. 965a case where this is useful.
966
967Example: Create a watcher for the IO::AIO module and store it in
968C<$WATCHER>. Only do so after the event loop is initialised, though.
969
970 our WATCHER;
971
972 my $guard = AnyEvent::post_detect {
973 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
974 };
975
976 # the ||= is important in case post_detect immediately runs the block,
977 # as to not clobber the newly-created watcher. assigning both watcher and
978 # post_detect guard to the same variable has the advantage of users being
979 # able to just C<undef $WATCHER> if the watcher causes them grief.
980
981 $WATCHER ||= $guard;
656 982
657=item @AnyEvent::post_detect 983=item @AnyEvent::post_detect
658 984
659If there are any code references in this array (you can C<push> to it 985If there are any code references in this array (you can C<push> to it
660before or after loading AnyEvent), then they will called directly after 986before or after loading AnyEvent), then they will called directly after
661the event loop has been chosen. 987the event loop has been chosen.
662 988
663You should check C<$AnyEvent::MODEL> before adding to this array, though: 989You should check C<$AnyEvent::MODEL> before adding to this array, though:
664if it contains a true value then the event loop has already been detected, 990if it is defined then the event loop has already been detected, and the
665and the array will be ignored. 991array will be ignored.
666 992
667Best use C<AnyEvent::post_detect { BLOCK }> instead. 993Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
994it, as it takes care of these details.
995
996This variable is mainly useful for modules that can do something useful
997when AnyEvent is used and thus want to know when it is initialised, but do
998not need to even load it by default. This array provides the means to hook
999into AnyEvent passively, without loading it.
1000
1001Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
1002together, you could put this into Coro (this is the actual code used by
1003Coro to accomplish this):
1004
1005 if (defined $AnyEvent::MODEL) {
1006 # AnyEvent already initialised, so load Coro::AnyEvent
1007 require Coro::AnyEvent;
1008 } else {
1009 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1010 # as soon as it is
1011 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1012 }
668 1013
669=back 1014=back
670 1015
671=head1 WHAT TO DO IN A MODULE 1016=head1 WHAT TO DO IN A MODULE
672 1017
727 1072
728 1073
729=head1 OTHER MODULES 1074=head1 OTHER MODULES
730 1075
731The following is a non-exhaustive list of additional modules that use 1076The following is a non-exhaustive list of additional modules that use
732AnyEvent and can therefore be mixed easily with other AnyEvent modules 1077AnyEvent as a client and can therefore be mixed easily with other AnyEvent
733in the same program. Some of the modules come with AnyEvent, some are 1078modules and other event loops in the same program. Some of the modules
734available via CPAN. 1079come as part of AnyEvent, the others are available via CPAN.
735 1080
736=over 4 1081=over 4
737 1082
738=item L<AnyEvent::Util> 1083=item L<AnyEvent::Util>
739 1084
740Contains various utility functions that replace often-used but blocking 1085Contains various utility functions that replace often-used but blocking
741functions such as C<inet_aton> by event-/callback-based versions. 1086functions such as C<inet_aton> by event-/callback-based versions.
742
743=item L<AnyEvent::Handle>
744
745Provide read and write buffers and manages watchers for reads and writes.
746 1087
747=item L<AnyEvent::Socket> 1088=item L<AnyEvent::Socket>
748 1089
749Provides various utility functions for (internet protocol) sockets, 1090Provides various utility functions for (internet protocol) sockets,
750addresses and name resolution. Also functions to create non-blocking tcp 1091addresses and name resolution. Also functions to create non-blocking tcp
751connections or tcp servers, with IPv6 and SRV record support and more. 1092connections or tcp servers, with IPv6 and SRV record support and more.
752 1093
1094=item L<AnyEvent::Handle>
1095
1096Provide read and write buffers, manages watchers for reads and writes,
1097supports raw and formatted I/O, I/O queued and fully transparent and
1098non-blocking SSL/TLS (via L<AnyEvent::TLS>.
1099
753=item L<AnyEvent::DNS> 1100=item L<AnyEvent::DNS>
754 1101
755Provides rich asynchronous DNS resolver capabilities. 1102Provides rich asynchronous DNS resolver capabilities.
756 1103
1104=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1105
1106Implement event-based interfaces to the protocols of the same name (for
1107the curious, IGS is the International Go Server and FCP is the Freenet
1108Client Protocol).
1109
1110=item L<AnyEvent::Handle::UDP>
1111
1112Here be danger!
1113
1114As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1115there are so many things wrong with AnyEvent::Handle::UDP, most notably
1116it's use of a stream-based API with a protocol that isn't streamable, that
1117the only way to improve it is to delete it.
1118
1119It features data corruption (but typically only under load) and general
1120confusion. On top, the author is not only clueless about UDP but also
1121fact-resistant - some gems of his understanding: "connect doesn't work
1122with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1123packets", "I don't need to implement proper error checking as UDP doesn't
1124support error checking" and so on - he doesn't even understand what's
1125wrong with his module when it is explained to him.
1126
757=item L<AnyEvent::HTTP> 1127=item L<AnyEvent::DBI>
758 1128
759A simple-to-use HTTP library that is capable of making a lot of concurrent 1129Executes L<DBI> requests asynchronously in a proxy process for you,
760HTTP requests. 1130notifying you in an event-bnased way when the operation is finished.
1131
1132=item L<AnyEvent::AIO>
1133
1134Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1135toolbox of every event programmer. AnyEvent::AIO transparently fuses
1136L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1137file I/O, and much more.
761 1138
762=item L<AnyEvent::HTTPD> 1139=item L<AnyEvent::HTTPD>
763 1140
764Provides a simple web application server framework. 1141A simple embedded webserver.
765 1142
766=item L<AnyEvent::FastPing> 1143=item L<AnyEvent::FastPing>
767 1144
768The fastest ping in the west. 1145The fastest ping in the west.
769 1146
770=item L<Net::IRC3>
771
772AnyEvent based IRC client module family.
773
774=item L<Net::XMPP2>
775
776AnyEvent based XMPP (Jabber protocol) module family.
777
778=item L<Net::FCP>
779
780AnyEvent-based implementation of the Freenet Client Protocol, birthplace
781of AnyEvent.
782
783=item L<Event::ExecFlow>
784
785High level API for event-based execution flow control.
786
787=item L<Coro> 1147=item L<Coro>
788 1148
789Has special support for AnyEvent via L<Coro::AnyEvent>. 1149Has special support for AnyEvent via L<Coro::AnyEvent>.
790 1150
791=item L<AnyEvent::AIO>, L<IO::AIO>
792
793Truly asynchronous I/O, should be in the toolbox of every event
794programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
795together.
796
797=item L<AnyEvent::BDB>, L<BDB>
798
799Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
800IO::AIO and AnyEvent together.
801
802=item L<IO::Lambda>
803
804The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
805
806=back 1151=back
807 1152
808=cut 1153=cut
809 1154
810package AnyEvent; 1155package AnyEvent;
811 1156
812no warnings; 1157# basically a tuned-down version of common::sense
813use strict; 1158sub common_sense {
1159 # from common:.sense 1.0
1160 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1161 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1162 $^H |= 0x00000600;
1163}
814 1164
1165BEGIN { AnyEvent::common_sense }
1166
815use Carp; 1167use Carp ();
816 1168
817our $VERSION = 4.14; 1169our $VERSION = '5.271';
818our $MODEL; 1170our $MODEL;
819 1171
820our $AUTOLOAD; 1172our $AUTOLOAD;
821our @ISA; 1173our @ISA;
822 1174
823our @REGISTRY; 1175our @REGISTRY;
824 1176
825our $WIN32; 1177our $VERBOSE;
826 1178
827BEGIN { 1179BEGIN {
828 my $win32 = ! ! ($^O =~ /mswin32/i); 1180 require "AnyEvent/constants.pl";
829 eval "sub WIN32(){ $win32 }";
830}
831 1181
1182 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1183
1184 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1185 if ${^TAINT};
1186
832our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1187 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1188
1189}
1190
1191our $MAX_SIGNAL_LATENCY = 10;
833 1192
834our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1193our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
835 1194
836{ 1195{
837 my $idx; 1196 my $idx;
839 for reverse split /\s*,\s*/, 1198 for reverse split /\s*,\s*/,
840 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1199 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
841} 1200}
842 1201
843my @models = ( 1202my @models = (
844 [EV:: => AnyEvent::Impl::EV::], 1203 [EV:: => AnyEvent::Impl::EV:: , 1],
845 [Event:: => AnyEvent::Impl::Event::],
846 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1204 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
847 # everything below here will not be autoprobed 1205 # everything below here will not (normally) be autoprobed
848 # as the pureperl backend should work everywhere 1206 # as the pureperl backend should work everywhere
849 # and is usually faster 1207 # and is usually faster
1208 [Event:: => AnyEvent::Impl::Event::, 1],
1209 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1210 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1211 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
850 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1212 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
851 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
852 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
853 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1213 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
854 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1214 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
855 [Wx:: => AnyEvent::Impl::POE::], 1215 [Wx:: => AnyEvent::Impl::POE::],
856 [Prima:: => AnyEvent::Impl::POE::], 1216 [Prima:: => AnyEvent::Impl::POE::],
1217 # IO::Async is just too broken - we would need workarounds for its
1218 # byzantine signal and broken child handling, among others.
1219 # IO::Async is rather hard to detect, as it doesn't have any
1220 # obvious default class.
1221 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1222 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1223 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1224 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
857); 1225);
858 1226
859our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); 1227our %method = map +($_ => 1),
1228 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
860 1229
861our @post_detect; 1230our @post_detect;
862 1231
863sub post_detect(&) { 1232sub post_detect(&) {
864 my ($cb) = @_; 1233 my ($cb) = @_;
865 1234
866 if ($MODEL) {
867 $cb->();
868
869 1
870 } else {
871 push @post_detect, $cb; 1235 push @post_detect, $cb;
872 1236
873 defined wantarray 1237 defined wantarray
874 ? bless \$cb, "AnyEvent::Util::PostDetect" 1238 ? bless \$cb, "AnyEvent::Util::postdetect"
875 : () 1239 : ()
1240}
1241
1242sub AnyEvent::Util::postdetect::DESTROY {
1243 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1244}
1245
1246sub detect() {
1247 # free some memory
1248 *detect = sub () { $MODEL };
1249
1250 local $!; # for good measure
1251 local $SIG{__DIE__};
1252
1253 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1254 my $model = "AnyEvent::Impl::$1";
1255 if (eval "require $model") {
1256 $MODEL = $model;
1257 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1258 } else {
1259 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1260 }
876 } 1261 }
877}
878 1262
879sub AnyEvent::Util::PostDetect::DESTROY { 1263 # check for already loaded models
880 @post_detect = grep $_ != ${$_[0]}, @post_detect;
881}
882
883sub detect() {
884 unless ($MODEL) { 1264 unless ($MODEL) {
885 no strict 'refs'; 1265 for (@REGISTRY, @models) {
886 local $SIG{__DIE__}; 1266 my ($package, $model) = @$_;
887 1267 if (${"$package\::VERSION"} > 0) {
888 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
889 my $model = "AnyEvent::Impl::$1";
890 if (eval "require $model") { 1268 if (eval "require $model") {
891 $MODEL = $model; 1269 $MODEL = $model;
892 warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; 1270 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
893 } else { 1271 last;
894 warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; 1272 }
895 } 1273 }
896 } 1274 }
897 1275
898 # check for already loaded models
899 unless ($MODEL) { 1276 unless ($MODEL) {
1277 # try to autoload a model
900 for (@REGISTRY, @models) { 1278 for (@REGISTRY, @models) {
901 my ($package, $model) = @$_; 1279 my ($package, $model, $autoload) = @$_;
1280 if (
1281 $autoload
1282 and eval "require $package"
902 if (${"$package\::VERSION"} > 0) { 1283 and ${"$package\::VERSION"} > 0
903 if (eval "require $model") { 1284 and eval "require $model"
1285 ) {
904 $MODEL = $model; 1286 $MODEL = $model;
905 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; 1287 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
906 last; 1288 last;
907 }
908 } 1289 }
909 } 1290 }
910 1291
911 unless ($MODEL) {
912 # try to load a model
913
914 for (@REGISTRY, @models) {
915 my ($package, $model) = @$_;
916 if (eval "require $package"
917 and ${"$package\::VERSION"} > 0
918 and eval "require $model") {
919 $MODEL = $model;
920 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;
921 last;
922 }
923 }
924
925 $MODEL 1292 $MODEL
926 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 1293 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
927 }
928 } 1294 }
929
930 unshift @ISA, $MODEL;
931 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
932
933 (shift @post_detect)->() while @post_detect;
934 } 1295 }
1296
1297 @models = (); # free probe data
1298
1299 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1300 unshift @ISA, $MODEL;
1301
1302 # now nuke some methods that are overriden by the backend.
1303 # SUPER is not allowed.
1304 for (qw(time signal child idle)) {
1305 undef &{"AnyEvent::Base::$_"}
1306 if defined &{"$MODEL\::$_"};
1307 }
1308
1309 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1310
1311 (shift @post_detect)->() while @post_detect;
1312
1313 *post_detect = sub(&) {
1314 shift->();
1315
1316 undef
1317 };
935 1318
936 $MODEL 1319 $MODEL
937} 1320}
938 1321
939sub AUTOLOAD { 1322sub AUTOLOAD {
940 (my $func = $AUTOLOAD) =~ s/.*://; 1323 (my $func = $AUTOLOAD) =~ s/.*://;
941 1324
942 $method{$func} 1325 $method{$func}
943 or croak "$func: not a valid method for AnyEvent objects"; 1326 or Carp::croak "$func: not a valid AnyEvent class method";
944 1327
945 detect unless $MODEL; 1328 detect;
946 1329
947 my $class = shift; 1330 my $class = shift;
948 $class->$func (@_); 1331 $class->$func (@_);
949} 1332}
950 1333
1334# utility function to dup a filehandle. this is used by many backends
1335# to support binding more than one watcher per filehandle (they usually
1336# allow only one watcher per fd, so we dup it to get a different one).
1337sub _dupfh($$;$$) {
1338 my ($poll, $fh, $r, $w) = @_;
1339
1340 # cygwin requires the fh mode to be matching, unix doesn't
1341 my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1342
1343 open my $fh2, $mode, $fh
1344 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1345
1346 # we assume CLOEXEC is already set by perl in all important cases
1347
1348 ($fh2, $rw)
1349}
1350
1351=head1 SIMPLIFIED AE API
1352
1353Starting with version 5.0, AnyEvent officially supports a second, much
1354simpler, API that is designed to reduce the calling, typing and memory
1355overhead by using function call syntax and a fixed number of parameters.
1356
1357See the L<AE> manpage for details.
1358
1359=cut
1360
1361package AE;
1362
1363our $VERSION = $AnyEvent::VERSION;
1364
1365# fall back to the main API by default - backends and AnyEvent::Base
1366# implementations can overwrite these.
1367
1368sub io($$$) {
1369 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1370}
1371
1372sub timer($$$) {
1373 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1374}
1375
1376sub signal($$) {
1377 AnyEvent->signal (signal => $_[0], cb => $_[1])
1378}
1379
1380sub child($$) {
1381 AnyEvent->child (pid => $_[0], cb => $_[1])
1382}
1383
1384sub idle($) {
1385 AnyEvent->idle (cb => $_[0])
1386}
1387
1388sub cv(;&) {
1389 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1390}
1391
1392sub now() {
1393 AnyEvent->now
1394}
1395
1396sub now_update() {
1397 AnyEvent->now_update
1398}
1399
1400sub time() {
1401 AnyEvent->time
1402}
1403
951package AnyEvent::Base; 1404package AnyEvent::Base;
952 1405
953# default implementation for now and time 1406# default implementations for many methods
954 1407
955use Time::HiRes (); 1408sub time {
1409 eval q{ # poor man's autoloading {}
1410 # probe for availability of Time::HiRes
1411 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1412 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1413 *AE::time = \&Time::HiRes::time;
1414 # if (eval "use POSIX (); (POSIX::times())...
1415 } else {
1416 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1417 *AE::time = sub (){ time }; # epic fail
1418 }
956 1419
957sub time { Time::HiRes::time } 1420 *time = sub { AE::time }; # different prototypes
958sub now { Time::HiRes::time } 1421 };
1422 die if $@;
1423
1424 &time
1425}
1426
1427*now = \&time;
1428
1429sub now_update { }
959 1430
960# default implementation for ->condvar 1431# default implementation for ->condvar
961 1432
962sub condvar { 1433sub condvar {
1434 eval q{ # poor man's autoloading {}
1435 *condvar = sub {
963 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1436 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1437 };
1438
1439 *AE::cv = sub (;&) {
1440 bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
1441 };
1442 };
1443 die if $@;
1444
1445 &condvar
964} 1446}
965 1447
966# default implementation for ->signal 1448# default implementation for ->signal
967 1449
968our %SIG_CB; 1450our $HAVE_ASYNC_INTERRUPT;
1451
1452sub _have_async_interrupt() {
1453 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1454 && eval "use Async::Interrupt 1.02 (); 1")
1455 unless defined $HAVE_ASYNC_INTERRUPT;
1456
1457 $HAVE_ASYNC_INTERRUPT
1458}
1459
1460our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1461our (%SIG_ASY, %SIG_ASY_W);
1462our ($SIG_COUNT, $SIG_TW);
1463
1464# install a dummy wakeup watcher to reduce signal catching latency
1465# used by Impls
1466sub _sig_add() {
1467 unless ($SIG_COUNT++) {
1468 # try to align timer on a full-second boundary, if possible
1469 my $NOW = AE::now;
1470
1471 $SIG_TW = AE::timer
1472 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1473 $MAX_SIGNAL_LATENCY,
1474 sub { } # just for the PERL_ASYNC_CHECK
1475 ;
1476 }
1477}
1478
1479sub _sig_del {
1480 undef $SIG_TW
1481 unless --$SIG_COUNT;
1482}
1483
1484our $_sig_name_init; $_sig_name_init = sub {
1485 eval q{ # poor man's autoloading {}
1486 undef $_sig_name_init;
1487
1488 if (_have_async_interrupt) {
1489 *sig2num = \&Async::Interrupt::sig2num;
1490 *sig2name = \&Async::Interrupt::sig2name;
1491 } else {
1492 require Config;
1493
1494 my %signame2num;
1495 @signame2num{ split ' ', $Config::Config{sig_name} }
1496 = split ' ', $Config::Config{sig_num};
1497
1498 my @signum2name;
1499 @signum2name[values %signame2num] = keys %signame2num;
1500
1501 *sig2num = sub($) {
1502 $_[0] > 0 ? shift : $signame2num{+shift}
1503 };
1504 *sig2name = sub ($) {
1505 $_[0] > 0 ? $signum2name[+shift] : shift
1506 };
1507 }
1508 };
1509 die if $@;
1510};
1511
1512sub sig2num ($) { &$_sig_name_init; &sig2num }
1513sub sig2name($) { &$_sig_name_init; &sig2name }
969 1514
970sub signal { 1515sub signal {
1516 eval q{ # poor man's autoloading {}
1517 # probe for availability of Async::Interrupt
1518 if (_have_async_interrupt) {
1519 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1520
1521 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1522 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1523
1524 } else {
1525 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1526
1527 if (AnyEvent::WIN32) {
1528 require AnyEvent::Util;
1529
1530 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1531 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1532 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1533 } else {
1534 pipe $SIGPIPE_R, $SIGPIPE_W;
1535 fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1536 fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1537
1538 # not strictly required, as $^F is normally 2, but let's make sure...
1539 fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1540 fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1541 }
1542
1543 $SIGPIPE_R
1544 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1545
1546 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1547 }
1548
1549 *signal = $HAVE_ASYNC_INTERRUPT
1550 ? sub {
971 my (undef, %arg) = @_; 1551 my (undef, %arg) = @_;
972 1552
1553 # async::interrupt
973 my $signal = uc $arg{signal} 1554 my $signal = sig2num $arg{signal};
974 or Carp::croak "required option 'signal' is missing";
975
976 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1555 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1556
1557 $SIG_ASY{$signal} ||= new Async::Interrupt
1558 cb => sub { undef $SIG_EV{$signal} },
1559 signal => $signal,
1560 pipe => [$SIGPIPE_R->filenos],
1561 pipe_autodrain => 0,
1562 ;
1563
1564 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1565 }
1566 : sub {
1567 my (undef, %arg) = @_;
1568
1569 # pure perl
1570 my $signal = sig2name $arg{signal};
1571 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1572
977 $SIG{$signal} ||= sub { 1573 $SIG{$signal} ||= sub {
1574 local $!;
1575 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1576 undef $SIG_EV{$signal};
1577 };
1578
1579 # can't do signal processing without introducing races in pure perl,
1580 # so limit the signal latency.
1581 _sig_add;
1582
1583 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1584 }
1585 ;
1586
1587 *AnyEvent::Base::signal::DESTROY = sub {
1588 my ($signal, $cb) = @{$_[0]};
1589
1590 _sig_del;
1591
1592 delete $SIG_CB{$signal}{$cb};
1593
1594 $HAVE_ASYNC_INTERRUPT
1595 ? delete $SIG_ASY{$signal}
1596 : # delete doesn't work with older perls - they then
1597 # print weird messages, or just unconditionally exit
1598 # instead of getting the default action.
1599 undef $SIG{$signal}
1600 unless keys %{ $SIG_CB{$signal} };
1601 };
1602
1603 *_signal_exec = sub {
1604 $HAVE_ASYNC_INTERRUPT
1605 ? $SIGPIPE_R->drain
1606 : sysread $SIGPIPE_R, (my $dummy), 9;
1607
1608 while (%SIG_EV) {
1609 for (keys %SIG_EV) {
1610 delete $SIG_EV{$_};
978 $_->() for values %{ $SIG_CB{$signal} || {} }; 1611 $_->() for values %{ $SIG_CB{$_} || {} };
1612 }
1613 }
1614 };
979 }; 1615 };
1616 die if $@;
980 1617
981 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1618 &signal
982}
983
984sub AnyEvent::Base::Signal::DESTROY {
985 my ($signal, $cb) = @{$_[0]};
986
987 delete $SIG_CB{$signal}{$cb};
988
989 $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };
990} 1619}
991 1620
992# default implementation for ->child 1621# default implementation for ->child
993 1622
994our %PID_CB; 1623our %PID_CB;
995our $CHLD_W; 1624our $CHLD_W;
996our $CHLD_DELAY_W; 1625our $CHLD_DELAY_W;
997our $PID_IDLE;
998our $WNOHANG; 1626our $WNOHANG;
999 1627
1000sub _child_wait { 1628# used by many Impl's
1001 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1629sub _emit_childstatus($$) {
1630 my (undef, $rpid, $rstatus) = @_;
1631
1632 $_->($rpid, $rstatus)
1002 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1633 for values %{ $PID_CB{$rpid} || {} },
1003 (values %{ $PID_CB{0} || {} }); 1634 values %{ $PID_CB{0} || {} };
1004 }
1005
1006 undef $PID_IDLE;
1007}
1008
1009sub _sigchld {
1010 # make sure we deliver these changes "synchronous" with the event loop.
1011 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1012 undef $CHLD_DELAY_W;
1013 &_child_wait;
1014 });
1015} 1635}
1016 1636
1017sub child { 1637sub child {
1638 eval q{ # poor man's autoloading {}
1639 *_sigchld = sub {
1640 my $pid;
1641
1642 AnyEvent->_emit_childstatus ($pid, $?)
1643 while ($pid = waitpid -1, $WNOHANG) > 0;
1644 };
1645
1646 *child = sub {
1018 my (undef, %arg) = @_; 1647 my (undef, %arg) = @_;
1019 1648
1020 defined (my $pid = $arg{pid} + 0) 1649 defined (my $pid = $arg{pid} + 0)
1021 or Carp::croak "required option 'pid' is missing"; 1650 or Carp::croak "required option 'pid' is missing";
1022 1651
1023 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1652 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1024 1653
1025 unless ($WNOHANG) { 1654 # WNOHANG is almost cetrainly 1 everywhere
1655 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1656 ? 1
1026 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1657 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1027 }
1028 1658
1029 unless ($CHLD_W) { 1659 unless ($CHLD_W) {
1030 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1660 $CHLD_W = AE::signal CHLD => \&_sigchld;
1031 # child could be a zombie already, so make at least one round 1661 # child could be a zombie already, so make at least one round
1032 &_sigchld; 1662 &_sigchld;
1033 } 1663 }
1034 1664
1035 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1665 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1036} 1666 };
1037 1667
1038sub AnyEvent::Base::Child::DESTROY { 1668 *AnyEvent::Base::child::DESTROY = sub {
1039 my ($pid, $cb) = @{$_[0]}; 1669 my ($pid, $cb) = @{$_[0]};
1040 1670
1041 delete $PID_CB{$pid}{$cb}; 1671 delete $PID_CB{$pid}{$cb};
1042 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1672 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1043 1673
1044 undef $CHLD_W unless keys %PID_CB; 1674 undef $CHLD_W unless keys %PID_CB;
1675 };
1676 };
1677 die if $@;
1678
1679 &child
1680}
1681
1682# idle emulation is done by simply using a timer, regardless
1683# of whether the process is idle or not, and not letting
1684# the callback use more than 50% of the time.
1685sub idle {
1686 eval q{ # poor man's autoloading {}
1687 *idle = sub {
1688 my (undef, %arg) = @_;
1689
1690 my ($cb, $w, $rcb) = $arg{cb};
1691
1692 $rcb = sub {
1693 if ($cb) {
1694 $w = _time;
1695 &$cb;
1696 $w = _time - $w;
1697
1698 # never use more then 50% of the time for the idle watcher,
1699 # within some limits
1700 $w = 0.0001 if $w < 0.0001;
1701 $w = 5 if $w > 5;
1702
1703 $w = AE::timer $w, 0, $rcb;
1704 } else {
1705 # clean up...
1706 undef $w;
1707 undef $rcb;
1708 }
1709 };
1710
1711 $w = AE::timer 0.05, 0, $rcb;
1712
1713 bless \\$cb, "AnyEvent::Base::idle"
1714 };
1715
1716 *AnyEvent::Base::idle::DESTROY = sub {
1717 undef $${$_[0]};
1718 };
1719 };
1720 die if $@;
1721
1722 &idle
1045} 1723}
1046 1724
1047package AnyEvent::CondVar; 1725package AnyEvent::CondVar;
1048 1726
1049our @ISA = AnyEvent::CondVar::Base::; 1727our @ISA = AnyEvent::CondVar::Base::;
1050 1728
1051package AnyEvent::CondVar::Base; 1729package AnyEvent::CondVar::Base;
1052 1730
1053use overload 1731#use overload
1054 '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1732# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1055 fallback => 1; 1733# fallback => 1;
1734
1735# save 300+ kilobytes by dirtily hardcoding overloading
1736${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
1737*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
1738*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
1739${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1740
1741our $WAITING;
1056 1742
1057sub _send { 1743sub _send {
1058 # nop 1744 # nop
1059} 1745}
1060 1746
1073sub ready { 1759sub ready {
1074 $_[0]{_ae_sent} 1760 $_[0]{_ae_sent}
1075} 1761}
1076 1762
1077sub _wait { 1763sub _wait {
1764 $WAITING
1765 and !$_[0]{_ae_sent}
1766 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1767
1768 local $WAITING = 1;
1078 AnyEvent->one_event while !$_[0]{_ae_sent}; 1769 AnyEvent->one_event while !$_[0]{_ae_sent};
1079} 1770}
1080 1771
1081sub recv { 1772sub recv {
1082 $_[0]->_wait; 1773 $_[0]->_wait;
1084 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1775 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1085 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1776 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1086} 1777}
1087 1778
1088sub cb { 1779sub cb {
1089 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1780 my $cv = shift;
1781
1782 @_
1783 and $cv->{_ae_cb} = shift
1784 and $cv->{_ae_sent}
1785 and (delete $cv->{_ae_cb})->($cv);
1786
1090 $_[0]{_ae_cb} 1787 $cv->{_ae_cb}
1091} 1788}
1092 1789
1093sub begin { 1790sub begin {
1094 ++$_[0]{_ae_counter}; 1791 ++$_[0]{_ae_counter};
1095 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1792 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1101} 1798}
1102 1799
1103# undocumented/compatibility with pre-3.4 1800# undocumented/compatibility with pre-3.4
1104*broadcast = \&send; 1801*broadcast = \&send;
1105*wait = \&_wait; 1802*wait = \&_wait;
1803
1804=head1 ERROR AND EXCEPTION HANDLING
1805
1806In general, AnyEvent does not do any error handling - it relies on the
1807caller to do that if required. The L<AnyEvent::Strict> module (see also
1808the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
1809checking of all AnyEvent methods, however, which is highly useful during
1810development.
1811
1812As for exception handling (i.e. runtime errors and exceptions thrown while
1813executing a callback), this is not only highly event-loop specific, but
1814also not in any way wrapped by this module, as this is the job of the main
1815program.
1816
1817The pure perl event loop simply re-throws the exception (usually
1818within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
1819$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1820so on.
1821
1822=head1 ENVIRONMENT VARIABLES
1823
1824The following environment variables are used by this module or its
1825submodules.
1826
1827Note that AnyEvent will remove I<all> environment variables starting with
1828C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
1829enabled.
1830
1831=over 4
1832
1833=item C<PERL_ANYEVENT_VERBOSE>
1834
1835By default, AnyEvent will be completely silent except in fatal
1836conditions. You can set this environment variable to make AnyEvent more
1837talkative.
1838
1839When set to C<1> or higher, causes AnyEvent to warn about unexpected
1840conditions, such as not being able to load the event model specified by
1841C<PERL_ANYEVENT_MODEL>.
1842
1843When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1844model it chooses.
1845
1846When set to C<8> or higher, then AnyEvent will report extra information on
1847which optional modules it loads and how it implements certain features.
1848
1849=item C<PERL_ANYEVENT_STRICT>
1850
1851AnyEvent does not do much argument checking by default, as thorough
1852argument checking is very costly. Setting this variable to a true value
1853will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1854check the arguments passed to most method calls. If it finds any problems,
1855it will croak.
1856
1857In other words, enables "strict" mode.
1858
1859Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1860>>, it is definitely recommended to keep it off in production. Keeping
1861C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1862can be very useful, however.
1863
1864=item C<PERL_ANYEVENT_MODEL>
1865
1866This can be used to specify the event model to be used by AnyEvent, before
1867auto detection and -probing kicks in. It must be a string consisting
1868entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1869and the resulting module name is loaded and if the load was successful,
1870used as event model. If it fails to load AnyEvent will proceed with
1871auto detection and -probing.
1872
1873This functionality might change in future versions.
1874
1875For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1876could start your program like this:
1877
1878 PERL_ANYEVENT_MODEL=Perl perl ...
1879
1880=item C<PERL_ANYEVENT_PROTOCOLS>
1881
1882Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1883for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1884of auto probing).
1885
1886Must be set to a comma-separated list of protocols or address families,
1887current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1888used, and preference will be given to protocols mentioned earlier in the
1889list.
1890
1891This variable can effectively be used for denial-of-service attacks
1892against local programs (e.g. when setuid), although the impact is likely
1893small, as the program has to handle conenction and other failures anyways.
1894
1895Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1896but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1897- only support IPv4, never try to resolve or contact IPv6
1898addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1899IPv6, but prefer IPv6 over IPv4.
1900
1901=item C<PERL_ANYEVENT_EDNS0>
1902
1903Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1904for DNS. This extension is generally useful to reduce DNS traffic, but
1905some (broken) firewalls drop such DNS packets, which is why it is off by
1906default.
1907
1908Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1909EDNS0 in its DNS requests.
1910
1911=item C<PERL_ANYEVENT_MAX_FORKS>
1912
1913The maximum number of child processes that C<AnyEvent::Util::fork_call>
1914will create in parallel.
1915
1916=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1917
1918The default value for the C<max_outstanding> parameter for the default DNS
1919resolver - this is the maximum number of parallel DNS requests that are
1920sent to the DNS server.
1921
1922=item C<PERL_ANYEVENT_RESOLV_CONF>
1923
1924The file to use instead of F</etc/resolv.conf> (or OS-specific
1925configuration) in the default resolver. When set to the empty string, no
1926default config will be used.
1927
1928=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1929
1930When neither C<ca_file> nor C<ca_path> was specified during
1931L<AnyEvent::TLS> context creation, and either of these environment
1932variables exist, they will be used to specify CA certificate locations
1933instead of a system-dependent default.
1934
1935=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1936
1937When these are set to C<1>, then the respective modules are not
1938loaded. Mostly good for testing AnyEvent itself.
1939
1940=back
1106 1941
1107=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1942=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1108 1943
1109This is an advanced topic that you do not normally need to use AnyEvent in 1944This is an advanced topic that you do not normally need to use AnyEvent in
1110a module. This section is only of use to event loop authors who want to 1945a module. This section is only of use to event loop authors who want to
1144 1979
1145I<rxvt-unicode> also cheats a bit by not providing blocking access to 1980I<rxvt-unicode> also cheats a bit by not providing blocking access to
1146condition variables: code blocking while waiting for a condition will 1981condition variables: code blocking while waiting for a condition will
1147C<die>. This still works with most modules/usages, and blocking calls must 1982C<die>. This still works with most modules/usages, and blocking calls must
1148not be done in an interactive application, so it makes sense. 1983not be done in an interactive application, so it makes sense.
1149
1150=head1 ENVIRONMENT VARIABLES
1151
1152The following environment variables are used by this module:
1153
1154=over 4
1155
1156=item C<PERL_ANYEVENT_VERBOSE>
1157
1158By default, AnyEvent will be completely silent except in fatal
1159conditions. You can set this environment variable to make AnyEvent more
1160talkative.
1161
1162When set to C<1> or higher, causes AnyEvent to warn about unexpected
1163conditions, such as not being able to load the event model specified by
1164C<PERL_ANYEVENT_MODEL>.
1165
1166When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1167model it chooses.
1168
1169=item C<PERL_ANYEVENT_MODEL>
1170
1171This can be used to specify the event model to be used by AnyEvent, before
1172auto detection and -probing kicks in. It must be a string consisting
1173entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1174and the resulting module name is loaded and if the load was successful,
1175used as event model. If it fails to load AnyEvent will proceed with
1176auto detection and -probing.
1177
1178This functionality might change in future versions.
1179
1180For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1181could start your program like this:
1182
1183 PERL_ANYEVENT_MODEL=Perl perl ...
1184
1185=item C<PERL_ANYEVENT_PROTOCOLS>
1186
1187Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1188for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1189of auto probing).
1190
1191Must be set to a comma-separated list of protocols or address families,
1192current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1193used, and preference will be given to protocols mentioned earlier in the
1194list.
1195
1196This variable can effectively be used for denial-of-service attacks
1197against local programs (e.g. when setuid), although the impact is likely
1198small, as the program has to handle connection errors already-
1199
1200Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1201but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1202- only support IPv4, never try to resolve or contact IPv6
1203addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1204IPv6, but prefer IPv6 over IPv4.
1205
1206=item C<PERL_ANYEVENT_EDNS0>
1207
1208Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1209for DNS. This extension is generally useful to reduce DNS traffic, but
1210some (broken) firewalls drop such DNS packets, which is why it is off by
1211default.
1212
1213Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1214EDNS0 in its DNS requests.
1215
1216=item C<PERL_ANYEVENT_MAX_FORKS>
1217
1218The maximum number of child processes that C<AnyEvent::Util::fork_call>
1219will create in parallel.
1220
1221=back
1222 1984
1223=head1 EXAMPLE PROGRAM 1985=head1 EXAMPLE PROGRAM
1224 1986
1225The following program uses an I/O watcher to read data from STDIN, a timer 1987The following program uses an I/O watcher to read data from STDIN, a timer
1226to display a message once per second, and a condition variable to quit the 1988to display a message once per second, and a condition variable to quit the
1239 warn "read: $input\n"; # output what has been read 2001 warn "read: $input\n"; # output what has been read
1240 $cv->send if $input =~ /^q/i; # quit program if /^q/i 2002 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1241 }, 2003 },
1242 ); 2004 );
1243 2005
1244 my $time_watcher; # can only be used once
1245
1246 sub new_timer {
1247 $timer = AnyEvent->timer (after => 1, cb => sub { 2006 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1248 warn "timeout\n"; # print 'timeout' about every second 2007 warn "timeout\n"; # print 'timeout' at most every second
1249 &new_timer; # and restart the time
1250 }); 2008 });
1251 }
1252
1253 new_timer; # create first timer
1254 2009
1255 $cv->recv; # wait until user enters /^q/i 2010 $cv->recv; # wait until user enters /^q/i
1256 2011
1257=head1 REAL-WORLD EXAMPLE 2012=head1 REAL-WORLD EXAMPLE
1258 2013
1331 2086
1332The actual code goes further and collects all errors (C<die>s, exceptions) 2087The actual code goes further and collects all errors (C<die>s, exceptions)
1333that occurred during request processing. The C<result> method detects 2088that occurred during request processing. The C<result> method detects
1334whether an exception as thrown (it is stored inside the $txn object) 2089whether an exception as thrown (it is stored inside the $txn object)
1335and just throws the exception, which means connection errors and other 2090and just throws the exception, which means connection errors and other
1336problems get reported tot he code that tries to use the result, not in a 2091problems get reported to the code that tries to use the result, not in a
1337random callback. 2092random callback.
1338 2093
1339All of this enables the following usage styles: 2094All of this enables the following usage styles:
1340 2095
13411. Blocking: 20961. Blocking:
1389through AnyEvent. The benchmark creates a lot of timers (with a zero 2144through AnyEvent. The benchmark creates a lot of timers (with a zero
1390timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2145timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1391which it is), lets them fire exactly once and destroys them again. 2146which it is), lets them fire exactly once and destroys them again.
1392 2147
1393Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2148Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1394distribution. 2149distribution. It uses the L<AE> interface, which makes a real difference
2150for the EV and Perl backends only.
1395 2151
1396=head3 Explanation of the columns 2152=head3 Explanation of the columns
1397 2153
1398I<watcher> is the number of event watchers created/destroyed. Since 2154I<watcher> is the number of event watchers created/destroyed. Since
1399different event models feature vastly different performances, each event 2155different event models feature vastly different performances, each event
1420watcher. 2176watcher.
1421 2177
1422=head3 Results 2178=head3 Results
1423 2179
1424 name watchers bytes create invoke destroy comment 2180 name watchers bytes create invoke destroy comment
1425 EV/EV 400000 244 0.56 0.46 0.31 EV native interface 2181 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1426 EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers 2182 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1427 CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal 2183 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1428 Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation 2184 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1429 Event/Event 16000 516 31.88 31.30 0.85 Event native interface 2185 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1430 Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers 2186 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2187 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2188 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1431 Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour 2189 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1432 Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers 2190 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1433 POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event 2191 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1434 POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select 2192 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1435 2193
1436=head3 Discussion 2194=head3 Discussion
1437 2195
1438The benchmark does I<not> measure scalability of the event loop very 2196The benchmark does I<not> measure scalability of the event loop very
1439well. For example, a select-based event loop (such as the pure perl one) 2197well. For example, a select-based event loop (such as the pure perl one)
1451benchmark machine, handling an event takes roughly 1600 CPU cycles with 2209benchmark machine, handling an event takes roughly 1600 CPU cycles with
1452EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2210EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1453cycles with POE. 2211cycles with POE.
1454 2212
1455C<EV> is the sole leader regarding speed and memory use, which are both 2213C<EV> is the sole leader regarding speed and memory use, which are both
1456maximal/minimal, respectively. Even when going through AnyEvent, it uses 2214maximal/minimal, respectively. When using the L<AE> API there is zero
2215overhead (when going through the AnyEvent API create is about 5-6 times
2216slower, with other times being equal, so still uses far less memory than
1457far less memory than any other event loop and is still faster than Event 2217any other event loop and is still faster than Event natively).
1458natively.
1459 2218
1460The pure perl implementation is hit in a few sweet spots (both the 2219The pure perl implementation is hit in a few sweet spots (both the
1461constant timeout and the use of a single fd hit optimisations in the perl 2220constant timeout and the use of a single fd hit optimisations in the perl
1462interpreter and the backend itself). Nevertheless this shows that it 2221interpreter and the backend itself). Nevertheless this shows that it
1463adds very little overhead in itself. Like any select-based backend its 2222adds very little overhead in itself. Like any select-based backend its
1464performance becomes really bad with lots of file descriptors (and few of 2223performance becomes really bad with lots of file descriptors (and few of
1465them active), of course, but this was not subject of this benchmark. 2224them active), of course, but this was not subject of this benchmark.
1466 2225
1467The C<Event> module has a relatively high setup and callback invocation 2226The C<Event> module has a relatively high setup and callback invocation
1468cost, but overall scores in on the third place. 2227cost, but overall scores in on the third place.
2228
2229C<IO::Async> performs admirably well, about on par with C<Event>, even
2230when using its pure perl backend.
1469 2231
1470C<Glib>'s memory usage is quite a bit higher, but it features a 2232C<Glib>'s memory usage is quite a bit higher, but it features a
1471faster callback invocation and overall ends up in the same class as 2233faster callback invocation and overall ends up in the same class as
1472C<Event>. However, Glib scales extremely badly, doubling the number of 2234C<Event>. However, Glib scales extremely badly, doubling the number of
1473watchers increases the processing time by more than a factor of four, 2235watchers increases the processing time by more than a factor of four,
1534In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2296In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1535(1%) are active. This mirrors the activity of large servers with many 2297(1%) are active. This mirrors the activity of large servers with many
1536connections, most of which are idle at any one point in time. 2298connections, most of which are idle at any one point in time.
1537 2299
1538Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2300Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1539distribution. 2301distribution. It uses the L<AE> interface, which makes a real difference
2302for the EV and Perl backends only.
1540 2303
1541=head3 Explanation of the columns 2304=head3 Explanation of the columns
1542 2305
1543I<sockets> is the number of sockets, and twice the number of "servers" (as 2306I<sockets> is the number of sockets, and twice the number of "servers" (as
1544each server has a read and write socket end). 2307each server has a read and write socket end).
1551it to another server. This includes deleting the old timeout and creating 2314it to another server. This includes deleting the old timeout and creating
1552a new one that moves the timeout into the future. 2315a new one that moves the timeout into the future.
1553 2316
1554=head3 Results 2317=head3 Results
1555 2318
1556 name sockets create request 2319 name sockets create request
1557 EV 20000 69.01 11.16 2320 EV 20000 62.66 7.99
1558 Perl 20000 73.32 35.87 2321 Perl 20000 68.32 32.64
1559 Event 20000 212.62 257.32 2322 IOAsync 20000 174.06 101.15 epoll
1560 Glib 20000 651.16 1896.30 2323 IOAsync 20000 174.67 610.84 poll
2324 Event 20000 202.69 242.91
2325 Glib 20000 557.01 1689.52
1561 POE 20000 349.67 12317.24 uses POE::Loop::Event 2326 POE 20000 341.54 12086.32 uses POE::Loop::Event
1562 2327
1563=head3 Discussion 2328=head3 Discussion
1564 2329
1565This benchmark I<does> measure scalability and overall performance of the 2330This benchmark I<does> measure scalability and overall performance of the
1566particular event loop. 2331particular event loop.
1568EV is again fastest. Since it is using epoll on my system, the setup time 2333EV is again fastest. Since it is using epoll on my system, the setup time
1569is relatively high, though. 2334is relatively high, though.
1570 2335
1571Perl surprisingly comes second. It is much faster than the C-based event 2336Perl surprisingly comes second. It is much faster than the C-based event
1572loops Event and Glib. 2337loops Event and Glib.
2338
2339IO::Async performs very well when using its epoll backend, and still quite
2340good compared to Glib when using its pure perl backend.
1573 2341
1574Event suffers from high setup time as well (look at its code and you will 2342Event suffers from high setup time as well (look at its code and you will
1575understand why). Callback invocation also has a high overhead compared to 2343understand why). Callback invocation also has a high overhead compared to
1576the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 2344the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1577uses select or poll in basically all documented configurations. 2345uses select or poll in basically all documented configurations.
1640=item * C-based event loops perform very well with small number of 2408=item * C-based event loops perform very well with small number of
1641watchers, as the management overhead dominates. 2409watchers, as the management overhead dominates.
1642 2410
1643=back 2411=back
1644 2412
2413=head2 THE IO::Lambda BENCHMARK
2414
2415Recently I was told about the benchmark in the IO::Lambda manpage, which
2416could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
2417simply compares IO::Lambda with POE, and IO::Lambda looks better (which
2418shouldn't come as a surprise to anybody). As such, the benchmark is
2419fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
2420very optimal. But how would AnyEvent compare when used without the extra
2421baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
2422
2423The benchmark itself creates an echo-server, and then, for 500 times,
2424connects to the echo server, sends a line, waits for the reply, and then
2425creates the next connection. This is a rather bad benchmark, as it doesn't
2426test the efficiency of the framework or much non-blocking I/O, but it is a
2427benchmark nevertheless.
2428
2429 name runtime
2430 Lambda/select 0.330 sec
2431 + optimized 0.122 sec
2432 Lambda/AnyEvent 0.327 sec
2433 + optimized 0.138 sec
2434 Raw sockets/select 0.077 sec
2435 POE/select, components 0.662 sec
2436 POE/select, raw sockets 0.226 sec
2437 POE/select, optimized 0.404 sec
2438
2439 AnyEvent/select/nb 0.085 sec
2440 AnyEvent/EV/nb 0.068 sec
2441 +state machine 0.134 sec
2442
2443The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
2444benchmarks actually make blocking connects and use 100% blocking I/O,
2445defeating the purpose of an event-based solution. All of the newly
2446written AnyEvent benchmarks use 100% non-blocking connects (using
2447AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
2448resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
2449generally require a lot more bookkeeping and event handling than blocking
2450connects (which involve a single syscall only).
2451
2452The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
2453offers similar expressive power as POE and IO::Lambda, using conventional
2454Perl syntax. This means that both the echo server and the client are 100%
2455non-blocking, further placing it at a disadvantage.
2456
2457As you can see, the AnyEvent + EV combination even beats the
2458hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2459backend easily beats IO::Lambda and POE.
2460
2461And even the 100% non-blocking version written using the high-level (and
2462slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2463higher level ("unoptimised") abstractions by a large margin, even though
2464it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2465
2466The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2467F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2468part of the IO::Lambda distribution and were used without any changes.
2469
2470
2471=head1 SIGNALS
2472
2473AnyEvent currently installs handlers for these signals:
2474
2475=over 4
2476
2477=item SIGCHLD
2478
2479A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2480emulation for event loops that do not support them natively. Also, some
2481event loops install a similar handler.
2482
2483Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2484AnyEvent will reset it to default, to avoid losing child exit statuses.
2485
2486=item SIGPIPE
2487
2488A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2489when AnyEvent gets loaded.
2490
2491The rationale for this is that AnyEvent users usually do not really depend
2492on SIGPIPE delivery (which is purely an optimisation for shell use, or
2493badly-written programs), but C<SIGPIPE> can cause spurious and rare
2494program exits as a lot of people do not expect C<SIGPIPE> when writing to
2495some random socket.
2496
2497The rationale for installing a no-op handler as opposed to ignoring it is
2498that this way, the handler will be restored to defaults on exec.
2499
2500Feel free to install your own handler, or reset it to defaults.
2501
2502=back
2503
2504=cut
2505
2506undef $SIG{CHLD}
2507 if $SIG{CHLD} eq 'IGNORE';
2508
2509$SIG{PIPE} = sub { }
2510 unless defined $SIG{PIPE};
2511
2512=head1 RECOMMENDED/OPTIONAL MODULES
2513
2514One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2515it's built-in modules) are required to use it.
2516
2517That does not mean that AnyEvent won't take advantage of some additional
2518modules if they are installed.
2519
2520This section explains which additional modules will be used, and how they
2521affect AnyEvent's operation.
2522
2523=over 4
2524
2525=item L<Async::Interrupt>
2526
2527This slightly arcane module is used to implement fast signal handling: To
2528my knowledge, there is no way to do completely race-free and quick
2529signal handling in pure perl. To ensure that signals still get
2530delivered, AnyEvent will start an interval timer to wake up perl (and
2531catch the signals) with some delay (default is 10 seconds, look for
2532C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2533
2534If this module is available, then it will be used to implement signal
2535catching, which means that signals will not be delayed, and the event loop
2536will not be interrupted regularly, which is more efficient (and good for
2537battery life on laptops).
2538
2539This affects not just the pure-perl event loop, but also other event loops
2540that have no signal handling on their own (e.g. Glib, Tk, Qt).
2541
2542Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
2543and either employ their own workarounds (POE) or use AnyEvent's workaround
2544(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
2545does nothing for those backends.
2546
2547=item L<EV>
2548
2549This module isn't really "optional", as it is simply one of the backend
2550event loops that AnyEvent can use. However, it is simply the best event
2551loop available in terms of features, speed and stability: It supports
2552the AnyEvent API optimally, implements all the watcher types in XS, does
2553automatic timer adjustments even when no monotonic clock is available,
2554can take avdantage of advanced kernel interfaces such as C<epoll> and
2555C<kqueue>, and is the fastest backend I<by far>. You can even embed
2556L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2557
2558If you only use backends that rely on another event loop (e.g. C<Tk>),
2559then this module will do nothing for you.
2560
2561=item L<Guard>
2562
2563The guard module, when used, will be used to implement
2564C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2565lot less memory), but otherwise doesn't affect guard operation much. It is
2566purely used for performance.
2567
2568=item L<JSON> and L<JSON::XS>
2569
2570One of these modules is required when you want to read or write JSON data
2571via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2572advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2573
2574=item L<Net::SSLeay>
2575
2576Implementing TLS/SSL in Perl is certainly interesting, but not very
2577worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2578the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2579
2580=item L<Time::HiRes>
2581
2582This module is part of perl since release 5.008. It will be used when the
2583chosen event library does not come with a timing source on it's own. The
2584pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2585try to use a monotonic clock for timing stability.
2586
2587=back
2588
1645 2589
1646=head1 FORK 2590=head1 FORK
1647 2591
1648Most event libraries are not fork-safe. The ones who are usually are 2592Most event libraries are not fork-safe. The ones who are usually are
1649because they rely on inefficient but fork-safe C<select> or C<poll> 2593because they rely on inefficient but fork-safe C<select> or C<poll> calls
1650calls. Only L<EV> is fully fork-aware. 2594- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
2595are usually badly thought-out hacks that are incompatible with fork in
2596one way or another. Only L<EV> is fully fork-aware and ensures that you
2597continue event-processing in both parent and child (or both, if you know
2598what you are doing).
2599
2600This means that, in general, you cannot fork and do event processing in
2601the child if the event library was initialised before the fork (which
2602usually happens when the first AnyEvent watcher is created, or the library
2603is loaded).
1651 2604
1652If you have to fork, you must either do so I<before> creating your first 2605If you have to fork, you must either do so I<before> creating your first
1653watcher OR you must not use AnyEvent at all in the child. 2606watcher OR you must not use AnyEvent at all in the child OR you must do
2607something completely out of the scope of AnyEvent.
2608
2609The problem of doing event processing in the parent I<and> the child
2610is much more complicated: even for backends that I<are> fork-aware or
2611fork-safe, their behaviour is not usually what you want: fork clones all
2612watchers, that means all timers, I/O watchers etc. are active in both
2613parent and child, which is almost never what you want. USing C<exec>
2614to start worker children from some kind of manage rprocess is usually
2615preferred, because it is much easier and cleaner, at the expense of having
2616to have another binary.
1654 2617
1655 2618
1656=head1 SECURITY CONSIDERATIONS 2619=head1 SECURITY CONSIDERATIONS
1657 2620
1658AnyEvent can be forced to load any event model via 2621AnyEvent can be forced to load any event model via
1669 2632
1670 use AnyEvent; 2633 use AnyEvent;
1671 2634
1672Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2635Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1673be used to probe what backend is used and gain other information (which is 2636be used to probe what backend is used and gain other information (which is
1674probably even less useful to an attacker than PERL_ANYEVENT_MODEL). 2637probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
2638$ENV{PERL_ANYEVENT_STRICT}.
2639
2640Note that AnyEvent will remove I<all> environment variables starting with
2641C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2642enabled.
1675 2643
1676 2644
1677=head1 BUGS 2645=head1 BUGS
1678 2646
1679Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 2647Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1680to work around. If you suffer from memleaks, first upgrade to Perl 5.10 2648to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1681and check wether the leaks still show up. (Perl 5.10.0 has other annoying 2649and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1682mamleaks, such as leaking on C<map> and C<grep> but it is usually not as 2650memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1683pronounced). 2651pronounced).
1684 2652
1685 2653
1686=head1 SEE ALSO 2654=head1 SEE ALSO
1687 2655
1691L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2659L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1692 2660
1693Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2661Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1694L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2662L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1695L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2663L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1696L<AnyEvent::Impl::POE>. 2664L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
1697 2665
1698Non-blocking file handles, sockets, TCP clients and 2666Non-blocking file handles, sockets, TCP clients and
1699servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. 2667servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1700 2668
1701Asynchronous DNS: L<AnyEvent::DNS>. 2669Asynchronous DNS: L<AnyEvent::DNS>.
1702 2670
1703Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 2671Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
2672L<Coro::Event>,
1704 2673
1705Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 2674Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
2675L<AnyEvent::HTTP>.
1706 2676
1707 2677
1708=head1 AUTHOR 2678=head1 AUTHOR
1709 2679
1710 Marc Lehmann <schmorp@schmorp.de> 2680 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines