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.159 by root, Fri Jun 6 16:19:19 2008 UTC vs.
Revision 1.244 by root, Fri Jul 17 23:15:57 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines