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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.265 by root, Wed Jul 29 13:10:58 2009 UTC vs.
Revision 1.317 by root, Wed Mar 24 21:22:57 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.251';
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 {
1104	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1172	require "AnyEvent/constants.pl";
		1173
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
1152	our @post_detect;	1222	our @post_detect;
1153		1223
1154	sub post_detect(&) {	1224	sub post_detect(&) {
1155	my ($cb) = @_;	1225	my ($cb) = @_;
1156		1226
1157	if ($MODEL) {
1158	$cb->();
1159
1160	undef
1161	} else {
1162	push @post_detect, $cb;	1227	push @post_detect, $cb;
1163		1228
1164	defined wantarray	1229	defined wantarray
1165	? bless \$cb, "AnyEvent::Util::postdetect"	1230	? bless \$cb, "AnyEvent::Util::postdetect"
1166	: ()	1231	: ()
1167	}
1168	}	1232	}
1169		1233
1170	sub AnyEvent::Util::postdetect::DESTROY {	1234	sub AnyEvent::Util::postdetect::DESTROY {
1171	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1235	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1172	}	1236	}
1173		1237
1174	sub detect() {	1238	sub detect() {
		1239	# free some memory
		1240	*detect = sub () { $MODEL };
		1241
		1242	local $!; # for good measure
		1243	local $SIG{__DIE__};
		1244
		1245	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1246	my $model = "AnyEvent::Impl::$1";
		1247	if (eval "require $model") {
		1248	$MODEL = $model;
		1249	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1250	} else {
		1251	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1252	}
		1253	}
		1254
		1255	# check for already loaded models
1175	unless ($MODEL) {	1256	unless ($MODEL) {
1176	local $SIG{__DIE__};	1257	for (@REGISTRY, @models) {
1177		1258	my ($package, $model) = @$_;
1178	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1259	if (${"$package\::VERSION"} > 0) {
1179	my $model = "AnyEvent::Impl::$1";
1180	if (eval "require $model") {	1260	if (eval "require $model") {
1181	$MODEL = $model;	1261	$MODEL = $model;
1182	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1262	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1183	} else {	1263	last;
1184	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1264	}
1185	}	1265	}
1186	}	1266	}
1187		1267
1188	# check for already loaded models
1189	unless ($MODEL) {	1268	unless ($MODEL) {
		1269	# try to autoload a model
1190	for (@REGISTRY, @models) {	1270	for (@REGISTRY, @models) {
1191	my ($package, $model) = @$_;	1271	my ($package, $model, $autoload) = @$_;
		1272	if (
		1273	$autoload
		1274	and eval "require $package"
1192	if (${"$package\::VERSION"} > 0) {	1275	and ${"$package\::VERSION"} > 0
1193	if (eval "require $model") {	1276	and eval "require $model"
		1277	) {
1194	$MODEL = $model;	1278	$MODEL = $model;
1195	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1279	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1196	last;	1280	last;
1197	}
1198	}	1281	}
1199	}	1282	}
1200		1283
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	1284	$MODEL
1218	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1285	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1219	}
1220	}	1286	}
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	}	1287	}
		1288
		1289	@models = (); # free probe data
		1290
		1291	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1292	unshift @ISA, $MODEL;
		1293
		1294	# now nuke some methods that are overriden by the backend.
		1295	# SUPER is not allowed.
		1296	for (qw(time signal child idle)) {
		1297	undef &{"AnyEvent::Base::$_"}
		1298	if defined &{"$MODEL\::$_"};
		1299	}
		1300
		1301	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1302
		1303	(shift @post_detect)->() while @post_detect;
		1304
		1305	*post_detect = sub(&) {
		1306	shift->();
		1307
		1308	undef
		1309	};
1230		1310
1231	$MODEL	1311	$MODEL
1232	}	1312	}
1233		1313
1234	sub AUTOLOAD {	1314	sub AUTOLOAD {
1235	(my $func = $AUTOLOAD) =~ s/.*://;	1315	(my $func = $AUTOLOAD) =~ s/.*://;
1236		1316
1237	$method{$func}	1317	$method{$func}
1238	or Carp::croak "$func: not a valid method for AnyEvent objects";	1318	or Carp::croak "$func: not a valid AnyEvent class method";
1239		1319
1240	detect unless $MODEL;	1320	detect;
1241		1321
1242	my $class = shift;	1322	my $class = shift;
1243	$class->$func (@_);	1323	$class->$func (@_);
1244	}	1324	}
1245		1325
…		…
1258	# we assume CLOEXEC is already set by perl in all important cases	1338	# we assume CLOEXEC is already set by perl in all important cases
1259		1339
1260	($fh2, $rw)	1340	($fh2, $rw)
1261	}	1341	}
1262		1342
		1343	=head1 SIMPLIFIED AE API
		1344
		1345	Starting with version 5.0, AnyEvent officially supports a second, much
		1346	simpler, API that is designed to reduce the calling, typing and memory
		1347	overhead.
		1348
		1349	See the L<AE> manpage for details.
		1350
		1351	=cut
		1352
		1353	package AE;
		1354
		1355	our $VERSION = $AnyEvent::VERSION;
		1356
		1357	sub io($$$) {
		1358	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1359	}
		1360
		1361	sub timer($$$) {
		1362	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1363	}
		1364
		1365	sub signal($$) {
		1366	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1367	}
		1368
		1369	sub child($$) {
		1370	AnyEvent->child (pid => $_[0], cb => $_[1])
		1371	}
		1372
		1373	sub idle($) {
		1374	AnyEvent->idle (cb => $_[0])
		1375	}
		1376
		1377	sub cv(;&) {
		1378	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1379	}
		1380
		1381	sub now() {
		1382	AnyEvent->now
		1383	}
		1384
		1385	sub now_update() {
		1386	AnyEvent->now_update
		1387	}
		1388
		1389	sub time() {
		1390	AnyEvent->time
		1391	}
		1392
1263	package AnyEvent::Base;	1393	package AnyEvent::Base;
1264		1394
1265	# default implementations for many methods	1395	# default implementations for many methods
1266		1396
1267	sub _time {	1397	sub time {
		1398	eval q{ # poor man's autoloading {}
1268	# probe for availability of Time::HiRes	1399	# probe for availability of Time::HiRes
1269	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1400	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1270	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1401	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1271	*_time = \&Time::HiRes::time;	1402	*AE::time = \&Time::HiRes::time;
1272	# if (eval "use POSIX (); (POSIX::times())...	1403	# if (eval "use POSIX (); (POSIX::times())...
1273	} else {	1404	} else {
1274	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1405	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1275	*_time = sub { time }; # epic fail	1406	*AE::time = sub (){ time }; # epic fail
		1407	}
		1408
		1409	*time = sub { AE::time }; # different prototypes
1276	}	1410	};
		1411	die if $@;
1277		1412
1278	&_time	1413	&time
1279	}	1414	}
1280		1415
1281	sub time { _time }	1416	*now = \&time;
1282	sub now { _time }	1417
1283	sub now_update { }	1418	sub now_update { }
1284		1419
1285	# default implementation for ->condvar	1420	# default implementation for ->condvar
1286		1421
1287	sub condvar {	1422	sub condvar {
		1423	eval q{ # poor man's autoloading {}
		1424	*condvar = sub {
1288	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1425	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1426	};
		1427
		1428	*AE::cv = sub (;&) {
		1429	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1430	};
		1431	};
		1432	die if $@;
		1433
		1434	&condvar
1289	}	1435	}
1290		1436
1291	# default implementation for ->signal	1437	# default implementation for ->signal
1292		1438
1293	our $HAVE_ASYNC_INTERRUPT;	1439	our $HAVE_ASYNC_INTERRUPT;
1294		1440
1295	sub _have_async_interrupt() {	1441	sub _have_async_interrupt() {
1296	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}	1442	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1297	&& eval "use Async::Interrupt 1.0 (); 1")	1443	&& eval "use Async::Interrupt 1.02 (); 1")
1298	unless defined $HAVE_ASYNC_INTERRUPT;	1444	unless defined $HAVE_ASYNC_INTERRUPT;
1299		1445
1300	$HAVE_ASYNC_INTERRUPT	1446	$HAVE_ASYNC_INTERRUPT
1301	}	1447	}
1302		1448
1303	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1449	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1304	our (%SIG_ASY, %SIG_ASY_W);	1450	our (%SIG_ASY, %SIG_ASY_W);
1305	our ($SIG_COUNT, $SIG_TW);	1451	our ($SIG_COUNT, $SIG_TW);
1306		1452
1307	sub _signal_exec {
1308	$HAVE_ASYNC_INTERRUPT
1309	? $SIGPIPE_R->drain
1310	: sysread $SIGPIPE_R, my $dummy, 9;
1311
1312	while (%SIG_EV) {
1313	for (keys %SIG_EV) {
1314	delete $SIG_EV{$_};
1315	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1316	}
1317	}
1318	}
1319
1320	# install a dummy wakeup watcher to reduce signal catching latency	1453	# install a dummy wakeup watcher to reduce signal catching latency
		1454	# used by Impls
1321	sub _sig_add() {	1455	sub _sig_add() {
1322	unless ($SIG_COUNT++) {	1456	unless ($SIG_COUNT++) {
1323	# try to align timer on a full-second boundary, if possible	1457	# try to align timer on a full-second boundary, if possible
1324	my $NOW = AnyEvent->now;	1458	my $NOW = AE::now;
1325		1459
1326	$SIG_TW = AnyEvent->timer (	1460	$SIG_TW = AE::timer
1327	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1461	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1328	interval => $MAX_SIGNAL_LATENCY,	1462	$MAX_SIGNAL_LATENCY,
1329	cb => sub { }, # just for the PERL_ASYNC_CHECK	1463	sub { } # just for the PERL_ASYNC_CHECK
1330	);	1464	;
1331	}	1465	}
1332	}	1466	}
1333		1467
1334	sub _sig_del {	1468	sub _sig_del {
1335	undef $SIG_TW	1469	undef $SIG_TW
1336	unless --$SIG_COUNT;	1470	unless --$SIG_COUNT;
1337	}	1471	}
1338		1472
1339	our $_sig_name_init; $_sig_name_init = sub {	1473	our $_sig_name_init; $_sig_name_init = sub {
1340	eval q{ # poor man's autoloading	1474	eval q{ # poor man's autoloading {}
1341	undef $_sig_name_init;	1475	undef $_sig_name_init;
1342		1476
1343	if (_have_async_interrupt) {	1477	if (_have_async_interrupt) {
1344	*sig2num = \&Async::Interrupt::sig2num;	1478	*sig2num = \&Async::Interrupt::sig2num;
1345	*sig2name = \&Async::Interrupt::sig2name;	1479	*sig2name = \&Async::Interrupt::sig2name;
…		…
1372	# probe for availability of Async::Interrupt	1506	# probe for availability of Async::Interrupt
1373	if (_have_async_interrupt) {	1507	if (_have_async_interrupt) {
1374	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1508	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1375		1509
1376	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1510	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1377	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);	1511	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1378		1512
1379	} else {	1513	} else {
1380	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1514	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1381
1382	require Fcntl;
1383		1515
1384	if (AnyEvent::WIN32) {	1516	if (AnyEvent::WIN32) {
1385	require AnyEvent::Util;	1517	require AnyEvent::Util;
1386		1518
1387	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1519	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1388	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1520	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1389	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1521	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1390	} else {	1522	} else {
1391	pipe $SIGPIPE_R, $SIGPIPE_W;	1523	pipe $SIGPIPE_R, $SIGPIPE_W;
1392	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1524	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1393	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1525	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1394		1526
1395	# not strictly required, as $^F is normally 2, but let's make sure...	1527	# not strictly required, as $^F is normally 2, but let's make sure...
1396	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1528	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1397	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1529	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1398	}	1530	}
1399		1531
1400	$SIGPIPE_R	1532	$SIGPIPE_R
1401	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1533	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1402		1534
1403	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);	1535	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1404	}	1536	}
1405		1537
1406	*signal = sub {	1538	*signal = $HAVE_ASYNC_INTERRUPT
		1539	? sub {
1407	my (undef, %arg) = @_;	1540	my (undef, %arg) = @_;
1408		1541
1409	my $signal = uc $arg{signal}
1410	or Carp::croak "required option 'signal' is missing";
1411
1412	if ($HAVE_ASYNC_INTERRUPT) {
1413	# async::interrupt	1542	# async::interrupt
1414
1415	$signal = sig2num $signal;	1543	my $signal = sig2num $arg{signal};
1416	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1544	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1417		1545
1418	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1546	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1419	cb => sub { undef $SIG_EV{$signal} },	1547	cb => sub { undef $SIG_EV{$signal} },
1420	signal => $signal,	1548	signal => $signal,
1421	pipe => [$SIGPIPE_R->filenos],	1549	pipe => [$SIGPIPE_R->filenos],
1422	pipe_autodrain => 0,	1550	pipe_autodrain => 0,
1423	;	1551	;
1424		1552
1425	} else {	1553	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1554	}
		1555	: sub {
		1556	my (undef, %arg) = @_;
		1557
1426	# pure perl	1558	# pure perl
1427
1428	# AE::Util has been loaded in signal
1429	$signal = sig2name $signal;	1559	my $signal = sig2name $arg{signal};
1430	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1560	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1431		1561
1432	$SIG{$signal} \|\|= sub {	1562	$SIG{$signal} \|\|= sub {
1433	local $!;	1563	local $!;
1434	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1564	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1435	undef $SIG_EV{$signal};	1565	undef $SIG_EV{$signal};
1436	};	1566	};
1437		1567
1438	# can't do signal processing without introducing races in pure perl,	1568	# can't do signal processing without introducing races in pure perl,
1439	# so limit the signal latency.	1569	# so limit the signal latency.
1440	_sig_add;	1570	_sig_add;
1441	}
1442		1571
1443	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1572	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1573	}
1444	};	1574	;
1445		1575
1446	*AnyEvent::Base::signal::DESTROY = sub {	1576	*AnyEvent::Base::signal::DESTROY = sub {
1447	my ($signal, $cb) = @{$_[0]};	1577	my ($signal, $cb) = @{$_[0]};
1448		1578
1449	_sig_del;	1579	_sig_del;
…		…
1456	# print weird messages, or just unconditionally exit	1586	# print weird messages, or just unconditionally exit
1457	# instead of getting the default action.	1587	# instead of getting the default action.
1458	undef $SIG{$signal}	1588	undef $SIG{$signal}
1459	unless keys %{ $SIG_CB{$signal} };	1589	unless keys %{ $SIG_CB{$signal} };
1460	};	1590	};
		1591
		1592	*_signal_exec = sub {
		1593	$HAVE_ASYNC_INTERRUPT
		1594	? $SIGPIPE_R->drain
		1595	: sysread $SIGPIPE_R, (my $dummy), 9;
		1596
		1597	while (%SIG_EV) {
		1598	for (keys %SIG_EV) {
		1599	delete $SIG_EV{$_};
		1600	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1601	}
		1602	}
		1603	};
1461	};	1604	};
1462	die if $@;	1605	die if $@;
		1606
1463	&signal	1607	&signal
1464	}	1608	}
1465		1609
1466	# default implementation for ->child	1610	# default implementation for ->child
1467		1611
1468	our %PID_CB;	1612	our %PID_CB;
1469	our $CHLD_W;	1613	our $CHLD_W;
1470	our $CHLD_DELAY_W;	1614	our $CHLD_DELAY_W;
1471	our $WNOHANG;	1615	our $WNOHANG;
1472		1616
		1617	# used by many Impl's
1473	sub _emit_childstatus($$) {	1618	sub _emit_childstatus($$) {
1474	my (undef, $rpid, $rstatus) = @_;	1619	my (undef, $rpid, $rstatus) = @_;
1475		1620
1476	$_->($rpid, $rstatus)	1621	$_->($rpid, $rstatus)
1477	for values %{ $PID_CB{$rpid} \|\| {} },	1622	for values %{ $PID_CB{$rpid} \|\| {} },
1478	values %{ $PID_CB{0} \|\| {} };	1623	values %{ $PID_CB{0} \|\| {} };
1479	}	1624	}
1480		1625
1481	sub _sigchld {
1482	my $pid;
1483
1484	AnyEvent->_emit_childstatus ($pid, $?)
1485	while ($pid = waitpid -1, $WNOHANG) > 0;
1486	}
1487
1488	sub child {	1626	sub child {
		1627	eval q{ # poor man's autoloading {}
		1628	*_sigchld = sub {
		1629	my $pid;
		1630
		1631	AnyEvent->_emit_childstatus ($pid, $?)
		1632	while ($pid = waitpid -1, $WNOHANG) > 0;
		1633	};
		1634
		1635	*child = sub {
1489	my (undef, %arg) = @_;	1636	my (undef, %arg) = @_;
1490		1637
1491	defined (my $pid = $arg{pid} + 0)	1638	defined (my $pid = $arg{pid} + 0)
1492	or Carp::croak "required option 'pid' is missing";	1639	or Carp::croak "required option 'pid' is missing";
1493		1640
1494	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1641	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1495		1642
1496	# WNOHANG is almost cetrainly 1 everywhere	1643	# WNOHANG is almost cetrainly 1 everywhere
1497	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1644	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1498	? 1	1645	? 1
1499	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1646	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1500		1647
1501	unless ($CHLD_W) {	1648	unless ($CHLD_W) {
1502	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1649	$CHLD_W = AE::signal CHLD => \&_sigchld;
1503	# child could be a zombie already, so make at least one round	1650	# child could be a zombie already, so make at least one round
1504	&_sigchld;	1651	&_sigchld;
1505	}	1652	}
1506		1653
1507	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1654	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1508	}	1655	};
1509		1656
1510	sub AnyEvent::Base::child::DESTROY {	1657	*AnyEvent::Base::child::DESTROY = sub {
1511	my ($pid, $cb) = @{$_[0]};	1658	my ($pid, $cb) = @{$_[0]};
1512		1659
1513	delete $PID_CB{$pid}{$cb};	1660	delete $PID_CB{$pid}{$cb};
1514	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1661	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1515		1662
1516	undef $CHLD_W unless keys %PID_CB;	1663	undef $CHLD_W unless keys %PID_CB;
		1664	};
		1665	};
		1666	die if $@;
		1667
		1668	&child
1517	}	1669	}
1518		1670
1519	# idle emulation is done by simply using a timer, regardless	1671	# idle emulation is done by simply using a timer, regardless
1520	# of whether the process is idle or not, and not letting	1672	# of whether the process is idle or not, and not letting
1521	# the callback use more than 50% of the time.	1673	# the callback use more than 50% of the time.
1522	sub idle {	1674	sub idle {
		1675	eval q{ # poor man's autoloading {}
		1676	*idle = sub {
1523	my (undef, %arg) = @_;	1677	my (undef, %arg) = @_;
1524		1678
1525	my ($cb, $w, $rcb) = $arg{cb};	1679	my ($cb, $w, $rcb) = $arg{cb};
1526		1680
1527	$rcb = sub {	1681	$rcb = sub {
1528	if ($cb) {	1682	if ($cb) {
1529	$w = _time;	1683	$w = _time;
1530	&$cb;	1684	&$cb;
1531	$w = _time - $w;	1685	$w = _time - $w;
1532		1686
1533	# never use more then 50% of the time for the idle watcher,	1687	# never use more then 50% of the time for the idle watcher,
1534	# within some limits	1688	# within some limits
1535	$w = 0.0001 if $w < 0.0001;	1689	$w = 0.0001 if $w < 0.0001;
1536	$w = 5 if $w > 5;	1690	$w = 5 if $w > 5;
1537		1691
1538	$w = AnyEvent->timer (after => $w, cb => $rcb);	1692	$w = AE::timer $w, 0, $rcb;
1539	} else {	1693	} else {
1540	# clean up...	1694	# clean up...
1541	undef $w;	1695	undef $w;
1542	undef $rcb;	1696	undef $rcb;
		1697	}
		1698	};
		1699
		1700	$w = AE::timer 0.05, 0, $rcb;
		1701
		1702	bless \\$cb, "AnyEvent::Base::idle"
1543	}	1703	};
		1704
		1705	*AnyEvent::Base::idle::DESTROY = sub {
		1706	undef $${$_[0]};
		1707	};
1544	};	1708	};
		1709	die if $@;
1545		1710
1546	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1711	&idle
1547
1548	bless \\$cb, "AnyEvent::Base::idle"
1549	}
1550
1551	sub AnyEvent::Base::idle::DESTROY {
1552	undef $${$_[0]};
1553	}	1712	}
1554		1713
1555	package AnyEvent::CondVar;	1714	package AnyEvent::CondVar;
1556		1715
1557	our @ISA = AnyEvent::CondVar::Base::;	1716	our @ISA = AnyEvent::CondVar::Base::;
…		…
1605	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1764	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1606	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1765	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1607	}	1766	}
1608		1767
1609	sub cb {	1768	sub cb {
1610	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1769	my $cv = shift;
		1770
		1771	@_
		1772	and $cv->{_ae_cb} = shift
		1773	and $cv->{_ae_sent}
		1774	and (delete $cv->{_ae_cb})->($cv);
		1775
1611	$_[0]{_ae_cb}	1776	$cv->{_ae_cb}
1612	}	1777	}
1613		1778
1614	sub begin {	1779	sub begin {
1615	++$_[0]{_ae_counter};	1780	++$_[0]{_ae_counter};
1616	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1781	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1825	warn "read: $input\n"; # output what has been read	1990	warn "read: $input\n"; # output what has been read
1826	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1991	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1827	},	1992	},
1828	);	1993	);
1829		1994
1830	my $time_watcher; # can only be used once
1831
1832	sub new_timer {
1833	$timer = AnyEvent->timer (after => 1, cb => sub {	1995	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1834	warn "timeout\n"; # print 'timeout' about every second	1996	warn "timeout\n"; # print 'timeout' at most every second
1835	&new_timer; # and restart the time
1836	});	1997	});
1837	}
1838
1839	new_timer; # create first timer
1840		1998
1841	$cv->recv; # wait until user enters /^q/i	1999	$cv->recv; # wait until user enters /^q/i
1842		2000
1843	=head1 REAL-WORLD EXAMPLE	2001	=head1 REAL-WORLD EXAMPLE
1844		2002
…		…
1975	through AnyEvent. The benchmark creates a lot of timers (with a zero	2133	through AnyEvent. The benchmark creates a lot of timers (with a zero
1976	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2134	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1977	which it is), lets them fire exactly once and destroys them again.	2135	which it is), lets them fire exactly once and destroys them again.
1978		2136
1979	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2137	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1980	distribution.	2138	distribution. It uses the L<AE> interface, which makes a real difference
		2139	for the EV and Perl backends only.
1981		2140
1982	=head3 Explanation of the columns	2141	=head3 Explanation of the columns
1983		2142
1984	I<watcher> is the number of event watchers created/destroyed. Since	2143	I<watcher> is the number of event watchers created/destroyed. Since
1985	different event models feature vastly different performances, each event	2144	different event models feature vastly different performances, each event
…		…
2006	watcher.	2165	watcher.
2007		2166
2008	=head3 Results	2167	=head3 Results
2009		2168
2010	name watchers bytes create invoke destroy comment	2169	name watchers bytes create invoke destroy comment
2011	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2170	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2012	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2171	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2013	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2172	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2014	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2173	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2015	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2174	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2016	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2175	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2017	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2176	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2018	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2177	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2019	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2178	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2020	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2179	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2021	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2180	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2022	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2181	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2023		2182
2024	=head3 Discussion	2183	=head3 Discussion
2025		2184
2026	The benchmark does I<not> measure scalability of the event loop very	2185	The benchmark does I<not> measure scalability of the event loop very
2027	well. For example, a select-based event loop (such as the pure perl one)	2186	well. For example, a select-based event loop (such as the pure perl one)
…		…
2039	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2198	benchmark machine, handling an event takes roughly 1600 CPU cycles with
2040	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2199	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2041	cycles with POE.	2200	cycles with POE.
2042		2201
2043	C<EV> is the sole leader regarding speed and memory use, which are both	2202	C<EV> is the sole leader regarding speed and memory use, which are both
2044	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2203	maximal/minimal, respectively. When using the L<AE> API there is zero
		2204	overhead (when going through the AnyEvent API create is about 5-6 times
		2205	slower, with other times being equal, so still uses far less memory than
2045	far less memory than any other event loop and is still faster than Event	2206	any other event loop and is still faster than Event natively).
2046	natively.
2047		2207
2048	The pure perl implementation is hit in a few sweet spots (both the	2208	The pure perl implementation is hit in a few sweet spots (both the
2049	constant timeout and the use of a single fd hit optimisations in the perl	2209	constant timeout and the use of a single fd hit optimisations in the perl
2050	interpreter and the backend itself). Nevertheless this shows that it	2210	interpreter and the backend itself). Nevertheless this shows that it
2051	adds very little overhead in itself. Like any select-based backend its	2211	adds very little overhead in itself. Like any select-based backend its
…		…
2125	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2285	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2126	(1%) are active. This mirrors the activity of large servers with many	2286	(1%) are active. This mirrors the activity of large servers with many
2127	connections, most of which are idle at any one point in time.	2287	connections, most of which are idle at any one point in time.
2128		2288
2129	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2289	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2130	distribution.	2290	distribution. It uses the L<AE> interface, which makes a real difference
		2291	for the EV and Perl backends only.
2131		2292
2132	=head3 Explanation of the columns	2293	=head3 Explanation of the columns
2133		2294
2134	I<sockets> is the number of sockets, and twice the number of "servers" (as	2295	I<sockets> is the number of sockets, and twice the number of "servers" (as
2135	each server has a read and write socket end).	2296	each server has a read and write socket end).
…		…
2143	a new one that moves the timeout into the future.	2304	a new one that moves the timeout into the future.
2144		2305
2145	=head3 Results	2306	=head3 Results
2146		2307
2147	name sockets create request	2308	name sockets create request
2148	EV 20000 69.01 11.16	2309	EV 20000 62.66 7.99
2149	Perl 20000 73.32 35.87	2310	Perl 20000 68.32 32.64
2150	IOAsync 20000 157.00 98.14 epoll	2311	IOAsync 20000 174.06 101.15 epoll
2151	IOAsync 20000 159.31 616.06 poll	2312	IOAsync 20000 174.67 610.84 poll
2152	Event 20000 212.62 257.32	2313	Event 20000 202.69 242.91
2153	Glib 20000 651.16 1896.30	2314	Glib 20000 557.01 1689.52
2154	POE 20000 349.67 12317.24 uses POE::Loop::Event	2315	POE 20000 341.54 12086.32 uses POE::Loop::Event
2155		2316
2156	=head3 Discussion	2317	=head3 Discussion
2157		2318
2158	This benchmark I<does> measure scalability and overall performance of the	2319	This benchmark I<does> measure scalability and overall performance of the
2159	particular event loop.	2320	particular event loop.
…		…
2285	As you can see, the AnyEvent + EV combination even beats the	2446	As you can see, the AnyEvent + EV combination even beats the
2286	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2447	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2287	backend easily beats IO::Lambda and POE.	2448	backend easily beats IO::Lambda and POE.
2288		2449
2289	And even the 100% non-blocking version written using the high-level (and	2450	And even the 100% non-blocking version written using the high-level (and
2290	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2451	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2291	large margin, even though it does all of DNS, tcp-connect and socket I/O	2452	higher level ("unoptimised") abstractions by a large margin, even though
2292	in a non-blocking way.	2453	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2293		2454
2294	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2455	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2295	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2456	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2296	part of the IO::lambda distribution and were used without any changes.	2457	part of the IO::Lambda distribution and were used without any changes.
2297		2458
2298		2459
2299	=head1 SIGNALS	2460	=head1 SIGNALS
2300		2461
2301	AnyEvent currently installs handlers for these signals:	2462	AnyEvent currently installs handlers for these signals:
…		…
2343	it's built-in modules) are required to use it.	2504	it's built-in modules) are required to use it.
2344		2505
2345	That does not mean that AnyEvent won't take advantage of some additional	2506	That does not mean that AnyEvent won't take advantage of some additional
2346	modules if they are installed.	2507	modules if they are installed.
2347		2508
2348	This section epxlains which additional modules will be used, and how they	2509	This section explains which additional modules will be used, and how they
2349	affect AnyEvent's operetion.	2510	affect AnyEvent's operation.
2350		2511
2351	=over 4	2512	=over 4
2352		2513
2353	=item L<Async::Interrupt>	2514	=item L<Async::Interrupt>
2354		2515
…		…
2359	catch the signals) with some delay (default is 10 seconds, look for	2520	catch the signals) with some delay (default is 10 seconds, look for
2360	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2521	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2361		2522
2362	If this module is available, then it will be used to implement signal	2523	If this module is available, then it will be used to implement signal
2363	catching, which means that signals will not be delayed, and the event loop	2524	catching, which means that signals will not be delayed, and the event loop
2364	will not be interrupted regularly, which is more efficient (And good for	2525	will not be interrupted regularly, which is more efficient (and good for
2365	battery life on laptops).	2526	battery life on laptops).
2366		2527
2367	This affects not just the pure-perl event loop, but also other event loops	2528	This affects not just the pure-perl event loop, but also other event loops
2368	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2529	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2369		2530
…		…
2381	automatic timer adjustments even when no monotonic clock is available,	2542	automatic timer adjustments even when no monotonic clock is available,
2382	can take avdantage of advanced kernel interfaces such as C<epoll> and	2543	can take avdantage of advanced kernel interfaces such as C<epoll> and
2383	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2544	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2384	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2545	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2385		2546
		2547	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2548	then this module will do nothing for you.
		2549
2386	=item L<Guard>	2550	=item L<Guard>
2387		2551
2388	The guard module, when used, will be used to implement	2552	The guard module, when used, will be used to implement
2389	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2553	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2390	lot less memory), but otherwise doesn't affect guard operation much. It is	2554	lot less memory), but otherwise doesn't affect guard operation much. It is
2391	purely used for performance.	2555	purely used for performance.
2392		2556
2393	=item L<JSON> and L<JSON::XS>	2557	=item L<JSON> and L<JSON::XS>
2394		2558
2395	This module is required when you want to read or write JSON data via	2559	One of these modules is required when you want to read or write JSON data
2396	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2560	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2397	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2561	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2398
2399	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2400	installed.
2401		2562
2402	=item L<Net::SSLeay>	2563	=item L<Net::SSLeay>
2403		2564
2404	Implementing TLS/SSL in Perl is certainly interesting, but not very	2565	Implementing TLS/SSL in Perl is certainly interesting, but not very
2405	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2566	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
…		…
2416		2577
2417		2578
2418	=head1 FORK	2579	=head1 FORK
2419		2580
2420	Most event libraries are not fork-safe. The ones who are usually are	2581	Most event libraries are not fork-safe. The ones who are usually are
2421	because they rely on inefficient but fork-safe C<select> or C<poll>	2582	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2422	calls. Only L<EV> is fully fork-aware.	2583	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2584	are usually badly thought-out hacks that are incompatible with fork in
		2585	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2586	continue event-processing in both parent and child (or both, if you know
		2587	what you are doing).
		2588
		2589	This means that, in general, you cannot fork and do event processing in
		2590	the child if the event library was initialised before the fork (which
		2591	usually happens when the first AnyEvent watcher is created, or the library
		2592	is loaded).
2423		2593
2424	If you have to fork, you must either do so I<before> creating your first	2594	If you have to fork, you must either do so I<before> creating your first
2425	watcher OR you must not use AnyEvent at all in the child OR you must do	2595	watcher OR you must not use AnyEvent at all in the child OR you must do
2426	something completely out of the scope of AnyEvent.	2596	something completely out of the scope of AnyEvent.
		2597
		2598	The problem of doing event processing in the parent I<and> the child
		2599	is much more complicated: even for backends that I<are> fork-aware or
		2600	fork-safe, their behaviour is not usually what you want: fork clones all
		2601	watchers, that means all timers, I/O watchers etc. are active in both
		2602	parent and child, which is almost never what you want. USing C<exec>
		2603	to start worker children from some kind of manage rprocess is usually
		2604	preferred, because it is much easier and cleaner, at the expense of having
		2605	to have another binary.
2427		2606
2428		2607
2429	=head1 SECURITY CONSIDERATIONS	2608	=head1 SECURITY CONSIDERATIONS
2430		2609
2431	AnyEvent can be forced to load any event model via	2610	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.265 by root, Wed Jul 29 13:10:58 2009 UTC vs. Revision 1.317 by root, Wed Mar 24 21:22:57 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.265 by root, Wed Jul 29 13:10:58 2009 UTC vs.
Revision 1.317 by root, Wed Mar 24 21:22:57 2010 UTC