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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.262 by root, Tue Jul 28 13:08:17 2009 UTC vs.
Revision 1.312 by root, Mon Feb 15 18:02:35 2010 UTC

…		…
181	my variables are only visible after the statement in which they are	181	my variables are only visible after the statement in which they are
182	declared.	182	declared.
183		183
184	=head2 I/O WATCHERS	184	=head2 I/O WATCHERS
185		185
		186	$w = AnyEvent->io (
		187	fh => <filehandle_or_fileno>,
		188	poll => <"r" or "w">,
		189	cb => <callback>,
		190	);
		191
186	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	192	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
187	with the following mandatory key-value pairs as arguments:	193	with the following mandatory key-value pairs as arguments:
188		194
189	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch	195	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
190	for events (AnyEvent might or might not keep a reference to this file	196	for events (AnyEvent might or might not keep a reference to this file
…		…
219	undef $w;	225	undef $w;
220	});	226	});
221		227
222	=head2 TIME WATCHERS	228	=head2 TIME WATCHERS
223		229
		230	$w = AnyEvent->timer (after => <seconds>, cb => <callback>);
		231
		232	$w = AnyEvent->timer (
		233	after => <fractional_seconds>,
		234	interval => <fractional_seconds>,
		235	cb => <callback>,
		236	);
		237
224	You can create a time watcher by calling the C<< AnyEvent->timer >>	238	You can create a time watcher by calling the C<< AnyEvent->timer >>
225	method with the following mandatory arguments:	239	method with the following mandatory arguments:
226		240
227	C<after> specifies after how many seconds (fractional values are	241	C<after> specifies after how many seconds (fractional values are
228	supported) the callback should be invoked. C<cb> is the callback to invoke	242	supported) the callback should be invoked. C<cb> is the callback to invoke
…		…
349	might affect timers and time-outs.	363	might affect timers and time-outs.
350		364
351	When this is the case, you can call this method, which will update the	365	When this is the case, you can call this method, which will update the
352	event loop's idea of "current time".	366	event loop's idea of "current time".
353		367
		368	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		369	when mod_perl executes the script, then the event loop will have the wrong
		370	idea about the "current time" (being potentially far in the past, when the
		371	script ran the last time). In that case you should arrange a call to C<<
		372	AnyEvent->now_update >> each time the web server process wakes up again
		373	(e.g. at the start of your script, or in a handler).
		374
354	Note that updating the time I<might> cause some events to be handled.	375	Note that updating the time I<might> cause some events to be handled.
355		376
356	=back	377	=back
357		378
358	=head2 SIGNAL WATCHERS	379	=head2 SIGNAL WATCHERS
		380
		381	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
359		382
360	You can watch for signals using a signal watcher, C<signal> is the signal	383	You can watch for signals using a signal watcher, C<signal> is the signal
361	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl	384	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
362	callback to be invoked whenever a signal occurs.	385	callback to be invoked whenever a signal occurs.
363		386
…		…
380		403
381	Example: exit on SIGINT	404	Example: exit on SIGINT
382		405
383	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	406	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384		407
		408	=head3 Restart Behaviour
		409
		410	While restart behaviour is up to the event loop implementation, most will
		411	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		412	pure perl implementation).
		413
		414	=head3 Safe/Unsafe Signals
		415
		416	Perl signals can be either "safe" (synchronous to opcode handling) or
		417	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		418	latter might corrupt your memory.
		419
		420	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		421	i.e. they will not interrupt your running perl program but will only be
		422	called as part of the normal event handling (just like timer, I/O etc.
		423	callbacks, too).
		424
385	=head3 Signal Races, Delays and Workarounds	425	=head3 Signal Races, Delays and Workarounds
386		426
387	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	427	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
388	callbacks to signals in a generic way, which is a pity, as you cannot do	428	callbacks to signals in a generic way, which is a pity, as you cannot
389	race-free signal handling in perl. AnyEvent will try to do it's best, but	429	do race-free signal handling in perl, requiring C libraries for
		430	this. AnyEvent will try to do it's best, which means in some cases,
390	in some cases, signals will be delayed. The maximum time a signal might	431	signals will be delayed. The maximum time a signal might be delayed is
391	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	432	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392	seconds). This variable can be changed only before the first signal	433	variable can be changed only before the first signal watcher is created,
393	watcher is created, and should be left alone otherwise. Higher values	434	and should be left alone otherwise. This variable determines how often
		435	AnyEvent polls for signals (in case a wake-up was missed). Higher values
394	will cause fewer spurious wake-ups, which is better for power and CPU	436	will cause fewer spurious wake-ups, which is better for power and CPU
		437	saving.
		438
395	saving. All these problems can be avoided by installing the optional	439	All these problems can be avoided by installing the optional
396	L<Async::Interrupt> module. This will not work with inherently broken	440	L<Async::Interrupt> module, which works with most event loops. It will not
397	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>	441	work with inherently broken event loops such as L<Event> or L<Event::Lib>
398	currently, as POE does it's own workaround with one-second latency). With	442	(and not with L<POE> currently, as POE does it's own workaround with
399	those, you just have to suffer the delays.	443	one-second latency). For those, you just have to suffer the delays.
400		444
401	=head2 CHILD PROCESS WATCHERS	445	=head2 CHILD PROCESS WATCHERS
		446
		447	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
402		448
403	You can also watch on a child process exit and catch its exit status.	449	You can also watch on a child process exit and catch its exit status.
404		450
405	The child process is specified by the C<pid> argument (one some backends,	451	The child process is specified by the C<pid> argument (one some backends,
406	using C<0> watches for any child process exit, on others this will	452	using C<0> watches for any child process exit, on others this will
…		…
455	# do something else, then wait for process exit	501	# do something else, then wait for process exit
456	$done->recv;	502	$done->recv;
457		503
458	=head2 IDLE WATCHERS	504	=head2 IDLE WATCHERS
459		505
460	Sometimes there is a need to do something, but it is not so important	506	$w = AnyEvent->idle (cb => <callback>);
461	to do it instantly, but only when there is nothing better to do. This
462	"nothing better to do" is usually defined to be "no other events need
463	attention by the event loop".
464		507
465	Idle watchers ideally get invoked when the event loop has nothing	508	Repeatedly invoke the callback after the process becomes idle, until
466	better to do, just before it would block the process to wait for new	509	either the watcher is destroyed or new events have been detected.
467	events. Instead of blocking, the idle watcher is invoked.
468		510
469	Most event loops unfortunately do not really support idle watchers (only	511	Idle watchers are useful when there is a need to do something, but it
		512	is not so important (or wise) to do it instantly. The callback will be
		513	invoked only when there is "nothing better to do", which is usually
		514	defined as "all outstanding events have been handled and no new events
		515	have been detected". That means that idle watchers ideally get invoked
		516	when the event loop has just polled for new events but none have been
		517	detected. Instead of blocking to wait for more events, the idle watchers
		518	will be invoked.
		519
		520	Unfortunately, most event loops do not really support idle watchers (only
470	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	521	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
471	will simply call the callback "from time to time".	522	will simply call the callback "from time to time".
472		523
473	Example: read lines from STDIN, but only process them when the	524	Example: read lines from STDIN, but only process them when the
474	program is otherwise idle:	525	program is otherwise idle:
…		…
490	});	541	});
491	});	542	});
492		543
493	=head2 CONDITION VARIABLES	544	=head2 CONDITION VARIABLES
494		545
		546	$cv = AnyEvent->condvar;
		547
		548	$cv->send (<list>);
		549	my @res = $cv->recv;
		550
495	If you are familiar with some event loops you will know that all of them	551	If you are familiar with some event loops you will know that all of them
496	require you to run some blocking "loop", "run" or similar function that	552	require you to run some blocking "loop", "run" or similar function that
497	will actively watch for new events and call your callbacks.	553	will actively watch for new events and call your callbacks.
498		554
499	AnyEvent is slightly different: it expects somebody else to run the event	555	AnyEvent is slightly different: it expects somebody else to run the event
…		…
563	after => 1,	619	after => 1,
564	cb => sub { $result_ready->send },	620	cb => sub { $result_ready->send },
565	);	621	);
566		622
567	# this "blocks" (while handling events) till the callback	623	# this "blocks" (while handling events) till the callback
568	# calls -<send	624	# calls ->send
569	$result_ready->recv;	625	$result_ready->recv;
570		626
571	Example: wait for a timer, but take advantage of the fact that condition	627	Example: wait for a timer, but take advantage of the fact that condition
572	variables are also callable directly.	628	variables are also callable directly.
573		629
…		…
637	one. For example, a function that pings many hosts in parallel might want	693	one. For example, a function that pings many hosts in parallel might want
638	to use a condition variable for the whole process.	694	to use a condition variable for the whole process.
639		695
640	Every call to C<< ->begin >> will increment a counter, and every call to	696	Every call to C<< ->begin >> will increment a counter, and every call to
641	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	697	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
642	>>, the (last) callback passed to C<begin> will be executed. That callback	698	>>, the (last) callback passed to C<begin> will be executed, passing the
643	is I<supposed> to call C<< ->send >>, but that is not required. If no	699	condvar as first argument. That callback is I<supposed> to call C<< ->send
644	callback was set, C<send> will be called without any arguments.	700	>>, but that is not required. If no group callback was set, C<send> will
		701	be called without any arguments.
645		702
646	You can think of C<< $cv->send >> giving you an OR condition (one call	703	You can think of C<< $cv->send >> giving you an OR condition (one call
647	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	704	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
648	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	705	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
649		706
…		…
676	begung can potentially be zero:	733	begung can potentially be zero:
677		734
678	my $cv = AnyEvent->condvar;	735	my $cv = AnyEvent->condvar;
679		736
680	my %result;	737	my %result;
681	$cv->begin (sub { $cv->send (\%result) });	738	$cv->begin (sub { shift->send (\%result) });
682		739
683	for my $host (@list_of_hosts) {	740	for my $host (@list_of_hosts) {
684	$cv->begin;	741	$cv->begin;
685	ping_host_then_call_callback $host, sub {	742	ping_host_then_call_callback $host, sub {
686	$result{$host} = ...;	743	$result{$host} = ...;
…		…
761	=item $cb = $cv->cb ($cb->($cv))	818	=item $cb = $cv->cb ($cb->($cv))
762		819
763	This is a mutator function that returns the callback set and optionally	820	This is a mutator function that returns the callback set and optionally
764	replaces it before doing so.	821	replaces it before doing so.
765		822
766	The callback will be called when the condition becomes "true", i.e. when	823	The callback will be called when the condition becomes (or already was)
767	C<send> or C<croak> are called, with the only argument being the condition	824	"true", i.e. when C<send> or C<croak> are called (or were called), with
768	variable itself. Calling C<recv> inside the callback or at any later time	825	the only argument being the condition variable itself. Calling C<recv>
769	is guaranteed not to block.	826	inside the callback or at any later time is guaranteed not to block.
770		827
771	=back	828	=back
772		829
773	=head1 SUPPORTED EVENT LOOPS/BACKENDS	830	=head1 SUPPORTED EVENT LOOPS/BACKENDS
774		831
…		…
777	=over 4	834	=over 4
778		835
779	=item Backends that are autoprobed when no other event loop can be found.	836	=item Backends that are autoprobed when no other event loop can be found.
780		837
781	EV is the preferred backend when no other event loop seems to be in	838	EV is the preferred backend when no other event loop seems to be in
782	use. If EV is not installed, then AnyEvent will try Event, and, failing	839	use. If EV is not installed, then AnyEvent will fall back to its own
783	that, will fall back to its own pure-perl implementation, which is	840	pure-perl implementation, which is available everywhere as it comes with
784	available everywhere as it comes with AnyEvent itself.	841	AnyEvent itself.
785		842
786	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	843	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
787	AnyEvent::Impl::Event based on Event, very stable, few glitches.
788	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	844	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
789		845
790	=item Backends that are transparently being picked up when they are used.	846	=item Backends that are transparently being picked up when they are used.
791		847
792	These will be used when they are currently loaded when the first watcher	848	These will be used when they are currently loaded when the first watcher
793	is created, in which case it is assumed that the application is using	849	is created, in which case it is assumed that the application is using
794	them. This means that AnyEvent will automatically pick the right backend	850	them. This means that AnyEvent will automatically pick the right backend
795	when the main program loads an event module before anything starts to	851	when the main program loads an event module before anything starts to
796	create watchers. Nothing special needs to be done by the main program.	852	create watchers. Nothing special needs to be done by the main program.
797		853
		854	AnyEvent::Impl::Event based on Event, very stable, few glitches.
798	AnyEvent::Impl::Glib based on Glib, slow but very stable.	855	AnyEvent::Impl::Glib based on Glib, slow but very stable.
799	AnyEvent::Impl::Tk based on Tk, very broken.	856	AnyEvent::Impl::Tk based on Tk, very broken.
800	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	857	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
801	AnyEvent::Impl::POE based on POE, very slow, some limitations.	858	AnyEvent::Impl::POE based on POE, very slow, some limitations.
802	AnyEvent::Impl::Irssi used when running within irssi.	859	AnyEvent::Impl::Irssi used when running within irssi.
…		…
912	You should check C<$AnyEvent::MODEL> before adding to this array, though:	969	You should check C<$AnyEvent::MODEL> before adding to this array, though:
913	if it is defined then the event loop has already been detected, and the	970	if it is defined then the event loop has already been detected, and the
914	array will be ignored.	971	array will be ignored.
915		972
916	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	973	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
917	it,as it takes care of these details.	974	it, as it takes care of these details.
918		975
919	This variable is mainly useful for modules that can do something useful	976	This variable is mainly useful for modules that can do something useful
920	when AnyEvent is used and thus want to know when it is initialised, but do	977	when AnyEvent is used and thus want to know when it is initialised, but do
921	not need to even load it by default. This array provides the means to hook	978	not need to even load it by default. This array provides the means to hook
922	into AnyEvent passively, without loading it.	979	into AnyEvent passively, without loading it.
		980
		981	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		982	together, you could put this into Coro (this is the actual code used by
		983	Coro to accomplish this):
		984
		985	if (defined $AnyEvent::MODEL) {
		986	# AnyEvent already initialised, so load Coro::AnyEvent
		987	require Coro::AnyEvent;
		988	} else {
		989	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		990	# as soon as it is
		991	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		992	}
923		993
924	=back	994	=back
925		995
926	=head1 WHAT TO DO IN A MODULE	996	=head1 WHAT TO DO IN A MODULE
927		997
…		…
1076		1146
1077	package AnyEvent;	1147	package AnyEvent;
1078		1148
1079	# basically a tuned-down version of common::sense	1149	# basically a tuned-down version of common::sense
1080	sub common_sense {	1150	sub common_sense {
1081	# no warnings	1151	# from common:.sense 1.0
1082	${^WARNING_BITS} ^= ${^WARNING_BITS};	1152	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1083	# use strict vars subs	1153	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1084	$^H \|= 0x00000600;	1154	$^H \|= 0x00000600;
1085	}	1155	}
1086		1156
1087	BEGIN { AnyEvent::common_sense }	1157	BEGIN { AnyEvent::common_sense }
1088		1158
1089	use Carp ();	1159	use Carp ();
1090		1160
1091	our $VERSION = 4.881;	1161	our $VERSION = '5.24';
1092	our $MODEL;	1162	our $MODEL;
1093		1163
1094	our $AUTOLOAD;	1164	our $AUTOLOAD;
1095	our @ISA;	1165	our @ISA;
1096		1166
1097	our @REGISTRY;	1167	our @REGISTRY;
1098		1168
1099	our $WIN32;
1100
1101	our $VERBOSE;	1169	our $VERBOSE;
1102		1170
1103	BEGIN {	1171	BEGIN {
		1172	eval "sub CYGWIN(){" . (($^O =~ /cygwin/i) *1) . "}";
1104	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1173	eval "sub WIN32 (){" . (($^O =~ /mswin32/i)*1) . "}";
1105	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1174	eval "sub TAINT (){" . (${^TAINT} *1) . "}";
1106		1175
1107	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1176	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1108	if ${^TAINT};	1177	if ${^TAINT};
1109		1178
1110	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1179	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1122	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1191	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1123	}	1192	}
1124		1193
1125	my @models = (	1194	my @models = (
1126	[EV:: => AnyEvent::Impl::EV:: , 1],	1195	[EV:: => AnyEvent::Impl::EV:: , 1],
1127	[Event:: => AnyEvent::Impl::Event::, 1],
1128	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1196	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1129	# everything below here will not (normally) be autoprobed	1197	# everything below here will not (normally) be autoprobed
1130	# as the pureperl backend should work everywhere	1198	# as the pureperl backend should work everywhere
1131	# and is usually faster	1199	# and is usually faster
		1200	[Event:: => AnyEvent::Impl::Event::, 1],
1132	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1201	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1133	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1202	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1134	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1203	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1135	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1204	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1136	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1205	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
…		…
1139	[Prima:: => AnyEvent::Impl::POE::],	1208	[Prima:: => AnyEvent::Impl::POE::],
1140	# IO::Async is just too broken - we would need workarounds for its	1209	# IO::Async is just too broken - we would need workarounds for its
1141	# byzantine signal and broken child handling, among others.	1210	# byzantine signal and broken child handling, among others.
1142	# IO::Async is rather hard to detect, as it doesn't have any	1211	# IO::Async is rather hard to detect, as it doesn't have any
1143	# obvious default class.	1212	# obvious default class.
1144	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1213	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1145	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1214	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1146	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1215	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1216	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1147	);	1217	);
1148		1218
1149	our %method = map +($_ => 1),	1219	our %method = map +($_ => 1),
1150	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1220	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1151		1221
…		…
1170	sub AnyEvent::Util::postdetect::DESTROY {	1240	sub AnyEvent::Util::postdetect::DESTROY {
1171	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1241	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1172	}	1242	}
1173		1243
1174	sub detect() {	1244	sub detect() {
		1245	# free some memory
		1246	*detect = sub () { $MODEL };
		1247
		1248	local $!; # for good measure
		1249	local $SIG{__DIE__};
		1250
		1251	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1252	my $model = "AnyEvent::Impl::$1";
		1253	if (eval "require $model") {
		1254	$MODEL = $model;
		1255	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1256	} else {
		1257	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1258	}
		1259	}
		1260
		1261	# check for already loaded models
1175	unless ($MODEL) {	1262	unless ($MODEL) {
1176	local $SIG{__DIE__};	1263	for (@REGISTRY, @models) {
1177		1264	my ($package, $model) = @$_;
1178	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1265	if (${"$package\::VERSION"} > 0) {
1179	my $model = "AnyEvent::Impl::$1";
1180	if (eval "require $model") {	1266	if (eval "require $model") {
1181	$MODEL = $model;	1267	$MODEL = $model;
1182	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1268	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1183	} else {	1269	last;
1184	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1270	}
1185	}	1271	}
1186	}	1272	}
1187		1273
1188	# check for already loaded models
1189	unless ($MODEL) {	1274	unless ($MODEL) {
		1275	# try to autoload a model
1190	for (@REGISTRY, @models) {	1276	for (@REGISTRY, @models) {
1191	my ($package, $model) = @$_;	1277	my ($package, $model, $autoload) = @$_;
		1278	if (
		1279	$autoload
		1280	and eval "require $package"
1192	if (${"$package\::VERSION"} > 0) {	1281	and ${"$package\::VERSION"} > 0
1193	if (eval "require $model") {	1282	and eval "require $model"
		1283	) {
1194	$MODEL = $model;	1284	$MODEL = $model;
1195	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1285	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1196	last;	1286	last;
1197	}
1198	}	1287	}
1199	}	1288	}
1200		1289
1201	unless ($MODEL) {
1202	# try to autoload a model
1203	for (@REGISTRY, @models) {
1204	my ($package, $model, $autoload) = @$_;
1205	if (
1206	$autoload
1207	and eval "require $package"
1208	and ${"$package\::VERSION"} > 0
1209	and eval "require $model"
1210	) {
1211	$MODEL = $model;
1212	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1213	last;
1214	}
1215	}
1216
1217	$MODEL	1290	$MODEL
1218	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1291	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1219	}
1220	}	1292	}
1221
1222	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1223
1224	unshift @ISA, $MODEL;
1225
1226	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1227
1228	(shift @post_detect)->() while @post_detect;
1229	}	1293	}
		1294
		1295	@models = (); # free probe data
		1296
		1297	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1298	unshift @ISA, $MODEL;
		1299
		1300	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1301
		1302	(shift @post_detect)->() while @post_detect;
1230		1303
1231	$MODEL	1304	$MODEL
1232	}	1305	}
1233		1306
1234	sub AUTOLOAD {	1307	sub AUTOLOAD {
1235	(my $func = $AUTOLOAD) =~ s/.*://;	1308	(my $func = $AUTOLOAD) =~ s/.*://;
1236		1309
1237	$method{$func}	1310	$method{$func}
1238	or Carp::croak "$func: not a valid method for AnyEvent objects";	1311	or Carp::croak "$func: not a valid AnyEvent class method";
1239		1312
1240	detect unless $MODEL;	1313	detect;
1241		1314
1242	my $class = shift;	1315	my $class = shift;
1243	$class->$func (@_);	1316	$class->$func (@_);
1244	}	1317	}
1245		1318
…		…
1258	# we assume CLOEXEC is already set by perl in all important cases	1331	# we assume CLOEXEC is already set by perl in all important cases
1259		1332
1260	($fh2, $rw)	1333	($fh2, $rw)
1261	}	1334	}
1262		1335
		1336	=head1 SIMPLIFIED AE API
		1337
		1338	Starting with version 5.0, AnyEvent officially supports a second, much
		1339	simpler, API that is designed to reduce the calling, typing and memory
		1340	overhead.
		1341
		1342	See the L<AE> manpage for details.
		1343
		1344	=cut
		1345
		1346	package AE;
		1347
		1348	our $VERSION = $AnyEvent::VERSION;
		1349
		1350	sub io($$$) {
		1351	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1352	}
		1353
		1354	sub timer($$$) {
		1355	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1356	}
		1357
		1358	sub signal($$) {
		1359	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1360	}
		1361
		1362	sub child($$) {
		1363	AnyEvent->child (pid => $_[0], cb => $_[1])
		1364	}
		1365
		1366	sub idle($) {
		1367	AnyEvent->idle (cb => $_[0])
		1368	}
		1369
		1370	sub cv(;&) {
		1371	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1372	}
		1373
		1374	sub now() {
		1375	AnyEvent->now
		1376	}
		1377
		1378	sub now_update() {
		1379	AnyEvent->now_update
		1380	}
		1381
		1382	sub time() {
		1383	AnyEvent->time
		1384	}
		1385
1263	package AnyEvent::Base;	1386	package AnyEvent::Base;
1264		1387
1265	# default implementations for many methods	1388	# default implementations for many methods
1266		1389
1267	sub _time {	1390	sub _time() {
		1391	eval q{ # poor man's autoloading
1268	# probe for availability of Time::HiRes	1392	# probe for availability of Time::HiRes
1269	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1393	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1270	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1394	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1271	*_time = \&Time::HiRes::time;	1395	*_time = \&Time::HiRes::time;
1272	# if (eval "use POSIX (); (POSIX::times())...	1396	# if (eval "use POSIX (); (POSIX::times())...
1273	} else {	1397	} else {
1274	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1398	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1275	*_time = sub { time }; # epic fail	1399	*_time = sub (){ time }; # epic fail
		1400	}
1276	}	1401	};
		1402	die if $@;
1277		1403
1278	&_time	1404	&_time
1279	}	1405	}
1280		1406
1281	sub time { _time }	1407	sub time { _time }
…		…
1289	}	1415	}
1290		1416
1291	# default implementation for ->signal	1417	# default implementation for ->signal
1292		1418
1293	our $HAVE_ASYNC_INTERRUPT;	1419	our $HAVE_ASYNC_INTERRUPT;
		1420
		1421	sub _have_async_interrupt() {
		1422	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1423	&& eval "use Async::Interrupt 1.02 (); 1")
		1424	unless defined $HAVE_ASYNC_INTERRUPT;
		1425
		1426	$HAVE_ASYNC_INTERRUPT
		1427	}
		1428
1294	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1429	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1295	our (%SIG_ASY, %SIG_ASY_W);	1430	our (%SIG_ASY, %SIG_ASY_W);
1296	our ($SIG_COUNT, $SIG_TW);	1431	our ($SIG_COUNT, $SIG_TW);
1297		1432
1298	sub _signal_exec {
1299	$HAVE_ASYNC_INTERRUPT
1300	? $SIGPIPE_R->drain
1301	: sysread $SIGPIPE_R, my $dummy, 9;
1302
1303	while (%SIG_EV) {
1304	for (keys %SIG_EV) {
1305	delete $SIG_EV{$_};
1306	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1307	}
1308	}
1309	}
1310
1311	# install a dummy wakeup watcher to reduce signal catching latency	1433	# install a dummy wakeup watcher to reduce signal catching latency
		1434	# used by Impls
1312	sub _sig_add() {	1435	sub _sig_add() {
1313	unless ($SIG_COUNT++) {	1436	unless ($SIG_COUNT++) {
1314	# try to align timer on a full-second boundary, if possible	1437	# try to align timer on a full-second boundary, if possible
1315	my $NOW = AnyEvent->now;	1438	my $NOW = AE::now;
1316		1439
1317	$SIG_TW = AnyEvent->timer (	1440	$SIG_TW = AE::timer
1318	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1441	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1319	interval => $MAX_SIGNAL_LATENCY,	1442	$MAX_SIGNAL_LATENCY,
1320	cb => sub { }, # just for the PERL_ASYNC_CHECK	1443	sub { } # just for the PERL_ASYNC_CHECK
1321	);	1444	;
1322	}	1445	}
1323	}	1446	}
1324		1447
1325	sub _sig_del {	1448	sub _sig_del {
1326	undef $SIG_TW	1449	undef $SIG_TW
1327	unless --$SIG_COUNT;	1450	unless --$SIG_COUNT;
1328	}	1451	}
1329		1452
		1453	our $_sig_name_init; $_sig_name_init = sub {
		1454	eval q{ # poor man's autoloading
		1455	undef $_sig_name_init;
		1456
		1457	if (_have_async_interrupt) {
		1458	*sig2num = \&Async::Interrupt::sig2num;
		1459	*sig2name = \&Async::Interrupt::sig2name;
		1460	} else {
		1461	require Config;
		1462
		1463	my %signame2num;
		1464	@signame2num{ split ' ', $Config::Config{sig_name} }
		1465	= split ' ', $Config::Config{sig_num};
		1466
		1467	my @signum2name;
		1468	@signum2name[values %signame2num] = keys %signame2num;
		1469
		1470	*sig2num = sub($) {
		1471	$_[0] > 0 ? shift : $signame2num{+shift}
		1472	};
		1473	*sig2name = sub ($) {
		1474	$_[0] > 0 ? $signum2name[+shift] : shift
		1475	};
		1476	}
		1477	};
		1478	die if $@;
		1479	};
		1480
		1481	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1482	sub sig2name($) { &$_sig_name_init; &sig2name }
		1483
1330	sub _signal {	1484	sub signal {
		1485	eval q{ # poor man's autoloading {}
		1486	# probe for availability of Async::Interrupt
		1487	if (_have_async_interrupt) {
		1488	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1489
		1490	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1491	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1492
		1493	} else {
		1494	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1495
		1496	require Fcntl;
		1497
		1498	if (AnyEvent::WIN32) {
		1499	require AnyEvent::Util;
		1500
		1501	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1502	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1503	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1504	} else {
		1505	pipe $SIGPIPE_R, $SIGPIPE_W;
		1506	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1507	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1508
		1509	# not strictly required, as $^F is normally 2, but let's make sure...
		1510	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1511	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1512	}
		1513
		1514	$SIGPIPE_R
		1515	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1516
		1517	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1518	}
		1519
		1520	*signal = sub {
1331	my (undef, %arg) = @_;	1521	my (undef, %arg) = @_;
1332		1522
1333	my $signal = uc $arg{signal}	1523	my $signal = uc $arg{signal}
1334	or Carp::croak "required option 'signal' is missing";	1524	or Carp::croak "required option 'signal' is missing";
1335		1525
1336	if ($HAVE_ASYNC_INTERRUPT) {	1526	if ($HAVE_ASYNC_INTERRUPT) {
1337	# async::interrupt	1527	# async::interrupt
1338		1528
1339	$signal = Async::Interrupt::sig2num ($signal);	1529	$signal = sig2num $signal;
1340	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1530	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1341		1531
1342	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1532	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1343	cb => sub { undef $SIG_EV{$signal} },	1533	cb => sub { undef $SIG_EV{$signal} },
1344	signal => $signal,	1534	signal => $signal,
1345	pipe => [$SIGPIPE_R->filenos],	1535	pipe => [$SIGPIPE_R->filenos],
1346	pipe_autodrain => 0,	1536	pipe_autodrain => 0,
1347	;	1537	;
1348		1538
1349	} else {	1539	} else {
1350	# pure perl	1540	# pure perl
1351		1541
1352	# AE::Util has been loaded in signal	1542	# AE::Util has been loaded in signal
1353	$signal = AnyEvent::Util::sig2name ($signal);	1543	$signal = sig2name $signal;
1354	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1544	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1355		1545
1356	$SIG{$signal} \|\|= sub {	1546	$SIG{$signal} \|\|= sub {
1357	local $!;	1547	local $!;
1358	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1548	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1359	undef $SIG_EV{$signal};	1549	undef $SIG_EV{$signal};
		1550	};
		1551
		1552	# can't do signal processing without introducing races in pure perl,
		1553	# so limit the signal latency.
		1554	_sig_add;
		1555	}
		1556
		1557	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1360	};	1558	};
1361		1559
1362	# can't do signal processing without introducing races in pure perl,	1560	*AnyEvent::Base::signal::DESTROY = sub {
1363	# so limit the signal latency.	1561	my ($signal, $cb) = @{$_[0]};
		1562
1364	_sig_add;	1563	_sig_del;
1365	}
1366		1564
1367	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1565	delete $SIG_CB{$signal}{$cb};
1368	}
1369		1566
1370	sub signal {
1371	# probe for availability of Async::Interrupt
1372	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 1.0 (); 1") {
1373	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1374
1375	$HAVE_ASYNC_INTERRUPT = 1;	1567	$HAVE_ASYNC_INTERRUPT
1376	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1568	? delete $SIG_ASY{$signal}
1377	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);	1569	: # delete doesn't work with older perls - they then
1378		1570	# print weird messages, or just unconditionally exit
1379	} else {	1571	# instead of getting the default action.
1380	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1572	undef $SIG{$signal}
1381		1573	unless keys %{ $SIG_CB{$signal} };
1382	require Fcntl;
1383
1384	if (AnyEvent::WIN32) {
1385	require AnyEvent::Util;
1386
1387	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1388	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1389	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1390	} else {
1391	pipe $SIGPIPE_R, $SIGPIPE_W;
1392	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1393	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1394
1395	# not strictly required, as $^F is normally 2, but let's make sure...
1396	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1397	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1398	}	1574	};
1399		1575
1400	$SIGPIPE_R	1576	*_signal_exec = sub {
1401	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1577	$HAVE_ASYNC_INTERRUPT
		1578	? $SIGPIPE_R->drain
		1579	: sysread $SIGPIPE_R, (my $dummy), 9;
1402		1580
1403	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);	1581	while (%SIG_EV) {
		1582	for (keys %SIG_EV) {
		1583	delete $SIG_EV{$_};
		1584	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1585	}
		1586	}
		1587	};
1404	}	1588	};
		1589	die if $@;
1405		1590
1406	*signal = \&_signal;
1407	&signal	1591	&signal
1408	}
1409
1410	sub AnyEvent::Base::signal::DESTROY {
1411	my ($signal, $cb) = @{$_[0]};
1412
1413	_sig_del;
1414
1415	delete $SIG_CB{$signal}{$cb};
1416
1417	$HAVE_ASYNC_INTERRUPT
1418	? delete $SIG_ASY{$signal}
1419	: # delete doesn't work with older perls - they then
1420	# print weird messages, or just unconditionally exit
1421	# instead of getting the default action.
1422	undef $SIG{$signal}
1423	unless keys %{ $SIG_CB{$signal} };
1424	}	1592	}
1425		1593
1426	# default implementation for ->child	1594	# default implementation for ->child
1427		1595
1428	our %PID_CB;	1596	our %PID_CB;
1429	our $CHLD_W;	1597	our $CHLD_W;
1430	our $CHLD_DELAY_W;	1598	our $CHLD_DELAY_W;
1431	our $WNOHANG;	1599	our $WNOHANG;
1432		1600
		1601	# used by many Impl's
1433	sub _emit_childstatus($$) {	1602	sub _emit_childstatus($$) {
1434	my (undef, $rpid, $rstatus) = @_;	1603	my (undef, $rpid, $rstatus) = @_;
1435		1604
1436	$_->($rpid, $rstatus)	1605	$_->($rpid, $rstatus)
1437	for values %{ $PID_CB{$rpid} \|\| {} },	1606	for values %{ $PID_CB{$rpid} \|\| {} },
1438	values %{ $PID_CB{0} \|\| {} };	1607	values %{ $PID_CB{0} \|\| {} };
1439	}	1608	}
1440		1609
1441	sub _sigchld {
1442	my $pid;
1443
1444	AnyEvent->_emit_childstatus ($pid, $?)
1445	while ($pid = waitpid -1, $WNOHANG) > 0;
1446	}
1447
1448	sub child {	1610	sub child {
		1611	eval q{ # poor man's autoloading {}
		1612	*_sigchld = sub {
		1613	my $pid;
		1614
		1615	AnyEvent->_emit_childstatus ($pid, $?)
		1616	while ($pid = waitpid -1, $WNOHANG) > 0;
		1617	};
		1618
		1619	*child = sub {
1449	my (undef, %arg) = @_;	1620	my (undef, %arg) = @_;
1450		1621
1451	defined (my $pid = $arg{pid} + 0)	1622	defined (my $pid = $arg{pid} + 0)
1452	or Carp::croak "required option 'pid' is missing";	1623	or Carp::croak "required option 'pid' is missing";
1453		1624
1454	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1625	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1455		1626
1456	# WNOHANG is almost cetrainly 1 everywhere	1627	# WNOHANG is almost cetrainly 1 everywhere
1457	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1628	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1458	? 1	1629	? 1
1459	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1630	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1460		1631
1461	unless ($CHLD_W) {	1632	unless ($CHLD_W) {
1462	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1633	$CHLD_W = AE::signal CHLD => \&_sigchld;
1463	# child could be a zombie already, so make at least one round	1634	# child could be a zombie already, so make at least one round
1464	&_sigchld;	1635	&_sigchld;
1465	}	1636	}
1466		1637
1467	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1638	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1468	}	1639	};
1469		1640
1470	sub AnyEvent::Base::child::DESTROY {	1641	*AnyEvent::Base::child::DESTROY = sub {
1471	my ($pid, $cb) = @{$_[0]};	1642	my ($pid, $cb) = @{$_[0]};
1472		1643
1473	delete $PID_CB{$pid}{$cb};	1644	delete $PID_CB{$pid}{$cb};
1474	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1645	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1475		1646
1476	undef $CHLD_W unless keys %PID_CB;	1647	undef $CHLD_W unless keys %PID_CB;
		1648	};
		1649	};
		1650	die if $@;
		1651
		1652	&child
1477	}	1653	}
1478		1654
1479	# idle emulation is done by simply using a timer, regardless	1655	# idle emulation is done by simply using a timer, regardless
1480	# of whether the process is idle or not, and not letting	1656	# of whether the process is idle or not, and not letting
1481	# the callback use more than 50% of the time.	1657	# the callback use more than 50% of the time.
1482	sub idle {	1658	sub idle {
		1659	eval q{ # poor man's autoloading {}
		1660	*idle = sub {
1483	my (undef, %arg) = @_;	1661	my (undef, %arg) = @_;
1484		1662
1485	my ($cb, $w, $rcb) = $arg{cb};	1663	my ($cb, $w, $rcb) = $arg{cb};
1486		1664
1487	$rcb = sub {	1665	$rcb = sub {
1488	if ($cb) {	1666	if ($cb) {
1489	$w = _time;	1667	$w = _time;
1490	&$cb;	1668	&$cb;
1491	$w = _time - $w;	1669	$w = _time - $w;
1492		1670
1493	# never use more then 50% of the time for the idle watcher,	1671	# never use more then 50% of the time for the idle watcher,
1494	# within some limits	1672	# within some limits
1495	$w = 0.0001 if $w < 0.0001;	1673	$w = 0.0001 if $w < 0.0001;
1496	$w = 5 if $w > 5;	1674	$w = 5 if $w > 5;
1497		1675
1498	$w = AnyEvent->timer (after => $w, cb => $rcb);	1676	$w = AE::timer $w, 0, $rcb;
1499	} else {	1677	} else {
1500	# clean up...	1678	# clean up...
1501	undef $w;	1679	undef $w;
1502	undef $rcb;	1680	undef $rcb;
		1681	}
		1682	};
		1683
		1684	$w = AE::timer 0.05, 0, $rcb;
		1685
		1686	bless \\$cb, "AnyEvent::Base::idle"
1503	}	1687	};
		1688
		1689	*AnyEvent::Base::idle::DESTROY = sub {
		1690	undef $${$_[0]};
		1691	};
1504	};	1692	};
		1693	die if $@;
1505		1694
1506	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1695	&idle
1507
1508	bless \\$cb, "AnyEvent::Base::idle"
1509	}
1510
1511	sub AnyEvent::Base::idle::DESTROY {
1512	undef $${$_[0]};
1513	}	1696	}
1514		1697
1515	package AnyEvent::CondVar;	1698	package AnyEvent::CondVar;
1516		1699
1517	our @ISA = AnyEvent::CondVar::Base::;	1700	our @ISA = AnyEvent::CondVar::Base::;
…		…
1565	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1748	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1566	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1749	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1567	}	1750	}
1568		1751
1569	sub cb {	1752	sub cb {
1570	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1753	my $cv = shift;
		1754
		1755	@_
		1756	and $cv->{_ae_cb} = shift
		1757	and $cv->{_ae_sent}
		1758	and (delete $cv->{_ae_cb})->($cv);
		1759
1571	$_[0]{_ae_cb}	1760	$cv->{_ae_cb}
1572	}	1761	}
1573		1762
1574	sub begin {	1763	sub begin {
1575	++$_[0]{_ae_counter};	1764	++$_[0]{_ae_counter};
1576	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1765	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1785	warn "read: $input\n"; # output what has been read	1974	warn "read: $input\n"; # output what has been read
1786	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1975	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1787	},	1976	},
1788	);	1977	);
1789		1978
1790	my $time_watcher; # can only be used once
1791
1792	sub new_timer {
1793	$timer = AnyEvent->timer (after => 1, cb => sub {	1979	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1794	warn "timeout\n"; # print 'timeout' about every second	1980	warn "timeout\n"; # print 'timeout' at most every second
1795	&new_timer; # and restart the time
1796	});	1981	});
1797	}
1798
1799	new_timer; # create first timer
1800		1982
1801	$cv->recv; # wait until user enters /^q/i	1983	$cv->recv; # wait until user enters /^q/i
1802		1984
1803	=head1 REAL-WORLD EXAMPLE	1985	=head1 REAL-WORLD EXAMPLE
1804		1986
…		…
1935	through AnyEvent. The benchmark creates a lot of timers (with a zero	2117	through AnyEvent. The benchmark creates a lot of timers (with a zero
1936	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2118	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1937	which it is), lets them fire exactly once and destroys them again.	2119	which it is), lets them fire exactly once and destroys them again.
1938		2120
1939	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2121	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1940	distribution.	2122	distribution. It uses the L<AE> interface, which makes a real difference
		2123	for the EV and Perl backends only.
1941		2124
1942	=head3 Explanation of the columns	2125	=head3 Explanation of the columns
1943		2126
1944	I<watcher> is the number of event watchers created/destroyed. Since	2127	I<watcher> is the number of event watchers created/destroyed. Since
1945	different event models feature vastly different performances, each event	2128	different event models feature vastly different performances, each event
…		…
1966	watcher.	2149	watcher.
1967		2150
1968	=head3 Results	2151	=head3 Results
1969		2152
1970	name watchers bytes create invoke destroy comment	2153	name watchers bytes create invoke destroy comment
1971	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2154	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1972	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2155	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1973	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2156	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1974	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2157	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1975	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2158	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1976	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2159	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1977	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2160	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1978	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2161	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1979	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2162	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1980	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2163	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1981	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2164	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1982	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2165	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1983		2166
1984	=head3 Discussion	2167	=head3 Discussion
1985		2168
1986	The benchmark does I<not> measure scalability of the event loop very	2169	The benchmark does I<not> measure scalability of the event loop very
1987	well. For example, a select-based event loop (such as the pure perl one)	2170	well. For example, a select-based event loop (such as the pure perl one)
…		…
1999	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2182	benchmark machine, handling an event takes roughly 1600 CPU cycles with
2000	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2183	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2001	cycles with POE.	2184	cycles with POE.
2002		2185
2003	C<EV> is the sole leader regarding speed and memory use, which are both	2186	C<EV> is the sole leader regarding speed and memory use, which are both
2004	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2187	maximal/minimal, respectively. When using the L<AE> API there is zero
		2188	overhead (when going through the AnyEvent API create is about 5-6 times
		2189	slower, with other times being equal, so still uses far less memory than
2005	far less memory than any other event loop and is still faster than Event	2190	any other event loop and is still faster than Event natively).
2006	natively.
2007		2191
2008	The pure perl implementation is hit in a few sweet spots (both the	2192	The pure perl implementation is hit in a few sweet spots (both the
2009	constant timeout and the use of a single fd hit optimisations in the perl	2193	constant timeout and the use of a single fd hit optimisations in the perl
2010	interpreter and the backend itself). Nevertheless this shows that it	2194	interpreter and the backend itself). Nevertheless this shows that it
2011	adds very little overhead in itself. Like any select-based backend its	2195	adds very little overhead in itself. Like any select-based backend its
…		…
2085	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2269	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2086	(1%) are active. This mirrors the activity of large servers with many	2270	(1%) are active. This mirrors the activity of large servers with many
2087	connections, most of which are idle at any one point in time.	2271	connections, most of which are idle at any one point in time.
2088		2272
2089	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2273	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2090	distribution.	2274	distribution. It uses the L<AE> interface, which makes a real difference
		2275	for the EV and Perl backends only.
2091		2276
2092	=head3 Explanation of the columns	2277	=head3 Explanation of the columns
2093		2278
2094	I<sockets> is the number of sockets, and twice the number of "servers" (as	2279	I<sockets> is the number of sockets, and twice the number of "servers" (as
2095	each server has a read and write socket end).	2280	each server has a read and write socket end).
…		…
2103	a new one that moves the timeout into the future.	2288	a new one that moves the timeout into the future.
2104		2289
2105	=head3 Results	2290	=head3 Results
2106		2291
2107	name sockets create request	2292	name sockets create request
2108	EV 20000 69.01 11.16	2293	EV 20000 62.66 7.99
2109	Perl 20000 73.32 35.87	2294	Perl 20000 68.32 32.64
2110	IOAsync 20000 157.00 98.14 epoll	2295	IOAsync 20000 174.06 101.15 epoll
2111	IOAsync 20000 159.31 616.06 poll	2296	IOAsync 20000 174.67 610.84 poll
2112	Event 20000 212.62 257.32	2297	Event 20000 202.69 242.91
2113	Glib 20000 651.16 1896.30	2298	Glib 20000 557.01 1689.52
2114	POE 20000 349.67 12317.24 uses POE::Loop::Event	2299	POE 20000 341.54 12086.32 uses POE::Loop::Event
2115		2300
2116	=head3 Discussion	2301	=head3 Discussion
2117		2302
2118	This benchmark I<does> measure scalability and overall performance of the	2303	This benchmark I<does> measure scalability and overall performance of the
2119	particular event loop.	2304	particular event loop.
…		…
2245	As you can see, the AnyEvent + EV combination even beats the	2430	As you can see, the AnyEvent + EV combination even beats the
2246	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2431	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2247	backend easily beats IO::Lambda and POE.	2432	backend easily beats IO::Lambda and POE.
2248		2433
2249	And even the 100% non-blocking version written using the high-level (and	2434	And even the 100% non-blocking version written using the high-level (and
2250	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2435	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2251	large margin, even though it does all of DNS, tcp-connect and socket I/O	2436	higher level ("unoptimised") abstractions by a large margin, even though
2252	in a non-blocking way.	2437	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2253		2438
2254	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2439	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2255	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2440	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2256	part of the IO::lambda distribution and were used without any changes.	2441	part of the IO::Lambda distribution and were used without any changes.
2257		2442
2258		2443
2259	=head1 SIGNALS	2444	=head1 SIGNALS
2260		2445
2261	AnyEvent currently installs handlers for these signals:	2446	AnyEvent currently installs handlers for these signals:
…		…
2303	it's built-in modules) are required to use it.	2488	it's built-in modules) are required to use it.
2304		2489
2305	That does not mean that AnyEvent won't take advantage of some additional	2490	That does not mean that AnyEvent won't take advantage of some additional
2306	modules if they are installed.	2491	modules if they are installed.
2307		2492
2308	This section epxlains which additional modules will be used, and how they	2493	This section explains which additional modules will be used, and how they
2309	affect AnyEvent's operetion.	2494	affect AnyEvent's operation.
2310		2495
2311	=over 4	2496	=over 4
2312		2497
2313	=item L<Async::Interrupt>	2498	=item L<Async::Interrupt>
2314		2499
…		…
2319	catch the signals) with some delay (default is 10 seconds, look for	2504	catch the signals) with some delay (default is 10 seconds, look for
2320	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2505	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2321		2506
2322	If this module is available, then it will be used to implement signal	2507	If this module is available, then it will be used to implement signal
2323	catching, which means that signals will not be delayed, and the event loop	2508	catching, which means that signals will not be delayed, and the event loop
2324	will not be interrupted regularly, which is more efficient (And good for	2509	will not be interrupted regularly, which is more efficient (and good for
2325	battery life on laptops).	2510	battery life on laptops).
2326		2511
2327	This affects not just the pure-perl event loop, but also other event loops	2512	This affects not just the pure-perl event loop, but also other event loops
2328	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2513	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2329		2514
…		…
2350	lot less memory), but otherwise doesn't affect guard operation much. It is	2535	lot less memory), but otherwise doesn't affect guard operation much. It is
2351	purely used for performance.	2536	purely used for performance.
2352		2537
2353	=item L<JSON> and L<JSON::XS>	2538	=item L<JSON> and L<JSON::XS>
2354		2539
2355	This module is required when you want to read or write JSON data via	2540	One of these modules is required when you want to read or write JSON data
2356	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2541	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2357	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2542	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2358		2543
2359	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2544	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2360	installed.	2545	installed.
2361		2546
…		…
2376		2561
2377		2562
2378	=head1 FORK	2563	=head1 FORK
2379		2564
2380	Most event libraries are not fork-safe. The ones who are usually are	2565	Most event libraries are not fork-safe. The ones who are usually are
2381	because they rely on inefficient but fork-safe C<select> or C<poll>	2566	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2382	calls. Only L<EV> is fully fork-aware.	2567	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2568	are usually badly thought-out hacks that are incompatible with fork in
		2569	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2570	continue event-processing in both parent and child (or both, if you know
		2571	what you are doing).
		2572
		2573	This means that, in general, you cannot fork and do event processing in
		2574	the child if the event library was initialised before the fork (which
		2575	usually happens when the first AnyEvent watcher is created, or the library
		2576	is loaded).
2383		2577
2384	If you have to fork, you must either do so I<before> creating your first	2578	If you have to fork, you must either do so I<before> creating your first
2385	watcher OR you must not use AnyEvent at all in the child OR you must do	2579	watcher OR you must not use AnyEvent at all in the child OR you must do
2386	something completely out of the scope of AnyEvent.	2580	something completely out of the scope of AnyEvent.
		2581
		2582	The problem of doing event processing in the parent I<and> the child
		2583	is much more complicated: even for backends that I<are> fork-aware or
		2584	fork-safe, their behaviour is not usually what you want: fork clones all
		2585	watchers, that means all timers, I/O watchers etc. are active in both
		2586	parent and child, which is almost never what you want. USing C<exec>
		2587	to start worker children from some kind of manage rprocess is usually
		2588	preferred, because it is much easier and cleaner, at the expense of having
		2589	to have another binary.
2387		2590
2388		2591
2389	=head1 SECURITY CONSIDERATIONS	2592	=head1 SECURITY CONSIDERATIONS
2390		2593
2391	AnyEvent can be forced to load any event model via	2594	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.262 by root, Tue Jul 28 13:08:17 2009 UTC vs. Revision 1.312 by root, Mon Feb 15 18:02:35 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.262 by root, Tue Jul 28 13:08:17 2009 UTC vs.
Revision 1.312 by root, Mon Feb 15 18:02:35 2010 UTC