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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines