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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.266 by root, Thu Jul 30 03:41:56 2009 UTC vs.
Revision 1.318 by root, Wed Mar 24 23:28:06 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 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 => ...
…		…
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
…		…
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 });
400		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).
		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 do	431	callbacks to signals in a generic way, which is a pity, as you cannot
405	race-free signal handling in perl. AnyEvent will try to do it's best, but	432	do race-free signal handling in perl, requiring C libraries for
		433	this. AnyEvent will try to do it's best, which means in some cases,
406	in some cases, signals will be delayed. The maximum time a signal might	434	signals will be delayed. The maximum time a signal might be delayed is
407	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	435	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
408	seconds). This variable can be changed only before the first signal	436	variable can be changed only before the first signal watcher is created,
409	watcher is created, and should be left alone otherwise. Higher values	437	and should be left alone otherwise. This variable determines how often
		438	AnyEvent polls for signals (in case a wake-up was missed). Higher values
410	will cause fewer spurious wake-ups, which is better for power and CPU	439	will cause fewer spurious wake-ups, which is better for power and CPU
		440	saving.
		441
411	saving. All these problems can be avoided by installing the optional	442	All these problems can be avoided by installing the optional
412	L<Async::Interrupt> module. This will not work with inherently broken	443	L<Async::Interrupt> module, which works with most event loops. It will not
413	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>	444	work with inherently broken event loops such as L<Event> or L<Event::Lib>
414	currently, 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
415	those, you just have to suffer the delays.	446	one-second latency). For those, you just have to suffer the delays.
416		447
417	=head2 CHILD PROCESS WATCHERS	448	=head2 CHILD PROCESS WATCHERS
418		449
419	$w = AnyEvent->child (pid => <process id>, cb => <callback>);	450	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
420		451
…		…
475		506
476	=head2 IDLE WATCHERS	507	=head2 IDLE WATCHERS
477		508
478	$w = AnyEvent->idle (cb => <callback>);	509	$w = AnyEvent->idle (cb => <callback>);
479		510
480	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
481	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.
482	"nothing better to do" is usually defined to be "no other events need
483	attention by the event loop".
484		513
485	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
486	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
487	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.
488		522
489	Most event loops unfortunately do not really support idle watchers (only	523	Unfortunately, most event loops do not really support idle watchers (only
490	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
491	will simply call the callback "from time to time".	525	will simply call the callback "from time to time".
492		526
493	Example: read lines from STDIN, but only process them when the	527	Example: read lines from STDIN, but only process them when the
494	program is otherwise idle:	528	program is otherwise idle:
…		…
588	after => 1,	622	after => 1,
589	cb => sub { $result_ready->send },	623	cb => sub { $result_ready->send },
590	);	624	);
591		625
592	# this "blocks" (while handling events) till the callback	626	# this "blocks" (while handling events) till the callback
593	# calls -<send	627	# calls ->send
594	$result_ready->recv;	628	$result_ready->recv;
595		629
596	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
597	variables are also callable directly.	631	variables are also callable directly.
598		632
…		…
662	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
663	to use a condition variable for the whole process.	697	to use a condition variable for the whole process.
664		698
665	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
666	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
667	>>, 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
668	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
669	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.
670		705
671	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
672	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
673	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).
674		709
…		…
701	begung can potentially be zero:	736	begung can potentially be zero:
702		737
703	my $cv = AnyEvent->condvar;	738	my $cv = AnyEvent->condvar;
704		739
705	my %result;	740	my %result;
706	$cv->begin (sub { $cv->send (\%result) });	741	$cv->begin (sub { shift->send (\%result) });
707		742
708	for my $host (@list_of_hosts) {	743	for my $host (@list_of_hosts) {
709	$cv->begin;	744	$cv->begin;
710	ping_host_then_call_callback $host, sub {	745	ping_host_then_call_callback $host, sub {
711	$result{$host} = ...;	746	$result{$host} = ...;
…		…
786	=item $cb = $cv->cb ($cb->($cv))	821	=item $cb = $cv->cb ($cb->($cv))
787		822
788	This is a mutator function that returns the callback set and optionally	823	This is a mutator function that returns the callback set and optionally
789	replaces it before doing so.	824	replaces it before doing so.
790		825
791	The callback will be called when the condition becomes "true", i.e. when	826	The callback will be called when the condition becomes (or already was)
792	C<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
793	variable itself. Calling C<recv> inside the callback or at any later time	828	the only argument being the condition variable itself. Calling C<recv>
794	is guaranteed not to block.	829	inside the callback or at any later time is guaranteed not to block.
795		830
796	=back	831	=back
797		832
798	=head1 SUPPORTED EVENT LOOPS/BACKENDS	833	=head1 SUPPORTED EVENT LOOPS/BACKENDS
799		834
…		…
802	=over 4	837	=over 4
803		838
804	=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.
805		840
806	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
807	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
808	that, will fall back to its own pure-perl implementation, which is	843	pure-perl implementation, which is available everywhere as it comes with
809	available everywhere as it comes with AnyEvent itself.	844	AnyEvent itself.
810		845
811	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	846	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
812	AnyEvent::Impl::Event based on Event, very stable, few glitches.
813	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	847	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
814		848
815	=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.
816		850
817	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
818	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
819	them. This means that AnyEvent will automatically pick the right backend	853	them. This means that AnyEvent will automatically pick the right backend
820	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
821	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.
822		856
		857	AnyEvent::Impl::Event based on Event, very stable, few glitches.
823	AnyEvent::Impl::Glib based on Glib, slow but very stable.	858	AnyEvent::Impl::Glib based on Glib, slow but very stable.
824	AnyEvent::Impl::Tk based on Tk, very broken.	859	AnyEvent::Impl::Tk based on Tk, very broken.
825	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	860	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
826	AnyEvent::Impl::POE based on POE, very slow, some limitations.	861	AnyEvent::Impl::POE based on POE, very slow, some limitations.
827	AnyEvent::Impl::Irssi used when running within irssi.	862	AnyEvent::Impl::Irssi used when running within irssi.
…		…
937	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:
938	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
939	array will be ignored.	974	array will be ignored.
940		975
941	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	976	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
942	it,as it takes care of these details.	977	it, as it takes care of these details.
943		978
944	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
945	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
946	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
947	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	}
948		996
949	=back	997	=back
950		998
951	=head1 WHAT TO DO IN A MODULE	999	=head1 WHAT TO DO IN A MODULE
952		1000
…		…
1101		1149
1102	package AnyEvent;	1150	package AnyEvent;
1103		1151
1104	# basically a tuned-down version of common::sense	1152	# basically a tuned-down version of common::sense
1105	sub common_sense {	1153	sub common_sense {
1106	# no warnings	1154	# from common:.sense 1.0
1107	${^WARNING_BITS} ^= ${^WARNING_BITS};	1155	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1108	# use strict vars subs	1156	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1109	$^H \|= 0x00000600;	1157	$^H \|= 0x00000600;
1110	}	1158	}
1111		1159
1112	BEGIN { AnyEvent::common_sense }	1160	BEGIN { AnyEvent::common_sense }
1113		1161
1114	use Carp ();	1162	use Carp ();
1115		1163
1116	our $VERSION = 4.881;	1164	our $VERSION = '5.251';
1117	our $MODEL;	1165	our $MODEL;
1118		1166
1119	our $AUTOLOAD;	1167	our $AUTOLOAD;
1120	our @ISA;	1168	our @ISA;
1121		1169
1122	our @REGISTRY;	1170	our @REGISTRY;
1123		1171
1124	our $WIN32;
1125
1126	our $VERBOSE;	1172	our $VERBOSE;
1127		1173
1128	BEGIN {	1174	BEGIN {
1129	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1175	require "AnyEvent/constants.pl";
		1176
1130	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1177	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1131		1178
1132	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1179	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1133	if ${^TAINT};	1180	if ${^TAINT};
1134		1181
1135	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1182	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1147	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1194	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1148	}	1195	}
1149		1196
1150	my @models = (	1197	my @models = (
1151	[EV:: => AnyEvent::Impl::EV:: , 1],	1198	[EV:: => AnyEvent::Impl::EV:: , 1],
1152	[Event:: => AnyEvent::Impl::Event::, 1],
1153	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1199	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1154	# everything below here will not (normally) be autoprobed	1200	# everything below here will not (normally) be autoprobed
1155	# as the pureperl backend should work everywhere	1201	# as the pureperl backend should work everywhere
1156	# and is usually faster	1202	# and is usually faster
		1203	[Event:: => AnyEvent::Impl::Event::, 1],
1157	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1204	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1158	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1205	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1159	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1206	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1160	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1207	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1161	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1208	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
…		…
1164	[Prima:: => AnyEvent::Impl::POE::],	1211	[Prima:: => AnyEvent::Impl::POE::],
1165	# 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
1166	# byzantine signal and broken child handling, among others.	1213	# byzantine signal and broken child handling, among others.
1167	# 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
1168	# obvious default class.	1215	# obvious default class.
1169	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1216	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1170	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1217	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1171	# [0, 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
1172	);	1220	);
1173		1221
1174	our %method = map +($_ => 1),	1222	our %method = map +($_ => 1),
1175	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);
1176		1224
1177	our @post_detect;	1225	our @post_detect;
1178		1226
1179	sub post_detect(&) {	1227	sub post_detect(&) {
1180	my ($cb) = @_;	1228	my ($cb) = @_;
1181		1229
1182	if ($MODEL) {
1183	$cb->();
1184
1185	undef
1186	} else {
1187	push @post_detect, $cb;	1230	push @post_detect, $cb;
1188		1231
1189	defined wantarray	1232	defined wantarray
1190	? bless \$cb, "AnyEvent::Util::postdetect"	1233	? bless \$cb, "AnyEvent::Util::postdetect"
1191	: ()	1234	: ()
1192	}
1193	}	1235	}
1194		1236
1195	sub AnyEvent::Util::postdetect::DESTROY {	1237	sub AnyEvent::Util::postdetect::DESTROY {
1196	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1238	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1197	}	1239	}
1198		1240
1199	sub detect() {	1241	sub 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
1200	unless ($MODEL) {	1259	unless ($MODEL) {
1201	local $SIG{__DIE__};	1260	for (@REGISTRY, @models) {
1202		1261	my ($package, $model) = @$_;
1203	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1262	if (${"$package\::VERSION"} > 0) {
1204	my $model = "AnyEvent::Impl::$1";
1205	if (eval "require $model") {	1263	if (eval "require $model") {
1206	$MODEL = $model;	1264	$MODEL = $model;
1207	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;
1208	} else {	1266	last;
1209	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1267	}
1210	}	1268	}
1211	}	1269	}
1212		1270
1213	# check for already loaded models
1214	unless ($MODEL) {	1271	unless ($MODEL) {
		1272	# try to autoload a model
1215	for (@REGISTRY, @models) {	1273	for (@REGISTRY, @models) {
1216	my ($package, $model) = @$_;	1274	my ($package, $model, $autoload) = @$_;
		1275	if (
		1276	$autoload
		1277	and eval "require $package"
1217	if (${"$package\::VERSION"} > 0) {	1278	and ${"$package\::VERSION"} > 0
1218	if (eval "require $model") {	1279	and eval "require $model"
		1280	) {
1219	$MODEL = $model;	1281	$MODEL = $model;
1220	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1282	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1221	last;	1283	last;
1222	}
1223	}	1284	}
1224	}	1285	}
1225		1286
1226	unless ($MODEL) {
1227	# try to autoload a model
1228	for (@REGISTRY, @models) {
1229	my ($package, $model, $autoload) = @$_;
1230	if (
1231	$autoload
1232	and eval "require $package"
1233	and ${"$package\::VERSION"} > 0
1234	and eval "require $model"
1235	) {
1236	$MODEL = $model;
1237	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1238	last;
1239	}
1240	}
1241
1242	$MODEL	1287	$MODEL
1243	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";
1244	}
1245	}	1289	}
1246
1247	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1248
1249	unshift @ISA, $MODEL;
1250
1251	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1252
1253	(shift @post_detect)->() while @post_detect;
1254	}	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	};
1255		1313
1256	$MODEL	1314	$MODEL
1257	}	1315	}
1258		1316
1259	sub AUTOLOAD {	1317	sub AUTOLOAD {
1260	(my $func = $AUTOLOAD) =~ s/.*://;	1318	(my $func = $AUTOLOAD) =~ s/.*://;
1261		1319
1262	$method{$func}	1320	$method{$func}
1263	or Carp::croak "$func: not a valid method for AnyEvent objects";	1321	or Carp::croak "$func: not a valid AnyEvent class method";
1264		1322
1265	detect unless $MODEL;	1323	detect;
1266		1324
1267	my $class = shift;	1325	my $class = shift;
1268	$class->$func (@_);	1326	$class->$func (@_);
1269	}	1327	}
1270		1328
…		…
1283	# 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
1284		1342
1285	($fh2, $rw)	1343	($fh2, $rw)
1286	}	1344	}
1287		1345
		1346	=head1 SIMPLIFIED AE API
		1347
		1348	Starting with version 5.0, AnyEvent officially supports a second, much
		1349	simpler, API that is designed to reduce the calling, typing and memory
		1350	overhead by using function call syntax and a fixed number of parameters.
		1351
		1352	See the L<AE> manpage for details.
		1353
		1354	=cut
		1355
		1356	package AE;
		1357
		1358	our $VERSION = $AnyEvent::VERSION;
		1359
		1360	# fall back to the main API by default - backends and AnyEvent::Base
		1361	# implementations can overwrite these.
		1362
		1363	sub io($$$) {
		1364	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1365	}
		1366
		1367	sub timer($$$) {
		1368	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1369	}
		1370
		1371	sub signal($$) {
		1372	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1373	}
		1374
		1375	sub child($$) {
		1376	AnyEvent->child (pid => $_[0], cb => $_[1])
		1377	}
		1378
		1379	sub idle($) {
		1380	AnyEvent->idle (cb => $_[0])
		1381	}
		1382
		1383	sub cv(;&) {
		1384	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1385	}
		1386
		1387	sub now() {
		1388	AnyEvent->now
		1389	}
		1390
		1391	sub now_update() {
		1392	AnyEvent->now_update
		1393	}
		1394
		1395	sub time() {
		1396	AnyEvent->time
		1397	}
		1398
1288	package AnyEvent::Base;	1399	package AnyEvent::Base;
1289		1400
1290	# default implementations for many methods	1401	# default implementations for many methods
1291		1402
1292	sub _time {	1403	sub time {
		1404	eval q{ # poor man's autoloading {}
1293	# probe for availability of Time::HiRes	1405	# probe for availability of Time::HiRes
1294	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1406	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1295	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;
1296	*_time = \&Time::HiRes::time;	1408	*AE::time = \&Time::HiRes::time;
1297	# if (eval "use POSIX (); (POSIX::times())...	1409	# if (eval "use POSIX (); (POSIX::times())...
1298	} else {	1410	} else {
1299	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;
1300	*_time = sub { time }; # epic fail	1412	*AE::time = sub (){ time }; # epic fail
		1413	}
		1414
		1415	*time = sub { AE::time }; # different prototypes
1301	}	1416	};
		1417	die if $@;
1302		1418
1303	&_time	1419	&time
1304	}	1420	}
1305		1421
1306	sub time { _time }	1422	*now = \&time;
1307	sub now { _time }	1423
1308	sub now_update { }	1424	sub now_update { }
1309		1425
1310	# default implementation for ->condvar	1426	# default implementation for ->condvar
1311		1427
1312	sub condvar {	1428	sub condvar {
		1429	eval q{ # poor man's autoloading {}
		1430	*condvar = sub {
1313	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
1314	}	1441	}
1315		1442
1316	# default implementation for ->signal	1443	# default implementation for ->signal
1317		1444
1318	our $HAVE_ASYNC_INTERRUPT;	1445	our $HAVE_ASYNC_INTERRUPT;
1319		1446
1320	sub _have_async_interrupt() {	1447	sub _have_async_interrupt() {
1321	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}	1448	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1322	&& eval "use Async::Interrupt 1.0 (); 1")	1449	&& eval "use Async::Interrupt 1.02 (); 1")
1323	unless defined $HAVE_ASYNC_INTERRUPT;	1450	unless defined $HAVE_ASYNC_INTERRUPT;
1324		1451
1325	$HAVE_ASYNC_INTERRUPT	1452	$HAVE_ASYNC_INTERRUPT
1326	}	1453	}
1327		1454
1328	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1455	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1329	our (%SIG_ASY, %SIG_ASY_W);	1456	our (%SIG_ASY, %SIG_ASY_W);
1330	our ($SIG_COUNT, $SIG_TW);	1457	our ($SIG_COUNT, $SIG_TW);
1331		1458
1332	sub _signal_exec {
1333	$HAVE_ASYNC_INTERRUPT
1334	? $SIGPIPE_R->drain
1335	: sysread $SIGPIPE_R, my $dummy, 9;
1336
1337	while (%SIG_EV) {
1338	for (keys %SIG_EV) {
1339	delete $SIG_EV{$_};
1340	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1341	}
1342	}
1343	}
1344
1345	# install a dummy wakeup watcher to reduce signal catching latency	1459	# install a dummy wakeup watcher to reduce signal catching latency
		1460	# used by Impls
1346	sub _sig_add() {	1461	sub _sig_add() {
1347	unless ($SIG_COUNT++) {	1462	unless ($SIG_COUNT++) {
1348	# try to align timer on a full-second boundary, if possible	1463	# try to align timer on a full-second boundary, if possible
1349	my $NOW = AnyEvent->now;	1464	my $NOW = AE::now;
1350		1465
1351	$SIG_TW = AnyEvent->timer (	1466	$SIG_TW = AE::timer
1352	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1467	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1353	interval => $MAX_SIGNAL_LATENCY,	1468	$MAX_SIGNAL_LATENCY,
1354	cb => sub { }, # just for the PERL_ASYNC_CHECK	1469	sub { } # just for the PERL_ASYNC_CHECK
1355	);	1470	;
1356	}	1471	}
1357	}	1472	}
1358		1473
1359	sub _sig_del {	1474	sub _sig_del {
1360	undef $SIG_TW	1475	undef $SIG_TW
1361	unless --$SIG_COUNT;	1476	unless --$SIG_COUNT;
1362	}	1477	}
1363		1478
1364	our $_sig_name_init; $_sig_name_init = sub {	1479	our $_sig_name_init; $_sig_name_init = sub {
1365	eval q{ # poor man's autoloading	1480	eval q{ # poor man's autoloading {}
1366	undef $_sig_name_init;	1481	undef $_sig_name_init;
1367		1482
1368	if (_have_async_interrupt) {	1483	if (_have_async_interrupt) {
1369	*sig2num = \&Async::Interrupt::sig2num;	1484	*sig2num = \&Async::Interrupt::sig2num;
1370	*sig2name = \&Async::Interrupt::sig2name;	1485	*sig2name = \&Async::Interrupt::sig2name;
…		…
1397	# probe for availability of Async::Interrupt	1512	# probe for availability of Async::Interrupt
1398	if (_have_async_interrupt) {	1513	if (_have_async_interrupt) {
1399	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1514	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1400		1515
1401	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1516	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1402	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);	1517	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1403		1518
1404	} else {	1519	} else {
1405	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1520	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1406
1407	require Fcntl;
1408		1521
1409	if (AnyEvent::WIN32) {	1522	if (AnyEvent::WIN32) {
1410	require AnyEvent::Util;	1523	require AnyEvent::Util;
1411		1524
1412	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1525	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1413	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1526	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1414	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1527	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1415	} else {	1528	} else {
1416	pipe $SIGPIPE_R, $SIGPIPE_W;	1529	pipe $SIGPIPE_R, $SIGPIPE_W;
1417	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1530	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1418	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1531	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1419		1532
1420	# not strictly required, as $^F is normally 2, but let's make sure...	1533	# not strictly required, as $^F is normally 2, but let's make sure...
1421	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1534	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1422	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1535	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1423	}	1536	}
1424		1537
1425	$SIGPIPE_R	1538	$SIGPIPE_R
1426	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1539	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1427		1540
1428	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);	1541	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1429	}	1542	}
1430		1543
1431	*signal = sub {	1544	*signal = $HAVE_ASYNC_INTERRUPT
		1545	? sub {
1432	my (undef, %arg) = @_;	1546	my (undef, %arg) = @_;
1433		1547
1434	my $signal = uc $arg{signal}
1435	or Carp::croak "required option 'signal' is missing";
1436
1437	if ($HAVE_ASYNC_INTERRUPT) {
1438	# async::interrupt	1548	# async::interrupt
1439
1440	$signal = sig2num $signal;	1549	my $signal = sig2num $arg{signal};
1441	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1550	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1442		1551
1443	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1552	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1444	cb => sub { undef $SIG_EV{$signal} },	1553	cb => sub { undef $SIG_EV{$signal} },
1445	signal => $signal,	1554	signal => $signal,
1446	pipe => [$SIGPIPE_R->filenos],	1555	pipe => [$SIGPIPE_R->filenos],
1447	pipe_autodrain => 0,	1556	pipe_autodrain => 0,
1448	;	1557	;
1449		1558
1450	} else {	1559	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1560	}
		1561	: sub {
		1562	my (undef, %arg) = @_;
		1563
1451	# pure perl	1564	# pure perl
1452
1453	# AE::Util has been loaded in signal
1454	$signal = sig2name $signal;	1565	my $signal = sig2name $arg{signal};
1455	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1566	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1456		1567
1457	$SIG{$signal} \|\|= sub {	1568	$SIG{$signal} \|\|= sub {
1458	local $!;	1569	local $!;
1459	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1570	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1460	undef $SIG_EV{$signal};	1571	undef $SIG_EV{$signal};
1461	};	1572	};
1462		1573
1463	# can't do signal processing without introducing races in pure perl,	1574	# can't do signal processing without introducing races in pure perl,
1464	# so limit the signal latency.	1575	# so limit the signal latency.
1465	_sig_add;	1576	_sig_add;
1466	}
1467		1577
1468	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1578	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1579	}
1469	};	1580	;
1470		1581
1471	*AnyEvent::Base::signal::DESTROY = sub {	1582	*AnyEvent::Base::signal::DESTROY = sub {
1472	my ($signal, $cb) = @{$_[0]};	1583	my ($signal, $cb) = @{$_[0]};
1473		1584
1474	_sig_del;	1585	_sig_del;
…		…
1481	# print weird messages, or just unconditionally exit	1592	# print weird messages, or just unconditionally exit
1482	# instead of getting the default action.	1593	# instead of getting the default action.
1483	undef $SIG{$signal}	1594	undef $SIG{$signal}
1484	unless keys %{ $SIG_CB{$signal} };	1595	unless keys %{ $SIG_CB{$signal} };
1485	};	1596	};
		1597
		1598	*_signal_exec = sub {
		1599	$HAVE_ASYNC_INTERRUPT
		1600	? $SIGPIPE_R->drain
		1601	: sysread $SIGPIPE_R, (my $dummy), 9;
		1602
		1603	while (%SIG_EV) {
		1604	for (keys %SIG_EV) {
		1605	delete $SIG_EV{$_};
		1606	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1607	}
		1608	}
		1609	};
1486	};	1610	};
1487	die if $@;	1611	die if $@;
		1612
1488	&signal	1613	&signal
1489	}	1614	}
1490		1615
1491	# default implementation for ->child	1616	# default implementation for ->child
1492		1617
1493	our %PID_CB;	1618	our %PID_CB;
1494	our $CHLD_W;	1619	our $CHLD_W;
1495	our $CHLD_DELAY_W;	1620	our $CHLD_DELAY_W;
1496	our $WNOHANG;	1621	our $WNOHANG;
1497		1622
		1623	# used by many Impl's
1498	sub _emit_childstatus($$) {	1624	sub _emit_childstatus($$) {
1499	my (undef, $rpid, $rstatus) = @_;	1625	my (undef, $rpid, $rstatus) = @_;
1500		1626
1501	$_->($rpid, $rstatus)	1627	$_->($rpid, $rstatus)
1502	for values %{ $PID_CB{$rpid} \|\| {} },	1628	for values %{ $PID_CB{$rpid} \|\| {} },
1503	values %{ $PID_CB{0} \|\| {} };	1629	values %{ $PID_CB{0} \|\| {} };
1504	}	1630	}
1505		1631
1506	sub _sigchld {
1507	my $pid;
1508
1509	AnyEvent->_emit_childstatus ($pid, $?)
1510	while ($pid = waitpid -1, $WNOHANG) > 0;
1511	}
1512
1513	sub child {	1632	sub 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 {
1514	my (undef, %arg) = @_;	1642	my (undef, %arg) = @_;
1515		1643
1516	defined (my $pid = $arg{pid} + 0)	1644	defined (my $pid = $arg{pid} + 0)
1517	or Carp::croak "required option 'pid' is missing";	1645	or Carp::croak "required option 'pid' is missing";
1518		1646
1519	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1647	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1520		1648
1521	# WNOHANG is almost cetrainly 1 everywhere	1649	# WNOHANG is almost cetrainly 1 everywhere
1522	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1650	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1523	? 1	1651	? 1
1524	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1652	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1525		1653
1526	unless ($CHLD_W) {	1654	unless ($CHLD_W) {
1527	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1655	$CHLD_W = AE::signal CHLD => \&_sigchld;
1528	# 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
1529	&_sigchld;	1657	&_sigchld;
1530	}	1658	}
1531		1659
1532	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1660	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1533	}	1661	};
1534		1662
1535	sub AnyEvent::Base::child::DESTROY {	1663	*AnyEvent::Base::child::DESTROY = sub {
1536	my ($pid, $cb) = @{$_[0]};	1664	my ($pid, $cb) = @{$_[0]};
1537		1665
1538	delete $PID_CB{$pid}{$cb};	1666	delete $PID_CB{$pid}{$cb};
1539	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1667	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1540		1668
1541	undef $CHLD_W unless keys %PID_CB;	1669	undef $CHLD_W unless keys %PID_CB;
		1670	};
		1671	};
		1672	die if $@;
		1673
		1674	&child
1542	}	1675	}
1543		1676
1544	# idle emulation is done by simply using a timer, regardless	1677	# idle emulation is done by simply using a timer, regardless
1545	# of whether the process is idle or not, and not letting	1678	# of whether the process is idle or not, and not letting
1546	# the callback use more than 50% of the time.	1679	# the callback use more than 50% of the time.
1547	sub idle {	1680	sub idle {
		1681	eval q{ # poor man's autoloading {}
		1682	*idle = sub {
1548	my (undef, %arg) = @_;	1683	my (undef, %arg) = @_;
1549		1684
1550	my ($cb, $w, $rcb) = $arg{cb};	1685	my ($cb, $w, $rcb) = $arg{cb};
1551		1686
1552	$rcb = sub {	1687	$rcb = sub {
1553	if ($cb) {	1688	if ($cb) {
1554	$w = _time;	1689	$w = _time;
1555	&$cb;	1690	&$cb;
1556	$w = _time - $w;	1691	$w = _time - $w;
1557		1692
1558	# 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,
1559	# within some limits	1694	# within some limits
1560	$w = 0.0001 if $w < 0.0001;	1695	$w = 0.0001 if $w < 0.0001;
1561	$w = 5 if $w > 5;	1696	$w = 5 if $w > 5;
1562		1697
1563	$w = AnyEvent->timer (after => $w, cb => $rcb);	1698	$w = AE::timer $w, 0, $rcb;
1564	} else {	1699	} else {
1565	# clean up...	1700	# clean up...
1566	undef $w;	1701	undef $w;
1567	undef $rcb;	1702	undef $rcb;
		1703	}
		1704	};
		1705
		1706	$w = AE::timer 0.05, 0, $rcb;
		1707
		1708	bless \\$cb, "AnyEvent::Base::idle"
1568	}	1709	};
		1710
		1711	*AnyEvent::Base::idle::DESTROY = sub {
		1712	undef $${$_[0]};
		1713	};
1569	};	1714	};
		1715	die if $@;
1570		1716
1571	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1717	&idle
1572
1573	bless \\$cb, "AnyEvent::Base::idle"
1574	}
1575
1576	sub AnyEvent::Base::idle::DESTROY {
1577	undef $${$_[0]};
1578	}	1718	}
1579		1719
1580	package AnyEvent::CondVar;	1720	package AnyEvent::CondVar;
1581		1721
1582	our @ISA = AnyEvent::CondVar::Base::;	1722	our @ISA = AnyEvent::CondVar::Base::;
…		…
1630	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1770	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1631	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1771	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1632	}	1772	}
1633		1773
1634	sub cb {	1774	sub cb {
1635	$_[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
1636	$_[0]{_ae_cb}	1782	$cv->{_ae_cb}
1637	}	1783	}
1638		1784
1639	sub begin {	1785	sub begin {
1640	++$_[0]{_ae_counter};	1786	++$_[0]{_ae_counter};
1641	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1787	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1647	}	1793	}
1648		1794
1649	# undocumented/compatibility with pre-3.4	1795	# undocumented/compatibility with pre-3.4
1650	*broadcast = \&send;	1796	*broadcast = \&send;
1651	*wait = \&_wait;	1797	*wait = \&_wait;
1652
1653	#############################################################################
1654	# "new" API, currently only emulation of it
1655	#############################################################################
1656
1657	package AE;
1658
1659	sub io($$$) {
1660	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1661	}
1662
1663	sub timer($$$) {
1664	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
1665	}
1666
1667	sub signal($$) {
1668	AnyEvent->signal (signal => $_[0], cb => $_[1]);
1669	}
1670
1671	sub child($$) {
1672	AnyEvent->child (pid => $_[0], cb => $_[1]);
1673	}
1674
1675	sub idle($) {
1676	AnyEvent->idle (cb => $_[0]);
1677	}
1678
1679	sub cv() {
1680	AnyEvent->condvar
1681	}
1682
1683	sub now() {
1684	AnyEvent->now
1685	}
1686
1687	sub now_update() {
1688	AnyEvent->now_update
1689	}
1690
1691	sub time() {
1692	AnyEvent->time
1693	}
1694		1798
1695	=head1 ERROR AND EXCEPTION HANDLING	1799	=head1 ERROR AND EXCEPTION HANDLING
1696		1800
1697	In general, AnyEvent does not do any error handling - it relies on the	1801	In general, AnyEvent does not do any error handling - it relies on the
1698	caller to do that if required. The L<AnyEvent::Strict> module (see also	1802	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1892	warn "read: $input\n"; # output what has been read	1996	warn "read: $input\n"; # output what has been read
1893	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1997	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1894	},	1998	},
1895	);	1999	);
1896		2000
1897	my $time_watcher; # can only be used once
1898
1899	sub new_timer {
1900	$timer = AnyEvent->timer (after => 1, cb => sub {	2001	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1901	warn "timeout\n"; # print 'timeout' about every second	2002	warn "timeout\n"; # print 'timeout' at most every second
1902	&new_timer; # and restart the time
1903	});	2003	});
1904	}
1905
1906	new_timer; # create first timer
1907		2004
1908	$cv->recv; # wait until user enters /^q/i	2005	$cv->recv; # wait until user enters /^q/i
1909		2006
1910	=head1 REAL-WORLD EXAMPLE	2007	=head1 REAL-WORLD EXAMPLE
1911		2008
…		…
1984		2081
1985	The actual code goes further and collects all errors (C<die>s, exceptions)	2082	The actual code goes further and collects all errors (C<die>s, exceptions)
1986	that occurred during request processing. The C<result> method detects	2083	that occurred during request processing. The C<result> method detects
1987	whether an exception as thrown (it is stored inside the $txn object)	2084	whether an exception as thrown (it is stored inside the $txn object)
1988	and just throws the exception, which means connection errors and other	2085	and just throws the exception, which means connection errors and other
1989	problems get reported tot he code that tries to use the result, not in a	2086	problems get reported to the code that tries to use the result, not in a
1990	random callback.	2087	random callback.
1991		2088
1992	All of this enables the following usage styles:	2089	All of this enables the following usage styles:
1993		2090
1994	1. Blocking:	2091	1. Blocking:
…		…
2042	through AnyEvent. The benchmark creates a lot of timers (with a zero	2139	through AnyEvent. The benchmark creates a lot of timers (with a zero
2043	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2140	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
2044	which it is), lets them fire exactly once and destroys them again.	2141	which it is), lets them fire exactly once and destroys them again.
2045		2142
2046	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2143	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
2047	distribution.	2144	distribution. It uses the L<AE> interface, which makes a real difference
		2145	for the EV and Perl backends only.
2048		2146
2049	=head3 Explanation of the columns	2147	=head3 Explanation of the columns
2050		2148
2051	I<watcher> is the number of event watchers created/destroyed. Since	2149	I<watcher> is the number of event watchers created/destroyed. Since
2052	different event models feature vastly different performances, each event	2150	different event models feature vastly different performances, each event
…		…
2073	watcher.	2171	watcher.
2074		2172
2075	=head3 Results	2173	=head3 Results
2076		2174
2077	name watchers bytes create invoke destroy comment	2175	name watchers bytes create invoke destroy comment
2078	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
2079	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
2080	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
2081	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
2082	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
2083	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
2084	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
2085	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
2086	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
2087	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
2088	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
2089	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
2090		2188
2091	=head3 Discussion	2189	=head3 Discussion
2092		2190
2093	The benchmark does I<not> measure scalability of the event loop very	2191	The benchmark does I<not> measure scalability of the event loop very
2094	well. For example, a select-based event loop (such as the pure perl one)	2192	well. For example, a select-based event loop (such as the pure perl one)
…		…
2106	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2204	benchmark machine, handling an event takes roughly 1600 CPU cycles with
2107	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2205	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2108	cycles with POE.	2206	cycles with POE.
2109		2207
2110	C<EV> is the sole leader regarding speed and memory use, which are both	2208	C<EV> is the sole leader regarding speed and memory use, which are both
2111	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2209	maximal/minimal, respectively. When using the L<AE> API there is zero
		2210	overhead (when going through the AnyEvent API create is about 5-6 times
		2211	slower, with other times being equal, so still uses far less memory than
2112	far less memory than any other event loop and is still faster than Event	2212	any other event loop and is still faster than Event natively).
2113	natively.
2114		2213
2115	The pure perl implementation is hit in a few sweet spots (both the	2214	The pure perl implementation is hit in a few sweet spots (both the
2116	constant timeout and the use of a single fd hit optimisations in the perl	2215	constant timeout and the use of a single fd hit optimisations in the perl
2117	interpreter and the backend itself). Nevertheless this shows that it	2216	interpreter and the backend itself). Nevertheless this shows that it
2118	adds very little overhead in itself. Like any select-based backend its	2217	adds very little overhead in itself. Like any select-based backend its
…		…
2192	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2291	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2193	(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
2194	connections, most of which are idle at any one point in time.	2293	connections, most of which are idle at any one point in time.
2195		2294
2196	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2295	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2197	distribution.	2296	distribution. It uses the L<AE> interface, which makes a real difference
		2297	for the EV and Perl backends only.
2198		2298
2199	=head3 Explanation of the columns	2299	=head3 Explanation of the columns
2200		2300
2201	I<sockets> is the number of sockets, and twice the number of "servers" (as	2301	I<sockets> is the number of sockets, and twice the number of "servers" (as
2202	each server has a read and write socket end).	2302	each server has a read and write socket end).
…		…
2210	a new one that moves the timeout into the future.	2310	a new one that moves the timeout into the future.
2211		2311
2212	=head3 Results	2312	=head3 Results
2213		2313
2214	name sockets create request	2314	name sockets create request
2215	EV 20000 69.01 11.16	2315	EV 20000 62.66 7.99
2216	Perl 20000 73.32 35.87	2316	Perl 20000 68.32 32.64
2217	IOAsync 20000 157.00 98.14 epoll	2317	IOAsync 20000 174.06 101.15 epoll
2218	IOAsync 20000 159.31 616.06 poll	2318	IOAsync 20000 174.67 610.84 poll
2219	Event 20000 212.62 257.32	2319	Event 20000 202.69 242.91
2220	Glib 20000 651.16 1896.30	2320	Glib 20000 557.01 1689.52
2221	POE 20000 349.67 12317.24 uses POE::Loop::Event	2321	POE 20000 341.54 12086.32 uses POE::Loop::Event
2222		2322
2223	=head3 Discussion	2323	=head3 Discussion
2224		2324
2225	This benchmark I<does> measure scalability and overall performance of the	2325	This benchmark I<does> measure scalability and overall performance of the
2226	particular event loop.	2326	particular event loop.
…		…
2352	As you can see, the AnyEvent + EV combination even beats the	2452	As you can see, the AnyEvent + EV combination even beats the
2353	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2453	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2354	backend easily beats IO::Lambda and POE.	2454	backend easily beats IO::Lambda and POE.
2355		2455
2356	And even the 100% non-blocking version written using the high-level (and	2456	And even the 100% non-blocking version written using the high-level (and
2357	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2457	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2358	large margin, even though it does all of DNS, tcp-connect and socket I/O	2458	higher level ("unoptimised") abstractions by a large margin, even though
2359	in a non-blocking way.	2459	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2360		2460
2361	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2461	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2362	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2462	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2363	part of the IO::lambda distribution and were used without any changes.	2463	part of the IO::Lambda distribution and were used without any changes.
2364		2464
2365		2465
2366	=head1 SIGNALS	2466	=head1 SIGNALS
2367		2467
2368	AnyEvent currently installs handlers for these signals:	2468	AnyEvent currently installs handlers for these signals:
…		…
2410	it's built-in modules) are required to use it.	2510	it's built-in modules) are required to use it.
2411		2511
2412	That does not mean that AnyEvent won't take advantage of some additional	2512	That does not mean that AnyEvent won't take advantage of some additional
2413	modules if they are installed.	2513	modules if they are installed.
2414		2514
2415	This section epxlains which additional modules will be used, and how they	2515	This section explains which additional modules will be used, and how they
2416	affect AnyEvent's operetion.	2516	affect AnyEvent's operation.
2417		2517
2418	=over 4	2518	=over 4
2419		2519
2420	=item L<Async::Interrupt>	2520	=item L<Async::Interrupt>
2421		2521
…		…
2426	catch the signals) with some delay (default is 10 seconds, look for	2526	catch the signals) with some delay (default is 10 seconds, look for
2427	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2527	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2428		2528
2429	If this module is available, then it will be used to implement signal	2529	If this module is available, then it will be used to implement signal
2430	catching, which means that signals will not be delayed, and the event loop	2530	catching, which means that signals will not be delayed, and the event loop
2431	will not be interrupted regularly, which is more efficient (And good for	2531	will not be interrupted regularly, which is more efficient (and good for
2432	battery life on laptops).	2532	battery life on laptops).
2433		2533
2434	This affects not just the pure-perl event loop, but also other event loops	2534	This affects not just the pure-perl event loop, but also other event loops
2435	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2535	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2436		2536
…		…
2448	automatic timer adjustments even when no monotonic clock is available,	2548	automatic timer adjustments even when no monotonic clock is available,
2449	can take avdantage of advanced kernel interfaces such as C<epoll> and	2549	can take avdantage of advanced kernel interfaces such as C<epoll> and
2450	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2550	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2451	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2551	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2452		2552
		2553	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2554	then this module will do nothing for you.
		2555
2453	=item L<Guard>	2556	=item L<Guard>
2454		2557
2455	The guard module, when used, will be used to implement	2558	The guard module, when used, will be used to implement
2456	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2559	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2457	lot less memory), but otherwise doesn't affect guard operation much. It is	2560	lot less memory), but otherwise doesn't affect guard operation much. It is
2458	purely used for performance.	2561	purely used for performance.
2459		2562
2460	=item L<JSON> and L<JSON::XS>	2563	=item L<JSON> and L<JSON::XS>
2461		2564
2462	This module is required when you want to read or write JSON data via	2565	One of these modules is required when you want to read or write JSON data
2463	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2566	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2464	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2567	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2465
2466	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2467	installed.
2468		2568
2469	=item L<Net::SSLeay>	2569	=item L<Net::SSLeay>
2470		2570
2471	Implementing TLS/SSL in Perl is certainly interesting, but not very	2571	Implementing TLS/SSL in Perl is certainly interesting, but not very
2472	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2572	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
…		…
2483		2583
2484		2584
2485	=head1 FORK	2585	=head1 FORK
2486		2586
2487	Most event libraries are not fork-safe. The ones who are usually are	2587	Most event libraries are not fork-safe. The ones who are usually are
2488	because they rely on inefficient but fork-safe C<select> or C<poll>	2588	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2489	calls. Only L<EV> is fully fork-aware.	2589	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2590	are usually badly thought-out hacks that are incompatible with fork in
		2591	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2592	continue event-processing in both parent and child (or both, if you know
		2593	what you are doing).
		2594
		2595	This means that, in general, you cannot fork and do event processing in
		2596	the child if the event library was initialised before the fork (which
		2597	usually happens when the first AnyEvent watcher is created, or the library
		2598	is loaded).
2490		2599
2491	If you have to fork, you must either do so I<before> creating your first	2600	If you have to fork, you must either do so I<before> creating your first
2492	watcher OR you must not use AnyEvent at all in the child OR you must do	2601	watcher OR you must not use AnyEvent at all in the child OR you must do
2493	something completely out of the scope of AnyEvent.	2602	something completely out of the scope of AnyEvent.
		2603
		2604	The problem of doing event processing in the parent I<and> the child
		2605	is much more complicated: even for backends that I<are> fork-aware or
		2606	fork-safe, their behaviour is not usually what you want: fork clones all
		2607	watchers, that means all timers, I/O watchers etc. are active in both
		2608	parent and child, which is almost never what you want. USing C<exec>
		2609	to start worker children from some kind of manage rprocess is usually
		2610	preferred, because it is much easier and cleaner, at the expense of having
		2611	to have another binary.
2494		2612
2495		2613
2496	=head1 SECURITY CONSIDERATIONS	2614	=head1 SECURITY CONSIDERATIONS
2497		2615
2498	AnyEvent can be forced to load any event model via	2616	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.266 by root, Thu Jul 30 03:41:56 2009 UTC vs. Revision 1.318 by root, Wed Mar 24 23:28:06 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.266 by root, Thu Jul 30 03:41:56 2009 UTC vs.
Revision 1.318 by root, Wed Mar 24 23:28:06 2010 UTC