[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.315 by root, Sat Mar 13 00:08:08 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
…		…
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 }
…		…
1292		1418
1293	our $HAVE_ASYNC_INTERRUPT;	1419	our $HAVE_ASYNC_INTERRUPT;
1294		1420
1295	sub _have_async_interrupt() {	1421	sub _have_async_interrupt() {
1296	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}	1422	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1297	&& eval "use Async::Interrupt 1.0 (); 1")	1423	&& eval "use Async::Interrupt 1.02 (); 1")
1298	unless defined $HAVE_ASYNC_INTERRUPT;	1424	unless defined $HAVE_ASYNC_INTERRUPT;
1299		1425
1300	$HAVE_ASYNC_INTERRUPT	1426	$HAVE_ASYNC_INTERRUPT
1301	}	1427	}
1302		1428
1303	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1429	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1304	our (%SIG_ASY, %SIG_ASY_W);	1430	our (%SIG_ASY, %SIG_ASY_W);
1305	our ($SIG_COUNT, $SIG_TW);	1431	our ($SIG_COUNT, $SIG_TW);
1306		1432
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	1433	# install a dummy wakeup watcher to reduce signal catching latency
		1434	# used by Impls
1321	sub _sig_add() {	1435	sub _sig_add() {
1322	unless ($SIG_COUNT++) {	1436	unless ($SIG_COUNT++) {
1323	# try to align timer on a full-second boundary, if possible	1437	# try to align timer on a full-second boundary, if possible
1324	my $NOW = AnyEvent->now;	1438	my $NOW = AE::now;
1325		1439
1326	$SIG_TW = AnyEvent->timer (	1440	$SIG_TW = AE::timer
1327	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1441	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1328	interval => $MAX_SIGNAL_LATENCY,	1442	$MAX_SIGNAL_LATENCY,
1329	cb => sub { }, # just for the PERL_ASYNC_CHECK	1443	sub { } # just for the PERL_ASYNC_CHECK
1330	);	1444	;
1331	}	1445	}
1332	}	1446	}
1333		1447
1334	sub _sig_del {	1448	sub _sig_del {
1335	undef $SIG_TW	1449	undef $SIG_TW
…		…
1372	# probe for availability of Async::Interrupt	1486	# probe for availability of Async::Interrupt
1373	if (_have_async_interrupt) {	1487	if (_have_async_interrupt) {
1374	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1488	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1375		1489
1376	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1490	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1377	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);	1491	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1378		1492
1379	} else {	1493	} else {
1380	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1494	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1381
1382	require Fcntl;
1383		1495
1384	if (AnyEvent::WIN32) {	1496	if (AnyEvent::WIN32) {
1385	require AnyEvent::Util;	1497	require AnyEvent::Util;
1386		1498
1387	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1499	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1388	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1500	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1389	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1501	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1390	} else {	1502	} else {
1391	pipe $SIGPIPE_R, $SIGPIPE_W;	1503	pipe $SIGPIPE_R, $SIGPIPE_W;
1392	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1504	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	1505	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1394		1506
1395	# not strictly required, as $^F is normally 2, but let's make sure...	1507	# not strictly required, as $^F is normally 2, but let's make sure...
1396	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1508	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1397	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1509	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1398	}	1510	}
1399		1511
1400	$SIGPIPE_R	1512	$SIGPIPE_R
1401	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1513	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1402		1514
1403	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);	1515	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1404	}	1516	}
1405		1517
1406	*signal = sub {	1518	*signal = sub {
1407	my (undef, %arg) = @_;	1519	my (undef, %arg) = @_;
1408		1520
…		…
1456	# print weird messages, or just unconditionally exit	1568	# print weird messages, or just unconditionally exit
1457	# instead of getting the default action.	1569	# instead of getting the default action.
1458	undef $SIG{$signal}	1570	undef $SIG{$signal}
1459	unless keys %{ $SIG_CB{$signal} };	1571	unless keys %{ $SIG_CB{$signal} };
1460	};	1572	};
		1573
		1574	*_signal_exec = sub {
		1575	$HAVE_ASYNC_INTERRUPT
		1576	? $SIGPIPE_R->drain
		1577	: sysread $SIGPIPE_R, (my $dummy), 9;
		1578
		1579	while (%SIG_EV) {
		1580	for (keys %SIG_EV) {
		1581	delete $SIG_EV{$_};
		1582	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1583	}
		1584	}
		1585	};
1461	};	1586	};
1462	die if $@;	1587	die if $@;
		1588
1463	&signal	1589	&signal
1464	}	1590	}
1465		1591
1466	# default implementation for ->child	1592	# default implementation for ->child
1467		1593
1468	our %PID_CB;	1594	our %PID_CB;
1469	our $CHLD_W;	1595	our $CHLD_W;
1470	our $CHLD_DELAY_W;	1596	our $CHLD_DELAY_W;
1471	our $WNOHANG;	1597	our $WNOHANG;
1472		1598
		1599	# used by many Impl's
1473	sub _emit_childstatus($$) {	1600	sub _emit_childstatus($$) {
1474	my (undef, $rpid, $rstatus) = @_;	1601	my (undef, $rpid, $rstatus) = @_;
1475		1602
1476	$_->($rpid, $rstatus)	1603	$_->($rpid, $rstatus)
1477	for values %{ $PID_CB{$rpid} \|\| {} },	1604	for values %{ $PID_CB{$rpid} \|\| {} },
1478	values %{ $PID_CB{0} \|\| {} };	1605	values %{ $PID_CB{0} \|\| {} };
1479	}	1606	}
1480		1607
1481	sub _sigchld {
1482	my $pid;
1483
1484	AnyEvent->_emit_childstatus ($pid, $?)
1485	while ($pid = waitpid -1, $WNOHANG) > 0;
1486	}
1487
1488	sub child {	1608	sub child {
		1609	eval q{ # poor man's autoloading {}
		1610	*_sigchld = sub {
		1611	my $pid;
		1612
		1613	AnyEvent->_emit_childstatus ($pid, $?)
		1614	while ($pid = waitpid -1, $WNOHANG) > 0;
		1615	};
		1616
		1617	*child = sub {
1489	my (undef, %arg) = @_;	1618	my (undef, %arg) = @_;
1490		1619
1491	defined (my $pid = $arg{pid} + 0)	1620	defined (my $pid = $arg{pid} + 0)
1492	or Carp::croak "required option 'pid' is missing";	1621	or Carp::croak "required option 'pid' is missing";
1493		1622
1494	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1623	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1495		1624
1496	# WNOHANG is almost cetrainly 1 everywhere	1625	# WNOHANG is almost cetrainly 1 everywhere
1497	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1626	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1498	? 1	1627	? 1
1499	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1628	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1500		1629
1501	unless ($CHLD_W) {	1630	unless ($CHLD_W) {
1502	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1631	$CHLD_W = AE::signal CHLD => \&_sigchld;
1503	# child could be a zombie already, so make at least one round	1632	# child could be a zombie already, so make at least one round
1504	&_sigchld;	1633	&_sigchld;
1505	}	1634	}
1506		1635
1507	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1636	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1508	}	1637	};
1509		1638
1510	sub AnyEvent::Base::child::DESTROY {	1639	*AnyEvent::Base::child::DESTROY = sub {
1511	my ($pid, $cb) = @{$_[0]};	1640	my ($pid, $cb) = @{$_[0]};
1512		1641
1513	delete $PID_CB{$pid}{$cb};	1642	delete $PID_CB{$pid}{$cb};
1514	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1643	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1515		1644
1516	undef $CHLD_W unless keys %PID_CB;	1645	undef $CHLD_W unless keys %PID_CB;
		1646	};
		1647	};
		1648	die if $@;
		1649
		1650	&child
1517	}	1651	}
1518		1652
1519	# idle emulation is done by simply using a timer, regardless	1653	# idle emulation is done by simply using a timer, regardless
1520	# of whether the process is idle or not, and not letting	1654	# of whether the process is idle or not, and not letting
1521	# the callback use more than 50% of the time.	1655	# the callback use more than 50% of the time.
1522	sub idle {	1656	sub idle {
		1657	eval q{ # poor man's autoloading {}
		1658	*idle = sub {
1523	my (undef, %arg) = @_;	1659	my (undef, %arg) = @_;
1524		1660
1525	my ($cb, $w, $rcb) = $arg{cb};	1661	my ($cb, $w, $rcb) = $arg{cb};
1526		1662
1527	$rcb = sub {	1663	$rcb = sub {
1528	if ($cb) {	1664	if ($cb) {
1529	$w = _time;	1665	$w = _time;
1530	&$cb;	1666	&$cb;
1531	$w = _time - $w;	1667	$w = _time - $w;
1532		1668
1533	# never use more then 50% of the time for the idle watcher,	1669	# never use more then 50% of the time for the idle watcher,
1534	# within some limits	1670	# within some limits
1535	$w = 0.0001 if $w < 0.0001;	1671	$w = 0.0001 if $w < 0.0001;
1536	$w = 5 if $w > 5;	1672	$w = 5 if $w > 5;
1537		1673
1538	$w = AnyEvent->timer (after => $w, cb => $rcb);	1674	$w = AE::timer $w, 0, $rcb;
1539	} else {	1675	} else {
1540	# clean up...	1676	# clean up...
1541	undef $w;	1677	undef $w;
1542	undef $rcb;	1678	undef $rcb;
		1679	}
		1680	};
		1681
		1682	$w = AE::timer 0.05, 0, $rcb;
		1683
		1684	bless \\$cb, "AnyEvent::Base::idle"
1543	}	1685	};
		1686
		1687	*AnyEvent::Base::idle::DESTROY = sub {
		1688	undef $${$_[0]};
		1689	};
1544	};	1690	};
		1691	die if $@;
1545		1692
1546	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1693	&idle
1547
1548	bless \\$cb, "AnyEvent::Base::idle"
1549	}
1550
1551	sub AnyEvent::Base::idle::DESTROY {
1552	undef $${$_[0]};
1553	}	1694	}
1554		1695
1555	package AnyEvent::CondVar;	1696	package AnyEvent::CondVar;
1556		1697
1557	our @ISA = AnyEvent::CondVar::Base::;	1698	our @ISA = AnyEvent::CondVar::Base::;
…		…
1605	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1746	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1606	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1747	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1607	}	1748	}
1608		1749
1609	sub cb {	1750	sub cb {
1610	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1751	my $cv = shift;
		1752
		1753	@_
		1754	and $cv->{_ae_cb} = shift
		1755	and $cv->{_ae_sent}
		1756	and (delete $cv->{_ae_cb})->($cv);
		1757
1611	$_[0]{_ae_cb}	1758	$cv->{_ae_cb}
1612	}	1759	}
1613		1760
1614	sub begin {	1761	sub begin {
1615	++$_[0]{_ae_counter};	1762	++$_[0]{_ae_counter};
1616	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1763	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1825	warn "read: $input\n"; # output what has been read	1972	warn "read: $input\n"; # output what has been read
1826	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1973	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1827	},	1974	},
1828	);	1975	);
1829		1976
1830	my $time_watcher; # can only be used once
1831
1832	sub new_timer {
1833	$timer = AnyEvent->timer (after => 1, cb => sub {	1977	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1834	warn "timeout\n"; # print 'timeout' about every second	1978	warn "timeout\n"; # print 'timeout' at most every second
1835	&new_timer; # and restart the time
1836	});	1979	});
1837	}
1838
1839	new_timer; # create first timer
1840		1980
1841	$cv->recv; # wait until user enters /^q/i	1981	$cv->recv; # wait until user enters /^q/i
1842		1982
1843	=head1 REAL-WORLD EXAMPLE	1983	=head1 REAL-WORLD EXAMPLE
1844		1984
…		…
1975	through AnyEvent. The benchmark creates a lot of timers (with a zero	2115	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,	2116	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.	2117	which it is), lets them fire exactly once and destroys them again.
1978		2118
1979	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2119	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1980	distribution.	2120	distribution. It uses the L<AE> interface, which makes a real difference
		2121	for the EV and Perl backends only.
1981		2122
1982	=head3 Explanation of the columns	2123	=head3 Explanation of the columns
1983		2124
1984	I<watcher> is the number of event watchers created/destroyed. Since	2125	I<watcher> is the number of event watchers created/destroyed. Since
1985	different event models feature vastly different performances, each event	2126	different event models feature vastly different performances, each event
…		…
2006	watcher.	2147	watcher.
2007		2148
2008	=head3 Results	2149	=head3 Results
2009		2150
2010	name watchers bytes create invoke destroy comment	2151	name watchers bytes create invoke destroy comment
2011	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2152	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	2153	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	2154	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	2155	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	2156	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	2157	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	2158	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	2159	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	2160	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	2161	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	2162	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	2163	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2023		2164
2024	=head3 Discussion	2165	=head3 Discussion
2025		2166
2026	The benchmark does I<not> measure scalability of the event loop very	2167	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)	2168	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	2180	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	2181	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2041	cycles with POE.	2182	cycles with POE.
2042		2183
2043	C<EV> is the sole leader regarding speed and memory use, which are both	2184	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	2185	maximal/minimal, respectively. When using the L<AE> API there is zero
		2186	overhead (when going through the AnyEvent API create is about 5-6 times
		2187	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	2188	any other event loop and is still faster than Event natively).
2046	natively.
2047		2189
2048	The pure perl implementation is hit in a few sweet spots (both the	2190	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	2191	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	2192	interpreter and the backend itself). Nevertheless this shows that it
2051	adds very little overhead in itself. Like any select-based backend its	2193	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	2267	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	2268	(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.	2269	connections, most of which are idle at any one point in time.
2128		2270
2129	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2271	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2130	distribution.	2272	distribution. It uses the L<AE> interface, which makes a real difference
		2273	for the EV and Perl backends only.
2131		2274
2132	=head3 Explanation of the columns	2275	=head3 Explanation of the columns
2133		2276
2134	I<sockets> is the number of sockets, and twice the number of "servers" (as	2277	I<sockets> is the number of sockets, and twice the number of "servers" (as
2135	each server has a read and write socket end).	2278	each server has a read and write socket end).
…		…
2143	a new one that moves the timeout into the future.	2286	a new one that moves the timeout into the future.
2144		2287
2145	=head3 Results	2288	=head3 Results
2146		2289
2147	name sockets create request	2290	name sockets create request
2148	EV 20000 69.01 11.16	2291	EV 20000 62.66 7.99
2149	Perl 20000 73.32 35.87	2292	Perl 20000 68.32 32.64
2150	IOAsync 20000 157.00 98.14 epoll	2293	IOAsync 20000 174.06 101.15 epoll
2151	IOAsync 20000 159.31 616.06 poll	2294	IOAsync 20000 174.67 610.84 poll
2152	Event 20000 212.62 257.32	2295	Event 20000 202.69 242.91
2153	Glib 20000 651.16 1896.30	2296	Glib 20000 557.01 1689.52
2154	POE 20000 349.67 12317.24 uses POE::Loop::Event	2297	POE 20000 341.54 12086.32 uses POE::Loop::Event
2155		2298
2156	=head3 Discussion	2299	=head3 Discussion
2157		2300
2158	This benchmark I<does> measure scalability and overall performance of the	2301	This benchmark I<does> measure scalability and overall performance of the
2159	particular event loop.	2302	particular event loop.
…		…
2285	As you can see, the AnyEvent + EV combination even beats the	2428	As you can see, the AnyEvent + EV combination even beats the
2286	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2429	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2287	backend easily beats IO::Lambda and POE.	2430	backend easily beats IO::Lambda and POE.
2288		2431
2289	And even the 100% non-blocking version written using the high-level (and	2432	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	2433	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	2434	higher level ("unoptimised") abstractions by a large margin, even though
2292	in a non-blocking way.	2435	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2293		2436
2294	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2437	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	2438	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.	2439	part of the IO::Lambda distribution and were used without any changes.
2297		2440
2298		2441
2299	=head1 SIGNALS	2442	=head1 SIGNALS
2300		2443
2301	AnyEvent currently installs handlers for these signals:	2444	AnyEvent currently installs handlers for these signals:
…		…
2343	it's built-in modules) are required to use it.	2486	it's built-in modules) are required to use it.
2344		2487
2345	That does not mean that AnyEvent won't take advantage of some additional	2488	That does not mean that AnyEvent won't take advantage of some additional
2346	modules if they are installed.	2489	modules if they are installed.
2347		2490
2348	This section epxlains which additional modules will be used, and how they	2491	This section explains which additional modules will be used, and how they
2349	affect AnyEvent's operetion.	2492	affect AnyEvent's operation.
2350		2493
2351	=over 4	2494	=over 4
2352		2495
2353	=item L<Async::Interrupt>	2496	=item L<Async::Interrupt>
2354		2497
…		…
2359	catch the signals) with some delay (default is 10 seconds, look for	2502	catch the signals) with some delay (default is 10 seconds, look for
2360	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2503	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2361		2504
2362	If this module is available, then it will be used to implement signal	2505	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	2506	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	2507	will not be interrupted regularly, which is more efficient (and good for
2365	battery life on laptops).	2508	battery life on laptops).
2366		2509
2367	This affects not just the pure-perl event loop, but also other event loops	2510	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).	2511	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2369		2512
…		…
2390	lot less memory), but otherwise doesn't affect guard operation much. It is	2533	lot less memory), but otherwise doesn't affect guard operation much. It is
2391	purely used for performance.	2534	purely used for performance.
2392		2535
2393	=item L<JSON> and L<JSON::XS>	2536	=item L<JSON> and L<JSON::XS>
2394		2537
2395	This module is required when you want to read or write JSON data via	2538	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	2539	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2397	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2540	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2398		2541
2399	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2542	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2400	installed.	2543	installed.
2401		2544
…		…
2416		2559
2417		2560
2418	=head1 FORK	2561	=head1 FORK
2419		2562
2420	Most event libraries are not fork-safe. The ones who are usually are	2563	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>	2564	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2422	calls. Only L<EV> is fully fork-aware.	2565	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2566	are usually badly thought-out hacks that are incompatible with fork in
		2567	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2568	continue event-processing in both parent and child (or both, if you know
		2569	what you are doing).
		2570
		2571	This means that, in general, you cannot fork and do event processing in
		2572	the child if the event library was initialised before the fork (which
		2573	usually happens when the first AnyEvent watcher is created, or the library
		2574	is loaded).
2423		2575
2424	If you have to fork, you must either do so I<before> creating your first	2576	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	2577	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.	2578	something completely out of the scope of AnyEvent.
		2579
		2580	The problem of doing event processing in the parent I<and> the child
		2581	is much more complicated: even for backends that I<are> fork-aware or
		2582	fork-safe, their behaviour is not usually what you want: fork clones all
		2583	watchers, that means all timers, I/O watchers etc. are active in both
		2584	parent and child, which is almost never what you want. USing C<exec>
		2585	to start worker children from some kind of manage rprocess is usually
		2586	preferred, because it is much easier and cleaner, at the expense of having
		2587	to have another binary.
2427		2588
2428		2589
2429	=head1 SECURITY CONSIDERATIONS	2590	=head1 SECURITY CONSIDERATIONS
2430		2591
2431	AnyEvent can be forced to load any event model via	2592	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.315 by root, Sat Mar 13 00:08:08 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.315 by root, Sat Mar 13 00:08:08 2010 UTC