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.167 by root, Tue Jul 8 23:44:51 2008 UTC vs.
Revision 1.246 by root, Sat Jul 18 15:51:52 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 for events 181C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
158(AnyEvent might or might not keep a reference to this file handle). C<poll> 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
159must be a string that is either C<r> or C<w>, which creates a watcher 188C<poll> must be a string that is either C<r> or C<w>, which creates a
160waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the 189watcher waiting for "r"eadable or "w"ritable events, respectively.
190
161callback to invoke each time the file handle becomes ready. 191C<cb> is the callback to invoke each time the file handle becomes 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
298In 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
299can 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
300difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 330difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
301account. 331account.
302 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
303=back 348=back
304 349
305=head2 SIGNAL WATCHERS 350=head2 SIGNAL WATCHERS
306 351
307You 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
316invocation, and callback invocation will be synchronous. Synchronous means 361invocation, and callback invocation will be synchronous. Synchronous means
317that 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,
318but it is guaranteed not to interrupt any other callbacks. 363but it is guaranteed not to interrupt any other callbacks.
319 364
320The 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
321between multiple watchers. 366between multiple watchers, and AnyEvent will ensure that signals will not
367interrupt your program at bad times.
322 368
323This watcher might use C<%SIG>, so programs overwriting those signals 369This watcher might use C<%SIG> (depending on the event loop used),
324directly 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.
325 383
326Example: exit on SIGINT 384Example: exit on SIGINT
327 385
328 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 386 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
329 387
330=head2 CHILD PROCESS WATCHERS 388=head2 CHILD PROCESS WATCHERS
331 389
332You 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.
333 391
334The 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
335watches for any child process exit). The watcher will trigger as often 393watches for any child process exit). The watcher will triggered only when
336as 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
337signal handler for C<SIGCHLD>. The callback will be called with the pid 395any trace events (stopped/continued).
338and exit status (as returned by waitpid), so unlike other watcher types, 396
339you 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).
340 405
341There 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
342I<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
343have exited already (and no SIGCHLD will be sent anymore). 408have exited already (and no SIGCHLD will be sent anymore).
344 409
345Not 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
346event 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
347loaded 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.
348 416
349This 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
350AnyEvent 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
351C<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.
352 425
353Example: fork a process and wait for it 426Example: fork a process and wait for it
354 427
355 my $done = AnyEvent->condvar; 428 my $done = AnyEvent->condvar;
356 429
366 ); 439 );
367 440
368 # do something else, then wait for process exit 441 # do something else, then wait for process exit
369 $done->recv; 442 $done->recv;
370 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
371=head2 CONDITION VARIABLES 479=head2 CONDITION VARIABLES
372 480
373If 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
374require you to run some blocking "loop", "run" or similar function that 482require you to run some blocking "loop", "run" or similar function that
375will actively watch for new events and call your callbacks. 483will actively watch for new events and call your callbacks.
376 484
377AnyEvent is different, it expects somebody else to run the event loop and 485AnyEvent is slightly different: it expects somebody else to run the event
378will only block when necessary (usually when told by the user). 486loop and will only block when necessary (usually when told by the user).
379 487
380The instrument to do that is called a "condition variable", so called 488The instrument to do that is called a "condition variable", so called
381because 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.
382 492
383Condition variables can be created by calling the C<< AnyEvent->condvar 493Condition variables can be created by calling the C<< AnyEvent->condvar
384>> method, usually without arguments. The only argument pair allowed is 494>> method, usually without arguments. The only argument pair allowed is
385C<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
386becomes true. 496becomes true, with the condition variable as the first argument (but not
497the results).
387 498
388After creation, the condition variable is "false" until it becomes "true" 499After creation, the condition variable is "false" until it becomes "true"
389by 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
390were 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<<
391->send >> method). 502->send >> method).
437 after => 1, 548 after => 1,
438 cb => sub { $result_ready->send }, 549 cb => sub { $result_ready->send },
439 ); 550 );
440 551
441 # this "blocks" (while handling events) till the callback 552 # this "blocks" (while handling events) till the callback
442 # calls send 553 # calls -<send
443 $result_ready->recv; 554 $result_ready->recv;
444 555
445Example: wait for a timer, but take advantage of the fact that 556Example: wait for a timer, but take advantage of the fact that condition
446condition variables are also code references. 557variables are also callable directly.
447 558
448 my $done = AnyEvent->condvar; 559 my $done = AnyEvent->condvar;
449 my $delay = AnyEvent->timer (after => 5, cb => $done); 560 my $delay = AnyEvent->timer (after => 5, cb => $done);
450 $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 });
451 579
452=head3 METHODS FOR PRODUCERS 580=head3 METHODS FOR PRODUCERS
453 581
454These 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
455code/module that eventually sends the signal. Note that it is also 583code/module that eventually sends the signal. Note that it is also
468immediately from within send. 596immediately from within send.
469 597
470Any 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
471future C<< ->recv >> calls. 599future C<< ->recv >> calls.
472 600
473Condition variables are overloaded so one can call them directly 601Condition variables are overloaded so one can call them directly (as if
474(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
475C<send>. Note, however, that many C-based event loops do not handle 603C<send>.
476overloading, so as tempting as it may be, passing a condition variable
477instead of a callback does not work. Both the pure perl and EV loops
478support overloading, however, as well as all functions that use perl to
479invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
480example).
481 604
482=item $cv->croak ($error) 605=item $cv->croak ($error)
483 606
484Similar 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
485C<Carp::croak> with the given error message/object/scalar. 608C<Carp::croak> with the given error message/object/scalar.
486 609
487This can be used to signal any errors to the condition variable 610This can be used to signal any errors to the condition variable
488user/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.
489 616
490=item $cv->begin ([group callback]) 617=item $cv->begin ([group callback])
491 618
492=item $cv->end 619=item $cv->end
493
494These two methods are EXPERIMENTAL and MIGHT CHANGE.
495 620
496These two methods can be used to combine many transactions/events into 621These two methods can be used to combine many transactions/events into
497one. 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
498to use a condition variable for the whole process. 623to use a condition variable for the whole process.
499 624
501C<< ->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
502>>, 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
503is 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
504callback was set, C<send> will be called without any arguments. 629callback was set, C<send> will be called without any arguments.
505 630
506Let'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:
507 662
508 my $cv = AnyEvent->condvar; 663 my $cv = AnyEvent->condvar;
509 664
510 my %result; 665 my %result;
511 $cv->begin (sub { $cv->send (\%result) }); 666 $cv->begin (sub { $cv->send (\%result) });
531loop, which serves two important purposes: first, it sets the callback 686loop, which serves two important purposes: first, it sets the callback
532to 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
533C<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
534doesn't execute once). 689doesn't execute once).
535 690
536This is the general pattern when you "fan out" into multiple subrequests: 691This is the general pattern when you "fan out" into multiple (but
537use 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
538is 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
539C<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>.
540 696
541=back 697=back
542 698
543=head3 METHODS FOR CONSUMERS 699=head3 METHODS FOR CONSUMERS
544 700
560function will call C<croak>. 716function will call C<croak>.
561 717
562In list context, all parameters passed to C<send> will be returned, 718In list context, all parameters passed to C<send> will be returned,
563in scalar context only the first one will be returned. 719in scalar context only the first one will be returned.
564 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
565Not 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
566(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
567using 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
568caller 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
569condition variables with some kind of request results and supporting 732condition variables with some kind of request results and supporting
570callbacks so the caller knows that getting the result will not block, 733callbacks so the caller knows that getting the result will not block,
571while still supporting blocking waits if the caller so desires). 734while still supporting blocking waits if the caller so desires).
572 735
573Another reason I<never> to C<< ->recv >> in a module is that you cannot
574sensibly have two C<< ->recv >>'s in parallel, as that would require
575multiple interpreters or coroutines/threads, none of which C<AnyEvent>
576can supply.
577
578The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
579fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
580versions and also integrates coroutines into AnyEvent, making blocking
581C<< ->recv >> calls perfectly safe as long as they are done from another
582coroutine (one that doesn't run the event loop).
583
584You 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
585only calling C<< ->recv >> from within that callback (or at a later 737only calling C<< ->recv >> from within that callback (or at a later
586time). 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
587waits otherwise. 739waits otherwise.
588 740
589=item $bool = $cv->ready 741=item $bool = $cv->ready
590 742
591Returns 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
592C<croak> have been called. 744C<croak> have been called.
593 745
594=item $cb = $cv->cb ([new callback]) 746=item $cb = $cv->cb ($cb->($cv))
595 747
596This is a mutator function that returns the callback set and optionally 748This is a mutator function that returns the callback set and optionally
597replaces it before doing so. 749replaces it before doing so.
598 750
599The 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
601variable 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
602is guaranteed not to block. 754is guaranteed not to block.
603 755
604=back 756=back
605 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
606=head1 GLOBAL VARIABLES AND FUNCTIONS 825=head1 GLOBAL VARIABLES AND FUNCTIONS
607 826
827These are not normally required to use AnyEvent, but can be useful to
828write AnyEvent extension modules.
829
608=over 4 830=over 4
609 831
610=item $AnyEvent::MODEL 832=item $AnyEvent::MODEL
611 833
612Contains 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
613contains 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
614Perl class implementing the model. This class is usually one of the 838name of the Perl class implementing the model. This class is usually one
615C<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
616AnyEvent 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
617 841will be C<urxvt::anyevent>).
618The known classes so far are:
619
620 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
621 AnyEvent::Impl::Event based on Event, second best choice.
622 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
623 AnyEvent::Impl::Glib based on Glib, third-best choice.
624 AnyEvent::Impl::Tk based on Tk, very bad choice.
625 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
626 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
627 AnyEvent::Impl::POE based on POE, not generic enough for full support.
628
629There is no support for WxWidgets, as WxWidgets has no support for
630watching file handles. However, you can use WxWidgets through the
631POE Adaptor, as POE has a Wx backend that simply polls 20 times per
632second, which was considered to be too horrible to even consider for
633AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
634it's adaptor.
635
636AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
637autodetecting them.
638 842
639=item AnyEvent::detect 843=item AnyEvent::detect
640 844
641Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 845Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
642if necessary. You should only call this function right before you would 846if necessary. You should only call this function right before you would
643have 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
644runtime. 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>.
645 852
646=item $guard = AnyEvent::post_detect { BLOCK } 853=item $guard = AnyEvent::post_detect { BLOCK }
647 854
648Arranges 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
649autodetected (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.
650 868
651If 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
652that automatically removes the callback again when it is destroyed. See 870that automatically removes the callback again when it is destroyed. See
653L<Coro::BDB> for a case where this is useful. 871L<Coro::BDB> for a case where this is useful.
654 872
657If 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
658before or after loading AnyEvent), then they will called directly after 876before or after loading AnyEvent), then they will called directly after
659the event loop has been chosen. 877the event loop has been chosen.
660 878
661You should check C<$AnyEvent::MODEL> before adding to this array, though: 879You should check C<$AnyEvent::MODEL> before adding to this array, though:
662if 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
663and the array will be ignored. 881array will be ignored.
664 882
665Best 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.
666 890
667=back 891=back
668 892
669=head1 WHAT TO DO IN A MODULE 893=head1 WHAT TO DO IN A MODULE
670 894
725 949
726 950
727=head1 OTHER MODULES 951=head1 OTHER MODULES
728 952
729The following is a non-exhaustive list of additional modules that use 953The following is a non-exhaustive list of additional modules that use
730AnyEvent and can therefore be mixed easily with other AnyEvent modules 954AnyEvent as a client and can therefore be mixed easily with other AnyEvent
731in 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
732available via CPAN. 956come with AnyEvent, most are available via CPAN.
733 957
734=over 4 958=over 4
735 959
736=item L<AnyEvent::Util> 960=item L<AnyEvent::Util>
737 961
746 970
747=item L<AnyEvent::Handle> 971=item L<AnyEvent::Handle>
748 972
749Provide read and write buffers, manages watchers for reads and writes, 973Provide read and write buffers, manages watchers for reads and writes,
750supports raw and formatted I/O, I/O queued and fully transparent and 974supports raw and formatted I/O, I/O queued and fully transparent and
751non-blocking SSL/TLS. 975non-blocking SSL/TLS (via L<AnyEvent::TLS>.
752 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
784 1008
785=item L<AnyEvent::GPSD> 1009=item L<AnyEvent::GPSD>
786 1010
787A non-blocking interface to gpsd, a daemon delivering GPS information. 1011A non-blocking interface to gpsd, a daemon delivering GPS information.
788 1012
1013=item L<AnyEvent::IRC>
1014
1015AnyEvent based IRC client module family (replacing the older Net::IRC3).
1016
1017=item L<AnyEvent::XMPP>
1018
1019AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1020Net::XMPP2>.
1021
789=item L<AnyEvent::IGS> 1022=item L<AnyEvent::IGS>
790 1023
791A non-blocking interface to the Internet Go Server protocol (used by 1024A non-blocking interface to the Internet Go Server protocol (used by
792L<App::IGS>). 1025L<App::IGS>).
793 1026
794=item L<Net::IRC3>
795
796AnyEvent based IRC client module family.
797
798=item L<Net::XMPP2>
799
800AnyEvent based XMPP (Jabber protocol) module family.
801
802=item L<Net::FCP> 1027=item L<Net::FCP>
803 1028
804AnyEvent-based implementation of the Freenet Client Protocol, birthplace 1029AnyEvent-based implementation of the Freenet Client Protocol, birthplace
805of AnyEvent. 1030of AnyEvent.
806 1031
810 1035
811=item L<Coro> 1036=item L<Coro>
812 1037
813Has special support for AnyEvent via L<Coro::AnyEvent>. 1038Has special support for AnyEvent via L<Coro::AnyEvent>.
814 1039
815=item L<IO::Lambda>
816
817The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
818
819=back 1040=back
820 1041
821=cut 1042=cut
822 1043
823package AnyEvent; 1044package AnyEvent;
824 1045
1046# basically a tuned-down version of common::sense
1047sub common_sense {
825no warnings; 1048 # no warnings
826use strict; 1049 ${^WARNING_BITS} ^= ${^WARNING_BITS};
1050 # use strict vars subs
1051 $^H |= 0x00000600;
1052}
827 1053
1054BEGIN { AnyEvent::common_sense }
1055
828use Carp; 1056use Carp ();
829 1057
830our $VERSION = 4.2; 1058our $VERSION = 4.85;
831our $MODEL; 1059our $MODEL;
832 1060
833our $AUTOLOAD; 1061our $AUTOLOAD;
834our @ISA; 1062our @ISA;
835 1063
836our @REGISTRY; 1064our @REGISTRY;
837 1065
838our $WIN32; 1066our $WIN32;
839 1067
1068our $VERBOSE;
1069
840BEGIN { 1070BEGIN {
841 my $win32 = ! ! ($^O =~ /mswin32/i); 1071 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
842 eval "sub WIN32(){ $win32 }"; 1072 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
843}
844 1073
1074 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1075 if ${^TAINT};
1076
845our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1077 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1078
1079}
1080
1081our $MAX_SIGNAL_LATENCY = 10;
846 1082
847our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1083our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
848 1084
849{ 1085{
850 my $idx; 1086 my $idx;
858 [Event:: => AnyEvent::Impl::Event::], 1094 [Event:: => AnyEvent::Impl::Event::],
859 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1095 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
860 # everything below here will not be autoprobed 1096 # everything below here will not be autoprobed
861 # as the pureperl backend should work everywhere 1097 # as the pureperl backend should work everywhere
862 # and is usually faster 1098 # and is usually faster
863 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
864 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1099 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
865 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1100 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1101 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
866 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1102 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
867 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1103 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
868 [Wx:: => AnyEvent::Impl::POE::], 1104 [Wx:: => AnyEvent::Impl::POE::],
869 [Prima:: => AnyEvent::Impl::POE::], 1105 [Prima:: => AnyEvent::Impl::POE::],
1106 # IO::Async is just too broken - we would need workarounds for its
1107 # byzantine signal and broken child handling, among others.
1108 # IO::Async is rather hard to detect, as it doesn't have any
1109 # obvious default class.
1110# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1111# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1112# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
870); 1113);
871 1114
872our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); 1115our %method = map +($_ => 1),
1116 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
873 1117
874our @post_detect; 1118our @post_detect;
875 1119
876sub post_detect(&) { 1120sub post_detect(&) {
877 my ($cb) = @_; 1121 my ($cb) = @_;
882 1 1126 1
883 } else { 1127 } else {
884 push @post_detect, $cb; 1128 push @post_detect, $cb;
885 1129
886 defined wantarray 1130 defined wantarray
887 ? bless \$cb, "AnyEvent::Util::PostDetect" 1131 ? bless \$cb, "AnyEvent::Util::postdetect"
888 : () 1132 : ()
889 } 1133 }
890} 1134}
891 1135
892sub AnyEvent::Util::PostDetect::DESTROY { 1136sub AnyEvent::Util::postdetect::DESTROY {
893 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1137 @post_detect = grep $_ != ${$_[0]}, @post_detect;
894} 1138}
895 1139
896sub detect() { 1140sub detect() {
897 unless ($MODEL) { 1141 unless ($MODEL) {
898 no strict 'refs';
899 local $SIG{__DIE__}; 1142 local $SIG{__DIE__};
900 1143
901 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1144 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
902 my $model = "AnyEvent::Impl::$1"; 1145 my $model = "AnyEvent::Impl::$1";
903 if (eval "require $model") { 1146 if (eval "require $model") {
904 $MODEL = $model; 1147 $MODEL = $model;
905 warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; 1148 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
906 } else { 1149 } else {
907 warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; 1150 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
908 } 1151 }
909 } 1152 }
910 1153
911 # check for already loaded models 1154 # check for already loaded models
912 unless ($MODEL) { 1155 unless ($MODEL) {
913 for (@REGISTRY, @models) { 1156 for (@REGISTRY, @models) {
914 my ($package, $model) = @$_; 1157 my ($package, $model) = @$_;
915 if (${"$package\::VERSION"} > 0) { 1158 if (${"$package\::VERSION"} > 0) {
916 if (eval "require $model") { 1159 if (eval "require $model") {
917 $MODEL = $model; 1160 $MODEL = $model;
918 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; 1161 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
919 last; 1162 last;
920 } 1163 }
921 } 1164 }
922 } 1165 }
923 1166
928 my ($package, $model) = @$_; 1171 my ($package, $model) = @$_;
929 if (eval "require $package" 1172 if (eval "require $package"
930 and ${"$package\::VERSION"} > 0 1173 and ${"$package\::VERSION"} > 0
931 and eval "require $model") { 1174 and eval "require $model") {
932 $MODEL = $model; 1175 $MODEL = $model;
933 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; 1176 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
934 last; 1177 last;
935 } 1178 }
936 } 1179 }
937 1180
938 $MODEL 1181 $MODEL
939 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 1182 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
940 } 1183 }
941 } 1184 }
942 1185
943 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1186 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
944 1187
945 if ($ENV{PERL_ANYEVENT_STRICT}) {
946 unshift @AnyEvent::Base::Strict::ISA, $MODEL;
947 unshift @ISA, AnyEvent::Base::Strict::
948 } else {
949 unshift @ISA, $MODEL; 1188 unshift @ISA, $MODEL;
950 } 1189
1190 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
951 1191
952 (shift @post_detect)->() while @post_detect; 1192 (shift @post_detect)->() while @post_detect;
953 } 1193 }
954 1194
955 $MODEL 1195 $MODEL
957 1197
958sub AUTOLOAD { 1198sub AUTOLOAD {
959 (my $func = $AUTOLOAD) =~ s/.*://; 1199 (my $func = $AUTOLOAD) =~ s/.*://;
960 1200
961 $method{$func} 1201 $method{$func}
962 or croak "$func: not a valid method for AnyEvent objects"; 1202 or Carp::croak "$func: not a valid method for AnyEvent objects";
963 1203
964 detect unless $MODEL; 1204 detect unless $MODEL;
965 1205
966 my $class = shift; 1206 my $class = shift;
967 $class->$func (@_); 1207 $class->$func (@_);
968} 1208}
969 1209
1210# utility function to dup a filehandle. this is used by many backends
1211# to support binding more than one watcher per filehandle (they usually
1212# allow only one watcher per fd, so we dup it to get a different one).
1213sub _dupfh($$;$$) {
1214 my ($poll, $fh, $r, $w) = @_;
1215
1216 # cygwin requires the fh mode to be matching, unix doesn't
1217 my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1218
1219 open my $fh2, $mode, $fh
1220 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1221
1222 # we assume CLOEXEC is already set by perl in all important cases
1223
1224 ($fh2, $rw)
1225}
1226
970package AnyEvent::Base; 1227package AnyEvent::Base;
971 1228
972# default implementation for now and time 1229# default implementations for many methods
973 1230
974use Time::HiRes (); 1231sub _time {
1232 # probe for availability of Time::HiRes
1233 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1234 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1235 *_time = \&Time::HiRes::time;
1236 # if (eval "use POSIX (); (POSIX::times())...
1237 } else {
1238 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1239 *_time = sub { time }; # epic fail
1240 }
975 1241
976sub time { Time::HiRes::time } 1242 &_time
977sub now { Time::HiRes::time } 1243}
1244
1245sub time { _time }
1246sub now { _time }
1247sub now_update { }
978 1248
979# default implementation for ->condvar 1249# default implementation for ->condvar
980 1250
981sub condvar { 1251sub condvar {
982 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1252 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
983} 1253}
984 1254
985# default implementation for ->signal 1255# default implementation for ->signal
986 1256
987our %SIG_CB; 1257our $HAVE_ASYNC_INTERRUPT;
1258our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1259our (%SIG_ASY, %SIG_ASY_W);
1260our ($SIG_COUNT, $SIG_TW);
988 1261
1262sub _signal_exec {
1263 $HAVE_ASYNC_INTERRUPT
1264 ? $SIGPIPE_R->drain
1265 : sysread $SIGPIPE_R, my $dummy, 9;
1266
1267 while (%SIG_EV) {
1268 for (keys %SIG_EV) {
1269 delete $SIG_EV{$_};
1270 $_->() for values %{ $SIG_CB{$_} || {} };
1271 }
1272 }
1273}
1274
1275# install a dumym wakeupw atcher to reduce signal catching latency
1276sub _sig_add() {
1277 unless ($SIG_COUNT++) {
1278 # try to align timer on a full-second boundary, if possible
1279 my $NOW = AnyEvent->now;
1280
1281 $SIG_TW = AnyEvent->timer (
1282 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1283 interval => $MAX_SIGNAL_LATENCY,
1284 cb => sub { }, # just for the PERL_ASYNC_CHECK
1285 );
1286 }
1287}
1288
1289sub _sig_del {
1290 undef $SIG_TW
1291 unless --$SIG_COUNT;
1292}
1293
989sub signal { 1294sub _signal {
990 my (undef, %arg) = @_; 1295 my (undef, %arg) = @_;
991 1296
992 my $signal = uc $arg{signal} 1297 my $signal = uc $arg{signal}
993 or Carp::croak "required option 'signal' is missing"; 1298 or Carp::croak "required option 'signal' is missing";
994 1299
995 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1300 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1301
1302 if ($HAVE_ASYNC_INTERRUPT) {
1303 # async::interrupt
1304
1305 $SIG_ASY{$signal} ||= do {
1306 my $asy = new Async::Interrupt
1307 cb => sub { undef $SIG_EV{$signal} },
1308 signal => $signal,
1309 pipe => [$SIGPIPE_R->filenos],
1310 ;
1311 $asy->pipe_autodrain (0);
1312
1313 $asy
1314 };
1315
1316 } else {
1317 # pure perl
1318
996 $SIG{$signal} ||= sub { 1319 $SIG{$signal} ||= sub {
997 $_->() for values %{ $SIG_CB{$signal} || {} }; 1320 local $!;
1321 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1322 undef $SIG_EV{$signal};
1323 };
1324
1325 # can't do signal processing without introducing races in pure perl,
1326 # so limit the signal latency.
1327 _sig_add;
998 }; 1328 }
999 1329
1000 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1330 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1001} 1331}
1002 1332
1333sub signal {
1334 # probe for availability of Async::Interrupt
1335 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1336 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1337
1338 $HAVE_ASYNC_INTERRUPT = 1;
1339 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1340 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1341
1342 } else {
1343 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1344
1345 require Fcntl;
1346
1347 if (AnyEvent::WIN32) {
1348 require AnyEvent::Util;
1349
1350 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1351 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1352 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1353 } else {
1354 pipe $SIGPIPE_R, $SIGPIPE_W;
1355 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1356 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1357
1358 # not strictly required, as $^F is normally 2, but let's make sure...
1359 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1360 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1361 }
1362
1363 $SIGPIPE_R
1364 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1365
1366 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1367 }
1368
1369 *signal = \&_signal;
1370 &signal
1371}
1372
1003sub AnyEvent::Base::Signal::DESTROY { 1373sub AnyEvent::Base::signal::DESTROY {
1004 my ($signal, $cb) = @{$_[0]}; 1374 my ($signal, $cb) = @{$_[0]};
1005 1375
1376 _sig_del;
1377
1006 delete $SIG_CB{$signal}{$cb}; 1378 delete $SIG_CB{$signal}{$cb};
1007 1379
1380 $HAVE_ASYNC_INTERRUPT
1381 ? delete $SIG_ASY{$signal}
1382 : # delete doesn't work with older perls - they then
1383 # print weird messages, or just unconditionally exit
1384 # instead of getting the default action.
1385 undef $SIG{$signal}
1008 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; 1386 unless keys %{ $SIG_CB{$signal} };
1009} 1387}
1010 1388
1011# default implementation for ->child 1389# default implementation for ->child
1012 1390
1013our %PID_CB; 1391our %PID_CB;
1014our $CHLD_W; 1392our $CHLD_W;
1015our $CHLD_DELAY_W; 1393our $CHLD_DELAY_W;
1016our $PID_IDLE;
1017our $WNOHANG; 1394our $WNOHANG;
1018 1395
1019sub _child_wait { 1396sub _sigchld {
1020 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1397 while (0 < (my $pid = waitpid -1, $WNOHANG)) {
1398 $_->($pid, $?)
1021 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1399 for values %{ $PID_CB{$pid} || {} },
1022 (values %{ $PID_CB{0} || {} }); 1400 values %{ $PID_CB{0} || {} };
1023 } 1401 }
1024
1025 undef $PID_IDLE;
1026}
1027
1028sub _sigchld {
1029 # make sure we deliver these changes "synchronous" with the event loop.
1030 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1031 undef $CHLD_DELAY_W;
1032 &_child_wait;
1033 });
1034} 1402}
1035 1403
1036sub child { 1404sub child {
1037 my (undef, %arg) = @_; 1405 my (undef, %arg) = @_;
1038 1406
1039 defined (my $pid = $arg{pid} + 0) 1407 defined (my $pid = $arg{pid} + 0)
1040 or Carp::croak "required option 'pid' is missing"; 1408 or Carp::croak "required option 'pid' is missing";
1041 1409
1042 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1410 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1043 1411
1044 unless ($WNOHANG) { 1412 # WNOHANG is almost cetrainly 1 everywhere
1413 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1414 ? 1
1045 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1415 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1046 }
1047 1416
1048 unless ($CHLD_W) { 1417 unless ($CHLD_W) {
1049 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1418 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1050 # child could be a zombie already, so make at least one round 1419 # child could be a zombie already, so make at least one round
1051 &_sigchld; 1420 &_sigchld;
1052 } 1421 }
1053 1422
1054 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1423 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1055} 1424}
1056 1425
1057sub AnyEvent::Base::Child::DESTROY { 1426sub AnyEvent::Base::child::DESTROY {
1058 my ($pid, $cb) = @{$_[0]}; 1427 my ($pid, $cb) = @{$_[0]};
1059 1428
1060 delete $PID_CB{$pid}{$cb}; 1429 delete $PID_CB{$pid}{$cb};
1061 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1430 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1062 1431
1063 undef $CHLD_W unless keys %PID_CB; 1432 undef $CHLD_W unless keys %PID_CB;
1064} 1433}
1065 1434
1435# idle emulation is done by simply using a timer, regardless
1436# of whether the process is idle or not, and not letting
1437# the callback use more than 50% of the time.
1438sub idle {
1439 my (undef, %arg) = @_;
1440
1441 my ($cb, $w, $rcb) = $arg{cb};
1442
1443 $rcb = sub {
1444 if ($cb) {
1445 $w = _time;
1446 &$cb;
1447 $w = _time - $w;
1448
1449 # never use more then 50% of the time for the idle watcher,
1450 # within some limits
1451 $w = 0.0001 if $w < 0.0001;
1452 $w = 5 if $w > 5;
1453
1454 $w = AnyEvent->timer (after => $w, cb => $rcb);
1455 } else {
1456 # clean up...
1457 undef $w;
1458 undef $rcb;
1459 }
1460 };
1461
1462 $w = AnyEvent->timer (after => 0.05, cb => $rcb);
1463
1464 bless \\$cb, "AnyEvent::Base::idle"
1465}
1466
1467sub AnyEvent::Base::idle::DESTROY {
1468 undef $${$_[0]};
1469}
1470
1066package AnyEvent::CondVar; 1471package AnyEvent::CondVar;
1067 1472
1068our @ISA = AnyEvent::CondVar::Base::; 1473our @ISA = AnyEvent::CondVar::Base::;
1069 1474
1070package AnyEvent::CondVar::Base; 1475package AnyEvent::CondVar::Base;
1071 1476
1072use overload 1477#use overload
1073 '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1478# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1074 fallback => 1; 1479# fallback => 1;
1480
1481# save 300+ kilobytes by dirtily hardcoding overloading
1482${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
1483*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
1484*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
1485${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1486
1487our $WAITING;
1075 1488
1076sub _send { 1489sub _send {
1077 # nop 1490 # nop
1078} 1491}
1079 1492
1092sub ready { 1505sub ready {
1093 $_[0]{_ae_sent} 1506 $_[0]{_ae_sent}
1094} 1507}
1095 1508
1096sub _wait { 1509sub _wait {
1510 $WAITING
1511 and !$_[0]{_ae_sent}
1512 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1513
1514 local $WAITING = 1;
1097 AnyEvent->one_event while !$_[0]{_ae_sent}; 1515 AnyEvent->one_event while !$_[0]{_ae_sent};
1098} 1516}
1099 1517
1100sub recv { 1518sub recv {
1101 $_[0]->_wait; 1519 $_[0]->_wait;
1121 1539
1122# undocumented/compatibility with pre-3.4 1540# undocumented/compatibility with pre-3.4
1123*broadcast = \&send; 1541*broadcast = \&send;
1124*wait = \&_wait; 1542*wait = \&_wait;
1125 1543
1126package AnyEvent::Base::Strict; 1544=head1 ERROR AND EXCEPTION HANDLING
1127 1545
1128use Carp qw(croak); 1546In general, AnyEvent does not do any error handling - it relies on the
1547caller to do that if required. The L<AnyEvent::Strict> module (see also
1548the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
1549checking of all AnyEvent methods, however, which is highly useful during
1550development.
1129 1551
1130# supply checks for argument validity for many functions 1552As for exception handling (i.e. runtime errors and exceptions thrown while
1553executing a callback), this is not only highly event-loop specific, but
1554also not in any way wrapped by this module, as this is the job of the main
1555program.
1131 1556
1132sub io { 1557The pure perl event loop simply re-throws the exception (usually
1133 my $class = shift; 1558within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
1134 my %arg = @_; 1559$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1560so on.
1135 1561
1136 ref $arg{cb} 1562=head1 ENVIRONMENT VARIABLES
1137 or croak "AnyEvent->io called with illegal cb argument '$arg{cb}'";
1138 delete $arg{cb};
1139
1140 fileno $arg{fh}
1141 or croak "AnyEvent->io called with illegal fh argument '$arg{fh}'";
1142 delete $arg{fh};
1143
1144 $arg{poll} =~ /^[rw]$/
1145 or croak "AnyEvent->io called with illegal poll argument '$arg{poll}'";
1146 delete $arg{poll};
1147
1148 croak "AnyEvent->io called with unsupported parameter(s) " . join ", ", keys %arg
1149 if keys %arg;
1150 1563
1151 $class->SUPER::io (@_) 1564The following environment variables are used by this module or its
1152} 1565submodules.
1153 1566
1154sub timer { 1567Note that AnyEvent will remove I<all> environment variables starting with
1155 my $class = shift; 1568C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
1156 my %arg = @_; 1569enabled.
1157 1570
1158 ref $arg{cb} 1571=over 4
1159 or croak "AnyEvent->timer called with illegal cb argument '$arg{cb}'";
1160 delete $arg{cb};
1161
1162 exists $arg{after}
1163 or croak "AnyEvent->timer called without mandatory 'after' parameter";
1164 delete $arg{after};
1165
1166 $arg{interval} > 0 || !$arg{interval}
1167 or croak "AnyEvent->timer called with illegal interval argument '$arg{interval}'";
1168 delete $arg{interval};
1169
1170 croak "AnyEvent->timer called with unsupported parameter(s) " . join ", ", keys %arg
1171 if keys %arg;
1172 1572
1173 $class->SUPER::timer (@_) 1573=item C<PERL_ANYEVENT_VERBOSE>
1174}
1175 1574
1176sub signal { 1575By default, AnyEvent will be completely silent except in fatal
1177 my $class = shift; 1576conditions. You can set this environment variable to make AnyEvent more
1178 my %arg = @_; 1577talkative.
1179 1578
1180 ref $arg{cb} 1579When set to C<1> or higher, causes AnyEvent to warn about unexpected
1181 or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'"; 1580conditions, such as not being able to load the event model specified by
1182 delete $arg{cb}; 1581C<PERL_ANYEVENT_MODEL>.
1183
1184 eval "require POSIX; defined &POSIX::SIG$arg{signal}"
1185 or croak "AnyEvent->signal called with illegal signal name '$arg{signal}'";
1186 delete $arg{signal};
1187
1188 croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg
1189 if keys %arg;
1190 1582
1191 $class->SUPER::signal (@_) 1583When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1192} 1584model it chooses.
1193 1585
1194sub child { 1586When set to C<8> or higher, then AnyEvent will report extra information on
1195 my $class = shift; 1587which optional modules it loads and how it implements certain features.
1196 my %arg = @_;
1197 1588
1198 ref $arg{cb} 1589=item C<PERL_ANYEVENT_STRICT>
1199 or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'";
1200 delete $arg{cb};
1201
1202 $arg{pid} =~ /^-?\d+$/
1203 or croak "AnyEvent->signal called with illegal pid value '$arg{pid}'";
1204 delete $arg{pid};
1205
1206 croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg
1207 if keys %arg;
1208 1590
1209 $class->SUPER::child (@_) 1591AnyEvent does not do much argument checking by default, as thorough
1210} 1592argument checking is very costly. Setting this variable to a true value
1593will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1594check the arguments passed to most method calls. If it finds any problems,
1595it will croak.
1211 1596
1212sub condvar { 1597In other words, enables "strict" mode.
1213 my $class = shift;
1214 my %arg = @_;
1215 1598
1216 !exists $arg{cb} or ref $arg{cb} 1599Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1217 or croak "AnyEvent->condvar called with illegal cb argument '$arg{cb}'"; 1600>>, it is definitely recommended to keep it off in production. Keeping
1218 delete $arg{cb}; 1601C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1219 1602can be very useful, however.
1220 croak "AnyEvent->condvar called with unsupported parameter(s) " . join ", ", keys %arg
1221 if keys %arg;
1222 1603
1223 $class->SUPER::condvar (@_) 1604=item C<PERL_ANYEVENT_MODEL>
1224}
1225 1605
1226sub time { 1606This can be used to specify the event model to be used by AnyEvent, before
1227 my $class = shift; 1607auto detection and -probing kicks in. It must be a string consisting
1608entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1609and the resulting module name is loaded and if the load was successful,
1610used as event model. If it fails to load AnyEvent will proceed with
1611auto detection and -probing.
1228 1612
1229 @_ 1613This functionality might change in future versions.
1230 and croak "AnyEvent->time wrongly called with paramaters";
1231 1614
1232 $class->SUPER::time (@_) 1615For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1233} 1616could start your program like this:
1234 1617
1235sub now { 1618 PERL_ANYEVENT_MODEL=Perl perl ...
1236 my $class = shift;
1237 1619
1238 @_ 1620=item C<PERL_ANYEVENT_PROTOCOLS>
1239 and croak "AnyEvent->now wrongly called with paramaters";
1240 1621
1241 $class->SUPER::now (@_) 1622Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1242} 1623for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1624of auto probing).
1625
1626Must be set to a comma-separated list of protocols or address families,
1627current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1628used, and preference will be given to protocols mentioned earlier in the
1629list.
1630
1631This variable can effectively be used for denial-of-service attacks
1632against local programs (e.g. when setuid), although the impact is likely
1633small, as the program has to handle conenction and other failures anyways.
1634
1635Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1636but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1637- only support IPv4, never try to resolve or contact IPv6
1638addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1639IPv6, but prefer IPv6 over IPv4.
1640
1641=item C<PERL_ANYEVENT_EDNS0>
1642
1643Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1644for DNS. This extension is generally useful to reduce DNS traffic, but
1645some (broken) firewalls drop such DNS packets, which is why it is off by
1646default.
1647
1648Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1649EDNS0 in its DNS requests.
1650
1651=item C<PERL_ANYEVENT_MAX_FORKS>
1652
1653The maximum number of child processes that C<AnyEvent::Util::fork_call>
1654will create in parallel.
1655
1656=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1657
1658The default value for the C<max_outstanding> parameter for the default DNS
1659resolver - this is the maximum number of parallel DNS requests that are
1660sent to the DNS server.
1661
1662=item C<PERL_ANYEVENT_RESOLV_CONF>
1663
1664The file to use instead of F</etc/resolv.conf> (or OS-specific
1665configuration) in the default resolver. When set to the empty string, no
1666default config will be used.
1667
1668=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1669
1670When neither C<ca_file> nor C<ca_path> was specified during
1671L<AnyEvent::TLS> context creation, and either of these environment
1672variables exist, they will be used to specify CA certificate locations
1673instead of a system-dependent default.
1674
1675=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1676
1677When these are set to C<1>, then the respective modules are not
1678loaded. Mostly good for testing AnyEvent itself.
1679
1680=back
1243 1681
1244=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1682=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1245 1683
1246This is an advanced topic that you do not normally need to use AnyEvent in 1684This is an advanced topic that you do not normally need to use AnyEvent in
1247a module. This section is only of use to event loop authors who want to 1685a module. This section is only of use to event loop authors who want to
1281 1719
1282I<rxvt-unicode> also cheats a bit by not providing blocking access to 1720I<rxvt-unicode> also cheats a bit by not providing blocking access to
1283condition variables: code blocking while waiting for a condition will 1721condition variables: code blocking while waiting for a condition will
1284C<die>. This still works with most modules/usages, and blocking calls must 1722C<die>. This still works with most modules/usages, and blocking calls must
1285not be done in an interactive application, so it makes sense. 1723not be done in an interactive application, so it makes sense.
1286
1287=head1 ENVIRONMENT VARIABLES
1288
1289The following environment variables are used by this module:
1290
1291=over 4
1292
1293=item C<PERL_ANYEVENT_VERBOSE>
1294
1295By default, AnyEvent will be completely silent except in fatal
1296conditions. You can set this environment variable to make AnyEvent more
1297talkative.
1298
1299When set to C<1> or higher, causes AnyEvent to warn about unexpected
1300conditions, such as not being able to load the event model specified by
1301C<PERL_ANYEVENT_MODEL>.
1302
1303When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1304model it chooses.
1305
1306=item C<PERL_ANYEVENT_STRICT>
1307
1308AnyEvent does not do much argument checking by default, as thorough
1309argument checking is very costly. Setting this variable to a true value
1310will cause AnyEvent to thoroughly check the arguments passed to most
1311method calls and croaks if it finds any problems. In other words, enables
1312"strict" mode. Unlike C<use strict> it is definitely recommended ot keep
1313it off in production.
1314
1315=item C<PERL_ANYEVENT_MODEL>
1316
1317This can be used to specify the event model to be used by AnyEvent, before
1318auto detection and -probing kicks in. It must be a string consisting
1319entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1320and the resulting module name is loaded and if the load was successful,
1321used as event model. If it fails to load AnyEvent will proceed with
1322auto detection and -probing.
1323
1324This functionality might change in future versions.
1325
1326For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1327could start your program like this:
1328
1329 PERL_ANYEVENT_MODEL=Perl perl ...
1330
1331=item C<PERL_ANYEVENT_PROTOCOLS>
1332
1333Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1334for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1335of auto probing).
1336
1337Must be set to a comma-separated list of protocols or address families,
1338current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1339used, and preference will be given to protocols mentioned earlier in the
1340list.
1341
1342This variable can effectively be used for denial-of-service attacks
1343against local programs (e.g. when setuid), although the impact is likely
1344small, as the program has to handle connection errors already-
1345
1346Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1347but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1348- only support IPv4, never try to resolve or contact IPv6
1349addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1350IPv6, but prefer IPv6 over IPv4.
1351
1352=item C<PERL_ANYEVENT_EDNS0>
1353
1354Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1355for DNS. This extension is generally useful to reduce DNS traffic, but
1356some (broken) firewalls drop such DNS packets, which is why it is off by
1357default.
1358
1359Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1360EDNS0 in its DNS requests.
1361
1362=item C<PERL_ANYEVENT_MAX_FORKS>
1363
1364The maximum number of child processes that C<AnyEvent::Util::fork_call>
1365will create in parallel.
1366
1367=back
1368 1724
1369=head1 EXAMPLE PROGRAM 1725=head1 EXAMPLE PROGRAM
1370 1726
1371The following program uses an I/O watcher to read data from STDIN, a timer 1727The following program uses an I/O watcher to read data from STDIN, a timer
1372to display a message once per second, and a condition variable to quit the 1728to display a message once per second, and a condition variable to quit the
1566watcher. 1922watcher.
1567 1923
1568=head3 Results 1924=head3 Results
1569 1925
1570 name watchers bytes create invoke destroy comment 1926 name watchers bytes create invoke destroy comment
1571 EV/EV 400000 244 0.56 0.46 0.31 EV native interface 1927 EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1572 EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers 1928 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1573 CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal 1929 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1574 Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation 1930 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1575 Event/Event 16000 516 31.88 31.30 0.85 Event native interface 1931 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1576 Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers 1932 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1933 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
1934 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1577 Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour 1935 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1578 Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers 1936 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1579 POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event 1937 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1580 POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select 1938 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1581 1939
1582=head3 Discussion 1940=head3 Discussion
1583 1941
1584The benchmark does I<not> measure scalability of the event loop very 1942The benchmark does I<not> measure scalability of the event loop very
1585well. For example, a select-based event loop (such as the pure perl one) 1943well. For example, a select-based event loop (such as the pure perl one)
1610performance becomes really bad with lots of file descriptors (and few of 1968performance becomes really bad with lots of file descriptors (and few of
1611them active), of course, but this was not subject of this benchmark. 1969them active), of course, but this was not subject of this benchmark.
1612 1970
1613The C<Event> module has a relatively high setup and callback invocation 1971The C<Event> module has a relatively high setup and callback invocation
1614cost, but overall scores in on the third place. 1972cost, but overall scores in on the third place.
1973
1974C<IO::Async> performs admirably well, about on par with C<Event>, even
1975when using its pure perl backend.
1615 1976
1616C<Glib>'s memory usage is quite a bit higher, but it features a 1977C<Glib>'s memory usage is quite a bit higher, but it features a
1617faster callback invocation and overall ends up in the same class as 1978faster callback invocation and overall ends up in the same class as
1618C<Event>. However, Glib scales extremely badly, doubling the number of 1979C<Event>. However, Glib scales extremely badly, doubling the number of
1619watchers increases the processing time by more than a factor of four, 1980watchers increases the processing time by more than a factor of four,
1697it to another server. This includes deleting the old timeout and creating 2058it to another server. This includes deleting the old timeout and creating
1698a new one that moves the timeout into the future. 2059a new one that moves the timeout into the future.
1699 2060
1700=head3 Results 2061=head3 Results
1701 2062
1702 name sockets create request 2063 name sockets create request
1703 EV 20000 69.01 11.16 2064 EV 20000 69.01 11.16
1704 Perl 20000 73.32 35.87 2065 Perl 20000 73.32 35.87
2066 IOAsync 20000 157.00 98.14 epoll
2067 IOAsync 20000 159.31 616.06 poll
1705 Event 20000 212.62 257.32 2068 Event 20000 212.62 257.32
1706 Glib 20000 651.16 1896.30 2069 Glib 20000 651.16 1896.30
1707 POE 20000 349.67 12317.24 uses POE::Loop::Event 2070 POE 20000 349.67 12317.24 uses POE::Loop::Event
1708 2071
1709=head3 Discussion 2072=head3 Discussion
1710 2073
1711This benchmark I<does> measure scalability and overall performance of the 2074This benchmark I<does> measure scalability and overall performance of the
1712particular event loop. 2075particular event loop.
1714EV is again fastest. Since it is using epoll on my system, the setup time 2077EV is again fastest. Since it is using epoll on my system, the setup time
1715is relatively high, though. 2078is relatively high, though.
1716 2079
1717Perl surprisingly comes second. It is much faster than the C-based event 2080Perl surprisingly comes second. It is much faster than the C-based event
1718loops Event and Glib. 2081loops Event and Glib.
2082
2083IO::Async performs very well when using its epoll backend, and still quite
2084good compared to Glib when using its pure perl backend.
1719 2085
1720Event suffers from high setup time as well (look at its code and you will 2086Event suffers from high setup time as well (look at its code and you will
1721understand why). Callback invocation also has a high overhead compared to 2087understand why). Callback invocation also has a high overhead compared to
1722the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 2088the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1723uses select or poll in basically all documented configurations. 2089uses select or poll in basically all documented configurations.
1786=item * C-based event loops perform very well with small number of 2152=item * C-based event loops perform very well with small number of
1787watchers, as the management overhead dominates. 2153watchers, as the management overhead dominates.
1788 2154
1789=back 2155=back
1790 2156
2157=head2 THE IO::Lambda BENCHMARK
2158
2159Recently I was told about the benchmark in the IO::Lambda manpage, which
2160could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
2161simply compares IO::Lambda with POE, and IO::Lambda looks better (which
2162shouldn't come as a surprise to anybody). As such, the benchmark is
2163fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
2164very optimal. But how would AnyEvent compare when used without the extra
2165baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
2166
2167The benchmark itself creates an echo-server, and then, for 500 times,
2168connects to the echo server, sends a line, waits for the reply, and then
2169creates the next connection. This is a rather bad benchmark, as it doesn't
2170test the efficiency of the framework or much non-blocking I/O, but it is a
2171benchmark nevertheless.
2172
2173 name runtime
2174 Lambda/select 0.330 sec
2175 + optimized 0.122 sec
2176 Lambda/AnyEvent 0.327 sec
2177 + optimized 0.138 sec
2178 Raw sockets/select 0.077 sec
2179 POE/select, components 0.662 sec
2180 POE/select, raw sockets 0.226 sec
2181 POE/select, optimized 0.404 sec
2182
2183 AnyEvent/select/nb 0.085 sec
2184 AnyEvent/EV/nb 0.068 sec
2185 +state machine 0.134 sec
2186
2187The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
2188benchmarks actually make blocking connects and use 100% blocking I/O,
2189defeating the purpose of an event-based solution. All of the newly
2190written AnyEvent benchmarks use 100% non-blocking connects (using
2191AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
2192resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
2193generally require a lot more bookkeeping and event handling than blocking
2194connects (which involve a single syscall only).
2195
2196The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
2197offers similar expressive power as POE and IO::Lambda, using conventional
2198Perl syntax. This means that both the echo server and the client are 100%
2199non-blocking, further placing it at a disadvantage.
2200
2201As you can see, the AnyEvent + EV combination even beats the
2202hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2203backend easily beats IO::Lambda and POE.
2204
2205And even the 100% non-blocking version written using the high-level (and
2206slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
2207large margin, even though it does all of DNS, tcp-connect and socket I/O
2208in a non-blocking way.
2209
2210The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2211F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2212part of the IO::lambda distribution and were used without any changes.
2213
2214
2215=head1 SIGNALS
2216
2217AnyEvent currently installs handlers for these signals:
2218
2219=over 4
2220
2221=item SIGCHLD
2222
2223A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2224emulation for event loops that do not support them natively. Also, some
2225event loops install a similar handler.
2226
2227Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2228AnyEvent will reset it to default, to avoid losing child exit statuses.
2229
2230=item SIGPIPE
2231
2232A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2233when AnyEvent gets loaded.
2234
2235The rationale for this is that AnyEvent users usually do not really depend
2236on SIGPIPE delivery (which is purely an optimisation for shell use, or
2237badly-written programs), but C<SIGPIPE> can cause spurious and rare
2238program exits as a lot of people do not expect C<SIGPIPE> when writing to
2239some random socket.
2240
2241The rationale for installing a no-op handler as opposed to ignoring it is
2242that this way, the handler will be restored to defaults on exec.
2243
2244Feel free to install your own handler, or reset it to defaults.
2245
2246=back
2247
2248=cut
2249
2250undef $SIG{CHLD}
2251 if $SIG{CHLD} eq 'IGNORE';
2252
2253$SIG{PIPE} = sub { }
2254 unless defined $SIG{PIPE};
2255
2256=head1 RECOMMENDED/OPTIONAL MODULES
2257
2258One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2259it's built-in modules) are required to use it.
2260
2261That does not mean that AnyEvent won't take advantage of some additional
2262modules if they are installed.
2263
2264This section epxlains which additional modules will be used, and how they
2265affect AnyEvent's operetion.
2266
2267=over 4
2268
2269=item L<Async::Interrupt>
2270
2271This slightly arcane module is used to implement fast signal handling: To
2272my knowledge, there is no way to do completely race-free and quick
2273signal handling in pure perl. To ensure that signals still get
2274delivered, AnyEvent will start an interval timer to wake up perl (and
2275catch the signals) with soemd elay (default is 10 seconds, look for
2276C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2277
2278If this module is available, then it will be used to implement signal
2279catching, which means that signals will not be delayed, and the event loop
2280will not be interrupted regularly, which is more efficient (And good for
2281battery life on laptops).
2282
2283This affects not just the pure-perl event loop, but also other event loops
2284that have no signal handling on their own (e.g. Glib, Tk, Qt).
2285
2286=item L<EV>
2287
2288This module isn't really "optional", as it is simply one of the backend
2289event loops that AnyEvent can use. However, it is simply the best event
2290loop available in terms of features, speed and stability: It supports
2291the AnyEvent API optimally, implements all the watcher types in XS, does
2292automatic timer adjustments even when no monotonic clock is available,
2293can take avdantage of advanced kernel interfaces such as C<epoll> and
2294C<kqueue>, and is the fastest backend I<by far>. You can even embed
2295L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2296
2297=item L<Guard>
2298
2299The guard module, when used, will be used to implement
2300C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2301lot less memory), but otherwise doesn't affect guard operation much. It is
2302purely used for performance.
2303
2304=item L<JSON> and L<JSON::XS>
2305
2306This module is required when you want to read or write JSON data via
2307L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2308advantage of the ulta-high-speed L<JSON::XS> module when it is installed.
2309
2310In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2311installed.
2312
2313=item L<Net::SSLeay>
2314
2315Implementing TLS/SSL in Perl is certainly interesting, but not very
2316worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2317the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2318
2319=item L<Time::HiRes>
2320
2321This module is part of perl since release 5.008. It will be used when the
2322chosen event library does not come with a timing source on it's own. The
2323pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2324try to use a monotonic clock for timing stability.
2325
2326=back
2327
1791 2328
1792=head1 FORK 2329=head1 FORK
1793 2330
1794Most event libraries are not fork-safe. The ones who are usually are 2331Most event libraries are not fork-safe. The ones who are usually are
1795because they rely on inefficient but fork-safe C<select> or C<poll> 2332because they rely on inefficient but fork-safe C<select> or C<poll>
1796calls. Only L<EV> is fully fork-aware. 2333calls. Only L<EV> is fully fork-aware.
1797 2334
1798If you have to fork, you must either do so I<before> creating your first 2335If you have to fork, you must either do so I<before> creating your first
1799watcher OR you must not use AnyEvent at all in the child. 2336watcher OR you must not use AnyEvent at all in the child OR you must do
2337something completely out of the scope of AnyEvent.
1800 2338
1801 2339
1802=head1 SECURITY CONSIDERATIONS 2340=head1 SECURITY CONSIDERATIONS
1803 2341
1804AnyEvent can be forced to load any event model via 2342AnyEvent can be forced to load any event model via
1816 use AnyEvent; 2354 use AnyEvent;
1817 2355
1818Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2356Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1819be used to probe what backend is used and gain other information (which is 2357be used to probe what backend is used and gain other information (which is
1820probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and 2358probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1821$ENV{PERL_ANYEGENT_STRICT}. 2359$ENV{PERL_ANYEVENT_STRICT}.
2360
2361Note that AnyEvent will remove I<all> environment variables starting with
2362C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2363enabled.
1822 2364
1823 2365
1824=head1 BUGS 2366=head1 BUGS
1825 2367
1826Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 2368Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1827to work around. If you suffer from memleaks, first upgrade to Perl 5.10 2369to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1828and check wether the leaks still show up. (Perl 5.10.0 has other annoying 2370and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1829mamleaks, such as leaking on C<map> and C<grep> but it is usually not as 2371memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1830pronounced). 2372pronounced).
1831 2373
1832 2374
1833=head1 SEE ALSO 2375=head1 SEE ALSO
1834 2376
1838L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2380L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1839 2381
1840Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2382Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1841L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2383L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1842L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2384L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1843L<AnyEvent::Impl::POE>. 2385L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.
1844 2386
1845Non-blocking file handles, sockets, TCP clients and 2387Non-blocking file handles, sockets, TCP clients and
1846servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. 2388servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1847 2389
1848Asynchronous DNS: L<AnyEvent::DNS>. 2390Asynchronous DNS: L<AnyEvent::DNS>.
1849 2391
1850Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 2392Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
2393L<Coro::Event>,
1851 2394
1852Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 2395Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
2396L<AnyEvent::HTTP>.
1853 2397
1854 2398
1855=head1 AUTHOR 2399=head1 AUTHOR
1856 2400
1857 Marc Lehmann <schmorp@schmorp.de> 2401 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines