[ViewVC] Diff of: cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.269 by root, Fri Jul 31 20:16:29 2009 UTC vs.
Revision 1.323 by root, Thu May 20 21:22:20 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 => ...
…		…
363	might affect timers and time-outs.	366	might affect timers and time-outs.
364		367
365	When this is the case, you can call this method, which will update the	368	When this is the case, you can call this method, which will update the
366	event loop's idea of "current time".	369	event loop's idea of "current time".
367		370
		371	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		372	when mod_perl executes the script, then the event loop will have the wrong
		373	idea about the "current time" (being potentially far in the past, when the
		374	script ran the last time). In that case you should arrange a call to C<<
		375	AnyEvent->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
368	Note that updating the time I<might> cause some events to be handled.	378	Note that updating the time I<might> cause some events to be handled.
369		379
370	=back	380	=back
371		381
372	=head2 SIGNAL WATCHERS	382	=head2 SIGNAL WATCHERS
…		…
395	correctly.	405	correctly.
396		406
397	Example: exit on SIGINT	407	Example: exit on SIGINT
398		408
399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	409	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		410
		411	=head3 Restart Behaviour
		412
		413	While restart behaviour is up to the event loop implementation, most will
		414	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		415	pure perl implementation).
		416
		417	=head3 Safe/Unsafe Signals
		418
		419	Perl signals can be either "safe" (synchronous to opcode handling) or
		420	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		421	latter might corrupt your memory.
		422
		423	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		424	i.e. they will not interrupt your running perl program but will only be
		425	called as part of the normal event handling (just like timer, I/O etc.
		426	callbacks, too).
400		427
401	=head3 Signal Races, Delays and Workarounds	428	=head3 Signal Races, Delays and Workarounds
402		429
403	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	430	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
404	callbacks to signals in a generic way, which is a pity, as you cannot	431	callbacks to signals in a generic way, which is a pity, as you cannot
…		…
479		506
480	=head2 IDLE WATCHERS	507	=head2 IDLE WATCHERS
481		508
482	$w = AnyEvent->idle (cb => <callback>);	509	$w = AnyEvent->idle (cb => <callback>);
483		510
484	Sometimes there is a need to do something, but it is not so important	511	Repeatedly invoke the callback after the process becomes idle, until
485	to do it instantly, but only when there is nothing better to do. This	512	either the watcher is destroyed or new events have been detected.
486	"nothing better to do" is usually defined to be "no other events need
487	attention by the event loop".
488		513
489	Idle watchers ideally get invoked when the event loop has nothing	514	Idle watchers are useful when there is a need to do something, but it
490	better to do, just before it would block the process to wait for new	515	is not so important (or wise) to do it instantly. The callback will be
491	events. Instead of blocking, the idle watcher is invoked.	516	invoked only when there is "nothing better to do", which is usually
		517	defined as "all outstanding events have been handled and no new events
		518	have been detected". That means that idle watchers ideally get invoked
		519	when the event loop has just polled for new events but none have been
		520	detected. Instead of blocking to wait for more events, the idle watchers
		521	will be invoked.
492		522
493	Most event loops unfortunately do not really support idle watchers (only	523	Unfortunately, most event loops do not really support idle watchers (only
494	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	524	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
495	will simply call the callback "from time to time".	525	will simply call the callback "from time to time".
496		526
497	Example: read lines from STDIN, but only process them when the	527	Example: read lines from STDIN, but only process them when the
498	program is otherwise idle:	528	program is otherwise idle:
…		…
579	eventually calls C<< -> send >>, and the "consumer side", which waits	609	eventually calls C<< -> send >>, and the "consumer side", which waits
580	for the send to occur.	610	for the send to occur.
581		611
582	Example: wait for a timer.	612	Example: wait for a timer.
583		613
584	# wait till the result is ready	614	# condition: "wait till the timer is fired"
585	my $result_ready = AnyEvent->condvar;	615	my $timer_fired = AnyEvent->condvar;
586		616
587	# do something such as adding a timer	617	# create the timer - we could wait for, say
588	# or socket watcher the calls $result_ready->send	618	# a handle becomign ready, or even an
589	# when the "result" is ready.	619	# AnyEvent::HTTP request to finish, but
590	# in this case, we simply use a timer:	620	# in this case, we simply use a timer:
591	my $w = AnyEvent->timer (	621	my $w = AnyEvent->timer (
592	after => 1,	622	after => 1,
593	cb => sub { $result_ready->send },	623	cb => sub { $timer_fired->send },
594	);	624	);
595		625
596	# this "blocks" (while handling events) till the callback	626	# this "blocks" (while handling events) till the callback
597	# calls -<send	627	# calls ->send
598	$result_ready->recv;	628	$timer_fired->recv;
599		629
600	Example: wait for a timer, but take advantage of the fact that condition	630	Example: wait for a timer, but take advantage of the fact that condition
601	variables are also callable directly.	631	variables are also callable directly.
602		632
603	my $done = AnyEvent->condvar;	633	my $done = AnyEvent->condvar;
…		…
666	one. For example, a function that pings many hosts in parallel might want	696	one. For example, a function that pings many hosts in parallel might want
667	to use a condition variable for the whole process.	697	to use a condition variable for the whole process.
668		698
669	Every call to C<< ->begin >> will increment a counter, and every call to	699	Every call to C<< ->begin >> will increment a counter, and every call to
670	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	700	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
671	>>, 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
672	is I<supposed> to call C<< ->send >>, but that is not required. If no	702	condvar as first argument. That callback is I<supposed> to call C<< ->send
673	callback 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
		704	be called without any arguments.
674		705
675	You can think of C<< $cv->send >> giving you an OR condition (one call	706	You can think of C<< $cv->send >> giving you an OR condition (one call
676	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	707	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
677	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	708	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
678		709
…		…
705	begung can potentially be zero:	736	begung can potentially be zero:
706		737
707	my $cv = AnyEvent->condvar;	738	my $cv = AnyEvent->condvar;
708		739
709	my %result;	740	my %result;
710	$cv->begin (sub { $cv->send (\%result) });	741	$cv->begin (sub { shift->send (\%result) });
711		742
712	for my $host (@list_of_hosts) {	743	for my $host (@list_of_hosts) {
713	$cv->begin;	744	$cv->begin;
714	ping_host_then_call_callback $host, sub {	745	ping_host_then_call_callback $host, sub {
715	$result{$host} = ...;	746	$result{$host} = ...;
…		…
806	=over 4	837	=over 4
807		838
808	=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.
809		840
810	EV is the preferred backend when no other event loop seems to be in	841	EV is the preferred backend when no other event loop seems to be in
811	use. If EV is not installed, then AnyEvent will try Event, and, failing	842	use. If EV is not installed, then AnyEvent will fall back to its own
812	that, will fall back to its own pure-perl implementation, which is	843	pure-perl implementation, which is available everywhere as it comes with
813	available everywhere as it comes with AnyEvent itself.	844	AnyEvent itself.
814		845
815	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	846	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
816	AnyEvent::Impl::Event based on Event, very stable, few glitches.
817	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	847	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
818		848
819	=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.
820		850
821	These will be used when they are currently loaded when the first watcher	851	These will be used when they are currently loaded when the first watcher
822	is created, in which case it is assumed that the application is using	852	is created, in which case it is assumed that the application is using
823	them. This means that AnyEvent will automatically pick the right backend	853	them. This means that AnyEvent will automatically pick the right backend
824	when the main program loads an event module before anything starts to	854	when the main program loads an event module before anything starts to
825	create watchers. Nothing special needs to be done by the main program.	855	create watchers. Nothing special needs to be done by the main program.
826		856
		857	AnyEvent::Impl::Event based on Event, very stable, few glitches.
827	AnyEvent::Impl::Glib based on Glib, slow but very stable.	858	AnyEvent::Impl::Glib based on Glib, slow but very stable.
828	AnyEvent::Impl::Tk based on Tk, very broken.	859	AnyEvent::Impl::Tk based on Tk, very broken.
829	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	860	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
830	AnyEvent::Impl::POE based on POE, very slow, some limitations.	861	AnyEvent::Impl::POE based on POE, very slow, some limitations.
831	AnyEvent::Impl::Irssi used when running within irssi.	862	AnyEvent::Impl::Irssi used when running within irssi.
…		…
941	You should check C<$AnyEvent::MODEL> before adding to this array, though:	972	You should check C<$AnyEvent::MODEL> before adding to this array, though:
942	if it is defined then the event loop has already been detected, and the	973	if it is defined then the event loop has already been detected, and the
943	array will be ignored.	974	array will be ignored.
944		975
945	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	976	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
946	it,as it takes care of these details.	977	it, as it takes care of these details.
947		978
948	This variable is mainly useful for modules that can do something useful	979	This variable is mainly useful for modules that can do something useful
949	when AnyEvent is used and thus want to know when it is initialised, but do	980	when AnyEvent is used and thus want to know when it is initialised, but do
950	not need to even load it by default. This array provides the means to hook	981	not need to even load it by default. This array provides the means to hook
951	into AnyEvent passively, without loading it.	982	into AnyEvent passively, without loading it.
		983
		984	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		985	together, you could put this into Coro (this is the actual code used by
		986	Coro 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	}
952		996
953	=back	997	=back
954		998
955	=head1 WHAT TO DO IN A MODULE	999	=head1 WHAT TO DO IN A MODULE
956		1000
…		…
1038		1082
1039	=item L<AnyEvent::DNS>	1083	=item L<AnyEvent::DNS>
1040		1084
1041	Provides rich asynchronous DNS resolver capabilities.	1085	Provides rich asynchronous DNS resolver capabilities.
1042		1086
		1087	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1088
		1089	Implement event-based interfaces to the protocols of the same name (for
		1090	the curious, IGS is the International Go Server and FCP is the Freenet
		1091	Client Protocol).
		1092
		1093	=item L<AnyEvent::Handle::UDP>
		1094
		1095	Here be danger!
		1096
		1097	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1098	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1099	it's use of a stream-based API with a protocol that isn't streamable, that
		1100	the only way to improve it is to delete it.
		1101
		1102	It features data corruption (but typically only under load) and general
		1103	confusion. On top, the author is not only clueless about UDP but also
		1104	fact-resistant - some gems of his understanding: "connect doesn't work
		1105	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1106	packets", "I don't need to implement proper error checking as UDP doesn't
		1107	support error checking" and so on - he doesn't even understand what's
		1108	wrong with his module when it is explained to him.
		1109
1043	=item L<AnyEvent::HTTP>	1110	=item L<AnyEvent::DBI>
1044		1111
1045	A simple-to-use HTTP library that is capable of making a lot of concurrent	1112	Executes L<DBI> requests asynchronously in a proxy process for you,
1046	HTTP requests.	1113	notifying you in an event-bnased way when the operation is finished.
		1114
		1115	=item L<AnyEvent::AIO>
		1116
		1117	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1118	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1119	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1120	file I/O, and much more.
1047		1121
1048	=item L<AnyEvent::HTTPD>	1122	=item L<AnyEvent::HTTPD>
1049		1123
1050	Provides a simple web application server framework.	1124	A simple embedded webserver.
1051		1125
1052	=item L<AnyEvent::FastPing>	1126	=item L<AnyEvent::FastPing>
1053		1127
1054	The fastest ping in the west.	1128	The fastest ping in the west.
1055
1056	=item L<AnyEvent::DBI>
1057
1058	Executes L<DBI> requests asynchronously in a proxy process.
1059
1060	=item L<AnyEvent::AIO>
1061
1062	Truly asynchronous I/O, should be in the toolbox of every event
1063	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1064	together.
1065
1066	=item L<AnyEvent::BDB>
1067
1068	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1069	L<BDB> and AnyEvent together.
1070
1071	=item L<AnyEvent::GPSD>
1072
1073	A non-blocking interface to gpsd, a daemon delivering GPS information.
1074
1075	=item L<AnyEvent::IRC>
1076
1077	AnyEvent based IRC client module family (replacing the older Net::IRC3).
1078
1079	=item L<AnyEvent::XMPP>
1080
1081	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1082	Net::XMPP2>.
1083
1084	=item L<AnyEvent::IGS>
1085
1086	A non-blocking interface to the Internet Go Server protocol (used by
1087	L<App::IGS>).
1088
1089	=item L<Net::FCP>
1090
1091	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1092	of AnyEvent.
1093
1094	=item L<Event::ExecFlow>
1095
1096	High level API for event-based execution flow control.
1097		1129
1098	=item L<Coro>	1130	=item L<Coro>
1099		1131
1100	Has special support for AnyEvent via L<Coro::AnyEvent>.	1132	Has special support for AnyEvent via L<Coro::AnyEvent>.
1101		1133
…		…
1105		1137
1106	package AnyEvent;	1138	package AnyEvent;
1107		1139
1108	# basically a tuned-down version of common::sense	1140	# basically a tuned-down version of common::sense
1109	sub common_sense {	1141	sub common_sense {
1110	# no warnings	1142	# from common:.sense 1.0
1111	${^WARNING_BITS} ^= ${^WARNING_BITS};	1143	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1112	# use strict vars subs	1144	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1113	$^H \|= 0x00000600;	1145	$^H \|= 0x00000600;
1114	}	1146	}
1115		1147
1116	BEGIN { AnyEvent::common_sense }	1148	BEGIN { AnyEvent::common_sense }
1117		1149
1118	use Carp ();	1150	use Carp ();
1119		1151
1120	our $VERSION = 4.9;	1152	our $VERSION = '5.261';
1121	our $MODEL;	1153	our $MODEL;
1122		1154
1123	our $AUTOLOAD;	1155	our $AUTOLOAD;
1124	our @ISA;	1156	our @ISA;
1125		1157
1126	our @REGISTRY;	1158	our @REGISTRY;
1127		1159
1128	our $WIN32;
1129
1130	our $VERBOSE;	1160	our $VERBOSE;
1131		1161
1132	BEGIN {	1162	BEGIN {
1133	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1163	require "AnyEvent/constants.pl";
		1164
1134	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1165	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1135		1166
1136	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1167	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1137	if ${^TAINT};	1168	if ${^TAINT};
1138		1169
1139	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1170	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1151	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1182	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1152	}	1183	}
1153		1184
1154	my @models = (	1185	my @models = (
1155	[EV:: => AnyEvent::Impl::EV:: , 1],	1186	[EV:: => AnyEvent::Impl::EV:: , 1],
1156	[Event:: => AnyEvent::Impl::Event::, 1],
1157	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1187	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1158	# everything below here will not (normally) be autoprobed	1188	# everything below here will not (normally) be autoprobed
1159	# as the pureperl backend should work everywhere	1189	# as the pureperl backend should work everywhere
1160	# and is usually faster	1190	# and is usually faster
		1191	[Event:: => AnyEvent::Impl::Event::, 1],
1161	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1192	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1162	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1193	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1163	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1194	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1164	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1195	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1165	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1196	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
…		…
1168	[Prima:: => AnyEvent::Impl::POE::],	1199	[Prima:: => AnyEvent::Impl::POE::],
1169	# 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
1170	# byzantine signal and broken child handling, among others.	1201	# byzantine signal and broken child handling, among others.
1171	# 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
1172	# obvious default class.	1203	# obvious default class.
1173	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1204	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1174	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1205	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1175	# [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
1176	);	1208	);
1177		1209
1178	our %method = map +($_ => 1),	1210	our %method = map +($_ => 1),
1179	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);
1180		1212
1181	our @post_detect;	1213	our @post_detect;
1182		1214
1183	sub post_detect(&) {	1215	sub post_detect(&) {
1184	my ($cb) = @_;	1216	my ($cb) = @_;
1185		1217
1186	if ($MODEL) {
1187	$cb->();
1188
1189	undef
1190	} else {
1191	push @post_detect, $cb;	1218	push @post_detect, $cb;
1192		1219
1193	defined wantarray	1220	defined wantarray
1194	? bless \$cb, "AnyEvent::Util::postdetect"	1221	? bless \$cb, "AnyEvent::Util::postdetect"
1195	: ()	1222	: ()
1196	}
1197	}	1223	}
1198		1224
1199	sub AnyEvent::Util::postdetect::DESTROY {	1225	sub AnyEvent::Util::postdetect::DESTROY {
1200	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1226	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1201	}	1227	}
1202		1228
1203	sub detect() {	1229	sub 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
1204	unless ($MODEL) {	1247	unless ($MODEL) {
1205	local $SIG{__DIE__};	1248	for (@REGISTRY, @models) {
1206		1249	my ($package, $model) = @$_;
1207	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1250	if (${"$package\::VERSION"} > 0) {
1208	my $model = "AnyEvent::Impl::$1";
1209	if (eval "require $model") {	1251	if (eval "require $model") {
1210	$MODEL = $model;	1252	$MODEL = $model;
1211	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;
1212	} else {	1254	last;
1213	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1255	}
1214	}	1256	}
1215	}	1257	}
1216		1258
1217	# check for already loaded models
1218	unless ($MODEL) {	1259	unless ($MODEL) {
		1260	# try to autoload a model
1219	for (@REGISTRY, @models) {	1261	for (@REGISTRY, @models) {
1220	my ($package, $model) = @$_;	1262	my ($package, $model, $autoload) = @$_;
		1263	if (
		1264	$autoload
		1265	and eval "require $package"
1221	if (${"$package\::VERSION"} > 0) {	1266	and ${"$package\::VERSION"} > 0
1222	if (eval "require $model") {	1267	and eval "require $model"
		1268	) {
1223	$MODEL = $model;	1269	$MODEL = $model;
1224	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1270	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1225	last;	1271	last;
1226	}
1227	}	1272	}
1228	}	1273	}
1229		1274
1230	unless ($MODEL) {
1231	# try to autoload a model
1232	for (@REGISTRY, @models) {
1233	my ($package, $model, $autoload) = @$_;
1234	if (
1235	$autoload
1236	and eval "require $package"
1237	and ${"$package\::VERSION"} > 0
1238	and eval "require $model"
1239	) {
1240	$MODEL = $model;
1241	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1242	last;
1243	}
1244	}
1245
1246	$MODEL	1275	$MODEL
1247	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";
1248	}
1249	}	1277	}
1250
1251	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1252
1253	unshift @ISA, $MODEL;
1254
1255	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1256
1257	(shift @post_detect)->() while @post_detect;
1258	}	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	};
1259		1301
1260	$MODEL	1302	$MODEL
1261	}	1303	}
1262		1304
1263	sub AUTOLOAD {	1305	sub AUTOLOAD {
1264	(my $func = $AUTOLOAD) =~ s/.*://;	1306	(my $func = $AUTOLOAD) =~ s/.*://;
1265		1307
1266	$method{$func}	1308	$method{$func}
1267	or Carp::croak "$func: not a valid method for AnyEvent objects";	1309	or Carp::croak "$func: not a valid AnyEvent class method";
1268		1310
1269	detect unless $MODEL;	1311	detect;
1270		1312
1271	my $class = shift;	1313	my $class = shift;
1272	$class->$func (@_);	1314	$class->$func (@_);
1273	}	1315	}
1274		1316
…		…
1287	# 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
1288		1330
1289	($fh2, $rw)	1331	($fh2, $rw)
1290	}	1332	}
1291		1333
		1334	=head1 SIMPLIFIED AE API
		1335
		1336	Starting with version 5.0, AnyEvent officially supports a second, much
		1337	simpler, API that is designed to reduce the calling, typing and memory
		1338	overhead by using function call syntax and a fixed number of parameters.
		1339
		1340	See the L<AE> manpage for details.
		1341
		1342	=cut
		1343
		1344	package AE;
		1345
		1346	our $VERSION = $AnyEvent::VERSION;
		1347
		1348	# fall back to the main API by default - backends and AnyEvent::Base
		1349	# implementations can overwrite these.
		1350
		1351	sub io($$$) {
		1352	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1353	}
		1354
		1355	sub timer($$$) {
		1356	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1357	}
		1358
		1359	sub signal($$) {
		1360	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1361	}
		1362
		1363	sub child($$) {
		1364	AnyEvent->child (pid => $_[0], cb => $_[1])
		1365	}
		1366
		1367	sub idle($) {
		1368	AnyEvent->idle (cb => $_[0])
		1369	}
		1370
		1371	sub cv(;&) {
		1372	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1373	}
		1374
		1375	sub now() {
		1376	AnyEvent->now
		1377	}
		1378
		1379	sub now_update() {
		1380	AnyEvent->now_update
		1381	}
		1382
		1383	sub time() {
		1384	AnyEvent->time
		1385	}
		1386
1292	package AnyEvent::Base;	1387	package AnyEvent::Base;
1293		1388
1294	# default implementations for many methods	1389	# default implementations for many methods
1295		1390
1296	sub _time {	1391	sub time {
		1392	eval q{ # poor man's autoloading {}
1297	# probe for availability of Time::HiRes	1393	# probe for availability of Time::HiRes
1298	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1394	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1299	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;
1300	*_time = \&Time::HiRes::time;	1396	*AE::time = \&Time::HiRes::time;
1301	# if (eval "use POSIX (); (POSIX::times())...	1397	# if (eval "use POSIX (); (POSIX::times())...
1302	} else {	1398	} else {
1303	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;
1304	*_time = sub { time }; # epic fail	1400	*AE::time = sub (){ time }; # epic fail
		1401	}
		1402
		1403	*time = sub { AE::time }; # different prototypes
1305	}	1404	};
		1405	die if $@;
1306		1406
1307	&_time	1407	&time
1308	}	1408	}
1309		1409
1310	sub time { _time }	1410	*now = \&time;
1311	sub now { _time }	1411
1312	sub now_update { }	1412	sub now_update { }
1313		1413
1314	# default implementation for ->condvar	1414	# default implementation for ->condvar
1315		1415
1316	sub condvar {	1416	sub condvar {
		1417	eval q{ # poor man's autoloading {}
		1418	*condvar = sub {
1317	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
1318	}	1429	}
1319		1430
1320	# default implementation for ->signal	1431	# default implementation for ->signal
1321		1432
1322	our $HAVE_ASYNC_INTERRUPT;	1433	our $HAVE_ASYNC_INTERRUPT;
1323		1434
1324	sub _have_async_interrupt() {	1435	sub _have_async_interrupt() {
1325	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}	1436	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1326	&& eval "use Async::Interrupt 1.0 (); 1")	1437	&& eval "use Async::Interrupt 1.02 (); 1")
1327	unless defined $HAVE_ASYNC_INTERRUPT;	1438	unless defined $HAVE_ASYNC_INTERRUPT;
1328		1439
1329	$HAVE_ASYNC_INTERRUPT	1440	$HAVE_ASYNC_INTERRUPT
1330	}	1441	}
1331		1442
1332	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1443	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1333	our (%SIG_ASY, %SIG_ASY_W);	1444	our (%SIG_ASY, %SIG_ASY_W);
1334	our ($SIG_COUNT, $SIG_TW);	1445	our ($SIG_COUNT, $SIG_TW);
1335		1446
1336	sub _signal_exec {
1337	$HAVE_ASYNC_INTERRUPT
1338	? $SIGPIPE_R->drain
1339	: sysread $SIGPIPE_R, my $dummy, 9;
1340
1341	while (%SIG_EV) {
1342	for (keys %SIG_EV) {
1343	delete $SIG_EV{$_};
1344	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1345	}
1346	}
1347	}
1348
1349	# 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
1350	sub _sig_add() {	1449	sub _sig_add() {
1351	unless ($SIG_COUNT++) {	1450	unless ($SIG_COUNT++) {
1352	# try to align timer on a full-second boundary, if possible	1451	# try to align timer on a full-second boundary, if possible
1353	my $NOW = AnyEvent->now;	1452	my $NOW = AE::now;
1354		1453
1355	$SIG_TW = AnyEvent->timer (	1454	$SIG_TW = AE::timer
1356	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1455	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1357	interval => $MAX_SIGNAL_LATENCY,	1456	$MAX_SIGNAL_LATENCY,
1358	cb => sub { }, # just for the PERL_ASYNC_CHECK	1457	sub { } # just for the PERL_ASYNC_CHECK
1359	);	1458	;
1360	}	1459	}
1361	}	1460	}
1362		1461
1363	sub _sig_del {	1462	sub _sig_del {
1364	undef $SIG_TW	1463	undef $SIG_TW
1365	unless --$SIG_COUNT;	1464	unless --$SIG_COUNT;
1366	}	1465	}
1367		1466
1368	our $_sig_name_init; $_sig_name_init = sub {	1467	our $_sig_name_init; $_sig_name_init = sub {
1369	eval q{ # poor man's autoloading	1468	eval q{ # poor man's autoloading {}
1370	undef $_sig_name_init;	1469	undef $_sig_name_init;
1371		1470
1372	if (_have_async_interrupt) {	1471	if (_have_async_interrupt) {
1373	*sig2num = \&Async::Interrupt::sig2num;	1472	*sig2num = \&Async::Interrupt::sig2num;
1374	*sig2name = \&Async::Interrupt::sig2name;	1473	*sig2name = \&Async::Interrupt::sig2name;
…		…
1401	# probe for availability of Async::Interrupt	1500	# probe for availability of Async::Interrupt
1402	if (_have_async_interrupt) {	1501	if (_have_async_interrupt) {
1403	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1502	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1404		1503
1405	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1504	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1406	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);	1505	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1407		1506
1408	} else {	1507	} else {
1409	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1508	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1410
1411	require Fcntl;
1412		1509
1413	if (AnyEvent::WIN32) {	1510	if (AnyEvent::WIN32) {
1414	require AnyEvent::Util;	1511	require AnyEvent::Util;
1415		1512
1416	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1513	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1417	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1514	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1418	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1515	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1419	} else {	1516	} else {
1420	pipe $SIGPIPE_R, $SIGPIPE_W;	1517	pipe $SIGPIPE_R, $SIGPIPE_W;
1421	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1518	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1422	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1519	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1423		1520
1424	# not strictly required, as $^F is normally 2, but let's make sure...	1521	# not strictly required, as $^F is normally 2, but let's make sure...
1425	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1522	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1426	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1523	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1427	}	1524	}
1428		1525
1429	$SIGPIPE_R	1526	$SIGPIPE_R
1430	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1527	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1431		1528
1432	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);	1529	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1433	}	1530	}
1434		1531
1435	*signal = sub {	1532	*signal = $HAVE_ASYNC_INTERRUPT
		1533	? sub {
1436	my (undef, %arg) = @_;	1534	my (undef, %arg) = @_;
1437		1535
1438	my $signal = uc $arg{signal}
1439	or Carp::croak "required option 'signal' is missing";
1440
1441	if ($HAVE_ASYNC_INTERRUPT) {
1442	# async::interrupt	1536	# async::interrupt
1443
1444	$signal = sig2num $signal;	1537	my $signal = sig2num $arg{signal};
1445	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1538	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1446		1539
1447	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1540	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1448	cb => sub { undef $SIG_EV{$signal} },	1541	cb => sub { undef $SIG_EV{$signal} },
1449	signal => $signal,	1542	signal => $signal,
1450	pipe => [$SIGPIPE_R->filenos],	1543	pipe => [$SIGPIPE_R->filenos],
1451	pipe_autodrain => 0,	1544	pipe_autodrain => 0,
1452	;	1545	;
1453		1546
1454	} else {	1547	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1548	}
		1549	: sub {
		1550	my (undef, %arg) = @_;
		1551
1455	# pure perl	1552	# pure perl
1456
1457	# AE::Util has been loaded in signal
1458	$signal = sig2name $signal;	1553	my $signal = sig2name $arg{signal};
1459	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1554	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1460		1555
1461	$SIG{$signal} \|\|= sub {	1556	$SIG{$signal} \|\|= sub {
1462	local $!;	1557	local $!;
1463	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1558	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1464	undef $SIG_EV{$signal};	1559	undef $SIG_EV{$signal};
1465	};	1560	};
1466		1561
1467	# can't do signal processing without introducing races in pure perl,	1562	# can't do signal processing without introducing races in pure perl,
1468	# so limit the signal latency.	1563	# so limit the signal latency.
1469	_sig_add;	1564	_sig_add;
1470	}
1471		1565
1472	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1566	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1567	}
1473	};	1568	;
1474		1569
1475	*AnyEvent::Base::signal::DESTROY = sub {	1570	*AnyEvent::Base::signal::DESTROY = sub {
1476	my ($signal, $cb) = @{$_[0]};	1571	my ($signal, $cb) = @{$_[0]};
1477		1572
1478	_sig_del;	1573	_sig_del;
…		…
1485	# print weird messages, or just unconditionally exit	1580	# print weird messages, or just unconditionally exit
1486	# instead of getting the default action.	1581	# instead of getting the default action.
1487	undef $SIG{$signal}	1582	undef $SIG{$signal}
1488	unless keys %{ $SIG_CB{$signal} };	1583	unless keys %{ $SIG_CB{$signal} };
1489	};	1584	};
		1585
		1586	*_signal_exec = sub {
		1587	$HAVE_ASYNC_INTERRUPT
		1588	? $SIGPIPE_R->drain
		1589	: sysread $SIGPIPE_R, (my $dummy), 9;
		1590
		1591	while (%SIG_EV) {
		1592	for (keys %SIG_EV) {
		1593	delete $SIG_EV{$_};
		1594	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1595	}
		1596	}
		1597	};
1490	};	1598	};
1491	die if $@;	1599	die if $@;
		1600
1492	&signal	1601	&signal
1493	}	1602	}
1494		1603
1495	# default implementation for ->child	1604	# default implementation for ->child
1496		1605
1497	our %PID_CB;	1606	our %PID_CB;
1498	our $CHLD_W;	1607	our $CHLD_W;
1499	our $CHLD_DELAY_W;	1608	our $CHLD_DELAY_W;
1500	our $WNOHANG;	1609	our $WNOHANG;
1501		1610
		1611	# used by many Impl's
1502	sub _emit_childstatus($$) {	1612	sub _emit_childstatus($$) {
1503	my (undef, $rpid, $rstatus) = @_;	1613	my (undef, $rpid, $rstatus) = @_;
1504		1614
1505	$_->($rpid, $rstatus)	1615	$_->($rpid, $rstatus)
1506	for values %{ $PID_CB{$rpid} \|\| {} },	1616	for values %{ $PID_CB{$rpid} \|\| {} },
1507	values %{ $PID_CB{0} \|\| {} };	1617	values %{ $PID_CB{0} \|\| {} };
1508	}	1618	}
1509		1619
1510	sub _sigchld {
1511	my $pid;
1512
1513	AnyEvent->_emit_childstatus ($pid, $?)
1514	while ($pid = waitpid -1, $WNOHANG) > 0;
1515	}
1516
1517	sub child {	1620	sub 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 {
1518	my (undef, %arg) = @_;	1630	my (undef, %arg) = @_;
1519		1631
1520	defined (my $pid = $arg{pid} + 0)	1632	defined (my $pid = $arg{pid} + 0)
1521	or Carp::croak "required option 'pid' is missing";	1633	or Carp::croak "required option 'pid' is missing";
1522		1634
1523	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1635	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1524		1636
1525	# WNOHANG is almost cetrainly 1 everywhere	1637	# WNOHANG is almost cetrainly 1 everywhere
1526	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1638	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1527	? 1	1639	? 1
1528	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1640	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1529		1641
1530	unless ($CHLD_W) {	1642	unless ($CHLD_W) {
1531	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1643	$CHLD_W = AE::signal CHLD => \&_sigchld;
1532	# 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
1533	&_sigchld;	1645	&_sigchld;
1534	}	1646	}
1535		1647
1536	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1648	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1537	}	1649	};
1538		1650
1539	sub AnyEvent::Base::child::DESTROY {	1651	*AnyEvent::Base::child::DESTROY = sub {
1540	my ($pid, $cb) = @{$_[0]};	1652	my ($pid, $cb) = @{$_[0]};
1541		1653
1542	delete $PID_CB{$pid}{$cb};	1654	delete $PID_CB{$pid}{$cb};
1543	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1655	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1544		1656
1545	undef $CHLD_W unless keys %PID_CB;	1657	undef $CHLD_W unless keys %PID_CB;
		1658	};
		1659	};
		1660	die if $@;
		1661
		1662	&child
1546	}	1663	}
1547		1664
1548	# idle emulation is done by simply using a timer, regardless	1665	# idle emulation is done by simply using a timer, regardless
1549	# of whether the process is idle or not, and not letting	1666	# of whether the process is idle or not, and not letting
1550	# the callback use more than 50% of the time.	1667	# the callback use more than 50% of the time.
1551	sub idle {	1668	sub idle {
		1669	eval q{ # poor man's autoloading {}
		1670	*idle = sub {
1552	my (undef, %arg) = @_;	1671	my (undef, %arg) = @_;
1553		1672
1554	my ($cb, $w, $rcb) = $arg{cb};	1673	my ($cb, $w, $rcb) = $arg{cb};
1555		1674
1556	$rcb = sub {	1675	$rcb = sub {
1557	if ($cb) {	1676	if ($cb) {
1558	$w = _time;	1677	$w = _time;
1559	&$cb;	1678	&$cb;
1560	$w = _time - $w;	1679	$w = _time - $w;
1561		1680
1562	# 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,
1563	# within some limits	1682	# within some limits
1564	$w = 0.0001 if $w < 0.0001;	1683	$w = 0.0001 if $w < 0.0001;
1565	$w = 5 if $w > 5;	1684	$w = 5 if $w > 5;
1566		1685
1567	$w = AnyEvent->timer (after => $w, cb => $rcb);	1686	$w = AE::timer $w, 0, $rcb;
1568	} else {	1687	} else {
1569	# clean up...	1688	# clean up...
1570	undef $w;	1689	undef $w;
1571	undef $rcb;	1690	undef $rcb;
		1691	}
		1692	};
		1693
		1694	$w = AE::timer 0.05, 0, $rcb;
		1695
		1696	bless \\$cb, "AnyEvent::Base::idle"
1572	}	1697	};
		1698
		1699	*AnyEvent::Base::idle::DESTROY = sub {
		1700	undef $${$_[0]};
		1701	};
1573	};	1702	};
		1703	die if $@;
1574		1704
1575	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1705	&idle
1576
1577	bless \\$cb, "AnyEvent::Base::idle"
1578	}
1579
1580	sub AnyEvent::Base::idle::DESTROY {
1581	undef $${$_[0]};
1582	}	1706	}
1583		1707
1584	package AnyEvent::CondVar;	1708	package AnyEvent::CondVar;
1585		1709
1586	our @ISA = AnyEvent::CondVar::Base::;	1710	our @ISA = AnyEvent::CondVar::Base::;
…		…
1640		1764
1641	@_	1765	@_
1642	and $cv->{_ae_cb} = shift	1766	and $cv->{_ae_cb} = shift
1643	and $cv->{_ae_sent}	1767	and $cv->{_ae_sent}
1644	and (delete $cv->{_ae_cb})->($cv);	1768	and (delete $cv->{_ae_cb})->($cv);
		1769
1645	$cv->{_ae_cb}	1770	$cv->{_ae_cb}
1646	}	1771	}
1647		1772
1648	sub begin {	1773	sub begin {
1649	++$_[0]{_ae_counter};	1774	++$_[0]{_ae_counter};
…		…
1656	}	1781	}
1657		1782
1658	# undocumented/compatibility with pre-3.4	1783	# undocumented/compatibility with pre-3.4
1659	*broadcast = \&send;	1784	*broadcast = \&send;
1660	*wait = \&_wait;	1785	*wait = \&_wait;
1661
1662	#############################################################################
1663	# "new" API, currently only emulation of it
1664	#############################################################################
1665
1666	package AE;
1667
1668	sub io($$$) {
1669	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1670	}
1671
1672	sub timer($$$) {
1673	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
1674	}
1675
1676	sub signal($$) {
1677	AnyEvent->signal (signal => $_[0], cb => $_[1]);
1678	}
1679
1680	sub child($$) {
1681	AnyEvent->child (pid => $_[0], cb => $_[1]);
1682	}
1683
1684	sub idle($) {
1685	AnyEvent->idle (cb => $_[0]);
1686	}
1687
1688	sub cv() {
1689	AnyEvent->condvar
1690	}
1691
1692	sub now() {
1693	AnyEvent->now
1694	}
1695
1696	sub now_update() {
1697	AnyEvent->now_update
1698	}
1699
1700	sub time() {
1701	AnyEvent->time
1702	}
1703		1786
1704	=head1 ERROR AND EXCEPTION HANDLING	1787	=head1 ERROR AND EXCEPTION HANDLING
1705		1788
1706	In general, AnyEvent does not do any error handling - it relies on the	1789	In general, AnyEvent does not do any error handling - it relies on the
1707	caller to do that if required. The L<AnyEvent::Strict> module (see also	1790	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1901	warn "read: $input\n"; # output what has been read	1984	warn "read: $input\n"; # output what has been read
1902	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1985	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1903	},	1986	},
1904	);	1987	);
1905		1988
1906	my $time_watcher; # can only be used once
1907
1908	sub new_timer {
1909	$timer = AnyEvent->timer (after => 1, cb => sub {	1989	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1910	warn "timeout\n"; # print 'timeout' about every second	1990	warn "timeout\n"; # print 'timeout' at most every second
1911	&new_timer; # and restart the time
1912	});	1991	});
1913	}
1914
1915	new_timer; # create first timer
1916		1992
1917	$cv->recv; # wait until user enters /^q/i	1993	$cv->recv; # wait until user enters /^q/i
1918		1994
1919	=head1 REAL-WORLD EXAMPLE	1995	=head1 REAL-WORLD EXAMPLE
1920		1996
…		…
1993		2069
1994	The actual code goes further and collects all errors (C<die>s, exceptions)	2070	The actual code goes further and collects all errors (C<die>s, exceptions)
1995	that occurred during request processing. The C<result> method detects	2071	that occurred during request processing. The C<result> method detects
1996	whether an exception as thrown (it is stored inside the $txn object)	2072	whether an exception as thrown (it is stored inside the $txn object)
1997	and just throws the exception, which means connection errors and other	2073	and just throws the exception, which means connection errors and other
1998	problems get reported tot he code that tries to use the result, not in a	2074	problems get reported to the code that tries to use the result, not in a
1999	random callback.	2075	random callback.
2000		2076
2001	All of this enables the following usage styles:	2077	All of this enables the following usage styles:
2002		2078
2003	1. Blocking:	2079	1. Blocking:
…		…
2051	through AnyEvent. The benchmark creates a lot of timers (with a zero	2127	through AnyEvent. The benchmark creates a lot of timers (with a zero
2052	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2128	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
2053	which it is), lets them fire exactly once and destroys them again.	2129	which it is), lets them fire exactly once and destroys them again.
2054		2130
2055	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2131	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
2056	distribution.	2132	distribution. It uses the L<AE> interface, which makes a real difference
		2133	for the EV and Perl backends only.
2057		2134
2058	=head3 Explanation of the columns	2135	=head3 Explanation of the columns
2059		2136
2060	I<watcher> is the number of event watchers created/destroyed. Since	2137	I<watcher> is the number of event watchers created/destroyed. Since
2061	different event models feature vastly different performances, each event	2138	different event models feature vastly different performances, each event
…		…
2082	watcher.	2159	watcher.
2083		2160
2084	=head3 Results	2161	=head3 Results
2085		2162
2086	name watchers bytes create invoke destroy comment	2163	name watchers bytes create invoke destroy comment
2087	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
2088	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
2089	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
2090	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
2091	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
2092	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
2093	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
2094	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
2095	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
2096	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
2097	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
2098	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
2099		2176
2100	=head3 Discussion	2177	=head3 Discussion
2101		2178
2102	The benchmark does I<not> measure scalability of the event loop very	2179	The benchmark does I<not> measure scalability of the event loop very
2103	well. For example, a select-based event loop (such as the pure perl one)	2180	well. For example, a select-based event loop (such as the pure perl one)
…		…
2115	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2192	benchmark machine, handling an event takes roughly 1600 CPU cycles with
2116	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2193	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2117	cycles with POE.	2194	cycles with POE.
2118		2195
2119	C<EV> is the sole leader regarding speed and memory use, which are both	2196	C<EV> is the sole leader regarding speed and memory use, which are both
2120	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2197	maximal/minimal, respectively. When using the L<AE> API there is zero
		2198	overhead (when going through the AnyEvent API create is about 5-6 times
		2199	slower, with other times being equal, so still uses far less memory than
2121	far less memory than any other event loop and is still faster than Event	2200	any other event loop and is still faster than Event natively).
2122	natively.
2123		2201
2124	The pure perl implementation is hit in a few sweet spots (both the	2202	The pure perl implementation is hit in a few sweet spots (both the
2125	constant timeout and the use of a single fd hit optimisations in the perl	2203	constant timeout and the use of a single fd hit optimisations in the perl
2126	interpreter and the backend itself). Nevertheless this shows that it	2204	interpreter and the backend itself). Nevertheless this shows that it
2127	adds very little overhead in itself. Like any select-based backend its	2205	adds very little overhead in itself. Like any select-based backend its
…		…
2201	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2279	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2202	(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
2203	connections, most of which are idle at any one point in time.	2281	connections, most of which are idle at any one point in time.
2204		2282
2205	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2283	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2206	distribution.	2284	distribution. It uses the L<AE> interface, which makes a real difference
		2285	for the EV and Perl backends only.
2207		2286
2208	=head3 Explanation of the columns	2287	=head3 Explanation of the columns
2209		2288
2210	I<sockets> is the number of sockets, and twice the number of "servers" (as	2289	I<sockets> is the number of sockets, and twice the number of "servers" (as
2211	each server has a read and write socket end).	2290	each server has a read and write socket end).
…		…
2219	a new one that moves the timeout into the future.	2298	a new one that moves the timeout into the future.
2220		2299
2221	=head3 Results	2300	=head3 Results
2222		2301
2223	name sockets create request	2302	name sockets create request
2224	EV 20000 69.01 11.16	2303	EV 20000 62.66 7.99
2225	Perl 20000 73.32 35.87	2304	Perl 20000 68.32 32.64
2226	IOAsync 20000 157.00 98.14 epoll	2305	IOAsync 20000 174.06 101.15 epoll
2227	IOAsync 20000 159.31 616.06 poll	2306	IOAsync 20000 174.67 610.84 poll
2228	Event 20000 212.62 257.32	2307	Event 20000 202.69 242.91
2229	Glib 20000 651.16 1896.30	2308	Glib 20000 557.01 1689.52
2230	POE 20000 349.67 12317.24 uses POE::Loop::Event	2309	POE 20000 341.54 12086.32 uses POE::Loop::Event
2231		2310
2232	=head3 Discussion	2311	=head3 Discussion
2233		2312
2234	This benchmark I<does> measure scalability and overall performance of the	2313	This benchmark I<does> measure scalability and overall performance of the
2235	particular event loop.	2314	particular event loop.
…		…
2361	As you can see, the AnyEvent + EV combination even beats the	2440	As you can see, the AnyEvent + EV combination even beats the
2362	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2441	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2363	backend easily beats IO::Lambda and POE.	2442	backend easily beats IO::Lambda and POE.
2364		2443
2365	And even the 100% non-blocking version written using the high-level (and	2444	And even the 100% non-blocking version written using the high-level (and
2366	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2445	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2367	large margin, even though it does all of DNS, tcp-connect and socket I/O	2446	higher level ("unoptimised") abstractions by a large margin, even though
2368	in a non-blocking way.	2447	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2369		2448
2370	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2449	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2371	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2450	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2372	part of the IO::lambda distribution and were used without any changes.	2451	part of the IO::Lambda distribution and were used without any changes.
2373		2452
2374		2453
2375	=head1 SIGNALS	2454	=head1 SIGNALS
2376		2455
2377	AnyEvent currently installs handlers for these signals:	2456	AnyEvent currently installs handlers for these signals:
…		…
2419	it's built-in modules) are required to use it.	2498	it's built-in modules) are required to use it.
2420		2499
2421	That does not mean that AnyEvent won't take advantage of some additional	2500	That does not mean that AnyEvent won't take advantage of some additional
2422	modules if they are installed.	2501	modules if they are installed.
2423		2502
2424	This section epxlains which additional modules will be used, and how they	2503	This section explains which additional modules will be used, and how they
2425	affect AnyEvent's operetion.	2504	affect AnyEvent's operation.
2426		2505
2427	=over 4	2506	=over 4
2428		2507
2429	=item L<Async::Interrupt>	2508	=item L<Async::Interrupt>
2430		2509
…		…
2435	catch the signals) with some delay (default is 10 seconds, look for	2514	catch the signals) with some delay (default is 10 seconds, look for
2436	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2515	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2437		2516
2438	If this module is available, then it will be used to implement signal	2517	If this module is available, then it will be used to implement signal
2439	catching, which means that signals will not be delayed, and the event loop	2518	catching, which means that signals will not be delayed, and the event loop
2440	will not be interrupted regularly, which is more efficient (And good for	2519	will not be interrupted regularly, which is more efficient (and good for
2441	battery life on laptops).	2520	battery life on laptops).
2442		2521
2443	This affects not just the pure-perl event loop, but also other event loops	2522	This affects not just the pure-perl event loop, but also other event loops
2444	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2523	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2445		2524
…		…
2457	automatic timer adjustments even when no monotonic clock is available,	2536	automatic timer adjustments even when no monotonic clock is available,
2458	can take avdantage of advanced kernel interfaces such as C<epoll> and	2537	can take avdantage of advanced kernel interfaces such as C<epoll> and
2459	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2538	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2460	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2539	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2461		2540
		2541	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2542	then this module will do nothing for you.
		2543
2462	=item L<Guard>	2544	=item L<Guard>
2463		2545
2464	The guard module, when used, will be used to implement	2546	The guard module, when used, will be used to implement
2465	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2547	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2466	lot less memory), but otherwise doesn't affect guard operation much. It is	2548	lot less memory), but otherwise doesn't affect guard operation much. It is
2467	purely used for performance.	2549	purely used for performance.
2468		2550
2469	=item L<JSON> and L<JSON::XS>	2551	=item L<JSON> and L<JSON::XS>
2470		2552
2471	This module is required when you want to read or write JSON data via	2553	One of these modules is required when you want to read or write JSON data
2472	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2554	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2473	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2555	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2474
2475	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2476	installed.
2477		2556
2478	=item L<Net::SSLeay>	2557	=item L<Net::SSLeay>
2479		2558
2480	Implementing TLS/SSL in Perl is certainly interesting, but not very	2559	Implementing TLS/SSL in Perl is certainly interesting, but not very
2481	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2560	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
…		…
2492		2571
2493		2572
2494	=head1 FORK	2573	=head1 FORK
2495		2574
2496	Most event libraries are not fork-safe. The ones who are usually are	2575	Most event libraries are not fork-safe. The ones who are usually are
2497	because they rely on inefficient but fork-safe C<select> or C<poll>	2576	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2498	calls. Only L<EV> is fully fork-aware.	2577	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2578	are usually badly thought-out hacks that are incompatible with fork in
		2579	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2580	continue event-processing in both parent and child (or both, if you know
		2581	what you are doing).
		2582
		2583	This means that, in general, you cannot fork and do event processing in
		2584	the child if the event library was initialised before the fork (which
		2585	usually happens when the first AnyEvent watcher is created, or the library
		2586	is loaded).
2499		2587
2500	If you have to fork, you must either do so I<before> creating your first	2588	If you have to fork, you must either do so I<before> creating your first
2501	watcher OR you must not use AnyEvent at all in the child OR you must do	2589	watcher OR you must not use AnyEvent at all in the child OR you must do
2502	something completely out of the scope of AnyEvent.	2590	something completely out of the scope of AnyEvent.
		2591
		2592	The problem of doing event processing in the parent I<and> the child
		2593	is much more complicated: even for backends that I<are> fork-aware or
		2594	fork-safe, their behaviour is not usually what you want: fork clones all
		2595	watchers, that means all timers, I/O watchers etc. are active in both
		2596	parent and child, which is almost never what you want. USing C<exec>
		2597	to start worker children from some kind of manage rprocess is usually
		2598	preferred, because it is much easier and cleaner, at the expense of having
		2599	to have another binary.
2503		2600
2504		2601
2505	=head1 SECURITY CONSIDERATIONS	2602	=head1 SECURITY CONSIDERATIONS
2506		2603
2507	AnyEvent can be forced to load any event model via	2604	AnyEvent can be forced to load any event model via

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.269 by root, Fri Jul 31 20:16:29 2009 UTC vs. Revision 1.323 by root, Thu May 20 21:22:20 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.269 by root, Fri Jul 31 20:16:29 2009 UTC vs.
Revision 1.323 by root, Thu May 20 21:22:20 2010 UTC