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.157 by root, Fri Jun 6 11:01:17 2008 UTC vs.
Revision 1.242 by root, Fri Jul 17 22:05:12 2009 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - provide framework for multiple event loops
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops 5EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported
6event loops.
6 7
7=head1 SYNOPSIS 8=head1 SYNOPSIS
8 9
9 use AnyEvent; 10 use AnyEvent;
10 11
12 # file descriptor readable
11 my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { 13 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14
15 # one-shot or repeating timers
16 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
18
19 print AnyEvent->now; # prints current event loop time
20 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
21
22 # POSIX signal
23 my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
24
25 # child process exit
26 my $w = AnyEvent->child (pid => $pid, cb => sub {
27 my ($pid, $status) = @_;
12 ... 28 ...
13 }); 29 });
14 30
15 my $w = AnyEvent->timer (after => $seconds, cb => sub { 31 # called when event loop idle (if applicable)
16 ... 32 my $w = AnyEvent->idle (cb => sub { ... });
17 });
18 33
19 my $w = AnyEvent->condvar; # stores whether a condition was flagged 34 my $w = AnyEvent->condvar; # stores whether a condition was flagged
20 $w->send; # wake up current and all future recv's 35 $w->send; # wake up current and all future recv's
21 $w->recv; # enters "main loop" till $condvar gets ->send 36 $w->recv; # enters "main loop" till $condvar gets ->send
37 # use a condvar in callback mode:
38 $w->cb (sub { $_[0]->recv });
22 39
23=head1 INTRODUCTION/TUTORIAL 40=head1 INTRODUCTION/TUTORIAL
24 41
25This manpage is mainly a reference manual. If you are interested 42This manpage is mainly a reference manual. If you are interested
26in a tutorial or some gentle introduction, have a look at the 43in a tutorial or some gentle introduction, have a look at the
33 50
34Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of 51Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
35policy> and AnyEvent is I<small and efficient>. 52policy> and AnyEvent is I<small and efficient>.
36 53
37First and foremost, I<AnyEvent is not an event model> itself, it only 54First 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 55interfaces to whatever event model the main program happens to use, in a
39pragmatic way. For event models and certain classes of immortals alike, 56pragmatic way. For event models and certain classes of immortals alike,
40the statement "there can only be one" is a bitter reality: In general, 57the 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 58only one event loop can be active at the same time in a process. AnyEvent
42helps hiding the differences between those event loops. 59cannot change this, but it can hide the differences between those event
60loops.
43 61
44The goal of AnyEvent is to offer module authors the ability to do event 62The 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 63programming (waiting for I/O or timer events) without subscribing to a
46religion, a way of living, and most importantly: without forcing your 64religion, a way of living, and most importantly: without forcing your
47module users into the same thing by forcing them to use the same event 65module users into the same thing by forcing them to use the same event
48model you use. 66model you use.
49 67
50For modules like POE or IO::Async (which is a total misnomer as it is 68For 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 69actually 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 70like 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 71cannot use anything else, as they are simply incompatible to everything
54isn't itself. What's worse, all the potential users of your module are 72that isn't them. What's worse, all the potential users of your
55I<also> forced to use the same event loop you use. 73module are I<also> forced to use the same event loop you use.
56 74
57AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 75AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
58fine. AnyEvent + Tk works fine etc. etc. but none of these work together 76fine. 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 77with 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, 78your 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 79too. But if your module uses AnyEvent, it works transparently with all
62event models it supports (including stuff like POE and IO::Async, as long 80event 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 81use one of the supported event loops. It is trivial to add new event loops
64event loops to AnyEvent, too, so it is future-proof). 82to AnyEvent, too, so it is future-proof).
65 83
66In addition to being free of having to use I<the one and only true event 84In 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 85model>, 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 86modules, 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 87follow. AnyEvent, on the other hand, is lean and up to the point, by only
127These watchers are normal Perl objects with normal Perl lifetime. After 145These watchers are normal Perl objects with normal Perl lifetime. After
128creating a watcher it will immediately "watch" for events and invoke the 146creating a watcher it will immediately "watch" for events and invoke the
129callback when the event occurs (of course, only when the event model 147callback when the event occurs (of course, only when the event model
130is in control). 148is in control).
131 149
150Note that B<callbacks must not permanently change global variables>
151potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
152callbacks must not C<die> >>. The former is good programming practise in
153Perl and the latter stems from the fact that exception handling differs
154widely between event loops.
155
132To disable the watcher you have to destroy it (e.g. by setting the 156To 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 157variable you store it in to C<undef> or otherwise deleting all references
134to it). 158to it).
135 159
136All watchers are created by calling a method on the C<AnyEvent> class. 160All watchers are created by calling a method on the C<AnyEvent> class.
152=head2 I/O WATCHERS 176=head2 I/O WATCHERS
153 177
154You can create an I/O watcher by calling the C<< AnyEvent->io >> method 178You can create an I/O watcher by calling the C<< AnyEvent->io >> method
155with the following mandatory key-value pairs as arguments: 179with the following mandatory key-value pairs as arguments:
156 180
157C<fh> the Perl I<file handle> (I<not> file descriptor) to watch 181C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
182for events (AnyEvent might or might not keep a reference to this file
183handle). Note that only file handles pointing to things for which
184non-blocking operation makes sense are allowed. This includes sockets,
185most character devices, pipes, fifos and so on, but not for example files
186or block devices.
187
158for events. C<poll> must be a string that is either C<r> or C<w>, 188C<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, 189watcher waiting for "r"eadable or "w"ritable events, respectively.
190
160respectively. C<cb> is the callback to invoke each time the file handle 191C<cb> is the callback to invoke each time the file handle becomes ready.
161becomes ready.
162 192
163Although the callback might get passed parameters, their value and 193Although the callback might get passed parameters, their value and
164presence is undefined and you cannot rely on them. Portable AnyEvent 194presence is undefined and you cannot rely on them. Portable AnyEvent
165callbacks cannot use arguments passed to I/O watcher callbacks. 195callbacks cannot use arguments passed to I/O watcher callbacks.
166 196
170 200
171Some event loops issue spurious readyness notifications, so you should 201Some event loops issue spurious readyness notifications, so you should
172always use non-blocking calls when reading/writing from/to your file 202always use non-blocking calls when reading/writing from/to your file
173handles. 203handles.
174 204
175Example:
176
177 # wait for readability of STDIN, then read a line and disable the watcher 205Example: wait for readability of STDIN, then read a line and disable the
206watcher.
207
178 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { 208 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
179 chomp (my $input = <STDIN>); 209 chomp (my $input = <STDIN>);
180 warn "read: $input\n"; 210 warn "read: $input\n";
181 undef $w; 211 undef $w;
182 }); 212 });
192 222
193Although the callback might get passed parameters, their value and 223Although the callback might get passed parameters, their value and
194presence is undefined and you cannot rely on them. Portable AnyEvent 224presence is undefined and you cannot rely on them. Portable AnyEvent
195callbacks cannot use arguments passed to time watcher callbacks. 225callbacks cannot use arguments passed to time watcher callbacks.
196 226
197The timer callback will be invoked at most once: if you want a repeating 227The 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 228parameter, C<interval>, as a strictly positive number (> 0), then the
199and Glib). 229callback will be invoked regularly at that interval (in fractional
230seconds) after the first invocation. If C<interval> is specified with a
231false value, then it is treated as if it were missing.
200 232
201Example: 233The callback will be rescheduled before invoking the callback, but no
234attempt is done to avoid timer drift in most backends, so the interval is
235only approximate.
202 236
203 # fire an event after 7.7 seconds 237Example: fire an event after 7.7 seconds.
238
204 my $w = AnyEvent->timer (after => 7.7, cb => sub { 239 my $w = AnyEvent->timer (after => 7.7, cb => sub {
205 warn "timeout\n"; 240 warn "timeout\n";
206 }); 241 });
207 242
208 # to cancel the timer: 243 # to cancel the timer:
209 undef $w; 244 undef $w;
210 245
211Example 2:
212
213 # fire an event after 0.5 seconds, then roughly every second 246Example 2: fire an event after 0.5 seconds, then roughly every second.
214 my $w;
215 247
216 my $cb = sub {
217 # cancel the old timer while creating a new one
218 $w = AnyEvent->timer (after => 1, cb => $cb); 248 my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
249 warn "timeout\n";
219 }; 250 };
220
221 # start the "loop" by creating the first watcher
222 $w = AnyEvent->timer (after => 0.5, cb => $cb);
223 251
224=head3 TIMING ISSUES 252=head3 TIMING ISSUES
225 253
226There are two ways to handle timers: based on real time (relative, "fire 254There are two ways to handle timers: based on real time (relative, "fire
227in 10 seconds") and based on wallclock time (absolute, "fire at 12 255in 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 328In 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 329can get whatever behaviour you want with any event loop, by taking the
302difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 330difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
303account. 331account.
304 332
333=item AnyEvent->now_update
334
335Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
336the current time for each loop iteration (see the discussion of L<<
337AnyEvent->now >>, above).
338
339When a callback runs for a long time (or when the process sleeps), then
340this "current" time will differ substantially from the real time, which
341might affect timers and time-outs.
342
343When this is the case, you can call this method, which will update the
344event loop's idea of "current time".
345
346Note that updating the time I<might> cause some events to be handled.
347
305=back 348=back
306 349
307=head2 SIGNAL WATCHERS 350=head2 SIGNAL WATCHERS
308 351
309You can watch for signals using a signal watcher, C<signal> is the signal 352You 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 353I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
311be invoked whenever a signal occurs. 354callback to be invoked whenever a signal occurs.
312 355
313Although the callback might get passed parameters, their value and 356Although the callback might get passed parameters, their value and
314presence is undefined and you cannot rely on them. Portable AnyEvent 357presence is undefined and you cannot rely on them. Portable AnyEvent
315callbacks cannot use arguments passed to signal watcher callbacks. 358callbacks cannot use arguments passed to signal watcher callbacks.
316 359
318invocation, and callback invocation will be synchronous. Synchronous means 361invocation, and callback invocation will be synchronous. Synchronous means
319that it might take a while until the signal gets handled by the process, 362that it might take a while until the signal gets handled by the process,
320but it is guaranteed not to interrupt any other callbacks. 363but it is guaranteed not to interrupt any other callbacks.
321 364
322The main advantage of using these watchers is that you can share a signal 365The main advantage of using these watchers is that you can share a signal
323between multiple watchers. 366between multiple watchers, and AnyEvent will ensure that signals will not
367interrupt your program at bad times.
324 368
325This watcher might use C<%SIG>, so programs overwriting those signals 369This watcher might use C<%SIG> (depending on the event loop used),
326directly will likely not work correctly. 370so programs overwriting those signals directly will likely not work
371correctly.
372
373Also note that many event loops (e.g. Glib, Tk, Qt, IO::Async) do not
374support attaching callbacks to signals, which is a pity, as you cannot do
375race-free signal handling in perl. AnyEvent will try to do it's best, but
376in some cases, signals will be delayed. The maximum time a signal might
377be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10
378seconds). This variable can be changed only before the first signal
379watcher is created, and should be left alone otherwise. Higher values
380will cause fewer spurious wake-ups, which is better for power and CPU
381saving. All these problems can be avoided by installing the optional
382L<Async::Interrupt> module.
327 383
328Example: exit on SIGINT 384Example: exit on SIGINT
329 385
330 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 386 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
331 387
332=head2 CHILD PROCESS WATCHERS 388=head2 CHILD PROCESS WATCHERS
333 389
334You can also watch on a child process exit and catch its exit status. 390You can also watch on a child process exit and catch its exit status.
335 391
336The child process is specified by the C<pid> argument (if set to C<0>, it 392The child process is specified by the C<pid> argument (if set to C<0>, it
337watches for any child process exit). The watcher will trigger as often 393watches for any child process exit). The watcher will triggered only when
338as status change for the child are received. This works by installing a 394the child process has finished and an exit status is available, not on
339signal handler for C<SIGCHLD>. The callback will be called with the pid 395any trace events (stopped/continued).
340and exit status (as returned by waitpid), so unlike other watcher types, 396
341you I<can> rely on child watcher callback arguments. 397The callback will be called with the pid and exit status (as returned by
398waitpid), so unlike other watcher types, you I<can> rely on child watcher
399callback arguments.
400
401This watcher type works by installing a signal handler for C<SIGCHLD>,
402and since it cannot be shared, nothing else should use SIGCHLD or reap
403random child processes (waiting for specific child processes, e.g. inside
404C<system>, is just fine).
342 405
343There is a slight catch to child watchers, however: you usually start them 406There 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 407I<after> the child process was created, and this means the process could
345have exited already (and no SIGCHLD will be sent anymore). 408have exited already (and no SIGCHLD will be sent anymore).
346 409
347Not all event models handle this correctly (POE doesn't), but even for 410Not all event models handle this correctly (neither POE nor IO::Async do,
411see their AnyEvent::Impl manpages for details), but even for event models
348event models that I<do> handle this correctly, they usually need to be 412that 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). 413the process exits (i.e. before you fork in the first place). AnyEvent's
414pure perl event loop handles all cases correctly regardless of when you
415start the watcher.
350 416
351This means you cannot create a child watcher as the very first thing in an 417This means you cannot create a child watcher as the very first
352AnyEvent program, you I<have> to create at least one watcher before you 418thing in an AnyEvent program, you I<have> to create at least one
353C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 419watcher before you C<fork> the child (alternatively, you can call
420C<AnyEvent::detect>).
421
422As most event loops do not support waiting for child events, they will be
423emulated by AnyEvent in most cases, in which the latency and race problems
424mentioned in the description of signal watchers apply.
354 425
355Example: fork a process and wait for it 426Example: fork a process and wait for it
356 427
357 my $done = AnyEvent->condvar; 428 my $done = AnyEvent->condvar;
358 429
368 ); 439 );
369 440
370 # do something else, then wait for process exit 441 # do something else, then wait for process exit
371 $done->recv; 442 $done->recv;
372 443
444=head2 IDLE WATCHERS
445
446Sometimes there is a need to do something, but it is not so important
447to do it instantly, but only when there is nothing better to do. This
448"nothing better to do" is usually defined to be "no other events need
449attention by the event loop".
450
451Idle watchers ideally get invoked when the event loop has nothing
452better to do, just before it would block the process to wait for new
453events. Instead of blocking, the idle watcher is invoked.
454
455Most event loops unfortunately do not really support idle watchers (only
456EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
457will simply call the callback "from time to time".
458
459Example: read lines from STDIN, but only process them when the
460program is otherwise idle:
461
462 my @lines; # read data
463 my $idle_w;
464 my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
465 push @lines, scalar <STDIN>;
466
467 # start an idle watcher, if not already done
468 $idle_w ||= AnyEvent->idle (cb => sub {
469 # handle only one line, when there are lines left
470 if (my $line = shift @lines) {
471 print "handled when idle: $line";
472 } else {
473 # otherwise disable the idle watcher again
474 undef $idle_w;
475 }
476 });
477 });
478
373=head2 CONDITION VARIABLES 479=head2 CONDITION VARIABLES
374 480
375If you are familiar with some event loops you will know that all of them 481If 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 482require you to run some blocking "loop", "run" or similar function that
377will actively watch for new events and call your callbacks. 483will actively watch for new events and call your callbacks.
378 484
379AnyEvent is different, it expects somebody else to run the event loop and 485AnyEvent is slightly different: it expects somebody else to run the event
380will only block when necessary (usually when told by the user). 486loop and will only block when necessary (usually when told by the user).
381 487
382The instrument to do that is called a "condition variable", so called 488The instrument to do that is called a "condition variable", so called
383because they represent a condition that must become true. 489because they represent a condition that must become true.
490
491Now is probably a good time to look at the examples further below.
384 492
385Condition variables can be created by calling the C<< AnyEvent->condvar 493Condition variables can be created by calling the C<< AnyEvent->condvar
386>> method, usually without arguments. The only argument pair allowed is 494>> method, usually without arguments. The only argument pair allowed is
387C<cb>, which specifies a callback to be called when the condition variable 495C<cb>, which specifies a callback to be called when the condition variable
388becomes true. 496becomes true, with the condition variable as the first argument (but not
497the results).
389 498
390After creation, the condition variable is "false" until it becomes "true" 499After creation, the condition variable is "false" until it becomes "true"
391by calling the C<send> method (or calling the condition variable as if it 500by 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<< 501were a callback, read about the caveats in the description for the C<<
393->send >> method). 502->send >> method).
439 after => 1, 548 after => 1,
440 cb => sub { $result_ready->send }, 549 cb => sub { $result_ready->send },
441 ); 550 );
442 551
443 # this "blocks" (while handling events) till the callback 552 # this "blocks" (while handling events) till the callback
444 # calls send 553 # calls -<send
445 $result_ready->recv; 554 $result_ready->recv;
446 555
447Example: wait for a timer, but take advantage of the fact that 556Example: wait for a timer, but take advantage of the fact that condition
448condition variables are also code references. 557variables are also callable directly.
449 558
450 my $done = AnyEvent->condvar; 559 my $done = AnyEvent->condvar;
451 my $delay = AnyEvent->timer (after => 5, cb => $done); 560 my $delay = AnyEvent->timer (after => 5, cb => $done);
452 $done->recv; 561 $done->recv;
562
563Example: Imagine an API that returns a condvar and doesn't support
564callbacks. This is how you make a synchronous call, for example from
565the main program:
566
567 use AnyEvent::CouchDB;
568
569 ...
570
571 my @info = $couchdb->info->recv;
572
573And this is how you would just set a callback to be called whenever the
574results are available:
575
576 $couchdb->info->cb (sub {
577 my @info = $_[0]->recv;
578 });
453 579
454=head3 METHODS FOR PRODUCERS 580=head3 METHODS FOR PRODUCERS
455 581
456These methods should only be used by the producing side, i.e. the 582These methods should only be used by the producing side, i.e. the
457code/module that eventually sends the signal. Note that it is also 583code/module that eventually sends the signal. Note that it is also
470immediately from within send. 596immediately from within send.
471 597
472Any arguments passed to the C<send> call will be returned by all 598Any arguments passed to the C<send> call will be returned by all
473future C<< ->recv >> calls. 599future C<< ->recv >> calls.
474 600
475Condition variables are overloaded so one can call them directly 601Condition variables are overloaded so one can call them directly (as if
476(as a code reference). Calling them directly is the same as calling 602they 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 603C<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 604
484=item $cv->croak ($error) 605=item $cv->croak ($error)
485 606
486Similar to send, but causes all call's to C<< ->recv >> to invoke 607Similar to send, but causes all call's to C<< ->recv >> to invoke
487C<Carp::croak> with the given error message/object/scalar. 608C<Carp::croak> with the given error message/object/scalar.
488 609
489This can be used to signal any errors to the condition variable 610This can be used to signal any errors to the condition variable
490user/consumer. 611user/consumer. Doing it this way instead of calling C<croak> directly
612delays the error detetcion, but has the overwhelmign advantage that it
613diagnoses the error at the place where the result is expected, and not
614deep in some event clalback without connection to the actual code causing
615the problem.
491 616
492=item $cv->begin ([group callback]) 617=item $cv->begin ([group callback])
493 618
494=item $cv->end 619=item $cv->end
495
496These two methods are EXPERIMENTAL and MIGHT CHANGE.
497 620
498These two methods can be used to combine many transactions/events into 621These two methods can be used to combine many transactions/events into
499one. For example, a function that pings many hosts in parallel might want 622one. For example, a function that pings many hosts in parallel might want
500to use a condition variable for the whole process. 623to use a condition variable for the whole process.
501 624
503C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 626C<< ->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 627>>, the (last) callback passed to C<begin> will be executed. That callback
505is I<supposed> to call C<< ->send >>, but that is not required. If no 628is I<supposed> to call C<< ->send >>, but that is not required. If no
506callback was set, C<send> will be called without any arguments. 629callback was set, C<send> will be called without any arguments.
507 630
508Let's clarify this with the ping example: 631You can think of C<< $cv->send >> giving you an OR condition (one call
632sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
633condition (all C<begin> calls must be C<end>'ed before the condvar sends).
634
635Let's start with a simple example: you have two I/O watchers (for example,
636STDOUT and STDERR for a program), and you want to wait for both streams to
637close before activating a condvar:
638
639 my $cv = AnyEvent->condvar;
640
641 $cv->begin; # first watcher
642 my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
643 defined sysread $fh1, my $buf, 4096
644 or $cv->end;
645 });
646
647 $cv->begin; # second watcher
648 my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
649 defined sysread $fh2, my $buf, 4096
650 or $cv->end;
651 });
652
653 $cv->recv;
654
655This works because for every event source (EOF on file handle), there is
656one call to C<begin>, so the condvar waits for all calls to C<end> before
657sending.
658
659The ping example mentioned above is slightly more complicated, as the
660there are results to be passwd back, and the number of tasks that are
661begung can potentially be zero:
509 662
510 my $cv = AnyEvent->condvar; 663 my $cv = AnyEvent->condvar;
511 664
512 my %result; 665 my %result;
513 $cv->begin (sub { $cv->send (\%result) }); 666 $cv->begin (sub { $cv->send (\%result) });
533loop, which serves two important purposes: first, it sets the callback 686loop, which serves two important purposes: first, it sets the callback
534to be called once the counter reaches C<0>, and second, it ensures that 687to 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 688C<send> is called even when C<no> hosts are being pinged (the loop
536doesn't execute once). 689doesn't execute once).
537 690
538This is the general pattern when you "fan out" into multiple subrequests: 691This 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> 692potentially 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 693the 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>. 694subrequest you start, call C<begin> and for each subrequest you finish,
695call C<end>.
542 696
543=back 697=back
544 698
545=head3 METHODS FOR CONSUMERS 699=head3 METHODS FOR CONSUMERS
546 700
562function will call C<croak>. 716function will call C<croak>.
563 717
564In list context, all parameters passed to C<send> will be returned, 718In list context, all parameters passed to C<send> will be returned,
565in scalar context only the first one will be returned. 719in scalar context only the first one will be returned.
566 720
721Note that doing a blocking wait in a callback is not supported by any
722event loop, that is, recursive invocation of a blocking C<< ->recv
723>> is not allowed, and the C<recv> call will C<croak> if such a
724condition is detected. This condition can be slightly loosened by using
725L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
726any thread that doesn't run the event loop itself.
727
567Not all event models support a blocking wait - some die in that case 728Not 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 729(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 730using 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 731caller decide whether the call will block or not (for example, by coupling
571condition variables with some kind of request results and supporting 732condition variables with some kind of request results and supporting
572callbacks so the caller knows that getting the result will not block, 733callbacks so the caller knows that getting the result will not block,
573while still supporting blocking waits if the caller so desires). 734while still supporting blocking waits if the caller so desires).
574 735
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 736You can ensure that C<< -recv >> never blocks by setting a callback and
587only calling C<< ->recv >> from within that callback (or at a later 737only calling C<< ->recv >> from within that callback (or at a later
588time). This will work even when the event loop does not support blocking 738time). This will work even when the event loop does not support blocking
589waits otherwise. 739waits otherwise.
590 740
591=item $bool = $cv->ready 741=item $bool = $cv->ready
592 742
593Returns true when the condition is "true", i.e. whether C<send> or 743Returns true when the condition is "true", i.e. whether C<send> or
594C<croak> have been called. 744C<croak> have been called.
595 745
596=item $cb = $cv->cb ([new callback]) 746=item $cb = $cv->cb ($cb->($cv))
597 747
598This is a mutator function that returns the callback set and optionally 748This is a mutator function that returns the callback set and optionally
599replaces it before doing so. 749replaces it before doing so.
600 750
601The callback will be called when the condition becomes "true", i.e. when 751The callback will be called when the condition becomes "true", i.e. when
603variable itself. Calling C<recv> inside the callback or at any later time 753variable itself. Calling C<recv> inside the callback or at any later time
604is guaranteed not to block. 754is guaranteed not to block.
605 755
606=back 756=back
607 757
758=head1 SUPPORTED EVENT LOOPS/BACKENDS
759
760The available backend classes are (every class has its own manpage):
761
762=over 4
763
764=item Backends that are autoprobed when no other event loop can be found.
765
766EV is the preferred backend when no other event loop seems to be in
767use. If EV is not installed, then AnyEvent will try Event, and, failing
768that, will fall back to its own pure-perl implementation, which is
769available everywhere as it comes with AnyEvent itself.
770
771 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
772 AnyEvent::Impl::Event based on Event, very stable, few glitches.
773 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
774
775=item Backends that are transparently being picked up when they are used.
776
777These will be used when they are currently loaded when the first watcher
778is created, in which case it is assumed that the application is using
779them. This means that AnyEvent will automatically pick the right backend
780when the main program loads an event module before anything starts to
781create watchers. Nothing special needs to be done by the main program.
782
783 AnyEvent::Impl::Glib based on Glib, slow but very stable.
784 AnyEvent::Impl::Tk based on Tk, very broken.
785 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
786 AnyEvent::Impl::POE based on POE, very slow, some limitations.
787
788=item Backends with special needs.
789
790Qt requires the Qt::Application to be instantiated first, but will
791otherwise be picked up automatically. As long as the main program
792instantiates the application before any AnyEvent watchers are created,
793everything should just work.
794
795 AnyEvent::Impl::Qt based on Qt.
796
797Support for IO::Async can only be partial, as it is too broken and
798architecturally limited to even support the AnyEvent API. It also
799is the only event loop that needs the loop to be set explicitly, so
800it can only be used by a main program knowing about AnyEvent. See
801L<AnyEvent::Impl::Async> for the gory details.
802
803 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
804
805=item Event loops that are indirectly supported via other backends.
806
807Some event loops can be supported via other modules:
808
809There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
810
811B<WxWidgets> has no support for watching file handles. However, you can
812use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
813polls 20 times per second, which was considered to be too horrible to even
814consider for AnyEvent.
815
816B<Prima> is not supported as nobody seems to be using it, but it has a POE
817backend, so it can be supported through POE.
818
819AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
820load L<POE> when detecting them, in the hope that POE will pick them up,
821in which case everything will be automatic.
822
823=back
824
608=head1 GLOBAL VARIABLES AND FUNCTIONS 825=head1 GLOBAL VARIABLES AND FUNCTIONS
609 826
827These are not normally required to use AnyEvent, but can be useful to
828write AnyEvent extension modules.
829
610=over 4 830=over 4
611 831
612=item $AnyEvent::MODEL 832=item $AnyEvent::MODEL
613 833
614Contains C<undef> until the first watcher is being created. Then it 834Contains C<undef> until the first watcher is being created, before the
835backend has been autodetected.
836
615contains the event model that is being used, which is the name of the 837Afterwards it contains the event model that is being used, which is the
616Perl class implementing the model. This class is usually one of the 838name 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 839of 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>). 840case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
619 841will 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 842
641=item AnyEvent::detect 843=item AnyEvent::detect
642 844
643Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 845Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
644if necessary. You should only call this function right before you would 846if necessary. You should only call this function right before you would
645have created an AnyEvent watcher anyway, that is, as late as possible at 847have created an AnyEvent watcher anyway, that is, as late as possible at
646runtime. 848runtime, and not e.g. while initialising of your module.
849
850If you need to do some initialisation before AnyEvent watchers are
851created, use C<post_detect>.
647 852
648=item $guard = AnyEvent::post_detect { BLOCK } 853=item $guard = AnyEvent::post_detect { BLOCK }
649 854
650Arranges for the code block to be executed as soon as the event model is 855Arranges for the code block to be executed as soon as the event model is
651autodetected (or immediately if this has already happened). 856autodetected (or immediately if this has already happened).
857
858The block will be executed I<after> the actual backend has been detected
859(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
860created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
861other initialisations - see the sources of L<AnyEvent::Strict> or
862L<AnyEvent::AIO> to see how this is used.
863
864The most common usage is to create some global watchers, without forcing
865event module detection too early, for example, L<AnyEvent::AIO> creates
866and installs the global L<IO::AIO> watcher in a C<post_detect> block to
867avoid autodetecting the event module at load time.
652 868
653If called in scalar or list context, then it creates and returns an object 869If called in scalar or list context, then it creates and returns an object
654that automatically removes the callback again when it is destroyed. See 870that automatically removes the callback again when it is destroyed. See
655L<Coro::BDB> for a case where this is useful. 871L<Coro::BDB> for a case where this is useful.
656 872
659If there are any code references in this array (you can C<push> to it 875If 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 876before or after loading AnyEvent), then they will called directly after
661the event loop has been chosen. 877the event loop has been chosen.
662 878
663You should check C<$AnyEvent::MODEL> before adding to this array, though: 879You 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, 880if it is defined then the event loop has already been detected, and the
665and the array will be ignored. 881array will be ignored.
666 882
667Best use C<AnyEvent::post_detect { BLOCK }> instead. 883Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
884it,as it takes care of these details.
885
886This variable is mainly useful for modules that can do something useful
887when AnyEvent is used and thus want to know when it is initialised, but do
888not need to even load it by default. This array provides the means to hook
889into AnyEvent passively, without loading it.
668 890
669=back 891=back
670 892
671=head1 WHAT TO DO IN A MODULE 893=head1 WHAT TO DO IN A MODULE
672 894
727 949
728 950
729=head1 OTHER MODULES 951=head1 OTHER MODULES
730 952
731The following is a non-exhaustive list of additional modules that use 953The following is a non-exhaustive list of additional modules that use
732AnyEvent and can therefore be mixed easily with other AnyEvent modules 954AnyEvent 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 955modules and other event loops in the same program. Some of the modules
734available via CPAN. 956come with AnyEvent, most are available via CPAN.
735 957
736=over 4 958=over 4
737 959
738=item L<AnyEvent::Util> 960=item L<AnyEvent::Util>
739 961
740Contains various utility functions that replace often-used but blocking 962Contains various utility functions that replace often-used but blocking
741functions such as C<inet_aton> by event-/callback-based versions. 963functions 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 964
747=item L<AnyEvent::Socket> 965=item L<AnyEvent::Socket>
748 966
749Provides various utility functions for (internet protocol) sockets, 967Provides various utility functions for (internet protocol) sockets,
750addresses and name resolution. Also functions to create non-blocking tcp 968addresses and name resolution. Also functions to create non-blocking tcp
751connections or tcp servers, with IPv6 and SRV record support and more. 969connections or tcp servers, with IPv6 and SRV record support and more.
752 970
971=item L<AnyEvent::Handle>
972
973Provide read and write buffers, manages watchers for reads and writes,
974supports raw and formatted I/O, I/O queued and fully transparent and
975non-blocking SSL/TLS (via L<AnyEvent::TLS>.
976
753=item L<AnyEvent::DNS> 977=item L<AnyEvent::DNS>
754 978
755Provides rich asynchronous DNS resolver capabilities. 979Provides rich asynchronous DNS resolver capabilities.
756 980
757=item L<AnyEvent::HTTP> 981=item L<AnyEvent::HTTP>
765 989
766=item L<AnyEvent::FastPing> 990=item L<AnyEvent::FastPing>
767 991
768The fastest ping in the west. 992The fastest ping in the west.
769 993
994=item L<AnyEvent::DBI>
995
996Executes L<DBI> requests asynchronously in a proxy process.
997
998=item L<AnyEvent::AIO>
999
1000Truly asynchronous I/O, should be in the toolbox of every event
1001programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1002together.
1003
1004=item L<AnyEvent::BDB>
1005
1006Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1007L<BDB> and AnyEvent together.
1008
1009=item L<AnyEvent::GPSD>
1010
1011A non-blocking interface to gpsd, a daemon delivering GPS information.
1012
770=item L<Net::IRC3> 1013=item L<AnyEvent::IRC>
771 1014
772AnyEvent based IRC client module family. 1015AnyEvent based IRC client module family (replacing the older Net::IRC3).
773 1016
774=item L<Net::XMPP2> 1017=item L<AnyEvent::XMPP>
775 1018
776AnyEvent based XMPP (Jabber protocol) module family. 1019AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1020Net::XMPP2>.
1021
1022=item L<AnyEvent::IGS>
1023
1024A non-blocking interface to the Internet Go Server protocol (used by
1025L<App::IGS>).
777 1026
778=item L<Net::FCP> 1027=item L<Net::FCP>
779 1028
780AnyEvent-based implementation of the Freenet Client Protocol, birthplace 1029AnyEvent-based implementation of the Freenet Client Protocol, birthplace
781of AnyEvent. 1030of AnyEvent.
786 1035
787=item L<Coro> 1036=item L<Coro>
788 1037
789Has special support for AnyEvent via L<Coro::AnyEvent>. 1038Has special support for AnyEvent via L<Coro::AnyEvent>.
790 1039
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 1040=back
807 1041
808=cut 1042=cut
809 1043
810package AnyEvent; 1044package AnyEvent;
811 1045
812no warnings; 1046no warnings;
813use strict; 1047use strict qw(vars subs);
814 1048
815use Carp; 1049use Carp ();
816 1050
817our $VERSION = 4.15; 1051our $VERSION = 4.83;
818our $MODEL; 1052our $MODEL;
819 1053
820our $AUTOLOAD; 1054our $AUTOLOAD;
821our @ISA; 1055our @ISA;
822 1056
823our @REGISTRY; 1057our @REGISTRY;
824 1058
825our $WIN32; 1059our $WIN32;
826 1060
1061our $VERBOSE;
1062
827BEGIN { 1063BEGIN {
828 my $win32 = ! ! ($^O =~ /mswin32/i); 1064 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
829 eval "sub WIN32(){ $win32 }"; 1065 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
830}
831 1066
1067 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1068 if ${^TAINT};
1069
832our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1070 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1071
1072}
1073
1074our $MAX_SIGNAL_LATENCY = 10;
833 1075
834our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1076our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
835 1077
836{ 1078{
837 my $idx; 1079 my $idx;
845 [Event:: => AnyEvent::Impl::Event::], 1087 [Event:: => AnyEvent::Impl::Event::],
846 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1088 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
847 # everything below here will not be autoprobed 1089 # everything below here will not be autoprobed
848 # as the pureperl backend should work everywhere 1090 # as the pureperl backend should work everywhere
849 # and is usually faster 1091 # and is usually faster
850 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
851 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1092 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
852 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1093 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1094 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
853 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1095 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
854 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1096 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
855 [Wx:: => AnyEvent::Impl::POE::], 1097 [Wx:: => AnyEvent::Impl::POE::],
856 [Prima:: => AnyEvent::Impl::POE::], 1098 [Prima:: => AnyEvent::Impl::POE::],
1099 # IO::Async is just too broken - we would need workarounds for its
1100 # byzantine signal and broken child handling, among others.
1101 # IO::Async is rather hard to detect, as it doesn't have any
1102 # obvious default class.
1103# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1104# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1105# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
857); 1106);
858 1107
859our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); 1108our %method = map +($_ => 1),
1109 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
860 1110
861our @post_detect; 1111our @post_detect;
862 1112
863sub post_detect(&) { 1113sub post_detect(&) {
864 my ($cb) = @_; 1114 my ($cb) = @_;
869 1 1119 1
870 } else { 1120 } else {
871 push @post_detect, $cb; 1121 push @post_detect, $cb;
872 1122
873 defined wantarray 1123 defined wantarray
874 ? bless \$cb, "AnyEvent::Util::PostDetect" 1124 ? bless \$cb, "AnyEvent::Util::postdetect"
875 : () 1125 : ()
876 } 1126 }
877} 1127}
878 1128
879sub AnyEvent::Util::PostDetect::DESTROY { 1129sub AnyEvent::Util::postdetect::DESTROY {
880 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1130 @post_detect = grep $_ != ${$_[0]}, @post_detect;
881} 1131}
882 1132
883sub detect() { 1133sub detect() {
884 unless ($MODEL) { 1134 unless ($MODEL) {
887 1137
888 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1138 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
889 my $model = "AnyEvent::Impl::$1"; 1139 my $model = "AnyEvent::Impl::$1";
890 if (eval "require $model") { 1140 if (eval "require $model") {
891 $MODEL = $model; 1141 $MODEL = $model;
892 warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; 1142 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
893 } else { 1143 } else {
894 warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; 1144 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
895 } 1145 }
896 } 1146 }
897 1147
898 # check for already loaded models 1148 # check for already loaded models
899 unless ($MODEL) { 1149 unless ($MODEL) {
900 for (@REGISTRY, @models) { 1150 for (@REGISTRY, @models) {
901 my ($package, $model) = @$_; 1151 my ($package, $model) = @$_;
902 if (${"$package\::VERSION"} > 0) { 1152 if (${"$package\::VERSION"} > 0) {
903 if (eval "require $model") { 1153 if (eval "require $model") {
904 $MODEL = $model; 1154 $MODEL = $model;
905 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; 1155 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
906 last; 1156 last;
907 } 1157 }
908 } 1158 }
909 } 1159 }
910 1160
915 my ($package, $model) = @$_; 1165 my ($package, $model) = @$_;
916 if (eval "require $package" 1166 if (eval "require $package"
917 and ${"$package\::VERSION"} > 0 1167 and ${"$package\::VERSION"} > 0
918 and eval "require $model") { 1168 and eval "require $model") {
919 $MODEL = $model; 1169 $MODEL = $model;
920 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; 1170 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
921 last; 1171 last;
922 } 1172 }
923 } 1173 }
924 1174
925 $MODEL 1175 $MODEL
926 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 1176 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
927 } 1177 }
928 } 1178 }
929 1179
1180 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1181
930 unshift @ISA, $MODEL; 1182 unshift @ISA, $MODEL;
931 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1183
1184 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
932 1185
933 (shift @post_detect)->() while @post_detect; 1186 (shift @post_detect)->() while @post_detect;
934 } 1187 }
935 1188
936 $MODEL 1189 $MODEL
938 1191
939sub AUTOLOAD { 1192sub AUTOLOAD {
940 (my $func = $AUTOLOAD) =~ s/.*://; 1193 (my $func = $AUTOLOAD) =~ s/.*://;
941 1194
942 $method{$func} 1195 $method{$func}
943 or croak "$func: not a valid method for AnyEvent objects"; 1196 or Carp::croak "$func: not a valid method for AnyEvent objects";
944 1197
945 detect unless $MODEL; 1198 detect unless $MODEL;
946 1199
947 my $class = shift; 1200 my $class = shift;
948 $class->$func (@_); 1201 $class->$func (@_);
949} 1202}
950 1203
1204# utility function to dup a filehandle. this is used by many backends
1205# to support binding more than one watcher per filehandle (they usually
1206# allow only one watcher per fd, so we dup it to get a different one).
1207sub _dupfh($$;$$) {
1208 my ($poll, $fh, $r, $w) = @_;
1209
1210 # cygwin requires the fh mode to be matching, unix doesn't
1211 my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1212
1213 open my $fh2, $mode, $fh
1214 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1215
1216 # we assume CLOEXEC is already set by perl in all important cases
1217
1218 ($fh2, $rw)
1219}
1220
951package AnyEvent::Base; 1221package AnyEvent::Base;
952 1222
953# default implementation for now and time 1223# default implementations for many methods
954 1224
955use Time::HiRes (); 1225sub _time {
1226 # probe for availability of Time::HiRes
1227 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1228 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1229 *_time = \&Time::HiRes::time;
1230 # if (eval "use POSIX (); (POSIX::times())...
1231 } else {
1232 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1233 *_time = sub { time }; # epic fail
1234 }
956 1235
957sub time { Time::HiRes::time } 1236 &_time
958sub now { Time::HiRes::time } 1237}
1238
1239sub time { _time }
1240sub now { _time }
1241sub now_update { }
959 1242
960# default implementation for ->condvar 1243# default implementation for ->condvar
961 1244
962sub condvar { 1245sub condvar {
963 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1246 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
964} 1247}
965 1248
966# default implementation for ->signal 1249# default implementation for ->signal
967 1250
968our %SIG_CB; 1251our $HAVE_ASYNC_INTERRUPT;
1252our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1253our (%SIG_ASY, %SIG_ASY_W);
1254our ($SIG_COUNT, $SIG_TW);
969 1255
1256sub _signal_exec {
1257 $HAVE_ASYNC_INTERRUPT
1258 ? $SIGPIPE_R->drain
1259 : sysread $SIGPIPE_R, my $dummy, 9;
1260
1261 while (%SIG_EV) {
1262 for (keys %SIG_EV) {
1263 delete $SIG_EV{$_};
1264 $_->() for values %{ $SIG_CB{$_} || {} };
1265 }
1266 }
1267}
1268
970sub signal { 1269sub _signal {
971 my (undef, %arg) = @_; 1270 my (undef, %arg) = @_;
972 1271
973 my $signal = uc $arg{signal} 1272 my $signal = uc $arg{signal}
974 or Carp::croak "required option 'signal' is missing"; 1273 or Carp::croak "required option 'signal' is missing";
975 1274
976 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1275 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1276
1277 if ($HAVE_ASYNC_INTERRUPT) {
1278 # async::interrupt
1279
1280 $SIG_ASY{$signal} ||= do {
1281 my $asy = new Async::Interrupt
1282 cb => sub { undef $SIG_EV{$signal} },
1283 signal => $signal,
1284 pipe => [$SIGPIPE_R->filenos],
1285 ;
1286 $asy->pipe_autodrain (0);
1287
1288 $asy
1289 };
1290
1291 } else {
1292 # pure perl
1293
977 $SIG{$signal} ||= sub { 1294 $SIG{$signal} ||= sub {
978 $_->() for values %{ $SIG_CB{$signal} || {} }; 1295 local $!;
1296 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1297 undef $SIG_EV{$signal};
1298 };
1299
1300 # can't do signal processing without introducing races in pure perl,
1301 # so limit the signal latency.
1302 ++$SIG_COUNT;
1303 $SIG_TW ||= AnyEvent->timer (
1304 after => $MAX_SIGNAL_LATENCY,
1305 interval => $MAX_SIGNAL_LATENCY,
1306 cb => sub { }, # just for the PERL_ASYNC_CHECK
1307 );
979 }; 1308 }
980 1309
981 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1310 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
982} 1311}
983 1312
1313sub signal {
1314 # probe for availability of Async::Interrupt
1315 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1316 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1317
1318 $HAVE_ASYNC_INTERRUPT = 1;
1319 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1320 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1321
1322 } else {
1323 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1324
1325 require Fcntl;
1326
1327 if (AnyEvent::WIN32) {
1328 require AnyEvent::Util;
1329
1330 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1331 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1332 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1333 } else {
1334 pipe $SIGPIPE_R, $SIGPIPE_W;
1335 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1336 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1337
1338 # not strictly required, as $^F is normally 2, but let's make sure...
1339 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1340 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1341 }
1342
1343 $SIGPIPE_R
1344 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1345
1346 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1347 }
1348
1349 *signal = \&_signal;
1350 &signal
1351}
1352
984sub AnyEvent::Base::Signal::DESTROY { 1353sub AnyEvent::Base::signal::DESTROY {
985 my ($signal, $cb) = @{$_[0]}; 1354 my ($signal, $cb) = @{$_[0]};
986 1355
1356 undef $SIG_TW
1357 unless --$SIG_COUNT;
1358
987 delete $SIG_CB{$signal}{$cb}; 1359 delete $SIG_CB{$signal}{$cb};
988 1360
989 $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; 1361 # delete doesn't work with older perls - they then
1362 # print weird messages, or just unconditionally exit
1363 # instead of getting the default action.
1364 undef $SIG{$signal}
1365 unless keys %{ $SIG_CB{$signal} };
990} 1366}
991 1367
992# default implementation for ->child 1368# default implementation for ->child
993 1369
994our %PID_CB; 1370our %PID_CB;
995our $CHLD_W; 1371our $CHLD_W;
996our $CHLD_DELAY_W; 1372our $CHLD_DELAY_W;
997our $PID_IDLE;
998our $WNOHANG; 1373our $WNOHANG;
999 1374
1000sub _child_wait { 1375sub _sigchld {
1001 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1376 while (0 < (my $pid = waitpid -1, $WNOHANG)) {
1377 $_->($pid, $?)
1002 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1378 for values %{ $PID_CB{$pid} || {} },
1003 (values %{ $PID_CB{0} || {} }); 1379 values %{ $PID_CB{0} || {} };
1004 } 1380 }
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} 1381}
1016 1382
1017sub child { 1383sub child {
1018 my (undef, %arg) = @_; 1384 my (undef, %arg) = @_;
1019 1385
1020 defined (my $pid = $arg{pid} + 0) 1386 defined (my $pid = $arg{pid} + 0)
1021 or Carp::croak "required option 'pid' is missing"; 1387 or Carp::croak "required option 'pid' is missing";
1022 1388
1023 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1389 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1024 1390
1025 unless ($WNOHANG) {
1026 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1391 $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1027 }
1028 1392
1029 unless ($CHLD_W) { 1393 unless ($CHLD_W) {
1030 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1394 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1031 # child could be a zombie already, so make at least one round 1395 # child could be a zombie already, so make at least one round
1032 &_sigchld; 1396 &_sigchld;
1033 } 1397 }
1034 1398
1035 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1399 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1036} 1400}
1037 1401
1038sub AnyEvent::Base::Child::DESTROY { 1402sub AnyEvent::Base::child::DESTROY {
1039 my ($pid, $cb) = @{$_[0]}; 1403 my ($pid, $cb) = @{$_[0]};
1040 1404
1041 delete $PID_CB{$pid}{$cb}; 1405 delete $PID_CB{$pid}{$cb};
1042 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1406 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1043 1407
1044 undef $CHLD_W unless keys %PID_CB; 1408 undef $CHLD_W unless keys %PID_CB;
1409}
1410
1411# idle emulation is done by simply using a timer, regardless
1412# of whether the process is idle or not, and not letting
1413# the callback use more than 50% of the time.
1414sub idle {
1415 my (undef, %arg) = @_;
1416
1417 my ($cb, $w, $rcb) = $arg{cb};
1418
1419 $rcb = sub {
1420 if ($cb) {
1421 $w = _time;
1422 &$cb;
1423 $w = _time - $w;
1424
1425 # never use more then 50% of the time for the idle watcher,
1426 # within some limits
1427 $w = 0.0001 if $w < 0.0001;
1428 $w = 5 if $w > 5;
1429
1430 $w = AnyEvent->timer (after => $w, cb => $rcb);
1431 } else {
1432 # clean up...
1433 undef $w;
1434 undef $rcb;
1435 }
1436 };
1437
1438 $w = AnyEvent->timer (after => 0.05, cb => $rcb);
1439
1440 bless \\$cb, "AnyEvent::Base::idle"
1441}
1442
1443sub AnyEvent::Base::idle::DESTROY {
1444 undef $${$_[0]};
1045} 1445}
1046 1446
1047package AnyEvent::CondVar; 1447package AnyEvent::CondVar;
1048 1448
1049our @ISA = AnyEvent::CondVar::Base::; 1449our @ISA = AnyEvent::CondVar::Base::;
1051package AnyEvent::CondVar::Base; 1451package AnyEvent::CondVar::Base;
1052 1452
1053use overload 1453use overload
1054 '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1454 '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1055 fallback => 1; 1455 fallback => 1;
1456
1457our $WAITING;
1056 1458
1057sub _send { 1459sub _send {
1058 # nop 1460 # nop
1059} 1461}
1060 1462
1073sub ready { 1475sub ready {
1074 $_[0]{_ae_sent} 1476 $_[0]{_ae_sent}
1075} 1477}
1076 1478
1077sub _wait { 1479sub _wait {
1480 $WAITING
1481 and !$_[0]{_ae_sent}
1482 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1483
1484 local $WAITING = 1;
1078 AnyEvent->one_event while !$_[0]{_ae_sent}; 1485 AnyEvent->one_event while !$_[0]{_ae_sent};
1079} 1486}
1080 1487
1081sub recv { 1488sub recv {
1082 $_[0]->_wait; 1489 $_[0]->_wait;
1101} 1508}
1102 1509
1103# undocumented/compatibility with pre-3.4 1510# undocumented/compatibility with pre-3.4
1104*broadcast = \&send; 1511*broadcast = \&send;
1105*wait = \&_wait; 1512*wait = \&_wait;
1513
1514=head1 ERROR AND EXCEPTION HANDLING
1515
1516In general, AnyEvent does not do any error handling - it relies on the
1517caller to do that if required. The L<AnyEvent::Strict> module (see also
1518the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
1519checking of all AnyEvent methods, however, which is highly useful during
1520development.
1521
1522As for exception handling (i.e. runtime errors and exceptions thrown while
1523executing a callback), this is not only highly event-loop specific, but
1524also not in any way wrapped by this module, as this is the job of the main
1525program.
1526
1527The pure perl event loop simply re-throws the exception (usually
1528within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
1529$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1530so on.
1531
1532=head1 ENVIRONMENT VARIABLES
1533
1534The following environment variables are used by this module or its
1535submodules.
1536
1537Note that AnyEvent will remove I<all> environment variables starting with
1538C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
1539enabled.
1540
1541=over 4
1542
1543=item C<PERL_ANYEVENT_VERBOSE>
1544
1545By default, AnyEvent will be completely silent except in fatal
1546conditions. You can set this environment variable to make AnyEvent more
1547talkative.
1548
1549When set to C<1> or higher, causes AnyEvent to warn about unexpected
1550conditions, such as not being able to load the event model specified by
1551C<PERL_ANYEVENT_MODEL>.
1552
1553When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1554model it chooses.
1555
1556=item C<PERL_ANYEVENT_STRICT>
1557
1558AnyEvent does not do much argument checking by default, as thorough
1559argument checking is very costly. Setting this variable to a true value
1560will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1561check the arguments passed to most method calls. If it finds any problems,
1562it will croak.
1563
1564In other words, enables "strict" mode.
1565
1566Unlike C<use strict>, it is definitely recommended to keep it off in
1567production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
1568developing programs can be very useful, however.
1569
1570=item C<PERL_ANYEVENT_MODEL>
1571
1572This can be used to specify the event model to be used by AnyEvent, before
1573auto detection and -probing kicks in. It must be a string consisting
1574entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1575and the resulting module name is loaded and if the load was successful,
1576used as event model. If it fails to load AnyEvent will proceed with
1577auto detection and -probing.
1578
1579This functionality might change in future versions.
1580
1581For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1582could start your program like this:
1583
1584 PERL_ANYEVENT_MODEL=Perl perl ...
1585
1586=item C<PERL_ANYEVENT_PROTOCOLS>
1587
1588Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1589for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1590of auto probing).
1591
1592Must be set to a comma-separated list of protocols or address families,
1593current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1594used, and preference will be given to protocols mentioned earlier in the
1595list.
1596
1597This variable can effectively be used for denial-of-service attacks
1598against local programs (e.g. when setuid), although the impact is likely
1599small, as the program has to handle conenction and other failures anyways.
1600
1601Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1602but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1603- only support IPv4, never try to resolve or contact IPv6
1604addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1605IPv6, but prefer IPv6 over IPv4.
1606
1607=item C<PERL_ANYEVENT_EDNS0>
1608
1609Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1610for DNS. This extension is generally useful to reduce DNS traffic, but
1611some (broken) firewalls drop such DNS packets, which is why it is off by
1612default.
1613
1614Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1615EDNS0 in its DNS requests.
1616
1617=item C<PERL_ANYEVENT_MAX_FORKS>
1618
1619The maximum number of child processes that C<AnyEvent::Util::fork_call>
1620will create in parallel.
1621
1622=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1623
1624The default value for the C<max_outstanding> parameter for the default DNS
1625resolver - this is the maximum number of parallel DNS requests that are
1626sent to the DNS server.
1627
1628=item C<PERL_ANYEVENT_RESOLV_CONF>
1629
1630The file to use instead of F</etc/resolv.conf> (or OS-specific
1631configuration) in the default resolver. When set to the empty string, no
1632default config will be used.
1633
1634=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1635
1636When neither C<ca_file> nor C<ca_path> was specified during
1637L<AnyEvent::TLS> context creation, and either of these environment
1638variables exist, they will be used to specify CA certificate locations
1639instead of a system-dependent default.
1640
1641=back
1106 1642
1107=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1643=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1108 1644
1109This is an advanced topic that you do not normally need to use AnyEvent in 1645This 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 1646a module. This section is only of use to event loop authors who want to
1144 1680
1145I<rxvt-unicode> also cheats a bit by not providing blocking access to 1681I<rxvt-unicode> also cheats a bit by not providing blocking access to
1146condition variables: code blocking while waiting for a condition will 1682condition variables: code blocking while waiting for a condition will
1147C<die>. This still works with most modules/usages, and blocking calls must 1683C<die>. This still works with most modules/usages, and blocking calls must
1148not be done in an interactive application, so it makes sense. 1684not 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 1685
1223=head1 EXAMPLE PROGRAM 1686=head1 EXAMPLE PROGRAM
1224 1687
1225The following program uses an I/O watcher to read data from STDIN, a timer 1688The 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 1689to display a message once per second, and a condition variable to quit the
1420watcher. 1883watcher.
1421 1884
1422=head3 Results 1885=head3 Results
1423 1886
1424 name watchers bytes create invoke destroy comment 1887 name watchers bytes create invoke destroy comment
1425 EV/EV 400000 244 0.56 0.46 0.31 EV native interface 1888 EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1426 EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers 1889 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1427 CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal 1890 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1428 Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation 1891 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1429 Event/Event 16000 516 31.88 31.30 0.85 Event native interface 1892 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1430 Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers 1893 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1894 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
1895 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1431 Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour 1896 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1432 Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers 1897 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1433 POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event 1898 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1434 POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select 1899 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1435 1900
1436=head3 Discussion 1901=head3 Discussion
1437 1902
1438The benchmark does I<not> measure scalability of the event loop very 1903The 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) 1904well. For example, a select-based event loop (such as the pure perl one)
1464performance becomes really bad with lots of file descriptors (and few of 1929performance becomes really bad with lots of file descriptors (and few of
1465them active), of course, but this was not subject of this benchmark. 1930them active), of course, but this was not subject of this benchmark.
1466 1931
1467The C<Event> module has a relatively high setup and callback invocation 1932The C<Event> module has a relatively high setup and callback invocation
1468cost, but overall scores in on the third place. 1933cost, but overall scores in on the third place.
1934
1935C<IO::Async> performs admirably well, about on par with C<Event>, even
1936when using its pure perl backend.
1469 1937
1470C<Glib>'s memory usage is quite a bit higher, but it features a 1938C<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 1939faster callback invocation and overall ends up in the same class as
1472C<Event>. However, Glib scales extremely badly, doubling the number of 1940C<Event>. However, Glib scales extremely badly, doubling the number of
1473watchers increases the processing time by more than a factor of four, 1941watchers increases the processing time by more than a factor of four,
1551it to another server. This includes deleting the old timeout and creating 2019it to another server. This includes deleting the old timeout and creating
1552a new one that moves the timeout into the future. 2020a new one that moves the timeout into the future.
1553 2021
1554=head3 Results 2022=head3 Results
1555 2023
1556 name sockets create request 2024 name sockets create request
1557 EV 20000 69.01 11.16 2025 EV 20000 69.01 11.16
1558 Perl 20000 73.32 35.87 2026 Perl 20000 73.32 35.87
2027 IOAsync 20000 157.00 98.14 epoll
2028 IOAsync 20000 159.31 616.06 poll
1559 Event 20000 212.62 257.32 2029 Event 20000 212.62 257.32
1560 Glib 20000 651.16 1896.30 2030 Glib 20000 651.16 1896.30
1561 POE 20000 349.67 12317.24 uses POE::Loop::Event 2031 POE 20000 349.67 12317.24 uses POE::Loop::Event
1562 2032
1563=head3 Discussion 2033=head3 Discussion
1564 2034
1565This benchmark I<does> measure scalability and overall performance of the 2035This benchmark I<does> measure scalability and overall performance of the
1566particular event loop. 2036particular event loop.
1568EV is again fastest. Since it is using epoll on my system, the setup time 2038EV is again fastest. Since it is using epoll on my system, the setup time
1569is relatively high, though. 2039is relatively high, though.
1570 2040
1571Perl surprisingly comes second. It is much faster than the C-based event 2041Perl surprisingly comes second. It is much faster than the C-based event
1572loops Event and Glib. 2042loops Event and Glib.
2043
2044IO::Async performs very well when using its epoll backend, and still quite
2045good compared to Glib when using its pure perl backend.
1573 2046
1574Event suffers from high setup time as well (look at its code and you will 2047Event 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 2048understand why). Callback invocation also has a high overhead compared to
1576the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 2049the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1577uses select or poll in basically all documented configurations. 2050uses select or poll in basically all documented configurations.
1640=item * C-based event loops perform very well with small number of 2113=item * C-based event loops perform very well with small number of
1641watchers, as the management overhead dominates. 2114watchers, as the management overhead dominates.
1642 2115
1643=back 2116=back
1644 2117
2118=head2 THE IO::Lambda BENCHMARK
2119
2120Recently I was told about the benchmark in the IO::Lambda manpage, which
2121could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
2122simply compares IO::Lambda with POE, and IO::Lambda looks better (which
2123shouldn't come as a surprise to anybody). As such, the benchmark is
2124fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
2125very optimal. But how would AnyEvent compare when used without the extra
2126baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
2127
2128The benchmark itself creates an echo-server, and then, for 500 times,
2129connects to the echo server, sends a line, waits for the reply, and then
2130creates the next connection. This is a rather bad benchmark, as it doesn't
2131test the efficiency of the framework or much non-blocking I/O, but it is a
2132benchmark nevertheless.
2133
2134 name runtime
2135 Lambda/select 0.330 sec
2136 + optimized 0.122 sec
2137 Lambda/AnyEvent 0.327 sec
2138 + optimized 0.138 sec
2139 Raw sockets/select 0.077 sec
2140 POE/select, components 0.662 sec
2141 POE/select, raw sockets 0.226 sec
2142 POE/select, optimized 0.404 sec
2143
2144 AnyEvent/select/nb 0.085 sec
2145 AnyEvent/EV/nb 0.068 sec
2146 +state machine 0.134 sec
2147
2148The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
2149benchmarks actually make blocking connects and use 100% blocking I/O,
2150defeating the purpose of an event-based solution. All of the newly
2151written AnyEvent benchmarks use 100% non-blocking connects (using
2152AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
2153resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
2154generally require a lot more bookkeeping and event handling than blocking
2155connects (which involve a single syscall only).
2156
2157The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
2158offers similar expressive power as POE and IO::Lambda, using conventional
2159Perl syntax. This means that both the echo server and the client are 100%
2160non-blocking, further placing it at a disadvantage.
2161
2162As you can see, the AnyEvent + EV combination even beats the
2163hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2164backend easily beats IO::Lambda and POE.
2165
2166And even the 100% non-blocking version written using the high-level (and
2167slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
2168large margin, even though it does all of DNS, tcp-connect and socket I/O
2169in a non-blocking way.
2170
2171The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2172F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2173part of the IO::lambda distribution and were used without any changes.
2174
2175
2176=head1 SIGNALS
2177
2178AnyEvent currently installs handlers for these signals:
2179
2180=over 4
2181
2182=item SIGCHLD
2183
2184A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2185emulation for event loops that do not support them natively. Also, some
2186event loops install a similar handler.
2187
2188Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2189AnyEvent will reset it to default, to avoid losing child exit statuses.
2190
2191=item SIGPIPE
2192
2193A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2194when AnyEvent gets loaded.
2195
2196The rationale for this is that AnyEvent users usually do not really depend
2197on SIGPIPE delivery (which is purely an optimisation for shell use, or
2198badly-written programs), but C<SIGPIPE> can cause spurious and rare
2199program exits as a lot of people do not expect C<SIGPIPE> when writing to
2200some random socket.
2201
2202The rationale for installing a no-op handler as opposed to ignoring it is
2203that this way, the handler will be restored to defaults on exec.
2204
2205Feel free to install your own handler, or reset it to defaults.
2206
2207=back
2208
2209=cut
2210
2211undef $SIG{CHLD}
2212 if $SIG{CHLD} eq 'IGNORE';
2213
2214$SIG{PIPE} = sub { }
2215 unless defined $SIG{PIPE};
2216
2217=head1 RECOMMENDED/OPTIONAL MODULES
2218
2219One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2220it's built-in modules) are required to use it.
2221
2222That does not mean that AnyEvent won't take advantage of some additional
2223modules if they are installed.
2224
2225This section epxlains which additional modules will be used, and how they
2226affect AnyEvent's operetion.
2227
2228=over 4
2229
2230=item L<Async::Interrupt>
2231
2232This slightly arcane module is used to implement fast signal handling: To
2233my knowledge, there is no way to do completely race-free and quick
2234signal handling in pure perl. To ensure that signals still get
2235delivered, AnyEvent will start an interval timer to wake up perl (and
2236catch the signals) with soemd elay (default is 10 seconds, look for
2237C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2238
2239If this module is available, then it will be used to implement signal
2240catching, which means that signals will not be delayed, and the event loop
2241will not be interrupted regularly, which is more efficient (And good for
2242battery life on laptops).
2243
2244This affects not just the pure-perl event loop, but also other event loops
2245that have no signal handling on their own (e.g. Glib, Tk, Qt).
2246
2247=item L<EV>
2248
2249This module isn't really "optional", as it is simply one of the backend
2250event loops that AnyEvent can use. However, it is simply the best event
2251loop available in terms of features, speed and stability: It supports
2252the AnyEvent API optimally, implements all the watcher types in XS, does
2253automatic timer adjustments even when no monotonic clock is available,
2254can take avdantage of advanced kernel interfaces such as C<epoll> and
2255C<kqueue>, and is the fastest backend I<by far>. You can even embed
2256L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2257
2258=item L<Guard>
2259
2260The guard module, when used, will be used to implement
2261C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2262lot less memory), but otherwise doesn't affect guard operation much. It is
2263purely used for performance.
2264
2265=item L<JSON> and L<JSON::XS>
2266
2267This module is required when you want to read or write JSON data via
2268L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2269advantage of the ulta-high-speed L<JSON::XS> module when it is installed.
2270
2271In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2272installed.
2273
2274=item L<Net::SSLeay>
2275
2276Implementing TLS/SSL in Perl is certainly interesting, but not very
2277worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2278the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2279
2280=item L<Time::HiRes>
2281
2282This module is part of perl since release 5.008. It will be used when the
2283chosen event library does not come with a timing source on it's own. The
2284pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2285try to use a monotonic clock for timing stability.
2286
2287=back
2288
1645 2289
1646=head1 FORK 2290=head1 FORK
1647 2291
1648Most event libraries are not fork-safe. The ones who are usually are 2292Most 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> 2293because they rely on inefficient but fork-safe C<select> or C<poll>
1650calls. Only L<EV> is fully fork-aware. 2294calls. Only L<EV> is fully fork-aware.
1651 2295
1652If you have to fork, you must either do so I<before> creating your first 2296If 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. 2297watcher OR you must not use AnyEvent at all in the child OR you must do
2298something completely out of the scope of AnyEvent.
1654 2299
1655 2300
1656=head1 SECURITY CONSIDERATIONS 2301=head1 SECURITY CONSIDERATIONS
1657 2302
1658AnyEvent can be forced to load any event model via 2303AnyEvent can be forced to load any event model via
1669 2314
1670 use AnyEvent; 2315 use AnyEvent;
1671 2316
1672Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2317Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1673be used to probe what backend is used and gain other information (which is 2318be used to probe what backend is used and gain other information (which is
1674probably even less useful to an attacker than PERL_ANYEVENT_MODEL). 2319probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
2320$ENV{PERL_ANYEVENT_STRICT}.
2321
2322Note that AnyEvent will remove I<all> environment variables starting with
2323C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2324enabled.
1675 2325
1676 2326
1677=head1 BUGS 2327=head1 BUGS
1678 2328
1679Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 2329Perl 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 2330to 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 2331and 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 2332memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1683pronounced). 2333pronounced).
1684 2334
1685 2335
1686=head1 SEE ALSO 2336=head1 SEE ALSO
1687 2337
1691L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2341L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1692 2342
1693Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2343Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1694L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2344L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1695L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2345L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1696L<AnyEvent::Impl::POE>. 2346L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.
1697 2347
1698Non-blocking file handles, sockets, TCP clients and 2348Non-blocking file handles, sockets, TCP clients and
1699servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. 2349servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1700 2350
1701Asynchronous DNS: L<AnyEvent::DNS>. 2351Asynchronous DNS: L<AnyEvent::DNS>.
1702 2352
1703Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 2353Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
2354L<Coro::Event>,
1704 2355
1705Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 2356Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
2357L<AnyEvent::HTTP>.
1706 2358
1707 2359
1708=head1 AUTHOR 2360=head1 AUTHOR
1709 2361
1710 Marc Lehmann <schmorp@schmorp.de> 2362 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines