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.248 by root, Sat Jul 18 22:27:10 2009 UTC vs.
Revision 1.320 by root, Mon Apr 12 02:50:31 2010 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 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 L<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 => ...
40=head1 INTRODUCTION/TUTORIAL 43=head1 INTRODUCTION/TUTORIAL
41 44
42This manpage is mainly a reference manual. If you are interested 45This manpage is mainly a reference manual. If you are interested
43in a tutorial or some gentle introduction, have a look at the 46in a tutorial or some gentle introduction, have a look at the
44L<AnyEvent::Intro> manpage. 47L<AnyEvent::Intro> manpage.
48
49=head1 SUPPORT
50
51There is a mailinglist for discussing all things AnyEvent, and an IRC
52channel, too.
53
54See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
55Repository>, at L<http://anyevent.schmorp.de>, for more info.
45 56
46=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 57=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
47 58
48Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 59Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
49nowadays. So what is different about AnyEvent? 60nowadays. So what is different about AnyEvent?
173my variables are only visible after the statement in which they are 184my variables are only visible after the statement in which they are
174declared. 185declared.
175 186
176=head2 I/O WATCHERS 187=head2 I/O WATCHERS
177 188
189 $w = AnyEvent->io (
190 fh => <filehandle_or_fileno>,
191 poll => <"r" or "w">,
192 cb => <callback>,
193 );
194
178You 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
179with the following mandatory key-value pairs as arguments: 196with the following mandatory key-value pairs as arguments:
180 197
181C<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
182for 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
211 undef $w; 228 undef $w;
212 }); 229 });
213 230
214=head2 TIME WATCHERS 231=head2 TIME WATCHERS
215 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
216You can create a time watcher by calling the C<< AnyEvent->timer >> 241You can create a time watcher by calling the C<< AnyEvent->timer >>
217method with the following mandatory arguments: 242method with the following mandatory arguments:
218 243
219C<after> specifies after how many seconds (fractional values are 244C<after> specifies after how many seconds (fractional values are
220supported) 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
341might affect timers and time-outs. 366might affect timers and time-outs.
342 367
343When 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
344event loop's idea of "current time". 369event loop's idea of "current time".
345 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
346Note 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.
347 379
348=back 380=back
349 381
350=head2 SIGNAL WATCHERS 382=head2 SIGNAL WATCHERS
383
384 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
351 385
352You 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
353I<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
354callback to be invoked whenever a signal occurs. 388callback to be invoked whenever a signal occurs.
355 389
372 406
373Example: exit on SIGINT 407Example: exit on SIGINT
374 408
375 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 409 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
376 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
377=head3 Signal Races, Delays and Workarounds 428=head3 Signal Races, Delays and Workarounds
378 429
379Many 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
380callbacks 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
381race-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,
382in 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
383be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 435specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
384seconds). This variable can be changed only before the first signal 436variable can be changed only before the first signal watcher is created,
385watcher 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
386will 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
387saving. All these problems can be avoided by installing the optional 442All these problems can be avoided by installing the optional
388L<Async::Interrupt> module. This will not work with inherently broken 443L<Async::Interrupt> module, which works with most event loops. It will not
389event 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>
390currently, 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
391those, you just have to suffer the delays. 446one-second latency). For those, you just have to suffer the delays.
392 447
393=head2 CHILD PROCESS WATCHERS 448=head2 CHILD PROCESS WATCHERS
394 449
450 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
451
395You 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.
396 453
397The 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,
398watches for any child process exit). The watcher will triggered only when 455using C<0> watches for any child process exit, on others this will
399the child process has finished and an exit status is available, not on 456croak). The watcher will be triggered only when the child process has
400any trace events (stopped/continued). 457finished and an exit status is available, not on any trace events
458(stopped/continued).
401 459
402The 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
403waitpid), 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
404callback arguments. 462callback arguments.
405 463
446 # do something else, then wait for process exit 504 # do something else, then wait for process exit
447 $done->recv; 505 $done->recv;
448 506
449=head2 IDLE WATCHERS 507=head2 IDLE WATCHERS
450 508
451Sometimes there is a need to do something, but it is not so important 509 $w = AnyEvent->idle (cb => <callback>);
452to do it instantly, but only when there is nothing better to do. This
453"nothing better to do" is usually defined to be "no other events need
454attention by the event loop".
455 510
456Idle watchers ideally get invoked when the event loop has nothing 511Repeatedly invoke the callback after the process becomes idle, until
457better to do, just before it would block the process to wait for new 512either the watcher is destroyed or new events have been detected.
458events. Instead of blocking, the idle watcher is invoked.
459 513
460Most 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
461EV, 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
462will simply call the callback "from time to time". 525will simply call the callback "from time to time".
463 526
464Example: read lines from STDIN, but only process them when the 527Example: read lines from STDIN, but only process them when the
465program is otherwise idle: 528program is otherwise idle:
481 }); 544 });
482 }); 545 });
483 546
484=head2 CONDITION VARIABLES 547=head2 CONDITION VARIABLES
485 548
549 $cv = AnyEvent->condvar;
550
551 $cv->send (<list>);
552 my @res = $cv->recv;
553
486If 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
487require you to run some blocking "loop", "run" or similar function that 555require you to run some blocking "loop", "run" or similar function that
488will actively watch for new events and call your callbacks. 556will actively watch for new events and call your callbacks.
489 557
490AnyEvent is slightly different: it expects somebody else to run the event 558AnyEvent is slightly different: it expects somebody else to run the event
509Condition variables are similar to callbacks, except that you can 577Condition variables are similar to callbacks, except that you can
510optionally wait for them. They can also be called merge points - points 578optionally wait for them. They can also be called merge points - points
511in time where multiple outstanding events have been processed. And yet 579in time where multiple outstanding events have been processed. And yet
512another way to call them is transactions - each condition variable can be 580another way to call them is transactions - each condition variable can be
513used to represent a transaction, which finishes at some point and delivers 581used to represent a transaction, which finishes at some point and delivers
514a result. 582a result. And yet some people know them as "futures" - a promise to
583compute/deliver something that you can wait for.
515 584
516Condition variables are very useful to signal that something has finished, 585Condition variables are very useful to signal that something has finished,
517for example, if you write a module that does asynchronous http requests, 586for example, if you write a module that does asynchronous http requests,
518then a condition variable would be the ideal candidate to signal the 587then a condition variable would be the ideal candidate to signal the
519availability of results. The user can either act when the callback is 588availability of results. The user can either act when the callback is
540eventually calls C<< -> send >>, and the "consumer side", which waits 609eventually calls C<< -> send >>, and the "consumer side", which waits
541for the send to occur. 610for the send to occur.
542 611
543Example: wait for a timer. 612Example: wait for a timer.
544 613
545 # wait till the result is ready 614 # condition: "wait till the timer is fired"
546 my $result_ready = AnyEvent->condvar; 615 my $timer_fired = AnyEvent->condvar;
547 616
548 # do something such as adding a timer 617 # create the timer - we could wait for, say
549 # or socket watcher the calls $result_ready->send 618 # a handle becomign ready, or even an
550 # when the "result" is ready. 619 # AnyEvent::HTTP request to finish, but
551 # in this case, we simply use a timer: 620 # in this case, we simply use a timer:
552 my $w = AnyEvent->timer ( 621 my $w = AnyEvent->timer (
553 after => 1, 622 after => 1,
554 cb => sub { $result_ready->send }, 623 cb => sub { $timer_fired->send },
555 ); 624 );
556 625
557 # this "blocks" (while handling events) till the callback 626 # this "blocks" (while handling events) till the callback
558 # calls -<send 627 # calls ->send
559 $result_ready->recv; 628 $timer_fired->recv;
560 629
561Example: 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
562variables are also callable directly. 631variables are also callable directly.
563 632
564 my $done = AnyEvent->condvar; 633 my $done = AnyEvent->condvar;
627one. 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
628to use a condition variable for the whole process. 697to use a condition variable for the whole process.
629 698
630Every 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
631C<< ->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
632>>, 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
633is 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
634callback 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.
635 705
636You 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
637sends), 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
638condition (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).
639 709
666begung can potentially be zero: 736begung can potentially be zero:
667 737
668 my $cv = AnyEvent->condvar; 738 my $cv = AnyEvent->condvar;
669 739
670 my %result; 740 my %result;
671 $cv->begin (sub { $cv->send (\%result) }); 741 $cv->begin (sub { shift->send (\%result) });
672 742
673 for my $host (@list_of_hosts) { 743 for my $host (@list_of_hosts) {
674 $cv->begin; 744 $cv->begin;
675 ping_host_then_call_callback $host, sub { 745 ping_host_then_call_callback $host, sub {
676 $result{$host} = ...; 746 $result{$host} = ...;
751=item $cb = $cv->cb ($cb->($cv)) 821=item $cb = $cv->cb ($cb->($cv))
752 822
753This is a mutator function that returns the callback set and optionally 823This is a mutator function that returns the callback set and optionally
754replaces it before doing so. 824replaces it before doing so.
755 825
756The callback will be called when the condition becomes "true", i.e. when 826The callback will be called when the condition becomes (or already was)
757C<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
758variable itself. Calling C<recv> inside the callback or at any later time 828the only argument being the condition variable itself. Calling C<recv>
759is guaranteed not to block. 829inside the callback or at any later time is guaranteed not to block.
760 830
761=back 831=back
762 832
763=head1 SUPPORTED EVENT LOOPS/BACKENDS 833=head1 SUPPORTED EVENT LOOPS/BACKENDS
764 834
767=over 4 837=over 4
768 838
769=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.
770 840
771EV 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
772use. 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
773that, will fall back to its own pure-perl implementation, which is 843pure-perl implementation, which is available everywhere as it comes with
774available everywhere as it comes with AnyEvent itself. 844AnyEvent itself.
775 845
776 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 846 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
777 AnyEvent::Impl::Event based on Event, very stable, few glitches.
778 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 847 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
779 848
780=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.
781 850
782These 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
783is 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
784them. This means that AnyEvent will automatically pick the right backend 853them. This means that AnyEvent will automatically pick the right backend
785when the main program loads an event module before anything starts to 854when the main program loads an event module before anything starts to
786create watchers. Nothing special needs to be done by the main program. 855create watchers. Nothing special needs to be done by the main program.
787 856
857 AnyEvent::Impl::Event based on Event, very stable, few glitches.
788 AnyEvent::Impl::Glib based on Glib, slow but very stable. 858 AnyEvent::Impl::Glib based on Glib, slow but very stable.
789 AnyEvent::Impl::Tk based on Tk, very broken. 859 AnyEvent::Impl::Tk based on Tk, very broken.
790 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 860 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
791 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.
792 863
793=item Backends with special needs. 864=item Backends with special needs.
794 865
795Qt requires the Qt::Application to be instantiated first, but will 866Qt requires the Qt::Application to be instantiated first, but will
796otherwise be picked up automatically. As long as the main program 867otherwise be picked up automatically. As long as the main program
870event module detection too early, for example, L<AnyEvent::AIO> creates 941event module detection too early, for example, L<AnyEvent::AIO> creates
871and installs the global L<IO::AIO> watcher in a C<post_detect> block to 942and installs the global L<IO::AIO> watcher in a C<post_detect> block to
872avoid autodetecting the event module at load time. 943avoid autodetecting the event module at load time.
873 944
874If 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
875that 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
876L<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;
877 965
878=item @AnyEvent::post_detect 966=item @AnyEvent::post_detect
879 967
880If 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
881before or after loading AnyEvent), then they will called directly after 969before or after loading AnyEvent), then they will called directly after
884You should check C<$AnyEvent::MODEL> before adding to this array, though: 972You should check C<$AnyEvent::MODEL> before adding to this array, though:
885if 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
886array will be ignored. 974array will be ignored.
887 975
888Best use C<AnyEvent::post_detect { BLOCK }> when your application allows 976Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
889it,as it takes care of these details. 977it, as it takes care of these details.
890 978
891This variable is mainly useful for modules that can do something useful 979This variable is mainly useful for modules that can do something useful
892when AnyEvent is used and thus want to know when it is initialised, but do 980when AnyEvent is used and thus want to know when it is initialised, but do
893not need to even load it by default. This array provides the means to hook 981not need to even load it by default. This array provides the means to hook
894into 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 }
895 996
896=back 997=back
897 998
898=head1 WHAT TO DO IN A MODULE 999=head1 WHAT TO DO IN A MODULE
899 1000
1048 1149
1049package AnyEvent; 1150package AnyEvent;
1050 1151
1051# basically a tuned-down version of common::sense 1152# basically a tuned-down version of common::sense
1052sub common_sense { 1153sub common_sense {
1053 # no warnings 1154 # from common:.sense 1.0
1054 ${^WARNING_BITS} ^= ${^WARNING_BITS}; 1155 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1055 # use strict vars subs 1156 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1056 $^H |= 0x00000600; 1157 $^H |= 0x00000600;
1057} 1158}
1058 1159
1059BEGIN { AnyEvent::common_sense } 1160BEGIN { AnyEvent::common_sense }
1060 1161
1061use Carp (); 1162use Carp ();
1062 1163
1063our $VERSION = 4.85; 1164our $VERSION = '5.26';
1064our $MODEL; 1165our $MODEL;
1065 1166
1066our $AUTOLOAD; 1167our $AUTOLOAD;
1067our @ISA; 1168our @ISA;
1068 1169
1069our @REGISTRY; 1170our @REGISTRY;
1070 1171
1071our $WIN32;
1072
1073our $VERBOSE; 1172our $VERBOSE;
1074 1173
1075BEGIN { 1174BEGIN {
1076 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1175 require "AnyEvent/constants.pl";
1176
1077 eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; 1177 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1078 1178
1079 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1179 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1080 if ${^TAINT}; 1180 if ${^TAINT};
1081 1181
1082 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1182 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1093 for reverse split /\s*,\s*/, 1193 for reverse split /\s*,\s*/,
1094 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1194 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1095} 1195}
1096 1196
1097my @models = ( 1197my @models = (
1098 [EV:: => AnyEvent::Impl::EV::], 1198 [EV:: => AnyEvent::Impl::EV:: , 1],
1099 [Event:: => AnyEvent::Impl::Event::],
1100 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1199 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1101 # everything below here will not be autoprobed 1200 # everything below here will not (normally) be autoprobed
1102 # as the pureperl backend should work everywhere 1201 # as the pureperl backend should work everywhere
1103 # and is usually faster 1202 # and is usually faster
1203 [Event:: => AnyEvent::Impl::Event::, 1],
1104 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1204 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1105 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1205 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1206 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1106 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1207 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1107 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1208 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1108 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1209 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1109 [Wx:: => AnyEvent::Impl::POE::], 1210 [Wx:: => AnyEvent::Impl::POE::],
1110 [Prima:: => AnyEvent::Impl::POE::], 1211 [Prima:: => AnyEvent::Impl::POE::],
1111 # IO::Async is just too broken - we would need workarounds for its 1212 # IO::Async is just too broken - we would need workarounds for its
1112 # byzantine signal and broken child handling, among others. 1213 # byzantine signal and broken child handling, among others.
1113 # IO::Async is rather hard to detect, as it doesn't have any 1214 # IO::Async is rather hard to detect, as it doesn't have any
1114 # obvious default class. 1215 # obvious default class.
1115# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1216 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1116# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1217 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1117# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1218 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1219 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1118); 1220);
1119 1221
1120our %method = map +($_ => 1), 1222our %method = map +($_ => 1),
1121 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1223 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1122 1224
1123our @post_detect; 1225our @post_detect;
1124 1226
1125sub post_detect(&) { 1227sub post_detect(&) {
1126 my ($cb) = @_; 1228 my ($cb) = @_;
1127 1229
1128 if ($MODEL) {
1129 $cb->();
1130
1131 1
1132 } else {
1133 push @post_detect, $cb; 1230 push @post_detect, $cb;
1134 1231
1135 defined wantarray 1232 defined wantarray
1136 ? bless \$cb, "AnyEvent::Util::postdetect" 1233 ? bless \$cb, "AnyEvent::Util::postdetect"
1137 : () 1234 : ()
1138 }
1139} 1235}
1140 1236
1141sub AnyEvent::Util::postdetect::DESTROY { 1237sub AnyEvent::Util::postdetect::DESTROY {
1142 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1238 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1143} 1239}
1144 1240
1145sub detect() { 1241sub detect() {
1242 # free some memory
1243 *detect = sub () { $MODEL };
1244
1245 local $!; # for good measure
1246 local $SIG{__DIE__};
1247
1248 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1249 my $model = "AnyEvent::Impl::$1";
1250 if (eval "require $model") {
1251 $MODEL = $model;
1252 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1253 } else {
1254 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1255 }
1256 }
1257
1258 # check for already loaded models
1146 unless ($MODEL) { 1259 unless ($MODEL) {
1147 local $SIG{__DIE__}; 1260 for (@REGISTRY, @models) {
1148 1261 my ($package, $model) = @$_;
1149 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1262 if (${"$package\::VERSION"} > 0) {
1150 my $model = "AnyEvent::Impl::$1";
1151 if (eval "require $model") { 1263 if (eval "require $model") {
1152 $MODEL = $model; 1264 $MODEL = $model;
1153 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; 1265 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1154 } else { 1266 last;
1155 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1267 }
1156 } 1268 }
1157 } 1269 }
1158 1270
1159 # check for already loaded models
1160 unless ($MODEL) { 1271 unless ($MODEL) {
1272 # try to autoload a model
1161 for (@REGISTRY, @models) { 1273 for (@REGISTRY, @models) {
1162 my ($package, $model) = @$_; 1274 my ($package, $model, $autoload) = @$_;
1275 if (
1276 $autoload
1277 and eval "require $package"
1163 if (${"$package\::VERSION"} > 0) { 1278 and ${"$package\::VERSION"} > 0
1164 if (eval "require $model") { 1279 and eval "require $model"
1280 ) {
1165 $MODEL = $model; 1281 $MODEL = $model;
1166 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1282 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1167 last; 1283 last;
1168 }
1169 } 1284 }
1170 } 1285 }
1171 1286
1172 unless ($MODEL) {
1173 # try to load a model
1174
1175 for (@REGISTRY, @models) {
1176 my ($package, $model) = @$_;
1177 if (eval "require $package"
1178 and ${"$package\::VERSION"} > 0
1179 and eval "require $model") {
1180 $MODEL = $model;
1181 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
1182 last;
1183 }
1184 }
1185
1186 $MODEL 1287 $MODEL
1187 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1288 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1188 }
1189 } 1289 }
1190
1191 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1192
1193 unshift @ISA, $MODEL;
1194
1195 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1196
1197 (shift @post_detect)->() while @post_detect;
1198 } 1290 }
1291
1292 @models = (); # free probe data
1293
1294 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1295 unshift @ISA, $MODEL;
1296
1297 # now nuke some methods that are overriden by the backend.
1298 # SUPER is not allowed.
1299 for (qw(time signal child idle)) {
1300 undef &{"AnyEvent::Base::$_"}
1301 if defined &{"$MODEL\::$_"};
1302 }
1303
1304 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1305
1306 (shift @post_detect)->() while @post_detect;
1307
1308 *post_detect = sub(&) {
1309 shift->();
1310
1311 undef
1312 };
1199 1313
1200 $MODEL 1314 $MODEL
1201} 1315}
1202 1316
1203sub AUTOLOAD { 1317sub AUTOLOAD {
1204 (my $func = $AUTOLOAD) =~ s/.*://; 1318 (my $func = $AUTOLOAD) =~ s/.*://;
1205 1319
1206 $method{$func} 1320 $method{$func}
1207 or Carp::croak "$func: not a valid method for AnyEvent objects"; 1321 or Carp::croak "$func: not a valid AnyEvent class method";
1208 1322
1209 detect unless $MODEL; 1323 detect;
1210 1324
1211 my $class = shift; 1325 my $class = shift;
1212 $class->$func (@_); 1326 $class->$func (@_);
1213} 1327}
1214 1328
1227 # we assume CLOEXEC is already set by perl in all important cases 1341 # we assume CLOEXEC is already set by perl in all important cases
1228 1342
1229 ($fh2, $rw) 1343 ($fh2, $rw)
1230} 1344}
1231 1345
1346=head1 SIMPLIFIED AE API
1347
1348Starting with version 5.0, AnyEvent officially supports a second, much
1349simpler, API that is designed to reduce the calling, typing and memory
1350overhead by using function call syntax and a fixed number of parameters.
1351
1352See the L<AE> manpage for details.
1353
1354=cut
1355
1356package AE;
1357
1358our $VERSION = $AnyEvent::VERSION;
1359
1360# fall back to the main API by default - backends and AnyEvent::Base
1361# implementations can overwrite these.
1362
1363sub io($$$) {
1364 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1365}
1366
1367sub timer($$$) {
1368 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1369}
1370
1371sub signal($$) {
1372 AnyEvent->signal (signal => $_[0], cb => $_[1])
1373}
1374
1375sub child($$) {
1376 AnyEvent->child (pid => $_[0], cb => $_[1])
1377}
1378
1379sub idle($) {
1380 AnyEvent->idle (cb => $_[0])
1381}
1382
1383sub cv(;&) {
1384 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1385}
1386
1387sub now() {
1388 AnyEvent->now
1389}
1390
1391sub now_update() {
1392 AnyEvent->now_update
1393}
1394
1395sub time() {
1396 AnyEvent->time
1397}
1398
1232package AnyEvent::Base; 1399package AnyEvent::Base;
1233 1400
1234# default implementations for many methods 1401# default implementations for many methods
1235 1402
1236sub _time { 1403sub time {
1404 eval q{ # poor man's autoloading {}
1237 # probe for availability of Time::HiRes 1405 # probe for availability of Time::HiRes
1238 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1406 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1239 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1407 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1240 *_time = \&Time::HiRes::time; 1408 *AE::time = \&Time::HiRes::time;
1241 # if (eval "use POSIX (); (POSIX::times())... 1409 # if (eval "use POSIX (); (POSIX::times())...
1242 } else { 1410 } else {
1243 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1411 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1244 *_time = sub { time }; # epic fail 1412 *AE::time = sub (){ time }; # epic fail
1413 }
1414
1415 *time = sub { AE::time }; # different prototypes
1245 } 1416 };
1417 die if $@;
1246 1418
1247 &_time 1419 &time
1248} 1420}
1249 1421
1250sub time { _time } 1422*now = \&time;
1251sub now { _time } 1423
1252sub now_update { } 1424sub now_update { }
1253 1425
1254# default implementation for ->condvar 1426# default implementation for ->condvar
1255 1427
1256sub condvar { 1428sub condvar {
1429 eval q{ # poor man's autoloading {}
1430 *condvar = sub {
1257 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1431 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1432 };
1433
1434 *AE::cv = sub (;&) {
1435 bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
1436 };
1437 };
1438 die if $@;
1439
1440 &condvar
1258} 1441}
1259 1442
1260# default implementation for ->signal 1443# default implementation for ->signal
1261 1444
1262our $HAVE_ASYNC_INTERRUPT; 1445our $HAVE_ASYNC_INTERRUPT;
1446
1447sub _have_async_interrupt() {
1448 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1449 && eval "use Async::Interrupt 1.02 (); 1")
1450 unless defined $HAVE_ASYNC_INTERRUPT;
1451
1452 $HAVE_ASYNC_INTERRUPT
1453}
1454
1263our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1455our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1264our (%SIG_ASY, %SIG_ASY_W); 1456our (%SIG_ASY, %SIG_ASY_W);
1265our ($SIG_COUNT, $SIG_TW); 1457our ($SIG_COUNT, $SIG_TW);
1266 1458
1267sub _signal_exec {
1268 $HAVE_ASYNC_INTERRUPT
1269 ? $SIGPIPE_R->drain
1270 : sysread $SIGPIPE_R, my $dummy, 9;
1271
1272 while (%SIG_EV) {
1273 for (keys %SIG_EV) {
1274 delete $SIG_EV{$_};
1275 $_->() for values %{ $SIG_CB{$_} || {} };
1276 }
1277 }
1278}
1279
1280# install a dumym wakeupw atcher to reduce signal catching latency 1459# install a dummy wakeup watcher to reduce signal catching latency
1460# used by Impls
1281sub _sig_add() { 1461sub _sig_add() {
1282 unless ($SIG_COUNT++) { 1462 unless ($SIG_COUNT++) {
1283 # try to align timer on a full-second boundary, if possible 1463 # try to align timer on a full-second boundary, if possible
1284 my $NOW = AnyEvent->now; 1464 my $NOW = AE::now;
1285 1465
1286 $SIG_TW = AnyEvent->timer ( 1466 $SIG_TW = AE::timer
1287 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1467 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1288 interval => $MAX_SIGNAL_LATENCY, 1468 $MAX_SIGNAL_LATENCY,
1289 cb => sub { }, # just for the PERL_ASYNC_CHECK 1469 sub { } # just for the PERL_ASYNC_CHECK
1290 ); 1470 ;
1291 } 1471 }
1292} 1472}
1293 1473
1294sub _sig_del { 1474sub _sig_del {
1295 undef $SIG_TW 1475 undef $SIG_TW
1296 unless --$SIG_COUNT; 1476 unless --$SIG_COUNT;
1297} 1477}
1298 1478
1479our $_sig_name_init; $_sig_name_init = sub {
1480 eval q{ # poor man's autoloading {}
1481 undef $_sig_name_init;
1482
1483 if (_have_async_interrupt) {
1484 *sig2num = \&Async::Interrupt::sig2num;
1485 *sig2name = \&Async::Interrupt::sig2name;
1486 } else {
1487 require Config;
1488
1489 my %signame2num;
1490 @signame2num{ split ' ', $Config::Config{sig_name} }
1491 = split ' ', $Config::Config{sig_num};
1492
1493 my @signum2name;
1494 @signum2name[values %signame2num] = keys %signame2num;
1495
1496 *sig2num = sub($) {
1497 $_[0] > 0 ? shift : $signame2num{+shift}
1498 };
1499 *sig2name = sub ($) {
1500 $_[0] > 0 ? $signum2name[+shift] : shift
1501 };
1502 }
1503 };
1504 die if $@;
1505};
1506
1507sub sig2num ($) { &$_sig_name_init; &sig2num }
1508sub sig2name($) { &$_sig_name_init; &sig2name }
1509
1299sub _signal { 1510sub signal {
1300 my (undef, %arg) = @_; 1511 eval q{ # poor man's autoloading {}
1512 # probe for availability of Async::Interrupt
1513 if (_have_async_interrupt) {
1514 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1301 1515
1302 my $signal = uc $arg{signal} 1516 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1303 or Carp::croak "required option 'signal' is missing"; 1517 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1304 1518
1305 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1519 } else {
1520 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1306 1521
1307 if ($HAVE_ASYNC_INTERRUPT) { 1522 if (AnyEvent::WIN32) {
1308 # async::interrupt 1523 require AnyEvent::Util;
1309 1524
1310 $SIG_ASY{$signal} ||= do { 1525 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1311 my $asy = new Async::Interrupt 1526 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1312 cb => sub { undef $SIG_EV{$signal} }, 1527 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1313 signal => $signal, 1528 } else {
1314 pipe => [$SIGPIPE_R->filenos], 1529 pipe $SIGPIPE_R, $SIGPIPE_W;
1530 fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1531 fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1532
1533 # not strictly required, as $^F is normally 2, but let's make sure...
1534 fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1535 fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1315 ; 1536 }
1316 $asy->pipe_autodrain (0);
1317 1537
1318 $asy 1538 $SIGPIPE_R
1539 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1540
1541 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1542 }
1543
1544 *signal = $HAVE_ASYNC_INTERRUPT
1545 ? sub {
1546 my (undef, %arg) = @_;
1547
1548 # async::interrupt
1549 my $signal = sig2num $arg{signal};
1550 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1551
1552 $SIG_ASY{$signal} ||= new Async::Interrupt
1553 cb => sub { undef $SIG_EV{$signal} },
1554 signal => $signal,
1555 pipe => [$SIGPIPE_R->filenos],
1556 pipe_autodrain => 0,
1557 ;
1558
1559 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1560 }
1561 : sub {
1562 my (undef, %arg) = @_;
1563
1564 # pure perl
1565 my $signal = sig2name $arg{signal};
1566 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1567
1568 $SIG{$signal} ||= sub {
1569 local $!;
1570 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1571 undef $SIG_EV{$signal};
1572 };
1573
1574 # can't do signal processing without introducing races in pure perl,
1575 # so limit the signal latency.
1576 _sig_add;
1577
1578 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1579 }
1580 ;
1581
1582 *AnyEvent::Base::signal::DESTROY = sub {
1583 my ($signal, $cb) = @{$_[0]};
1584
1585 _sig_del;
1586
1587 delete $SIG_CB{$signal}{$cb};
1588
1589 $HAVE_ASYNC_INTERRUPT
1590 ? delete $SIG_ASY{$signal}
1591 : # delete doesn't work with older perls - they then
1592 # print weird messages, or just unconditionally exit
1593 # instead of getting the default action.
1594 undef $SIG{$signal}
1595 unless keys %{ $SIG_CB{$signal} };
1319 }; 1596 };
1320 1597
1321 } else { 1598 *_signal_exec = sub {
1322 # pure perl 1599 $HAVE_ASYNC_INTERRUPT
1600 ? $SIGPIPE_R->drain
1601 : sysread $SIGPIPE_R, (my $dummy), 9;
1323 1602
1324 $SIG{$signal} ||= sub { 1603 while (%SIG_EV) {
1325 local $!; 1604 for (keys %SIG_EV) {
1326 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1605 delete $SIG_EV{$_};
1327 undef $SIG_EV{$signal}; 1606 $_->() for values %{ $SIG_CB{$_} || {} };
1607 }
1608 }
1328 }; 1609 };
1329
1330 # can't do signal processing without introducing races in pure perl,
1331 # so limit the signal latency.
1332 _sig_add;
1333 } 1610 };
1611 die if $@;
1334 1612
1335 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1336}
1337
1338sub signal {
1339 # probe for availability of Async::Interrupt
1340 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1341 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1342
1343 $HAVE_ASYNC_INTERRUPT = 1;
1344 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1345 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1346
1347 } else {
1348 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1349
1350 require Fcntl;
1351
1352 if (AnyEvent::WIN32) {
1353 require AnyEvent::Util;
1354
1355 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1356 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1357 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1358 } else {
1359 pipe $SIGPIPE_R, $SIGPIPE_W;
1360 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1361 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1362
1363 # not strictly required, as $^F is normally 2, but let's make sure...
1364 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1365 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1366 }
1367
1368 $SIGPIPE_R
1369 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1370
1371 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1372 }
1373
1374 *signal = \&_signal;
1375 &signal 1613 &signal
1376}
1377
1378sub AnyEvent::Base::signal::DESTROY {
1379 my ($signal, $cb) = @{$_[0]};
1380
1381 _sig_del;
1382
1383 delete $SIG_CB{$signal}{$cb};
1384
1385 $HAVE_ASYNC_INTERRUPT
1386 ? delete $SIG_ASY{$signal}
1387 : # delete doesn't work with older perls - they then
1388 # print weird messages, or just unconditionally exit
1389 # instead of getting the default action.
1390 undef $SIG{$signal}
1391 unless keys %{ $SIG_CB{$signal} };
1392} 1614}
1393 1615
1394# default implementation for ->child 1616# default implementation for ->child
1395 1617
1396our %PID_CB; 1618our %PID_CB;
1397our $CHLD_W; 1619our $CHLD_W;
1398our $CHLD_DELAY_W; 1620our $CHLD_DELAY_W;
1399our $WNOHANG; 1621our $WNOHANG;
1400 1622
1401sub _sigchld { 1623# used by many Impl's
1402 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1624sub _emit_childstatus($$) {
1403 $_->($pid, $?) 1625 my (undef, $rpid, $rstatus) = @_;
1626
1627 $_->($rpid, $rstatus)
1404 for values %{ $PID_CB{$pid} || {} }, 1628 for values %{ $PID_CB{$rpid} || {} },
1405 values %{ $PID_CB{0} || {} }; 1629 values %{ $PID_CB{0} || {} };
1406 }
1407} 1630}
1408 1631
1409sub child { 1632sub child {
1633 eval q{ # poor man's autoloading {}
1634 *_sigchld = sub {
1635 my $pid;
1636
1637 AnyEvent->_emit_childstatus ($pid, $?)
1638 while ($pid = waitpid -1, $WNOHANG) > 0;
1639 };
1640
1641 *child = sub {
1410 my (undef, %arg) = @_; 1642 my (undef, %arg) = @_;
1411 1643
1412 defined (my $pid = $arg{pid} + 0) 1644 defined (my $pid = $arg{pid} + 0)
1413 or Carp::croak "required option 'pid' is missing"; 1645 or Carp::croak "required option 'pid' is missing";
1414 1646
1415 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1647 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1416 1648
1417 # WNOHANG is almost cetrainly 1 everywhere 1649 # WNOHANG is almost cetrainly 1 everywhere
1418 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1650 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1419 ? 1 1651 ? 1
1420 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1652 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1421 1653
1422 unless ($CHLD_W) { 1654 unless ($CHLD_W) {
1423 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1655 $CHLD_W = AE::signal CHLD => \&_sigchld;
1424 # child could be a zombie already, so make at least one round 1656 # child could be a zombie already, so make at least one round
1425 &_sigchld; 1657 &_sigchld;
1426 } 1658 }
1427 1659
1428 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1660 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1429} 1661 };
1430 1662
1431sub AnyEvent::Base::child::DESTROY { 1663 *AnyEvent::Base::child::DESTROY = sub {
1432 my ($pid, $cb) = @{$_[0]}; 1664 my ($pid, $cb) = @{$_[0]};
1433 1665
1434 delete $PID_CB{$pid}{$cb}; 1666 delete $PID_CB{$pid}{$cb};
1435 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1667 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1436 1668
1437 undef $CHLD_W unless keys %PID_CB; 1669 undef $CHLD_W unless keys %PID_CB;
1670 };
1671 };
1672 die if $@;
1673
1674 &child
1438} 1675}
1439 1676
1440# idle emulation is done by simply using a timer, regardless 1677# idle emulation is done by simply using a timer, regardless
1441# of whether the process is idle or not, and not letting 1678# of whether the process is idle or not, and not letting
1442# the callback use more than 50% of the time. 1679# the callback use more than 50% of the time.
1443sub idle { 1680sub idle {
1681 eval q{ # poor man's autoloading {}
1682 *idle = sub {
1444 my (undef, %arg) = @_; 1683 my (undef, %arg) = @_;
1445 1684
1446 my ($cb, $w, $rcb) = $arg{cb}; 1685 my ($cb, $w, $rcb) = $arg{cb};
1447 1686
1448 $rcb = sub { 1687 $rcb = sub {
1449 if ($cb) { 1688 if ($cb) {
1450 $w = _time; 1689 $w = _time;
1451 &$cb; 1690 &$cb;
1452 $w = _time - $w; 1691 $w = _time - $w;
1453 1692
1454 # never use more then 50% of the time for the idle watcher, 1693 # never use more then 50% of the time for the idle watcher,
1455 # within some limits 1694 # within some limits
1456 $w = 0.0001 if $w < 0.0001; 1695 $w = 0.0001 if $w < 0.0001;
1457 $w = 5 if $w > 5; 1696 $w = 5 if $w > 5;
1458 1697
1459 $w = AnyEvent->timer (after => $w, cb => $rcb); 1698 $w = AE::timer $w, 0, $rcb;
1460 } else { 1699 } else {
1461 # clean up... 1700 # clean up...
1462 undef $w; 1701 undef $w;
1463 undef $rcb; 1702 undef $rcb;
1703 }
1704 };
1705
1706 $w = AE::timer 0.05, 0, $rcb;
1707
1708 bless \\$cb, "AnyEvent::Base::idle"
1464 } 1709 };
1710
1711 *AnyEvent::Base::idle::DESTROY = sub {
1712 undef $${$_[0]};
1713 };
1465 }; 1714 };
1715 die if $@;
1466 1716
1467 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1717 &idle
1468
1469 bless \\$cb, "AnyEvent::Base::idle"
1470}
1471
1472sub AnyEvent::Base::idle::DESTROY {
1473 undef $${$_[0]};
1474} 1718}
1475 1719
1476package AnyEvent::CondVar; 1720package AnyEvent::CondVar;
1477 1721
1478our @ISA = AnyEvent::CondVar::Base::; 1722our @ISA = AnyEvent::CondVar::Base::;
1526 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1770 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1527 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1771 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1528} 1772}
1529 1773
1530sub cb { 1774sub cb {
1531 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1775 my $cv = shift;
1776
1777 @_
1778 and $cv->{_ae_cb} = shift
1779 and $cv->{_ae_sent}
1780 and (delete $cv->{_ae_cb})->($cv);
1781
1532 $_[0]{_ae_cb} 1782 $cv->{_ae_cb}
1533} 1783}
1534 1784
1535sub begin { 1785sub begin {
1536 ++$_[0]{_ae_counter}; 1786 ++$_[0]{_ae_counter};
1537 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1787 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1746 warn "read: $input\n"; # output what has been read 1996 warn "read: $input\n"; # output what has been read
1747 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1997 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1748 }, 1998 },
1749 ); 1999 );
1750 2000
1751 my $time_watcher; # can only be used once
1752
1753 sub new_timer {
1754 $timer = AnyEvent->timer (after => 1, cb => sub { 2001 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1755 warn "timeout\n"; # print 'timeout' about every second 2002 warn "timeout\n"; # print 'timeout' at most every second
1756 &new_timer; # and restart the time
1757 }); 2003 });
1758 }
1759
1760 new_timer; # create first timer
1761 2004
1762 $cv->recv; # wait until user enters /^q/i 2005 $cv->recv; # wait until user enters /^q/i
1763 2006
1764=head1 REAL-WORLD EXAMPLE 2007=head1 REAL-WORLD EXAMPLE
1765 2008
1838 2081
1839The actual code goes further and collects all errors (C<die>s, exceptions) 2082The actual code goes further and collects all errors (C<die>s, exceptions)
1840that occurred during request processing. The C<result> method detects 2083that occurred during request processing. The C<result> method detects
1841whether an exception as thrown (it is stored inside the $txn object) 2084whether an exception as thrown (it is stored inside the $txn object)
1842and just throws the exception, which means connection errors and other 2085and just throws the exception, which means connection errors and other
1843problems get reported tot he code that tries to use the result, not in a 2086problems get reported to the code that tries to use the result, not in a
1844random callback. 2087random callback.
1845 2088
1846All of this enables the following usage styles: 2089All of this enables the following usage styles:
1847 2090
18481. Blocking: 20911. Blocking:
1896through AnyEvent. The benchmark creates a lot of timers (with a zero 2139through AnyEvent. The benchmark creates a lot of timers (with a zero
1897timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2140timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1898which it is), lets them fire exactly once and destroys them again. 2141which it is), lets them fire exactly once and destroys them again.
1899 2142
1900Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2143Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1901distribution. 2144distribution. It uses the L<AE> interface, which makes a real difference
2145for the EV and Perl backends only.
1902 2146
1903=head3 Explanation of the columns 2147=head3 Explanation of the columns
1904 2148
1905I<watcher> is the number of event watchers created/destroyed. Since 2149I<watcher> is the number of event watchers created/destroyed. Since
1906different event models feature vastly different performances, each event 2150different event models feature vastly different performances, each event
1927watcher. 2171watcher.
1928 2172
1929=head3 Results 2173=head3 Results
1930 2174
1931 name watchers bytes create invoke destroy comment 2175 name watchers bytes create invoke destroy comment
1932 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2176 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1933 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2177 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1934 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2178 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1935 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2179 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1936 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2180 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1937 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2181 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1938 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 2182 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1939 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 2183 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1940 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2184 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1941 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2185 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1942 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2186 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1943 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2187 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1944 2188
1945=head3 Discussion 2189=head3 Discussion
1946 2190
1947The benchmark does I<not> measure scalability of the event loop very 2191The benchmark does I<not> measure scalability of the event loop very
1948well. For example, a select-based event loop (such as the pure perl one) 2192well. For example, a select-based event loop (such as the pure perl one)
1960benchmark machine, handling an event takes roughly 1600 CPU cycles with 2204benchmark machine, handling an event takes roughly 1600 CPU cycles with
1961EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2205EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1962cycles with POE. 2206cycles with POE.
1963 2207
1964C<EV> is the sole leader regarding speed and memory use, which are both 2208C<EV> is the sole leader regarding speed and memory use, which are both
1965maximal/minimal, respectively. Even when going through AnyEvent, it uses 2209maximal/minimal, respectively. When using the L<AE> API there is zero
2210overhead (when going through the AnyEvent API create is about 5-6 times
2211slower, with other times being equal, so still uses far less memory than
1966far less memory than any other event loop and is still faster than Event 2212any other event loop and is still faster than Event natively).
1967natively.
1968 2213
1969The pure perl implementation is hit in a few sweet spots (both the 2214The pure perl implementation is hit in a few sweet spots (both the
1970constant timeout and the use of a single fd hit optimisations in the perl 2215constant timeout and the use of a single fd hit optimisations in the perl
1971interpreter and the backend itself). Nevertheless this shows that it 2216interpreter and the backend itself). Nevertheless this shows that it
1972adds very little overhead in itself. Like any select-based backend its 2217adds very little overhead in itself. Like any select-based backend its
2046In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2291In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2047(1%) are active. This mirrors the activity of large servers with many 2292(1%) are active. This mirrors the activity of large servers with many
2048connections, most of which are idle at any one point in time. 2293connections, most of which are idle at any one point in time.
2049 2294
2050Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2295Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2051distribution. 2296distribution. It uses the L<AE> interface, which makes a real difference
2297for the EV and Perl backends only.
2052 2298
2053=head3 Explanation of the columns 2299=head3 Explanation of the columns
2054 2300
2055I<sockets> is the number of sockets, and twice the number of "servers" (as 2301I<sockets> is the number of sockets, and twice the number of "servers" (as
2056each server has a read and write socket end). 2302each server has a read and write socket end).
2064a new one that moves the timeout into the future. 2310a new one that moves the timeout into the future.
2065 2311
2066=head3 Results 2312=head3 Results
2067 2313
2068 name sockets create request 2314 name sockets create request
2069 EV 20000 69.01 11.16 2315 EV 20000 62.66 7.99
2070 Perl 20000 73.32 35.87 2316 Perl 20000 68.32 32.64
2071 IOAsync 20000 157.00 98.14 epoll 2317 IOAsync 20000 174.06 101.15 epoll
2072 IOAsync 20000 159.31 616.06 poll 2318 IOAsync 20000 174.67 610.84 poll
2073 Event 20000 212.62 257.32 2319 Event 20000 202.69 242.91
2074 Glib 20000 651.16 1896.30 2320 Glib 20000 557.01 1689.52
2075 POE 20000 349.67 12317.24 uses POE::Loop::Event 2321 POE 20000 341.54 12086.32 uses POE::Loop::Event
2076 2322
2077=head3 Discussion 2323=head3 Discussion
2078 2324
2079This benchmark I<does> measure scalability and overall performance of the 2325This benchmark I<does> measure scalability and overall performance of the
2080particular event loop. 2326particular event loop.
2206As you can see, the AnyEvent + EV combination even beats the 2452As you can see, the AnyEvent + EV combination even beats the
2207hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2453hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2208backend easily beats IO::Lambda and POE. 2454backend easily beats IO::Lambda and POE.
2209 2455
2210And even the 100% non-blocking version written using the high-level (and 2456And even the 100% non-blocking version written using the high-level (and
2211slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2457slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2212large margin, even though it does all of DNS, tcp-connect and socket I/O 2458higher level ("unoptimised") abstractions by a large margin, even though
2213in a non-blocking way. 2459it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2214 2460
2215The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2461The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2216F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2462F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2217part of the IO::lambda distribution and were used without any changes. 2463part of the IO::Lambda distribution and were used without any changes.
2218 2464
2219 2465
2220=head1 SIGNALS 2466=head1 SIGNALS
2221 2467
2222AnyEvent currently installs handlers for these signals: 2468AnyEvent currently installs handlers for these signals:
2264it's built-in modules) are required to use it. 2510it's built-in modules) are required to use it.
2265 2511
2266That does not mean that AnyEvent won't take advantage of some additional 2512That does not mean that AnyEvent won't take advantage of some additional
2267modules if they are installed. 2513modules if they are installed.
2268 2514
2269This section epxlains which additional modules will be used, and how they 2515This section explains which additional modules will be used, and how they
2270affect AnyEvent's operetion. 2516affect AnyEvent's operation.
2271 2517
2272=over 4 2518=over 4
2273 2519
2274=item L<Async::Interrupt> 2520=item L<Async::Interrupt>
2275 2521
2280catch the signals) with some delay (default is 10 seconds, look for 2526catch the signals) with some delay (default is 10 seconds, look for
2281C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2527C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2282 2528
2283If this module is available, then it will be used to implement signal 2529If this module is available, then it will be used to implement signal
2284catching, which means that signals will not be delayed, and the event loop 2530catching, which means that signals will not be delayed, and the event loop
2285will not be interrupted regularly, which is more efficient (And good for 2531will not be interrupted regularly, which is more efficient (and good for
2286battery life on laptops). 2532battery life on laptops).
2287 2533
2288This affects not just the pure-perl event loop, but also other event loops 2534This affects not just the pure-perl event loop, but also other event loops
2289that have no signal handling on their own (e.g. Glib, Tk, Qt). 2535that have no signal handling on their own (e.g. Glib, Tk, Qt).
2290 2536
2302automatic timer adjustments even when no monotonic clock is available, 2548automatic timer adjustments even when no monotonic clock is available,
2303can take avdantage of advanced kernel interfaces such as C<epoll> and 2549can take avdantage of advanced kernel interfaces such as C<epoll> and
2304C<kqueue>, and is the fastest backend I<by far>. You can even embed 2550C<kqueue>, and is the fastest backend I<by far>. You can even embed
2305L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). 2551L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2306 2552
2553If you only use backends that rely on another event loop (e.g. C<Tk>),
2554then this module will do nothing for you.
2555
2307=item L<Guard> 2556=item L<Guard>
2308 2557
2309The guard module, when used, will be used to implement 2558The guard module, when used, will be used to implement
2310C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a 2559C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2311lot less memory), but otherwise doesn't affect guard operation much. It is 2560lot less memory), but otherwise doesn't affect guard operation much. It is
2312purely used for performance. 2561purely used for performance.
2313 2562
2314=item L<JSON> and L<JSON::XS> 2563=item L<JSON> and L<JSON::XS>
2315 2564
2316This module is required when you want to read or write JSON data via 2565One of these modules is required when you want to read or write JSON data
2317L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2566via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2318advantage of the ultra-high-speed L<JSON::XS> module when it is installed. 2567advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2319
2320In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2321installed.
2322 2568
2323=item L<Net::SSLeay> 2569=item L<Net::SSLeay>
2324 2570
2325Implementing TLS/SSL in Perl is certainly interesting, but not very 2571Implementing TLS/SSL in Perl is certainly interesting, but not very
2326worthwhile: If this module is installed, then L<AnyEvent::Handle> (with 2572worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2337 2583
2338 2584
2339=head1 FORK 2585=head1 FORK
2340 2586
2341Most event libraries are not fork-safe. The ones who are usually are 2587Most event libraries are not fork-safe. The ones who are usually are
2342because they rely on inefficient but fork-safe C<select> or C<poll> 2588because they rely on inefficient but fork-safe C<select> or C<poll> calls
2343calls. Only L<EV> is fully fork-aware. 2589- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
2590are usually badly thought-out hacks that are incompatible with fork in
2591one way or another. Only L<EV> is fully fork-aware and ensures that you
2592continue event-processing in both parent and child (or both, if you know
2593what you are doing).
2594
2595This means that, in general, you cannot fork and do event processing in
2596the child if the event library was initialised before the fork (which
2597usually happens when the first AnyEvent watcher is created, or the library
2598is loaded).
2344 2599
2345If you have to fork, you must either do so I<before> creating your first 2600If you have to fork, you must either do so I<before> creating your first
2346watcher OR you must not use AnyEvent at all in the child OR you must do 2601watcher OR you must not use AnyEvent at all in the child OR you must do
2347something completely out of the scope of AnyEvent. 2602something completely out of the scope of AnyEvent.
2603
2604The problem of doing event processing in the parent I<and> the child
2605is much more complicated: even for backends that I<are> fork-aware or
2606fork-safe, their behaviour is not usually what you want: fork clones all
2607watchers, that means all timers, I/O watchers etc. are active in both
2608parent and child, which is almost never what you want. USing C<exec>
2609to start worker children from some kind of manage rprocess is usually
2610preferred, because it is much easier and cleaner, at the expense of having
2611to have another binary.
2348 2612
2349 2613
2350=head1 SECURITY CONSIDERATIONS 2614=head1 SECURITY CONSIDERATIONS
2351 2615
2352AnyEvent can be forced to load any event model via 2616AnyEvent can be forced to load any event model via
2390L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2654L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2391 2655
2392Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2656Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2393L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2657L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2394L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2658L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2395L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. 2659L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2396 2660
2397Non-blocking file handles, sockets, TCP clients and 2661Non-blocking file handles, sockets, TCP clients and
2398servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2662servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2399 2663
2400Asynchronous DNS: L<AnyEvent::DNS>. 2664Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines