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.251 by root, Mon Jul 20 22:39:57 2009 UTC vs.
Revision 1.324 by root, Thu May 20 23:55:51 2010 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - events independent of event loop implementation 3AnyEvent - the DBI of event loop programming
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported 5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6event loops. 6and POE are various supported event loops/environments.
7 7
8=head1 SYNOPSIS 8=head1 SYNOPSIS
9 9
10 use AnyEvent; 10 use AnyEvent;
11 11
12 # if you prefer function calls, look at the AE manpage for
13 # an alternative API.
14
12 # file descriptor readable 15 # file handle or descriptor readable
13 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); 16 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14 17
15 # one-shot or repeating timers 18 # one-shot or repeating timers
16 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); 19 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... 20 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
47 50
48There is a mailinglist for discussing all things AnyEvent, and an IRC 51There is a mailinglist for discussing all things AnyEvent, and an IRC
49channel, too. 52channel, too.
50 53
51See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software 54See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52Respository>, at L<http://anyevent.schmorp.de>, for more info. 55Repository>, at L<http://anyevent.schmorp.de>, for more info.
53 56
54=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 57=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
55 58
56Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 59Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
57nowadays. So what is different about AnyEvent? 60nowadays. So what is different about AnyEvent?
181my variables are only visible after the statement in which they are 184my variables are only visible after the statement in which they are
182declared. 185declared.
183 186
184=head2 I/O WATCHERS 187=head2 I/O WATCHERS
185 188
189 $w = AnyEvent->io (
190 fh => <filehandle_or_fileno>,
191 poll => <"r" or "w">,
192 cb => <callback>,
193 );
194
186You can create an I/O watcher by calling the C<< AnyEvent->io >> method 195You can create an I/O watcher by calling the C<< AnyEvent->io >> method
187with the following mandatory key-value pairs as arguments: 196with the following mandatory key-value pairs as arguments:
188 197
189C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch 198C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
190for events (AnyEvent might or might not keep a reference to this file 199for events (AnyEvent might or might not keep a reference to this file
219 undef $w; 228 undef $w;
220 }); 229 });
221 230
222=head2 TIME WATCHERS 231=head2 TIME WATCHERS
223 232
233 $w = AnyEvent->timer (after => <seconds>, cb => <callback>);
234
235 $w = AnyEvent->timer (
236 after => <fractional_seconds>,
237 interval => <fractional_seconds>,
238 cb => <callback>,
239 );
240
224You can create a time watcher by calling the C<< AnyEvent->timer >> 241You can create a time watcher by calling the C<< AnyEvent->timer >>
225method with the following mandatory arguments: 242method with the following mandatory arguments:
226 243
227C<after> specifies after how many seconds (fractional values are 244C<after> specifies after how many seconds (fractional values are
228supported) the callback should be invoked. C<cb> is the callback to invoke 245supported) the callback should be invoked. C<cb> is the callback to invoke
349might affect timers and time-outs. 366might affect timers and time-outs.
350 367
351When this is the case, you can call this method, which will update the 368When this is the case, you can call this method, which will update the
352event loop's idea of "current time". 369event loop's idea of "current time".
353 370
371A typical example would be a script in a web server (e.g. C<mod_perl>) -
372when mod_perl executes the script, then the event loop will have the wrong
373idea about the "current time" (being potentially far in the past, when the
374script ran the last time). In that case you should arrange a call to C<<
375AnyEvent->now_update >> each time the web server process wakes up again
376(e.g. at the start of your script, or in a handler).
377
354Note that updating the time I<might> cause some events to be handled. 378Note that updating the time I<might> cause some events to be handled.
355 379
356=back 380=back
357 381
358=head2 SIGNAL WATCHERS 382=head2 SIGNAL WATCHERS
383
384 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
359 385
360You can watch for signals using a signal watcher, C<signal> is the signal 386You can watch for signals using a signal watcher, C<signal> is the signal
361I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl 387I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
362callback to be invoked whenever a signal occurs. 388callback to be invoked whenever a signal occurs.
363 389
380 406
381Example: exit on SIGINT 407Example: exit on SIGINT
382 408
383 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 409 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384 410
411=head3 Restart Behaviour
412
413While restart behaviour is up to the event loop implementation, most will
414not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
415pure perl implementation).
416
417=head3 Safe/Unsafe Signals
418
419Perl signals can be either "safe" (synchronous to opcode handling) or
420"unsafe" (asynchronous) - the former might get delayed indefinitely, the
421latter might corrupt your memory.
422
423AnyEvent signal handlers are, in addition, synchronous to the event loop,
424i.e. they will not interrupt your running perl program but will only be
425called as part of the normal event handling (just like timer, I/O etc.
426callbacks, too).
427
385=head3 Signal Races, Delays and Workarounds 428=head3 Signal Races, Delays and Workarounds
386 429
387Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 430Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
388callbacks to signals in a generic way, which is a pity, as you cannot do 431callbacks to signals in a generic way, which is a pity, as you cannot
389race-free signal handling in perl. AnyEvent will try to do it's best, but 432do race-free signal handling in perl, requiring C libraries for
433this. AnyEvent will try to do it's best, which means in some cases,
390in some cases, signals will be delayed. The maximum time a signal might 434signals will be delayed. The maximum time a signal might be delayed is
391be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 435specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392seconds). This variable can be changed only before the first signal 436variable can be changed only before the first signal watcher is created,
393watcher is created, and should be left alone otherwise. Higher values 437and should be left alone otherwise. This variable determines how often
438AnyEvent polls for signals (in case a wake-up was missed). Higher values
394will cause fewer spurious wake-ups, which is better for power and CPU 439will cause fewer spurious wake-ups, which is better for power and CPU
440saving.
441
395saving. All these problems can be avoided by installing the optional 442All these problems can be avoided by installing the optional
396L<Async::Interrupt> module. This will not work with inherently broken 443L<Async::Interrupt> module, which works with most event loops. It will not
397event loops such as L<Event> or L<Event::Lib> (and not with L<POE> 444work with inherently broken event loops such as L<Event> or L<Event::Lib>
398currently, as POE does it's own workaround with one-second latency). With 445(and not with L<POE> currently, as POE does it's own workaround with
399those, you just have to suffer the delays. 446one-second latency). For those, you just have to suffer the delays.
400 447
401=head2 CHILD PROCESS WATCHERS 448=head2 CHILD PROCESS WATCHERS
402 449
450 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
451
403You can also watch on a child process exit and catch its exit status. 452You can also watch on a child process exit and catch its exit status.
404 453
405The child process is specified by the C<pid> argument (if set to C<0>, it 454The child process is specified by the C<pid> argument (one some backends,
406watches for any child process exit). The watcher will triggered only when 455using C<0> watches for any child process exit, on others this will
407the child process has finished and an exit status is available, not on 456croak). The watcher will be triggered only when the child process has
408any trace events (stopped/continued). 457finished and an exit status is available, not on any trace events
458(stopped/continued).
409 459
410The callback will be called with the pid and exit status (as returned by 460The callback will be called with the pid and exit status (as returned by
411waitpid), so unlike other watcher types, you I<can> rely on child watcher 461waitpid), so unlike other watcher types, you I<can> rely on child watcher
412callback arguments. 462callback arguments.
413 463
454 # do something else, then wait for process exit 504 # do something else, then wait for process exit
455 $done->recv; 505 $done->recv;
456 506
457=head2 IDLE WATCHERS 507=head2 IDLE WATCHERS
458 508
459Sometimes there is a need to do something, but it is not so important 509 $w = AnyEvent->idle (cb => <callback>);
460to do it instantly, but only when there is nothing better to do. This
461"nothing better to do" is usually defined to be "no other events need
462attention by the event loop".
463 510
464Idle watchers ideally get invoked when the event loop has nothing 511Repeatedly invoke the callback after the process becomes idle, until
465better to do, just before it would block the process to wait for new 512either the watcher is destroyed or new events have been detected.
466events. Instead of blocking, the idle watcher is invoked.
467 513
468Most event loops unfortunately do not really support idle watchers (only 514Idle watchers are useful when there is a need to do something, but it
515is not so important (or wise) to do it instantly. The callback will be
516invoked only when there is "nothing better to do", which is usually
517defined as "all outstanding events have been handled and no new events
518have been detected". That means that idle watchers ideally get invoked
519when the event loop has just polled for new events but none have been
520detected. Instead of blocking to wait for more events, the idle watchers
521will be invoked.
522
523Unfortunately, most event loops do not really support idle watchers (only
469EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent 524EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
470will simply call the callback "from time to time". 525will simply call the callback "from time to time".
471 526
472Example: read lines from STDIN, but only process them when the 527Example: read lines from STDIN, but only process them when the
473program is otherwise idle: 528program is otherwise idle:
489 }); 544 });
490 }); 545 });
491 546
492=head2 CONDITION VARIABLES 547=head2 CONDITION VARIABLES
493 548
549 $cv = AnyEvent->condvar;
550
551 $cv->send (<list>);
552 my @res = $cv->recv;
553
494If you are familiar with some event loops you will know that all of them 554If you are familiar with some event loops you will know that all of them
495require you to run some blocking "loop", "run" or similar function that 555require you to run some blocking "loop", "run" or similar function that
496will actively watch for new events and call your callbacks. 556will actively watch for new events and call your callbacks.
497 557
498AnyEvent is slightly different: it expects somebody else to run the event 558AnyEvent is slightly different: it expects somebody else to run the event
549eventually calls C<< -> send >>, and the "consumer side", which waits 609eventually calls C<< -> send >>, and the "consumer side", which waits
550for the send to occur. 610for the send to occur.
551 611
552Example: wait for a timer. 612Example: wait for a timer.
553 613
554 # wait till the result is ready 614 # condition: "wait till the timer is fired"
555 my $result_ready = AnyEvent->condvar; 615 my $timer_fired = AnyEvent->condvar;
556 616
557 # do something such as adding a timer 617 # create the timer - we could wait for, say
558 # or socket watcher the calls $result_ready->send 618 # a handle becomign ready, or even an
559 # when the "result" is ready. 619 # AnyEvent::HTTP request to finish, but
560 # in this case, we simply use a timer: 620 # in this case, we simply use a timer:
561 my $w = AnyEvent->timer ( 621 my $w = AnyEvent->timer (
562 after => 1, 622 after => 1,
563 cb => sub { $result_ready->send }, 623 cb => sub { $timer_fired->send },
564 ); 624 );
565 625
566 # this "blocks" (while handling events) till the callback 626 # this "blocks" (while handling events) till the callback
567 # calls -<send 627 # calls ->send
568 $result_ready->recv; 628 $timer_fired->recv;
569 629
570Example: wait for a timer, but take advantage of the fact that condition 630Example: wait for a timer, but take advantage of the fact that condition
571variables are also callable directly. 631variables are also callable directly.
572 632
573 my $done = AnyEvent->condvar; 633 my $done = AnyEvent->condvar;
636one. For example, a function that pings many hosts in parallel might want 696one. For example, a function that pings many hosts in parallel might want
637to use a condition variable for the whole process. 697to use a condition variable for the whole process.
638 698
639Every call to C<< ->begin >> will increment a counter, and every call to 699Every call to C<< ->begin >> will increment a counter, and every call to
640C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 700C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
641>>, the (last) callback passed to C<begin> will be executed. That callback 701>>, the (last) callback passed to C<begin> will be executed, passing the
642is I<supposed> to call C<< ->send >>, but that is not required. If no 702condvar as first argument. That callback is I<supposed> to call C<< ->send
643callback was set, C<send> will be called without any arguments. 703>>, but that is not required. If no group callback was set, C<send> will
704be called without any arguments.
644 705
645You can think of C<< $cv->send >> giving you an OR condition (one call 706You can think of C<< $cv->send >> giving you an OR condition (one call
646sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND 707sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
647condition (all C<begin> calls must be C<end>'ed before the condvar sends). 708condition (all C<begin> calls must be C<end>'ed before the condvar sends).
648 709
675begung can potentially be zero: 736begung can potentially be zero:
676 737
677 my $cv = AnyEvent->condvar; 738 my $cv = AnyEvent->condvar;
678 739
679 my %result; 740 my %result;
680 $cv->begin (sub { $cv->send (\%result) }); 741 $cv->begin (sub { shift->send (\%result) });
681 742
682 for my $host (@list_of_hosts) { 743 for my $host (@list_of_hosts) {
683 $cv->begin; 744 $cv->begin;
684 ping_host_then_call_callback $host, sub { 745 ping_host_then_call_callback $host, sub {
685 $result{$host} = ...; 746 $result{$host} = ...;
760=item $cb = $cv->cb ($cb->($cv)) 821=item $cb = $cv->cb ($cb->($cv))
761 822
762This is a mutator function that returns the callback set and optionally 823This is a mutator function that returns the callback set and optionally
763replaces it before doing so. 824replaces it before doing so.
764 825
765The callback will be called when the condition becomes "true", i.e. when 826The callback will be called when the condition becomes (or already was)
766C<send> or C<croak> are called, with the only argument being the condition 827"true", i.e. when C<send> or C<croak> are called (or were called), with
767variable itself. Calling C<recv> inside the callback or at any later time 828the only argument being the condition variable itself. Calling C<recv>
768is guaranteed not to block. 829inside the callback or at any later time is guaranteed not to block.
769 830
770=back 831=back
771 832
772=head1 SUPPORTED EVENT LOOPS/BACKENDS 833=head1 SUPPORTED EVENT LOOPS/BACKENDS
773 834
776=over 4 837=over 4
777 838
778=item Backends that are autoprobed when no other event loop can be found. 839=item Backends that are autoprobed when no other event loop can be found.
779 840
780EV is the preferred backend when no other event loop seems to be in 841EV is the preferred backend when no other event loop seems to be in
781use. If EV is not installed, then AnyEvent will try Event, and, failing 842use. If EV is not installed, then AnyEvent will fall back to its own
782that, will fall back to its own pure-perl implementation, which is 843pure-perl implementation, which is available everywhere as it comes with
783available everywhere as it comes with AnyEvent itself. 844AnyEvent itself.
784 845
785 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 846 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
786 AnyEvent::Impl::Event based on Event, very stable, few glitches.
787 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 847 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
788 848
789=item Backends that are transparently being picked up when they are used. 849=item Backends that are transparently being picked up when they are used.
790 850
791These will be used when they are currently loaded when the first watcher 851These will be used when they are currently loaded when the first watcher
792is created, in which case it is assumed that the application is using 852is created, in which case it is assumed that the application is using
793them. This means that AnyEvent will automatically pick the right backend 853them. This means that AnyEvent will automatically pick the right backend
794when the main program loads an event module before anything starts to 854when the main program loads an event module before anything starts to
795create watchers. Nothing special needs to be done by the main program. 855create watchers. Nothing special needs to be done by the main program.
796 856
857 AnyEvent::Impl::Event based on Event, very stable, few glitches.
797 AnyEvent::Impl::Glib based on Glib, slow but very stable. 858 AnyEvent::Impl::Glib based on Glib, slow but very stable.
798 AnyEvent::Impl::Tk based on Tk, very broken. 859 AnyEvent::Impl::Tk based on Tk, very broken.
799 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 860 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
800 AnyEvent::Impl::POE based on POE, very slow, some limitations. 861 AnyEvent::Impl::POE based on POE, very slow, some limitations.
862 AnyEvent::Impl::Irssi used when running within irssi.
801 863
802=item Backends with special needs. 864=item Backends with special needs.
803 865
804Qt requires the Qt::Application to be instantiated first, but will 866Qt requires the Qt::Application to be instantiated first, but will
805otherwise be picked up automatically. As long as the main program 867otherwise be picked up automatically. As long as the main program
879event module detection too early, for example, L<AnyEvent::AIO> creates 941event module detection too early, for example, L<AnyEvent::AIO> creates
880and installs the global L<IO::AIO> watcher in a C<post_detect> block to 942and installs the global L<IO::AIO> watcher in a C<post_detect> block to
881avoid autodetecting the event module at load time. 943avoid autodetecting the event module at load time.
882 944
883If called in scalar or list context, then it creates and returns an object 945If called in scalar or list context, then it creates and returns an object
884that automatically removes the callback again when it is destroyed. See 946that automatically removes the callback again when it is destroyed (or
947C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
885L<Coro::BDB> for a case where this is useful. 948a case where this is useful.
949
950Example: Create a watcher for the IO::AIO module and store it in
951C<$WATCHER>. Only do so after the event loop is initialised, though.
952
953 our WATCHER;
954
955 my $guard = AnyEvent::post_detect {
956 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
957 };
958
959 # the ||= is important in case post_detect immediately runs the block,
960 # as to not clobber the newly-created watcher. assigning both watcher and
961 # post_detect guard to the same variable has the advantage of users being
962 # able to just C<undef $WATCHER> if the watcher causes them grief.
963
964 $WATCHER ||= $guard;
886 965
887=item @AnyEvent::post_detect 966=item @AnyEvent::post_detect
888 967
889If there are any code references in this array (you can C<push> to it 968If there are any code references in this array (you can C<push> to it
890before or after loading AnyEvent), then they will called directly after 969before or after loading AnyEvent), then they will called directly after
893You should check C<$AnyEvent::MODEL> before adding to this array, though: 972You should check C<$AnyEvent::MODEL> before adding to this array, though:
894if it is defined then the event loop has already been detected, and the 973if it is defined then the event loop has already been detected, and the
895array will be ignored. 974array will be ignored.
896 975
897Best use C<AnyEvent::post_detect { BLOCK }> when your application allows 976Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
898it,as it takes care of these details. 977it, as it takes care of these details.
899 978
900This variable is mainly useful for modules that can do something useful 979This variable is mainly useful for modules that can do something useful
901when AnyEvent is used and thus want to know when it is initialised, but do 980when AnyEvent is used and thus want to know when it is initialised, but do
902not need to even load it by default. This array provides the means to hook 981not need to even load it by default. This array provides the means to hook
903into AnyEvent passively, without loading it. 982into AnyEvent passively, without loading it.
983
984Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
985together, you could put this into Coro (this is the actual code used by
986Coro to accomplish this):
987
988 if (defined $AnyEvent::MODEL) {
989 # AnyEvent already initialised, so load Coro::AnyEvent
990 require Coro::AnyEvent;
991 } else {
992 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
993 # as soon as it is
994 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
995 }
904 996
905=back 997=back
906 998
907=head1 WHAT TO DO IN A MODULE 999=head1 WHAT TO DO IN A MODULE
908 1000
965=head1 OTHER MODULES 1057=head1 OTHER MODULES
966 1058
967The following is a non-exhaustive list of additional modules that use 1059The following is a non-exhaustive list of additional modules that use
968AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1060AnyEvent as a client and can therefore be mixed easily with other AnyEvent
969modules and other event loops in the same program. Some of the modules 1061modules and other event loops in the same program. Some of the modules
970come with AnyEvent, most are available via CPAN. 1062come with AnyEvent, the others are available via CPAN.
971 1063
972=over 4 1064=over 4
973 1065
974=item L<AnyEvent::Util> 1066=item L<AnyEvent::Util>
975 1067
990 1082
991=item L<AnyEvent::DNS> 1083=item L<AnyEvent::DNS>
992 1084
993Provides rich asynchronous DNS resolver capabilities. 1085Provides rich asynchronous DNS resolver capabilities.
994 1086
1087=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1088
1089Implement event-based interfaces to the protocols of the same name (for
1090the curious, IGS is the International Go Server and FCP is the Freenet
1091Client Protocol).
1092
1093=item L<AnyEvent::Handle::UDP>
1094
1095Here be danger!
1096
1097As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1098there are so many things wrong with AnyEvent::Handle::UDP, most notably
1099it's use of a stream-based API with a protocol that isn't streamable, that
1100the only way to improve it is to delete it.
1101
1102It features data corruption (but typically only under load) and general
1103confusion. On top, the author is not only clueless about UDP but also
1104fact-resistant - some gems of his understanding: "connect doesn't work
1105with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1106packets", "I don't need to implement proper error checking as UDP doesn't
1107support error checking" and so on - he doesn't even understand what's
1108wrong with his module when it is explained to him.
1109
995=item L<AnyEvent::HTTP> 1110=item L<AnyEvent::DBI>
996 1111
997A simple-to-use HTTP library that is capable of making a lot of concurrent 1112Executes L<DBI> requests asynchronously in a proxy process for you,
998HTTP requests. 1113notifying you in an event-bnased way when the operation is finished.
1114
1115=item L<AnyEvent::AIO>
1116
1117Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1118toolbox of every event programmer. AnyEvent::AIO transparently fuses
1119L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1120file I/O, and much more.
999 1121
1000=item L<AnyEvent::HTTPD> 1122=item L<AnyEvent::HTTPD>
1001 1123
1002Provides a simple web application server framework. 1124A simple embedded webserver.
1003 1125
1004=item L<AnyEvent::FastPing> 1126=item L<AnyEvent::FastPing>
1005 1127
1006The fastest ping in the west. 1128The fastest ping in the west.
1007
1008=item L<AnyEvent::DBI>
1009
1010Executes L<DBI> requests asynchronously in a proxy process.
1011
1012=item L<AnyEvent::AIO>
1013
1014Truly asynchronous I/O, should be in the toolbox of every event
1015programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1016together.
1017
1018=item L<AnyEvent::BDB>
1019
1020Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1021L<BDB> and AnyEvent together.
1022
1023=item L<AnyEvent::GPSD>
1024
1025A non-blocking interface to gpsd, a daemon delivering GPS information.
1026
1027=item L<AnyEvent::IRC>
1028
1029AnyEvent based IRC client module family (replacing the older Net::IRC3).
1030
1031=item L<AnyEvent::XMPP>
1032
1033AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1034Net::XMPP2>.
1035
1036=item L<AnyEvent::IGS>
1037
1038A non-blocking interface to the Internet Go Server protocol (used by
1039L<App::IGS>).
1040
1041=item L<Net::FCP>
1042
1043AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1044of AnyEvent.
1045
1046=item L<Event::ExecFlow>
1047
1048High level API for event-based execution flow control.
1049 1129
1050=item L<Coro> 1130=item L<Coro>
1051 1131
1052Has special support for AnyEvent via L<Coro::AnyEvent>. 1132Has special support for AnyEvent via L<Coro::AnyEvent>.
1053 1133
1057 1137
1058package AnyEvent; 1138package AnyEvent;
1059 1139
1060# basically a tuned-down version of common::sense 1140# basically a tuned-down version of common::sense
1061sub common_sense { 1141sub common_sense {
1062 # no warnings 1142 # from common:.sense 1.0
1063 ${^WARNING_BITS} ^= ${^WARNING_BITS}; 1143 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1064 # use strict vars subs 1144 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1065 $^H |= 0x00000600; 1145 $^H |= 0x00000600;
1066} 1146}
1067 1147
1068BEGIN { AnyEvent::common_sense } 1148BEGIN { AnyEvent::common_sense }
1069 1149
1070use Carp (); 1150use Carp ();
1071 1151
1072our $VERSION = 4.86; 1152our $VERSION = '5.261';
1073our $MODEL; 1153our $MODEL;
1074 1154
1075our $AUTOLOAD; 1155our $AUTOLOAD;
1076our @ISA; 1156our @ISA;
1077 1157
1078our @REGISTRY; 1158our @REGISTRY;
1079 1159
1080our $WIN32;
1081
1082our $VERBOSE; 1160our $VERBOSE;
1083 1161
1084BEGIN { 1162BEGIN {
1085 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1163 require "AnyEvent/constants.pl";
1164
1086 eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; 1165 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1087 1166
1088 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1167 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1089 if ${^TAINT}; 1168 if ${^TAINT};
1090 1169
1091 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1170 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1102 for reverse split /\s*,\s*/, 1181 for reverse split /\s*,\s*/,
1103 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1182 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1104} 1183}
1105 1184
1106my @models = ( 1185my @models = (
1107 [EV:: => AnyEvent::Impl::EV::], 1186 [EV:: => AnyEvent::Impl::EV:: , 1],
1108 [Event:: => AnyEvent::Impl::Event::],
1109 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1187 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1110 # everything below here will not be autoprobed 1188 # everything below here will not (normally) be autoprobed
1111 # as the pureperl backend should work everywhere 1189 # as the pureperl backend should work everywhere
1112 # and is usually faster 1190 # and is usually faster
1191 [Event:: => AnyEvent::Impl::Event::, 1],
1113 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1192 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1114 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1193 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1194 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1115 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1195 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1116 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1196 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1117 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1197 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1118 [Wx:: => AnyEvent::Impl::POE::], 1198 [Wx:: => AnyEvent::Impl::POE::],
1119 [Prima:: => AnyEvent::Impl::POE::], 1199 [Prima:: => AnyEvent::Impl::POE::],
1120 # IO::Async is just too broken - we would need workarounds for its 1200 # IO::Async is just too broken - we would need workarounds for its
1121 # byzantine signal and broken child handling, among others. 1201 # byzantine signal and broken child handling, among others.
1122 # IO::Async is rather hard to detect, as it doesn't have any 1202 # IO::Async is rather hard to detect, as it doesn't have any
1123 # obvious default class. 1203 # obvious default class.
1124# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1204 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1125# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1205 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1126# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1206 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1207 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1127); 1208);
1128 1209
1129our %method = map +($_ => 1), 1210our %method = map +($_ => 1),
1130 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1211 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1131 1212
1132our @post_detect; 1213our @post_detect;
1133 1214
1134sub post_detect(&) { 1215sub post_detect(&) {
1135 my ($cb) = @_; 1216 my ($cb) = @_;
1136 1217
1137 if ($MODEL) {
1138 $cb->();
1139
1140 1
1141 } else {
1142 push @post_detect, $cb; 1218 push @post_detect, $cb;
1143 1219
1144 defined wantarray 1220 defined wantarray
1145 ? bless \$cb, "AnyEvent::Util::postdetect" 1221 ? bless \$cb, "AnyEvent::Util::postdetect"
1146 : () 1222 : ()
1147 }
1148} 1223}
1149 1224
1150sub AnyEvent::Util::postdetect::DESTROY { 1225sub AnyEvent::Util::postdetect::DESTROY {
1151 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1226 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1152} 1227}
1153 1228
1154sub detect() { 1229sub detect() {
1230 # free some memory
1231 *detect = sub () { $MODEL };
1232
1233 local $!; # for good measure
1234 local $SIG{__DIE__};
1235
1236 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1237 my $model = "AnyEvent::Impl::$1";
1238 if (eval "require $model") {
1239 $MODEL = $model;
1240 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1241 } else {
1242 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1243 }
1244 }
1245
1246 # check for already loaded models
1155 unless ($MODEL) { 1247 unless ($MODEL) {
1156 local $SIG{__DIE__}; 1248 for (@REGISTRY, @models) {
1157 1249 my ($package, $model) = @$_;
1158 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1250 if (${"$package\::VERSION"} > 0) {
1159 my $model = "AnyEvent::Impl::$1";
1160 if (eval "require $model") { 1251 if (eval "require $model") {
1161 $MODEL = $model; 1252 $MODEL = $model;
1162 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; 1253 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1163 } else { 1254 last;
1164 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1255 }
1165 } 1256 }
1166 } 1257 }
1167 1258
1168 # check for already loaded models
1169 unless ($MODEL) { 1259 unless ($MODEL) {
1260 # try to autoload a model
1170 for (@REGISTRY, @models) { 1261 for (@REGISTRY, @models) {
1171 my ($package, $model) = @$_; 1262 my ($package, $model, $autoload) = @$_;
1263 if (
1264 $autoload
1265 and eval "require $package"
1172 if (${"$package\::VERSION"} > 0) { 1266 and ${"$package\::VERSION"} > 0
1173 if (eval "require $model") { 1267 and eval "require $model"
1268 ) {
1174 $MODEL = $model; 1269 $MODEL = $model;
1175 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1270 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1176 last; 1271 last;
1177 }
1178 } 1272 }
1179 } 1273 }
1180 1274
1181 unless ($MODEL) {
1182 # try to load a model
1183
1184 for (@REGISTRY, @models) {
1185 my ($package, $model) = @$_;
1186 if (eval "require $package"
1187 and ${"$package\::VERSION"} > 0
1188 and eval "require $model") {
1189 $MODEL = $model;
1190 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
1191 last;
1192 }
1193 }
1194
1195 $MODEL 1275 $MODEL
1196 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1276 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1197 }
1198 } 1277 }
1199
1200 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1201
1202 unshift @ISA, $MODEL;
1203
1204 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1205
1206 (shift @post_detect)->() while @post_detect;
1207 } 1278 }
1279
1280 @models = (); # free probe data
1281
1282 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1283 unshift @ISA, $MODEL;
1284
1285 # now nuke some methods that are overriden by the backend.
1286 # SUPER is not allowed.
1287 for (qw(time signal child idle)) {
1288 undef &{"AnyEvent::Base::$_"}
1289 if defined &{"$MODEL\::$_"};
1290 }
1291
1292 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1293
1294 (shift @post_detect)->() while @post_detect;
1295
1296 *post_detect = sub(&) {
1297 shift->();
1298
1299 undef
1300 };
1208 1301
1209 $MODEL 1302 $MODEL
1210} 1303}
1211 1304
1212sub AUTOLOAD { 1305sub AUTOLOAD {
1213 (my $func = $AUTOLOAD) =~ s/.*://; 1306 (my $func = $AUTOLOAD) =~ s/.*://;
1214 1307
1215 $method{$func} 1308 $method{$func}
1216 or Carp::croak "$func: not a valid method for AnyEvent objects"; 1309 or Carp::croak "$func: not a valid AnyEvent class method";
1217 1310
1218 detect unless $MODEL; 1311 detect;
1219 1312
1220 my $class = shift; 1313 my $class = shift;
1221 $class->$func (@_); 1314 $class->$func (@_);
1222} 1315}
1223 1316
1236 # we assume CLOEXEC is already set by perl in all important cases 1329 # we assume CLOEXEC is already set by perl in all important cases
1237 1330
1238 ($fh2, $rw) 1331 ($fh2, $rw)
1239} 1332}
1240 1333
1334=head1 SIMPLIFIED AE API
1335
1336Starting with version 5.0, AnyEvent officially supports a second, much
1337simpler, API that is designed to reduce the calling, typing and memory
1338overhead by using function call syntax and a fixed number of parameters.
1339
1340See the L<AE> manpage for details.
1341
1342=cut
1343
1344package AE;
1345
1346our $VERSION = $AnyEvent::VERSION;
1347
1348# fall back to the main API by default - backends and AnyEvent::Base
1349# implementations can overwrite these.
1350
1351sub io($$$) {
1352 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1353}
1354
1355sub timer($$$) {
1356 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1357}
1358
1359sub signal($$) {
1360 AnyEvent->signal (signal => $_[0], cb => $_[1])
1361}
1362
1363sub child($$) {
1364 AnyEvent->child (pid => $_[0], cb => $_[1])
1365}
1366
1367sub idle($) {
1368 AnyEvent->idle (cb => $_[0])
1369}
1370
1371sub cv(;&) {
1372 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1373}
1374
1375sub now() {
1376 AnyEvent->now
1377}
1378
1379sub now_update() {
1380 AnyEvent->now_update
1381}
1382
1383sub time() {
1384 AnyEvent->time
1385}
1386
1241package AnyEvent::Base; 1387package AnyEvent::Base;
1242 1388
1243# default implementations for many methods 1389# default implementations for many methods
1244 1390
1245sub _time { 1391sub time {
1392 eval q{ # poor man's autoloading {}
1246 # probe for availability of Time::HiRes 1393 # probe for availability of Time::HiRes
1247 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1394 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1248 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1395 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1249 *_time = \&Time::HiRes::time; 1396 *AE::time = \&Time::HiRes::time;
1250 # if (eval "use POSIX (); (POSIX::times())... 1397 # if (eval "use POSIX (); (POSIX::times())...
1251 } else { 1398 } else {
1252 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1399 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1253 *_time = sub { time }; # epic fail 1400 *AE::time = sub (){ time }; # epic fail
1401 }
1402
1403 *time = sub { AE::time }; # different prototypes
1254 } 1404 };
1405 die if $@;
1255 1406
1256 &_time 1407 &time
1257} 1408}
1258 1409
1259sub time { _time } 1410*now = \&time;
1260sub now { _time } 1411
1261sub now_update { } 1412sub now_update { }
1262 1413
1263# default implementation for ->condvar 1414# default implementation for ->condvar
1264 1415
1265sub condvar { 1416sub condvar {
1417 eval q{ # poor man's autoloading {}
1418 *condvar = sub {
1266 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1419 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1420 };
1421
1422 *AE::cv = sub (;&) {
1423 bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
1424 };
1425 };
1426 die if $@;
1427
1428 &condvar
1267} 1429}
1268 1430
1269# default implementation for ->signal 1431# default implementation for ->signal
1270 1432
1271our $HAVE_ASYNC_INTERRUPT; 1433our $HAVE_ASYNC_INTERRUPT;
1434
1435sub _have_async_interrupt() {
1436 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1437 && eval "use Async::Interrupt 1.02 (); 1")
1438 unless defined $HAVE_ASYNC_INTERRUPT;
1439
1440 $HAVE_ASYNC_INTERRUPT
1441}
1442
1272our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1443our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1273our (%SIG_ASY, %SIG_ASY_W); 1444our (%SIG_ASY, %SIG_ASY_W);
1274our ($SIG_COUNT, $SIG_TW); 1445our ($SIG_COUNT, $SIG_TW);
1275 1446
1276sub _signal_exec {
1277 $HAVE_ASYNC_INTERRUPT
1278 ? $SIGPIPE_R->drain
1279 : sysread $SIGPIPE_R, my $dummy, 9;
1280
1281 while (%SIG_EV) {
1282 for (keys %SIG_EV) {
1283 delete $SIG_EV{$_};
1284 $_->() for values %{ $SIG_CB{$_} || {} };
1285 }
1286 }
1287}
1288
1289# install a dumym wakeupw atcher to reduce signal catching latency 1447# install a dummy wakeup watcher to reduce signal catching latency
1448# used by Impls
1290sub _sig_add() { 1449sub _sig_add() {
1291 unless ($SIG_COUNT++) { 1450 unless ($SIG_COUNT++) {
1292 # try to align timer on a full-second boundary, if possible 1451 # try to align timer on a full-second boundary, if possible
1293 my $NOW = AnyEvent->now; 1452 my $NOW = AE::now;
1294 1453
1295 $SIG_TW = AnyEvent->timer ( 1454 $SIG_TW = AE::timer
1296 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1455 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1297 interval => $MAX_SIGNAL_LATENCY, 1456 $MAX_SIGNAL_LATENCY,
1298 cb => sub { }, # just for the PERL_ASYNC_CHECK 1457 sub { } # just for the PERL_ASYNC_CHECK
1299 ); 1458 ;
1300 } 1459 }
1301} 1460}
1302 1461
1303sub _sig_del { 1462sub _sig_del {
1304 undef $SIG_TW 1463 undef $SIG_TW
1305 unless --$SIG_COUNT; 1464 unless --$SIG_COUNT;
1306} 1465}
1307 1466
1467our $_sig_name_init; $_sig_name_init = sub {
1468 eval q{ # poor man's autoloading {}
1469 undef $_sig_name_init;
1470
1471 if (_have_async_interrupt) {
1472 *sig2num = \&Async::Interrupt::sig2num;
1473 *sig2name = \&Async::Interrupt::sig2name;
1474 } else {
1475 require Config;
1476
1477 my %signame2num;
1478 @signame2num{ split ' ', $Config::Config{sig_name} }
1479 = split ' ', $Config::Config{sig_num};
1480
1481 my @signum2name;
1482 @signum2name[values %signame2num] = keys %signame2num;
1483
1484 *sig2num = sub($) {
1485 $_[0] > 0 ? shift : $signame2num{+shift}
1486 };
1487 *sig2name = sub ($) {
1488 $_[0] > 0 ? $signum2name[+shift] : shift
1489 };
1490 }
1491 };
1492 die if $@;
1493};
1494
1495sub sig2num ($) { &$_sig_name_init; &sig2num }
1496sub sig2name($) { &$_sig_name_init; &sig2name }
1497
1308sub _signal { 1498sub signal {
1309 my (undef, %arg) = @_; 1499 eval q{ # poor man's autoloading {}
1500 # probe for availability of Async::Interrupt
1501 if (_have_async_interrupt) {
1502 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1310 1503
1311 my $signal = uc $arg{signal} 1504 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1312 or Carp::croak "required option 'signal' is missing"; 1505 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1313 1506
1314 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1507 } else {
1508 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1315 1509
1316 if ($HAVE_ASYNC_INTERRUPT) { 1510 if (AnyEvent::WIN32) {
1317 # async::interrupt 1511 require AnyEvent::Util;
1318 1512
1319 $SIG_ASY{$signal} ||= do { 1513 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1320 my $asy = new Async::Interrupt 1514 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1321 cb => sub { undef $SIG_EV{$signal} }, 1515 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1322 signal => $signal, 1516 } else {
1323 pipe => [$SIGPIPE_R->filenos], 1517 pipe $SIGPIPE_R, $SIGPIPE_W;
1518 fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1519 fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1520
1521 # not strictly required, as $^F is normally 2, but let's make sure...
1522 fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1523 fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1324 ; 1524 }
1325 $asy->pipe_autodrain (0);
1326 1525
1327 $asy 1526 $SIGPIPE_R
1527 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1528
1529 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1530 }
1531
1532 *signal = $HAVE_ASYNC_INTERRUPT
1533 ? sub {
1534 my (undef, %arg) = @_;
1535
1536 # async::interrupt
1537 my $signal = sig2num $arg{signal};
1538 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1539
1540 $SIG_ASY{$signal} ||= new Async::Interrupt
1541 cb => sub { undef $SIG_EV{$signal} },
1542 signal => $signal,
1543 pipe => [$SIGPIPE_R->filenos],
1544 pipe_autodrain => 0,
1545 ;
1546
1547 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1548 }
1549 : sub {
1550 my (undef, %arg) = @_;
1551
1552 # pure perl
1553 my $signal = sig2name $arg{signal};
1554 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1555
1556 $SIG{$signal} ||= sub {
1557 local $!;
1558 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1559 undef $SIG_EV{$signal};
1560 };
1561
1562 # can't do signal processing without introducing races in pure perl,
1563 # so limit the signal latency.
1564 _sig_add;
1565
1566 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1567 }
1568 ;
1569
1570 *AnyEvent::Base::signal::DESTROY = sub {
1571 my ($signal, $cb) = @{$_[0]};
1572
1573 _sig_del;
1574
1575 delete $SIG_CB{$signal}{$cb};
1576
1577 $HAVE_ASYNC_INTERRUPT
1578 ? delete $SIG_ASY{$signal}
1579 : # delete doesn't work with older perls - they then
1580 # print weird messages, or just unconditionally exit
1581 # instead of getting the default action.
1582 undef $SIG{$signal}
1583 unless keys %{ $SIG_CB{$signal} };
1328 }; 1584 };
1329 1585
1330 } else { 1586 *_signal_exec = sub {
1331 # pure perl 1587 $HAVE_ASYNC_INTERRUPT
1588 ? $SIGPIPE_R->drain
1589 : sysread $SIGPIPE_R, (my $dummy), 9;
1332 1590
1333 $SIG{$signal} ||= sub { 1591 while (%SIG_EV) {
1334 local $!; 1592 for (keys %SIG_EV) {
1335 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1593 delete $SIG_EV{$_};
1336 undef $SIG_EV{$signal}; 1594 $_->() for values %{ $SIG_CB{$_} || {} };
1595 }
1596 }
1337 }; 1597 };
1338
1339 # can't do signal processing without introducing races in pure perl,
1340 # so limit the signal latency.
1341 _sig_add;
1342 } 1598 };
1599 die if $@;
1343 1600
1344 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1345}
1346
1347sub signal {
1348 # probe for availability of Async::Interrupt
1349 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1350 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1351
1352 $HAVE_ASYNC_INTERRUPT = 1;
1353 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1354 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1355
1356 } else {
1357 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1358
1359 require Fcntl;
1360
1361 if (AnyEvent::WIN32) {
1362 require AnyEvent::Util;
1363
1364 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1365 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1366 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1367 } else {
1368 pipe $SIGPIPE_R, $SIGPIPE_W;
1369 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1370 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1371
1372 # not strictly required, as $^F is normally 2, but let's make sure...
1373 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1374 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1375 }
1376
1377 $SIGPIPE_R
1378 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1379
1380 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1381 }
1382
1383 *signal = \&_signal;
1384 &signal 1601 &signal
1385}
1386
1387sub AnyEvent::Base::signal::DESTROY {
1388 my ($signal, $cb) = @{$_[0]};
1389
1390 _sig_del;
1391
1392 delete $SIG_CB{$signal}{$cb};
1393
1394 $HAVE_ASYNC_INTERRUPT
1395 ? delete $SIG_ASY{$signal}
1396 : # delete doesn't work with older perls - they then
1397 # print weird messages, or just unconditionally exit
1398 # instead of getting the default action.
1399 undef $SIG{$signal}
1400 unless keys %{ $SIG_CB{$signal} };
1401} 1602}
1402 1603
1403# default implementation for ->child 1604# default implementation for ->child
1404 1605
1405our %PID_CB; 1606our %PID_CB;
1406our $CHLD_W; 1607our $CHLD_W;
1407our $CHLD_DELAY_W; 1608our $CHLD_DELAY_W;
1408our $WNOHANG; 1609our $WNOHANG;
1409 1610
1410sub _sigchld { 1611# used by many Impl's
1411 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1612sub _emit_childstatus($$) {
1412 $_->($pid, $?) 1613 my (undef, $rpid, $rstatus) = @_;
1614
1615 $_->($rpid, $rstatus)
1413 for values %{ $PID_CB{$pid} || {} }, 1616 for values %{ $PID_CB{$rpid} || {} },
1414 values %{ $PID_CB{0} || {} }; 1617 values %{ $PID_CB{0} || {} };
1415 }
1416} 1618}
1417 1619
1418sub child { 1620sub child {
1621 eval q{ # poor man's autoloading {}
1622 *_sigchld = sub {
1623 my $pid;
1624
1625 AnyEvent->_emit_childstatus ($pid, $?)
1626 while ($pid = waitpid -1, $WNOHANG) > 0;
1627 };
1628
1629 *child = sub {
1419 my (undef, %arg) = @_; 1630 my (undef, %arg) = @_;
1420 1631
1421 defined (my $pid = $arg{pid} + 0) 1632 defined (my $pid = $arg{pid} + 0)
1422 or Carp::croak "required option 'pid' is missing"; 1633 or Carp::croak "required option 'pid' is missing";
1423 1634
1424 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1635 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1425 1636
1426 # WNOHANG is almost cetrainly 1 everywhere 1637 # WNOHANG is almost cetrainly 1 everywhere
1427 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1638 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1428 ? 1 1639 ? 1
1429 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1640 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1430 1641
1431 unless ($CHLD_W) { 1642 unless ($CHLD_W) {
1432 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1643 $CHLD_W = AE::signal CHLD => \&_sigchld;
1433 # child could be a zombie already, so make at least one round 1644 # child could be a zombie already, so make at least one round
1434 &_sigchld; 1645 &_sigchld;
1435 } 1646 }
1436 1647
1437 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1648 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1438} 1649 };
1439 1650
1440sub AnyEvent::Base::child::DESTROY { 1651 *AnyEvent::Base::child::DESTROY = sub {
1441 my ($pid, $cb) = @{$_[0]}; 1652 my ($pid, $cb) = @{$_[0]};
1442 1653
1443 delete $PID_CB{$pid}{$cb}; 1654 delete $PID_CB{$pid}{$cb};
1444 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1655 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1445 1656
1446 undef $CHLD_W unless keys %PID_CB; 1657 undef $CHLD_W unless keys %PID_CB;
1658 };
1659 };
1660 die if $@;
1661
1662 &child
1447} 1663}
1448 1664
1449# idle emulation is done by simply using a timer, regardless 1665# idle emulation is done by simply using a timer, regardless
1450# of whether the process is idle or not, and not letting 1666# of whether the process is idle or not, and not letting
1451# the callback use more than 50% of the time. 1667# the callback use more than 50% of the time.
1452sub idle { 1668sub idle {
1669 eval q{ # poor man's autoloading {}
1670 *idle = sub {
1453 my (undef, %arg) = @_; 1671 my (undef, %arg) = @_;
1454 1672
1455 my ($cb, $w, $rcb) = $arg{cb}; 1673 my ($cb, $w, $rcb) = $arg{cb};
1456 1674
1457 $rcb = sub { 1675 $rcb = sub {
1458 if ($cb) { 1676 if ($cb) {
1459 $w = _time; 1677 $w = _time;
1460 &$cb; 1678 &$cb;
1461 $w = _time - $w; 1679 $w = _time - $w;
1462 1680
1463 # never use more then 50% of the time for the idle watcher, 1681 # never use more then 50% of the time for the idle watcher,
1464 # within some limits 1682 # within some limits
1465 $w = 0.0001 if $w < 0.0001; 1683 $w = 0.0001 if $w < 0.0001;
1466 $w = 5 if $w > 5; 1684 $w = 5 if $w > 5;
1467 1685
1468 $w = AnyEvent->timer (after => $w, cb => $rcb); 1686 $w = AE::timer $w, 0, $rcb;
1469 } else { 1687 } else {
1470 # clean up... 1688 # clean up...
1471 undef $w; 1689 undef $w;
1472 undef $rcb; 1690 undef $rcb;
1691 }
1692 };
1693
1694 $w = AE::timer 0.05, 0, $rcb;
1695
1696 bless \\$cb, "AnyEvent::Base::idle"
1473 } 1697 };
1698
1699 *AnyEvent::Base::idle::DESTROY = sub {
1700 undef $${$_[0]};
1701 };
1474 }; 1702 };
1703 die if $@;
1475 1704
1476 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1705 &idle
1477
1478 bless \\$cb, "AnyEvent::Base::idle"
1479}
1480
1481sub AnyEvent::Base::idle::DESTROY {
1482 undef $${$_[0]};
1483} 1706}
1484 1707
1485package AnyEvent::CondVar; 1708package AnyEvent::CondVar;
1486 1709
1487our @ISA = AnyEvent::CondVar::Base::; 1710our @ISA = AnyEvent::CondVar::Base::;
1535 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1758 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1536 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1759 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1537} 1760}
1538 1761
1539sub cb { 1762sub cb {
1540 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1763 my $cv = shift;
1764
1765 @_
1766 and $cv->{_ae_cb} = shift
1767 and $cv->{_ae_sent}
1768 and (delete $cv->{_ae_cb})->($cv);
1769
1541 $_[0]{_ae_cb} 1770 $cv->{_ae_cb}
1542} 1771}
1543 1772
1544sub begin { 1773sub begin {
1545 ++$_[0]{_ae_counter}; 1774 ++$_[0]{_ae_counter};
1546 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1775 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1755 warn "read: $input\n"; # output what has been read 1984 warn "read: $input\n"; # output what has been read
1756 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1985 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1757 }, 1986 },
1758 ); 1987 );
1759 1988
1760 my $time_watcher; # can only be used once
1761
1762 sub new_timer {
1763 $timer = AnyEvent->timer (after => 1, cb => sub { 1989 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1764 warn "timeout\n"; # print 'timeout' about every second 1990 warn "timeout\n"; # print 'timeout' at most every second
1765 &new_timer; # and restart the time
1766 }); 1991 });
1767 }
1768
1769 new_timer; # create first timer
1770 1992
1771 $cv->recv; # wait until user enters /^q/i 1993 $cv->recv; # wait until user enters /^q/i
1772 1994
1773=head1 REAL-WORLD EXAMPLE 1995=head1 REAL-WORLD EXAMPLE
1774 1996
1847 2069
1848The actual code goes further and collects all errors (C<die>s, exceptions) 2070The actual code goes further and collects all errors (C<die>s, exceptions)
1849that occurred during request processing. The C<result> method detects 2071that occurred during request processing. The C<result> method detects
1850whether an exception as thrown (it is stored inside the $txn object) 2072whether an exception as thrown (it is stored inside the $txn object)
1851and just throws the exception, which means connection errors and other 2073and just throws the exception, which means connection errors and other
1852problems get reported tot he code that tries to use the result, not in a 2074problems get reported to the code that tries to use the result, not in a
1853random callback. 2075random callback.
1854 2076
1855All of this enables the following usage styles: 2077All of this enables the following usage styles:
1856 2078
18571. Blocking: 20791. Blocking:
1905through AnyEvent. The benchmark creates a lot of timers (with a zero 2127through AnyEvent. The benchmark creates a lot of timers (with a zero
1906timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2128timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1907which it is), lets them fire exactly once and destroys them again. 2129which it is), lets them fire exactly once and destroys them again.
1908 2130
1909Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2131Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1910distribution. 2132distribution. It uses the L<AE> interface, which makes a real difference
2133for the EV and Perl backends only.
1911 2134
1912=head3 Explanation of the columns 2135=head3 Explanation of the columns
1913 2136
1914I<watcher> is the number of event watchers created/destroyed. Since 2137I<watcher> is the number of event watchers created/destroyed. Since
1915different event models feature vastly different performances, each event 2138different event models feature vastly different performances, each event
1936watcher. 2159watcher.
1937 2160
1938=head3 Results 2161=head3 Results
1939 2162
1940 name watchers bytes create invoke destroy comment 2163 name watchers bytes create invoke destroy comment
1941 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2164 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1942 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2165 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1943 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2166 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1944 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2167 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1945 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2168 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1946 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2169 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1947 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 2170 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1948 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 2171 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1949 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2172 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1950 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2173 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1951 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2174 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1952 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2175 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1953 2176
1954=head3 Discussion 2177=head3 Discussion
1955 2178
1956The benchmark does I<not> measure scalability of the event loop very 2179The benchmark does I<not> measure scalability of the event loop very
1957well. For example, a select-based event loop (such as the pure perl one) 2180well. For example, a select-based event loop (such as the pure perl one)
1969benchmark machine, handling an event takes roughly 1600 CPU cycles with 2192benchmark machine, handling an event takes roughly 1600 CPU cycles with
1970EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2193EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1971cycles with POE. 2194cycles with POE.
1972 2195
1973C<EV> is the sole leader regarding speed and memory use, which are both 2196C<EV> is the sole leader regarding speed and memory use, which are both
1974maximal/minimal, respectively. Even when going through AnyEvent, it uses 2197maximal/minimal, respectively. When using the L<AE> API there is zero
2198overhead (when going through the AnyEvent API create is about 5-6 times
2199slower, with other times being equal, so still uses far less memory than
1975far less memory than any other event loop and is still faster than Event 2200any other event loop and is still faster than Event natively).
1976natively.
1977 2201
1978The pure perl implementation is hit in a few sweet spots (both the 2202The pure perl implementation is hit in a few sweet spots (both the
1979constant timeout and the use of a single fd hit optimisations in the perl 2203constant timeout and the use of a single fd hit optimisations in the perl
1980interpreter and the backend itself). Nevertheless this shows that it 2204interpreter and the backend itself). Nevertheless this shows that it
1981adds very little overhead in itself. Like any select-based backend its 2205adds very little overhead in itself. Like any select-based backend its
2055In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2279In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2056(1%) are active. This mirrors the activity of large servers with many 2280(1%) are active. This mirrors the activity of large servers with many
2057connections, most of which are idle at any one point in time. 2281connections, most of which are idle at any one point in time.
2058 2282
2059Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2283Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2060distribution. 2284distribution. It uses the L<AE> interface, which makes a real difference
2285for the EV and Perl backends only.
2061 2286
2062=head3 Explanation of the columns 2287=head3 Explanation of the columns
2063 2288
2064I<sockets> is the number of sockets, and twice the number of "servers" (as 2289I<sockets> is the number of sockets, and twice the number of "servers" (as
2065each server has a read and write socket end). 2290each server has a read and write socket end).
2073a new one that moves the timeout into the future. 2298a new one that moves the timeout into the future.
2074 2299
2075=head3 Results 2300=head3 Results
2076 2301
2077 name sockets create request 2302 name sockets create request
2078 EV 20000 69.01 11.16 2303 EV 20000 62.66 7.99
2079 Perl 20000 73.32 35.87 2304 Perl 20000 68.32 32.64
2080 IOAsync 20000 157.00 98.14 epoll 2305 IOAsync 20000 174.06 101.15 epoll
2081 IOAsync 20000 159.31 616.06 poll 2306 IOAsync 20000 174.67 610.84 poll
2082 Event 20000 212.62 257.32 2307 Event 20000 202.69 242.91
2083 Glib 20000 651.16 1896.30 2308 Glib 20000 557.01 1689.52
2084 POE 20000 349.67 12317.24 uses POE::Loop::Event 2309 POE 20000 341.54 12086.32 uses POE::Loop::Event
2085 2310
2086=head3 Discussion 2311=head3 Discussion
2087 2312
2088This benchmark I<does> measure scalability and overall performance of the 2313This benchmark I<does> measure scalability and overall performance of the
2089particular event loop. 2314particular event loop.
2215As you can see, the AnyEvent + EV combination even beats the 2440As you can see, the AnyEvent + EV combination even beats the
2216hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2441hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2217backend easily beats IO::Lambda and POE. 2442backend easily beats IO::Lambda and POE.
2218 2443
2219And even the 100% non-blocking version written using the high-level (and 2444And even the 100% non-blocking version written using the high-level (and
2220slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2445slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2221large margin, even though it does all of DNS, tcp-connect and socket I/O 2446higher level ("unoptimised") abstractions by a large margin, even though
2222in a non-blocking way. 2447it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2223 2448
2224The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2449The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2225F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2450F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2226part of the IO::lambda distribution and were used without any changes. 2451part of the IO::Lambda distribution and were used without any changes.
2227 2452
2228 2453
2229=head1 SIGNALS 2454=head1 SIGNALS
2230 2455
2231AnyEvent currently installs handlers for these signals: 2456AnyEvent currently installs handlers for these signals:
2273it's built-in modules) are required to use it. 2498it's built-in modules) are required to use it.
2274 2499
2275That does not mean that AnyEvent won't take advantage of some additional 2500That does not mean that AnyEvent won't take advantage of some additional
2276modules if they are installed. 2501modules if they are installed.
2277 2502
2278This section epxlains which additional modules will be used, and how they 2503This section explains which additional modules will be used, and how they
2279affect AnyEvent's operetion. 2504affect AnyEvent's operation.
2280 2505
2281=over 4 2506=over 4
2282 2507
2283=item L<Async::Interrupt> 2508=item L<Async::Interrupt>
2284 2509
2289catch the signals) with some delay (default is 10 seconds, look for 2514catch the signals) with some delay (default is 10 seconds, look for
2290C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2515C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2291 2516
2292If this module is available, then it will be used to implement signal 2517If this module is available, then it will be used to implement signal
2293catching, which means that signals will not be delayed, and the event loop 2518catching, which means that signals will not be delayed, and the event loop
2294will not be interrupted regularly, which is more efficient (And good for 2519will not be interrupted regularly, which is more efficient (and good for
2295battery life on laptops). 2520battery life on laptops).
2296 2521
2297This affects not just the pure-perl event loop, but also other event loops 2522This affects not just the pure-perl event loop, but also other event loops
2298that have no signal handling on their own (e.g. Glib, Tk, Qt). 2523that have no signal handling on their own (e.g. Glib, Tk, Qt).
2299 2524
2311automatic timer adjustments even when no monotonic clock is available, 2536automatic timer adjustments even when no monotonic clock is available,
2312can take avdantage of advanced kernel interfaces such as C<epoll> and 2537can take avdantage of advanced kernel interfaces such as C<epoll> and
2313C<kqueue>, and is the fastest backend I<by far>. You can even embed 2538C<kqueue>, and is the fastest backend I<by far>. You can even embed
2314L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). 2539L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2315 2540
2541If you only use backends that rely on another event loop (e.g. C<Tk>),
2542then this module will do nothing for you.
2543
2316=item L<Guard> 2544=item L<Guard>
2317 2545
2318The guard module, when used, will be used to implement 2546The guard module, when used, will be used to implement
2319C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a 2547C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2320lot less memory), but otherwise doesn't affect guard operation much. It is 2548lot less memory), but otherwise doesn't affect guard operation much. It is
2321purely used for performance. 2549purely used for performance.
2322 2550
2323=item L<JSON> and L<JSON::XS> 2551=item L<JSON> and L<JSON::XS>
2324 2552
2325This module is required when you want to read or write JSON data via 2553One of these modules is required when you want to read or write JSON data
2326L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2554via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2327advantage of the ultra-high-speed L<JSON::XS> module when it is installed. 2555advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2328
2329In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2330installed.
2331 2556
2332=item L<Net::SSLeay> 2557=item L<Net::SSLeay>
2333 2558
2334Implementing TLS/SSL in Perl is certainly interesting, but not very 2559Implementing TLS/SSL in Perl is certainly interesting, but not very
2335worthwhile: If this module is installed, then L<AnyEvent::Handle> (with 2560worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2346 2571
2347 2572
2348=head1 FORK 2573=head1 FORK
2349 2574
2350Most event libraries are not fork-safe. The ones who are usually are 2575Most event libraries are not fork-safe. The ones who are usually are
2351because they rely on inefficient but fork-safe C<select> or C<poll> 2576because they rely on inefficient but fork-safe C<select> or C<poll> calls
2352calls. Only L<EV> is fully fork-aware. 2577- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
2578are usually badly thought-out hacks that are incompatible with fork in
2579one way or another. Only L<EV> is fully fork-aware and ensures that you
2580continue event-processing in both parent and child (or both, if you know
2581what you are doing).
2582
2583This means that, in general, you cannot fork and do event processing in
2584the child if the event library was initialised before the fork (which
2585usually happens when the first AnyEvent watcher is created, or the library
2586is loaded).
2353 2587
2354If you have to fork, you must either do so I<before> creating your first 2588If you have to fork, you must either do so I<before> creating your first
2355watcher OR you must not use AnyEvent at all in the child OR you must do 2589watcher OR you must not use AnyEvent at all in the child OR you must do
2356something completely out of the scope of AnyEvent. 2590something completely out of the scope of AnyEvent.
2591
2592The problem of doing event processing in the parent I<and> the child
2593is much more complicated: even for backends that I<are> fork-aware or
2594fork-safe, their behaviour is not usually what you want: fork clones all
2595watchers, that means all timers, I/O watchers etc. are active in both
2596parent and child, which is almost never what you want. USing C<exec>
2597to start worker children from some kind of manage rprocess is usually
2598preferred, because it is much easier and cleaner, at the expense of having
2599to have another binary.
2357 2600
2358 2601
2359=head1 SECURITY CONSIDERATIONS 2602=head1 SECURITY CONSIDERATIONS
2360 2603
2361AnyEvent can be forced to load any event model via 2604AnyEvent can be forced to load any event model via
2399L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2642L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2400 2643
2401Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2644Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2402L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2645L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2403L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2646L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2404L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. 2647L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2405 2648
2406Non-blocking file handles, sockets, TCP clients and 2649Non-blocking file handles, sockets, TCP clients and
2407servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2650servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2408 2651
2409Asynchronous DNS: L<AnyEvent::DNS>. 2652Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines