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.164 by root, Tue Jul 8 19:50:25 2008 UTC vs.
Revision 1.250 by root, Mon Jul 20 07:12:38 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines