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.263 by root, Wed Jul 29 12:39:21 2009 UTC vs.
Revision 1.324 by root, Thu May 20 23:55:51 2010 UTC

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 => ...
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
449
450 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
402 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 (one some backends, 454The child process is specified by the C<pid> argument (one some backends,
406using C<0> watches for any child process exit, on others this will 455using C<0> watches for any child process exit, on others this will
455 # do something else, then wait for process exit 504 # do something else, then wait for process exit
456 $done->recv; 505 $done->recv;
457 506
458=head2 IDLE WATCHERS 507=head2 IDLE WATCHERS
459 508
460Sometimes there is a need to do something, but it is not so important 509 $w = AnyEvent->idle (cb => <callback>);
461to do it instantly, but only when there is nothing better to do. This
462"nothing better to do" is usually defined to be "no other events need
463attention by the event loop".
464 510
465Idle watchers ideally get invoked when the event loop has nothing 511Repeatedly invoke the callback after the process becomes idle, until
466better to do, just before it would block the process to wait for new 512either the watcher is destroyed or new events have been detected.
467events. Instead of blocking, the idle watcher is invoked.
468 513
469Most 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
470EV, 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
471will simply call the callback "from time to time". 525will simply call the callback "from time to time".
472 526
473Example: read lines from STDIN, but only process them when the 527Example: read lines from STDIN, but only process them when the
474program is otherwise idle: 528program is otherwise idle:
490 }); 544 });
491 }); 545 });
492 546
493=head2 CONDITION VARIABLES 547=head2 CONDITION VARIABLES
494 548
549 $cv = AnyEvent->condvar;
550
551 $cv->send (<list>);
552 my @res = $cv->recv;
553
495If 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
496require you to run some blocking "loop", "run" or similar function that 555require you to run some blocking "loop", "run" or similar function that
497will actively watch for new events and call your callbacks. 556will actively watch for new events and call your callbacks.
498 557
499AnyEvent is slightly different: it expects somebody else to run the event 558AnyEvent is slightly different: it expects somebody else to run the event
550eventually calls C<< -> send >>, and the "consumer side", which waits 609eventually calls C<< -> send >>, and the "consumer side", which waits
551for the send to occur. 610for the send to occur.
552 611
553Example: wait for a timer. 612Example: wait for a timer.
554 613
555 # wait till the result is ready 614 # condition: "wait till the timer is fired"
556 my $result_ready = AnyEvent->condvar; 615 my $timer_fired = AnyEvent->condvar;
557 616
558 # do something such as adding a timer 617 # create the timer - we could wait for, say
559 # or socket watcher the calls $result_ready->send 618 # a handle becomign ready, or even an
560 # when the "result" is ready. 619 # AnyEvent::HTTP request to finish, but
561 # in this case, we simply use a timer: 620 # in this case, we simply use a timer:
562 my $w = AnyEvent->timer ( 621 my $w = AnyEvent->timer (
563 after => 1, 622 after => 1,
564 cb => sub { $result_ready->send }, 623 cb => sub { $timer_fired->send },
565 ); 624 );
566 625
567 # this "blocks" (while handling events) till the callback 626 # this "blocks" (while handling events) till the callback
568 # calls -<send 627 # calls ->send
569 $result_ready->recv; 628 $timer_fired->recv;
570 629
571Example: 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
572variables are also callable directly. 631variables are also callable directly.
573 632
574 my $done = AnyEvent->condvar; 633 my $done = AnyEvent->condvar;
637one. 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
638to use a condition variable for the whole process. 697to use a condition variable for the whole process.
639 698
640Every 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
641C<< ->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
642>>, 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
643is 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
644callback 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.
645 705
646You 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
647sends), 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
648condition (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).
649 709
676begung can potentially be zero: 736begung can potentially be zero:
677 737
678 my $cv = AnyEvent->condvar; 738 my $cv = AnyEvent->condvar;
679 739
680 my %result; 740 my %result;
681 $cv->begin (sub { $cv->send (\%result) }); 741 $cv->begin (sub { shift->send (\%result) });
682 742
683 for my $host (@list_of_hosts) { 743 for my $host (@list_of_hosts) {
684 $cv->begin; 744 $cv->begin;
685 ping_host_then_call_callback $host, sub { 745 ping_host_then_call_callback $host, sub {
686 $result{$host} = ...; 746 $result{$host} = ...;
761=item $cb = $cv->cb ($cb->($cv)) 821=item $cb = $cv->cb ($cb->($cv))
762 822
763This is a mutator function that returns the callback set and optionally 823This is a mutator function that returns the callback set and optionally
764replaces it before doing so. 824replaces it before doing so.
765 825
766The callback will be called when the condition becomes "true", i.e. when 826The callback will be called when the condition becomes (or already was)
767C<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
768variable itself. Calling C<recv> inside the callback or at any later time 828the only argument being the condition variable itself. Calling C<recv>
769is guaranteed not to block. 829inside the callback or at any later time is guaranteed not to block.
770 830
771=back 831=back
772 832
773=head1 SUPPORTED EVENT LOOPS/BACKENDS 833=head1 SUPPORTED EVENT LOOPS/BACKENDS
774 834
777=over 4 837=over 4
778 838
779=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.
780 840
781EV 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
782use. 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
783that, will fall back to its own pure-perl implementation, which is 843pure-perl implementation, which is available everywhere as it comes with
784available everywhere as it comes with AnyEvent itself. 844AnyEvent itself.
785 845
786 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 846 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
787 AnyEvent::Impl::Event based on Event, very stable, few glitches.
788 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 847 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
789 848
790=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.
791 850
792These 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
793is 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
794them. This means that AnyEvent will automatically pick the right backend 853them. This means that AnyEvent will automatically pick the right backend
795when the main program loads an event module before anything starts to 854when the main program loads an event module before anything starts to
796create watchers. Nothing special needs to be done by the main program. 855create watchers. Nothing special needs to be done by the main program.
797 856
857 AnyEvent::Impl::Event based on Event, very stable, few glitches.
798 AnyEvent::Impl::Glib based on Glib, slow but very stable. 858 AnyEvent::Impl::Glib based on Glib, slow but very stable.
799 AnyEvent::Impl::Tk based on Tk, very broken. 859 AnyEvent::Impl::Tk based on Tk, very broken.
800 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 860 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
801 AnyEvent::Impl::POE based on POE, very slow, some limitations. 861 AnyEvent::Impl::POE based on POE, very slow, some limitations.
802 AnyEvent::Impl::Irssi used when running within irssi. 862 AnyEvent::Impl::Irssi used when running within irssi.
912You should check C<$AnyEvent::MODEL> before adding to this array, though: 972You should check C<$AnyEvent::MODEL> before adding to this array, though:
913if 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
914array will be ignored. 974array will be ignored.
915 975
916Best use C<AnyEvent::post_detect { BLOCK }> when your application allows 976Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
917it,as it takes care of these details. 977it, as it takes care of these details.
918 978
919This variable is mainly useful for modules that can do something useful 979This variable is mainly useful for modules that can do something useful
920when 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
921not 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
922into 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 }
923 996
924=back 997=back
925 998
926=head1 WHAT TO DO IN A MODULE 999=head1 WHAT TO DO IN A MODULE
927 1000
984=head1 OTHER MODULES 1057=head1 OTHER MODULES
985 1058
986The following is a non-exhaustive list of additional modules that use 1059The following is a non-exhaustive list of additional modules that use
987AnyEvent 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
988modules 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
989come with AnyEvent, most are available via CPAN. 1062come with AnyEvent, the others are available via CPAN.
990 1063
991=over 4 1064=over 4
992 1065
993=item L<AnyEvent::Util> 1066=item L<AnyEvent::Util>
994 1067
1009 1082
1010=item L<AnyEvent::DNS> 1083=item L<AnyEvent::DNS>
1011 1084
1012Provides rich asynchronous DNS resolver capabilities. 1085Provides rich asynchronous DNS resolver capabilities.
1013 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
1014=item L<AnyEvent::HTTP> 1110=item L<AnyEvent::DBI>
1015 1111
1016A 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,
1017HTTP 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.
1018 1121
1019=item L<AnyEvent::HTTPD> 1122=item L<AnyEvent::HTTPD>
1020 1123
1021Provides a simple web application server framework. 1124A simple embedded webserver.
1022 1125
1023=item L<AnyEvent::FastPing> 1126=item L<AnyEvent::FastPing>
1024 1127
1025The fastest ping in the west. 1128The fastest ping in the west.
1026
1027=item L<AnyEvent::DBI>
1028
1029Executes L<DBI> requests asynchronously in a proxy process.
1030
1031=item L<AnyEvent::AIO>
1032
1033Truly asynchronous I/O, should be in the toolbox of every event
1034programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1035together.
1036
1037=item L<AnyEvent::BDB>
1038
1039Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1040L<BDB> and AnyEvent together.
1041
1042=item L<AnyEvent::GPSD>
1043
1044A non-blocking interface to gpsd, a daemon delivering GPS information.
1045
1046=item L<AnyEvent::IRC>
1047
1048AnyEvent based IRC client module family (replacing the older Net::IRC3).
1049
1050=item L<AnyEvent::XMPP>
1051
1052AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1053Net::XMPP2>.
1054
1055=item L<AnyEvent::IGS>
1056
1057A non-blocking interface to the Internet Go Server protocol (used by
1058L<App::IGS>).
1059
1060=item L<Net::FCP>
1061
1062AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1063of AnyEvent.
1064
1065=item L<Event::ExecFlow>
1066
1067High level API for event-based execution flow control.
1068 1129
1069=item L<Coro> 1130=item L<Coro>
1070 1131
1071Has special support for AnyEvent via L<Coro::AnyEvent>. 1132Has special support for AnyEvent via L<Coro::AnyEvent>.
1072 1133
1076 1137
1077package AnyEvent; 1138package AnyEvent;
1078 1139
1079# basically a tuned-down version of common::sense 1140# basically a tuned-down version of common::sense
1080sub common_sense { 1141sub common_sense {
1081 # no warnings 1142 # from common:.sense 1.0
1082 ${^WARNING_BITS} ^= ${^WARNING_BITS}; 1143 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1083 # use strict vars subs 1144 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1084 $^H |= 0x00000600; 1145 $^H |= 0x00000600;
1085} 1146}
1086 1147
1087BEGIN { AnyEvent::common_sense } 1148BEGIN { AnyEvent::common_sense }
1088 1149
1089use Carp (); 1150use Carp ();
1090 1151
1091our $VERSION = 4.881; 1152our $VERSION = '5.261';
1092our $MODEL; 1153our $MODEL;
1093 1154
1094our $AUTOLOAD; 1155our $AUTOLOAD;
1095our @ISA; 1156our @ISA;
1096 1157
1097our @REGISTRY; 1158our @REGISTRY;
1098 1159
1099our $WIN32;
1100
1101our $VERBOSE; 1160our $VERBOSE;
1102 1161
1103BEGIN { 1162BEGIN {
1104 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1163 require "AnyEvent/constants.pl";
1164
1105 eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; 1165 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1106 1166
1107 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1167 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1108 if ${^TAINT}; 1168 if ${^TAINT};
1109 1169
1110 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1170 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1122 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1182 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1123} 1183}
1124 1184
1125my @models = ( 1185my @models = (
1126 [EV:: => AnyEvent::Impl::EV:: , 1], 1186 [EV:: => AnyEvent::Impl::EV:: , 1],
1127 [Event:: => AnyEvent::Impl::Event::, 1],
1128 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1187 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1129 # everything below here will not (normally) be autoprobed 1188 # everything below here will not (normally) be autoprobed
1130 # as the pureperl backend should work everywhere 1189 # as the pureperl backend should work everywhere
1131 # and is usually faster 1190 # and is usually faster
1191 [Event:: => AnyEvent::Impl::Event::, 1],
1132 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1192 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1133 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1193 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1134 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1194 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1135 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1195 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1136 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1196 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1139 [Prima:: => AnyEvent::Impl::POE::], 1199 [Prima:: => AnyEvent::Impl::POE::],
1140 # 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
1141 # byzantine signal and broken child handling, among others. 1201 # byzantine signal and broken child handling, among others.
1142 # 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
1143 # obvious default class. 1203 # obvious default class.
1144# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1204 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1145# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1205 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1146# [0, 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
1147); 1208);
1148 1209
1149our %method = map +($_ => 1), 1210our %method = map +($_ => 1),
1150 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);
1151 1212
1152our @post_detect; 1213our @post_detect;
1153 1214
1154sub post_detect(&) { 1215sub post_detect(&) {
1155 my ($cb) = @_; 1216 my ($cb) = @_;
1156 1217
1157 if ($MODEL) {
1158 $cb->();
1159
1160 undef
1161 } else {
1162 push @post_detect, $cb; 1218 push @post_detect, $cb;
1163 1219
1164 defined wantarray 1220 defined wantarray
1165 ? bless \$cb, "AnyEvent::Util::postdetect" 1221 ? bless \$cb, "AnyEvent::Util::postdetect"
1166 : () 1222 : ()
1167 }
1168} 1223}
1169 1224
1170sub AnyEvent::Util::postdetect::DESTROY { 1225sub AnyEvent::Util::postdetect::DESTROY {
1171 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1226 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1172} 1227}
1173 1228
1174sub 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
1175 unless ($MODEL) { 1247 unless ($MODEL) {
1176 local $SIG{__DIE__}; 1248 for (@REGISTRY, @models) {
1177 1249 my ($package, $model) = @$_;
1178 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1250 if (${"$package\::VERSION"} > 0) {
1179 my $model = "AnyEvent::Impl::$1";
1180 if (eval "require $model") { 1251 if (eval "require $model") {
1181 $MODEL = $model; 1252 $MODEL = $model;
1182 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;
1183 } else { 1254 last;
1184 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1255 }
1185 } 1256 }
1186 } 1257 }
1187 1258
1188 # check for already loaded models
1189 unless ($MODEL) { 1259 unless ($MODEL) {
1260 # try to autoload a model
1190 for (@REGISTRY, @models) { 1261 for (@REGISTRY, @models) {
1191 my ($package, $model) = @$_; 1262 my ($package, $model, $autoload) = @$_;
1263 if (
1264 $autoload
1265 and eval "require $package"
1192 if (${"$package\::VERSION"} > 0) { 1266 and ${"$package\::VERSION"} > 0
1193 if (eval "require $model") { 1267 and eval "require $model"
1268 ) {
1194 $MODEL = $model; 1269 $MODEL = $model;
1195 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1270 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1196 last; 1271 last;
1197 }
1198 } 1272 }
1199 } 1273 }
1200 1274
1201 unless ($MODEL) {
1202 # try to autoload a model
1203 for (@REGISTRY, @models) {
1204 my ($package, $model, $autoload) = @$_;
1205 if (
1206 $autoload
1207 and eval "require $package"
1208 and ${"$package\::VERSION"} > 0
1209 and eval "require $model"
1210 ) {
1211 $MODEL = $model;
1212 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1213 last;
1214 }
1215 }
1216
1217 $MODEL 1275 $MODEL
1218 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";
1219 }
1220 } 1277 }
1221
1222 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1223
1224 unshift @ISA, $MODEL;
1225
1226 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1227
1228 (shift @post_detect)->() while @post_detect;
1229 } 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 };
1230 1301
1231 $MODEL 1302 $MODEL
1232} 1303}
1233 1304
1234sub AUTOLOAD { 1305sub AUTOLOAD {
1235 (my $func = $AUTOLOAD) =~ s/.*://; 1306 (my $func = $AUTOLOAD) =~ s/.*://;
1236 1307
1237 $method{$func} 1308 $method{$func}
1238 or Carp::croak "$func: not a valid method for AnyEvent objects"; 1309 or Carp::croak "$func: not a valid AnyEvent class method";
1239 1310
1240 detect unless $MODEL; 1311 detect;
1241 1312
1242 my $class = shift; 1313 my $class = shift;
1243 $class->$func (@_); 1314 $class->$func (@_);
1244} 1315}
1245 1316
1258 # 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
1259 1330
1260 ($fh2, $rw) 1331 ($fh2, $rw)
1261} 1332}
1262 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
1263package AnyEvent::Base; 1387package AnyEvent::Base;
1264 1388
1265# default implementations for many methods 1389# default implementations for many methods
1266 1390
1267sub _time { 1391sub time {
1392 eval q{ # poor man's autoloading {}
1268 # probe for availability of Time::HiRes 1393 # probe for availability of Time::HiRes
1269 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1394 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1270 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;
1271 *_time = \&Time::HiRes::time; 1396 *AE::time = \&Time::HiRes::time;
1272 # if (eval "use POSIX (); (POSIX::times())... 1397 # if (eval "use POSIX (); (POSIX::times())...
1273 } else { 1398 } else {
1274 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;
1275 *_time = sub { time }; # epic fail 1400 *AE::time = sub (){ time }; # epic fail
1401 }
1402
1403 *time = sub { AE::time }; # different prototypes
1276 } 1404 };
1405 die if $@;
1277 1406
1278 &_time 1407 &time
1279} 1408}
1280 1409
1281sub time { _time } 1410*now = \&time;
1282sub now { _time } 1411
1283sub now_update { } 1412sub now_update { }
1284 1413
1285# default implementation for ->condvar 1414# default implementation for ->condvar
1286 1415
1287sub condvar { 1416sub condvar {
1417 eval q{ # poor man's autoloading {}
1418 *condvar = sub {
1288 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
1289} 1429}
1290 1430
1291# default implementation for ->signal 1431# default implementation for ->signal
1292 1432
1293our $HAVE_ASYNC_INTERRUPT; 1433our $HAVE_ASYNC_INTERRUPT;
1294 1434
1295sub _have_async_interrupt() { 1435sub _have_async_interrupt() {
1296 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} 1436 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1297 && eval "use Async::Interrupt 1.0 (); 1") 1437 && eval "use Async::Interrupt 1.02 (); 1")
1298 unless defined $HAVE_ASYNC_INTERRUPT; 1438 unless defined $HAVE_ASYNC_INTERRUPT;
1299 1439
1300 $HAVE_ASYNC_INTERRUPT 1440 $HAVE_ASYNC_INTERRUPT
1301} 1441}
1302 1442
1303our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1443our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1304our (%SIG_ASY, %SIG_ASY_W); 1444our (%SIG_ASY, %SIG_ASY_W);
1305our ($SIG_COUNT, $SIG_TW); 1445our ($SIG_COUNT, $SIG_TW);
1306 1446
1307sub _signal_exec {
1308 $HAVE_ASYNC_INTERRUPT
1309 ? $SIGPIPE_R->drain
1310 : sysread $SIGPIPE_R, my $dummy, 9;
1311
1312 while (%SIG_EV) {
1313 for (keys %SIG_EV) {
1314 delete $SIG_EV{$_};
1315 $_->() for values %{ $SIG_CB{$_} || {} };
1316 }
1317 }
1318}
1319
1320# install a dummy wakeup watcher to reduce signal catching latency 1447# install a dummy wakeup watcher to reduce signal catching latency
1448# used by Impls
1321sub _sig_add() { 1449sub _sig_add() {
1322 unless ($SIG_COUNT++) { 1450 unless ($SIG_COUNT++) {
1323 # try to align timer on a full-second boundary, if possible 1451 # try to align timer on a full-second boundary, if possible
1324 my $NOW = AnyEvent->now; 1452 my $NOW = AE::now;
1325 1453
1326 $SIG_TW = AnyEvent->timer ( 1454 $SIG_TW = AE::timer
1327 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1455 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1328 interval => $MAX_SIGNAL_LATENCY, 1456 $MAX_SIGNAL_LATENCY,
1329 cb => sub { }, # just for the PERL_ASYNC_CHECK 1457 sub { } # just for the PERL_ASYNC_CHECK
1330 ); 1458 ;
1331 } 1459 }
1332} 1460}
1333 1461
1334sub _sig_del { 1462sub _sig_del {
1335 undef $SIG_TW 1463 undef $SIG_TW
1336 unless --$SIG_COUNT; 1464 unless --$SIG_COUNT;
1337} 1465}
1338 1466
1339our %SIGNAME2NUM;
1340our @SIGNUM2NAME;
1341our $_sig_name_init; $_sig_name_init = sub { 1467our $_sig_name_init; $_sig_name_init = sub {
1468 eval q{ # poor man's autoloading {}
1342 undef $_sig_name_init; 1469 undef $_sig_name_init;
1343 1470
1344 if (_have_async_interrupt) { 1471 if (_have_async_interrupt) {
1345 *sig2num = \&Async::Interrupt::sig2num; 1472 *sig2num = \&Async::Interrupt::sig2num;
1346 *sig2name = \&Async::Interrupt::sig2name; 1473 *sig2name = \&Async::Interrupt::sig2name;
1347 } else { 1474 } else {
1348 require Config; 1475 require Config;
1349 1476
1477 my %signame2num;
1350 @SIGNAME2NUM{ split ' ', $Config::Config{sig_name} } 1478 @signame2num{ split ' ', $Config::Config{sig_name} }
1351 = split ' ', $Config::Config{sig_num}; 1479 = split ' ', $Config::Config{sig_num};
1352 @SIGNUM2NAME[values %SIGNAME2NUM] = keys %SIGNAME2NUM;
1353 1480
1481 my @signum2name;
1482 @signum2name[values %signame2num] = keys %signame2num;
1483
1354 *sig2num = sub($) { 1484 *sig2num = sub($) {
1355 $_[0] > 0 ? shift : $SIGNAME2NUM{+shift} 1485 $_[0] > 0 ? shift : $signame2num{+shift}
1356 }; 1486 };
1357 *sig2name = sub ($) { 1487 *sig2name = sub ($) {
1358 $_[0] > 0 ? $SIGNUM2NAME[+shift] : shift 1488 $_[0] > 0 ? $signum2name[+shift] : shift
1489 };
1359 }; 1490 }
1360 } 1491 };
1492 die if $@;
1361}; 1493};
1362 1494
1363sub sig2num ($) { &$_sig_name_init; &sig2num } 1495sub sig2num ($) { &$_sig_name_init; &sig2num }
1364sub sig2name($) { &$_sig_name_init; &sig2name } 1496sub sig2name($) { &$_sig_name_init; &sig2name }
1365 1497
1366sub _signal { 1498sub signal {
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;
1503
1504 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1505 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1506
1507 } else {
1508 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1509
1510 if (AnyEvent::WIN32) {
1511 require AnyEvent::Util;
1512
1513 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1514 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1515 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1516 } else {
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;
1524 }
1525
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 {
1367 my (undef, %arg) = @_; 1534 my (undef, %arg) = @_;
1368 1535
1369 my $signal = uc $arg{signal}
1370 or Carp::croak "required option 'signal' is missing";
1371
1372 if ($HAVE_ASYNC_INTERRUPT) {
1373 # async::interrupt 1536 # async::interrupt
1374
1375 $signal = sig2num $signal; 1537 my $signal = sig2num $arg{signal};
1376 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1538 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1377 1539
1378 $SIG_ASY{$signal} ||= new Async::Interrupt 1540 $SIG_ASY{$signal} ||= new Async::Interrupt
1379 cb => sub { undef $SIG_EV{$signal} }, 1541 cb => sub { undef $SIG_EV{$signal} },
1380 signal => $signal, 1542 signal => $signal,
1381 pipe => [$SIGPIPE_R->filenos], 1543 pipe => [$SIGPIPE_R->filenos],
1382 pipe_autodrain => 0, 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 }
1383 ; 1568 ;
1384 1569
1385 } else { 1570 *AnyEvent::Base::signal::DESTROY = sub {
1386 # pure perl 1571 my ($signal, $cb) = @{$_[0]};
1387 1572
1388 # AE::Util has been loaded in signal 1573 _sig_del;
1389 $signal = sig2name $signal;
1390 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1391 1574
1392 $SIG{$signal} ||= sub { 1575 delete $SIG_CB{$signal}{$cb};
1393 local $!; 1576
1394 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 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.
1395 undef $SIG_EV{$signal}; 1582 undef $SIG{$signal}
1583 unless keys %{ $SIG_CB{$signal} };
1396 }; 1584 };
1397 1585
1398 # can't do signal processing without introducing races in pure perl, 1586 *_signal_exec = sub {
1399 # so limit the signal latency. 1587 $HAVE_ASYNC_INTERRUPT
1400 _sig_add; 1588 ? $SIGPIPE_R->drain
1401 } 1589 : sysread $SIGPIPE_R, (my $dummy), 9;
1402 1590
1403 bless [$signal, $arg{cb}], "AnyEvent::Base::signal" 1591 while (%SIG_EV) {
1404} 1592 for (keys %SIG_EV) {
1405 1593 delete $SIG_EV{$_};
1406sub signal { 1594 $_->() for values %{ $SIG_CB{$_} || {} };
1407 # probe for availability of Async::Interrupt 1595 }
1408 if (_have_async_interrupt) { 1596 }
1409 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1410
1411 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1412 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1413
1414 } else {
1415 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1416
1417 require Fcntl;
1418
1419 if (AnyEvent::WIN32) {
1420 require AnyEvent::Util;
1421
1422 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1423 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1424 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1425 } else {
1426 pipe $SIGPIPE_R, $SIGPIPE_W;
1427 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1428 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1429
1430 # not strictly required, as $^F is normally 2, but let's make sure...
1431 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1432 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1433 } 1597 };
1434
1435 $SIGPIPE_R
1436 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1437
1438 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1439 } 1598 };
1599 die if $@;
1440 1600
1441 *signal = \&_signal;
1442 &signal 1601 &signal
1443}
1444
1445sub AnyEvent::Base::signal::DESTROY {
1446 my ($signal, $cb) = @{$_[0]};
1447
1448 _sig_del;
1449
1450 delete $SIG_CB{$signal}{$cb};
1451
1452 $HAVE_ASYNC_INTERRUPT
1453 ? delete $SIG_ASY{$signal}
1454 : # delete doesn't work with older perls - they then
1455 # print weird messages, or just unconditionally exit
1456 # instead of getting the default action.
1457 undef $SIG{$signal}
1458 unless keys %{ $SIG_CB{$signal} };
1459} 1602}
1460 1603
1461# default implementation for ->child 1604# default implementation for ->child
1462 1605
1463our %PID_CB; 1606our %PID_CB;
1464our $CHLD_W; 1607our $CHLD_W;
1465our $CHLD_DELAY_W; 1608our $CHLD_DELAY_W;
1466our $WNOHANG; 1609our $WNOHANG;
1467 1610
1611# used by many Impl's
1468sub _emit_childstatus($$) { 1612sub _emit_childstatus($$) {
1469 my (undef, $rpid, $rstatus) = @_; 1613 my (undef, $rpid, $rstatus) = @_;
1470 1614
1471 $_->($rpid, $rstatus) 1615 $_->($rpid, $rstatus)
1472 for values %{ $PID_CB{$rpid} || {} }, 1616 for values %{ $PID_CB{$rpid} || {} },
1473 values %{ $PID_CB{0} || {} }; 1617 values %{ $PID_CB{0} || {} };
1474} 1618}
1475 1619
1476sub _sigchld {
1477 my $pid;
1478
1479 AnyEvent->_emit_childstatus ($pid, $?)
1480 while ($pid = waitpid -1, $WNOHANG) > 0;
1481}
1482
1483sub 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 {
1484 my (undef, %arg) = @_; 1630 my (undef, %arg) = @_;
1485 1631
1486 defined (my $pid = $arg{pid} + 0) 1632 defined (my $pid = $arg{pid} + 0)
1487 or Carp::croak "required option 'pid' is missing"; 1633 or Carp::croak "required option 'pid' is missing";
1488 1634
1489 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1635 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1490 1636
1491 # WNOHANG is almost cetrainly 1 everywhere 1637 # WNOHANG is almost cetrainly 1 everywhere
1492 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1638 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1493 ? 1 1639 ? 1
1494 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1640 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1495 1641
1496 unless ($CHLD_W) { 1642 unless ($CHLD_W) {
1497 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1643 $CHLD_W = AE::signal CHLD => \&_sigchld;
1498 # 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
1499 &_sigchld; 1645 &_sigchld;
1500 } 1646 }
1501 1647
1502 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1648 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1503} 1649 };
1504 1650
1505sub AnyEvent::Base::child::DESTROY { 1651 *AnyEvent::Base::child::DESTROY = sub {
1506 my ($pid, $cb) = @{$_[0]}; 1652 my ($pid, $cb) = @{$_[0]};
1507 1653
1508 delete $PID_CB{$pid}{$cb}; 1654 delete $PID_CB{$pid}{$cb};
1509 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1655 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1510 1656
1511 undef $CHLD_W unless keys %PID_CB; 1657 undef $CHLD_W unless keys %PID_CB;
1658 };
1659 };
1660 die if $@;
1661
1662 &child
1512} 1663}
1513 1664
1514# idle emulation is done by simply using a timer, regardless 1665# idle emulation is done by simply using a timer, regardless
1515# of whether the process is idle or not, and not letting 1666# of whether the process is idle or not, and not letting
1516# the callback use more than 50% of the time. 1667# the callback use more than 50% of the time.
1517sub idle { 1668sub idle {
1669 eval q{ # poor man's autoloading {}
1670 *idle = sub {
1518 my (undef, %arg) = @_; 1671 my (undef, %arg) = @_;
1519 1672
1520 my ($cb, $w, $rcb) = $arg{cb}; 1673 my ($cb, $w, $rcb) = $arg{cb};
1521 1674
1522 $rcb = sub { 1675 $rcb = sub {
1523 if ($cb) { 1676 if ($cb) {
1524 $w = _time; 1677 $w = _time;
1525 &$cb; 1678 &$cb;
1526 $w = _time - $w; 1679 $w = _time - $w;
1527 1680
1528 # 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,
1529 # within some limits 1682 # within some limits
1530 $w = 0.0001 if $w < 0.0001; 1683 $w = 0.0001 if $w < 0.0001;
1531 $w = 5 if $w > 5; 1684 $w = 5 if $w > 5;
1532 1685
1533 $w = AnyEvent->timer (after => $w, cb => $rcb); 1686 $w = AE::timer $w, 0, $rcb;
1534 } else { 1687 } else {
1535 # clean up... 1688 # clean up...
1536 undef $w; 1689 undef $w;
1537 undef $rcb; 1690 undef $rcb;
1691 }
1692 };
1693
1694 $w = AE::timer 0.05, 0, $rcb;
1695
1696 bless \\$cb, "AnyEvent::Base::idle"
1538 } 1697 };
1698
1699 *AnyEvent::Base::idle::DESTROY = sub {
1700 undef $${$_[0]};
1701 };
1539 }; 1702 };
1703 die if $@;
1540 1704
1541 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1705 &idle
1542
1543 bless \\$cb, "AnyEvent::Base::idle"
1544}
1545
1546sub AnyEvent::Base::idle::DESTROY {
1547 undef $${$_[0]};
1548} 1706}
1549 1707
1550package AnyEvent::CondVar; 1708package AnyEvent::CondVar;
1551 1709
1552our @ISA = AnyEvent::CondVar::Base::; 1710our @ISA = AnyEvent::CondVar::Base::;
1600 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1758 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1601 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1759 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1602} 1760}
1603 1761
1604sub cb { 1762sub cb {
1605 $_[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
1606 $_[0]{_ae_cb} 1770 $cv->{_ae_cb}
1607} 1771}
1608 1772
1609sub begin { 1773sub begin {
1610 ++$_[0]{_ae_counter}; 1774 ++$_[0]{_ae_counter};
1611 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1775 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1820 warn "read: $input\n"; # output what has been read 1984 warn "read: $input\n"; # output what has been read
1821 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1985 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1822 }, 1986 },
1823 ); 1987 );
1824 1988
1825 my $time_watcher; # can only be used once
1826
1827 sub new_timer {
1828 $timer = AnyEvent->timer (after => 1, cb => sub { 1989 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1829 warn "timeout\n"; # print 'timeout' about every second 1990 warn "timeout\n"; # print 'timeout' at most every second
1830 &new_timer; # and restart the time
1831 }); 1991 });
1832 }
1833
1834 new_timer; # create first timer
1835 1992
1836 $cv->recv; # wait until user enters /^q/i 1993 $cv->recv; # wait until user enters /^q/i
1837 1994
1838=head1 REAL-WORLD EXAMPLE 1995=head1 REAL-WORLD EXAMPLE
1839 1996
1912 2069
1913The 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)
1914that occurred during request processing. The C<result> method detects 2071that occurred during request processing. The C<result> method detects
1915whether an exception as thrown (it is stored inside the $txn object) 2072whether an exception as thrown (it is stored inside the $txn object)
1916and just throws the exception, which means connection errors and other 2073and just throws the exception, which means connection errors and other
1917problems 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
1918random callback. 2075random callback.
1919 2076
1920All of this enables the following usage styles: 2077All of this enables the following usage styles:
1921 2078
19221. Blocking: 20791. Blocking:
1970through AnyEvent. The benchmark creates a lot of timers (with a zero 2127through AnyEvent. The benchmark creates a lot of timers (with a zero
1971timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2128timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1972which it is), lets them fire exactly once and destroys them again. 2129which it is), lets them fire exactly once and destroys them again.
1973 2130
1974Source 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
1975distribution. 2132distribution. It uses the L<AE> interface, which makes a real difference
2133for the EV and Perl backends only.
1976 2134
1977=head3 Explanation of the columns 2135=head3 Explanation of the columns
1978 2136
1979I<watcher> is the number of event watchers created/destroyed. Since 2137I<watcher> is the number of event watchers created/destroyed. Since
1980different event models feature vastly different performances, each event 2138different event models feature vastly different performances, each event
2001watcher. 2159watcher.
2002 2160
2003=head3 Results 2161=head3 Results
2004 2162
2005 name watchers bytes create invoke destroy comment 2163 name watchers bytes create invoke destroy comment
2006 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
2007 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
2008 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
2009 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
2010 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
2011 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
2012 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
2013 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
2014 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
2015 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
2016 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
2017 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
2018 2176
2019=head3 Discussion 2177=head3 Discussion
2020 2178
2021The benchmark does I<not> measure scalability of the event loop very 2179The benchmark does I<not> measure scalability of the event loop very
2022well. 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)
2034benchmark machine, handling an event takes roughly 1600 CPU cycles with 2192benchmark machine, handling an event takes roughly 1600 CPU cycles with
2035EV, 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
2036cycles with POE. 2194cycles with POE.
2037 2195
2038C<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
2039maximal/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
2040far less memory than any other event loop and is still faster than Event 2200any other event loop and is still faster than Event natively).
2041natively.
2042 2201
2043The 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
2044constant 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
2045interpreter and the backend itself). Nevertheless this shows that it 2204interpreter and the backend itself). Nevertheless this shows that it
2046adds very little overhead in itself. Like any select-based backend its 2205adds very little overhead in itself. Like any select-based backend its
2120In 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
2121(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
2122connections, most of which are idle at any one point in time. 2281connections, most of which are idle at any one point in time.
2123 2282
2124Source 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
2125distribution. 2284distribution. It uses the L<AE> interface, which makes a real difference
2285for the EV and Perl backends only.
2126 2286
2127=head3 Explanation of the columns 2287=head3 Explanation of the columns
2128 2288
2129I<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
2130each server has a read and write socket end). 2290each server has a read and write socket end).
2138a new one that moves the timeout into the future. 2298a new one that moves the timeout into the future.
2139 2299
2140=head3 Results 2300=head3 Results
2141 2301
2142 name sockets create request 2302 name sockets create request
2143 EV 20000 69.01 11.16 2303 EV 20000 62.66 7.99
2144 Perl 20000 73.32 35.87 2304 Perl 20000 68.32 32.64
2145 IOAsync 20000 157.00 98.14 epoll 2305 IOAsync 20000 174.06 101.15 epoll
2146 IOAsync 20000 159.31 616.06 poll 2306 IOAsync 20000 174.67 610.84 poll
2147 Event 20000 212.62 257.32 2307 Event 20000 202.69 242.91
2148 Glib 20000 651.16 1896.30 2308 Glib 20000 557.01 1689.52
2149 POE 20000 349.67 12317.24 uses POE::Loop::Event 2309 POE 20000 341.54 12086.32 uses POE::Loop::Event
2150 2310
2151=head3 Discussion 2311=head3 Discussion
2152 2312
2153This benchmark I<does> measure scalability and overall performance of the 2313This benchmark I<does> measure scalability and overall performance of the
2154particular event loop. 2314particular event loop.
2280As you can see, the AnyEvent + EV combination even beats the 2440As you can see, the AnyEvent + EV combination even beats the
2281hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2441hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2282backend easily beats IO::Lambda and POE. 2442backend easily beats IO::Lambda and POE.
2283 2443
2284And 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
2285slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2445slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2286large margin, even though it does all of DNS, tcp-connect and socket I/O 2446higher level ("unoptimised") abstractions by a large margin, even though
2287in a non-blocking way. 2447it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2288 2448
2289The 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
2290F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2450F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2291part of the IO::lambda distribution and were used without any changes. 2451part of the IO::Lambda distribution and were used without any changes.
2292 2452
2293 2453
2294=head1 SIGNALS 2454=head1 SIGNALS
2295 2455
2296AnyEvent currently installs handlers for these signals: 2456AnyEvent currently installs handlers for these signals:
2338it's built-in modules) are required to use it. 2498it's built-in modules) are required to use it.
2339 2499
2340That 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
2341modules if they are installed. 2501modules if they are installed.
2342 2502
2343This section epxlains which additional modules will be used, and how they 2503This section explains which additional modules will be used, and how they
2344affect AnyEvent's operetion. 2504affect AnyEvent's operation.
2345 2505
2346=over 4 2506=over 4
2347 2507
2348=item L<Async::Interrupt> 2508=item L<Async::Interrupt>
2349 2509
2354catch the signals) with some delay (default is 10 seconds, look for 2514catch the signals) with some delay (default is 10 seconds, look for
2355C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2515C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2356 2516
2357If 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
2358catching, 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
2359will not be interrupted regularly, which is more efficient (And good for 2519will not be interrupted regularly, which is more efficient (and good for
2360battery life on laptops). 2520battery life on laptops).
2361 2521
2362This 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
2363that 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).
2364 2524
2376automatic timer adjustments even when no monotonic clock is available, 2536automatic timer adjustments even when no monotonic clock is available,
2377can take avdantage of advanced kernel interfaces such as C<epoll> and 2537can take avdantage of advanced kernel interfaces such as C<epoll> and
2378C<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
2379L<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>).
2380 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
2381=item L<Guard> 2544=item L<Guard>
2382 2545
2383The guard module, when used, will be used to implement 2546The guard module, when used, will be used to implement
2384C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a 2547C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2385lot 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
2386purely used for performance. 2549purely used for performance.
2387 2550
2388=item L<JSON> and L<JSON::XS> 2551=item L<JSON> and L<JSON::XS>
2389 2552
2390This 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
2391L<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
2392advantage 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.
2393
2394In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2395installed.
2396 2556
2397=item L<Net::SSLeay> 2557=item L<Net::SSLeay>
2398 2558
2399Implementing TLS/SSL in Perl is certainly interesting, but not very 2559Implementing TLS/SSL in Perl is certainly interesting, but not very
2400worthwhile: If this module is installed, then L<AnyEvent::Handle> (with 2560worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2411 2571
2412 2572
2413=head1 FORK 2573=head1 FORK
2414 2574
2415Most 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
2416because 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
2417calls. 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).
2418 2587
2419If 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
2420watcher 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
2421something 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.
2422 2600
2423 2601
2424=head1 SECURITY CONSIDERATIONS 2602=head1 SECURITY CONSIDERATIONS
2425 2603
2426AnyEvent can be forced to load any event model via 2604AnyEvent can be forced to load any event model via

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines