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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.266 by root, Thu Jul 30 03:41:56 2009 UTC vs.
Revision 1.313 by root, Sun Feb 21 09:28:18 2010 UTC

…		…
363	might affect timers and time-outs.	363	might affect timers and time-outs.
364		364
365	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
366	event loop's idea of "current time".	366	event loop's idea of "current time".
367		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
368	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.
369		376
370	=back	377	=back
371		378
372	=head2 SIGNAL WATCHERS	379	=head2 SIGNAL WATCHERS
…		…
396		403
397	Example: exit on SIGINT	404	Example: exit on SIGINT
398		405
399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	406	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
400		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
401	=head3 Signal Races, Delays and Workarounds	425	=head3 Signal Races, Delays and Workarounds
402		426
403	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
404	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
405	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,
406	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
407	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	432	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
408	seconds). This variable can be changed only before the first signal	433	variable can be changed only before the first signal watcher is created,
409	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
410	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
411	saving. All these problems can be avoided by installing the optional	439	All these problems can be avoided by installing the optional
412	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
413	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>
414	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
415	those, you just have to suffer the delays.	443	one-second latency). For those, you just have to suffer the delays.
416		444
417	=head2 CHILD PROCESS WATCHERS	445	=head2 CHILD PROCESS WATCHERS
418		446
419	$w = AnyEvent->child (pid => <process id>, cb => <callback>);	447	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
420		448
…		…
475		503
476	=head2 IDLE WATCHERS	504	=head2 IDLE WATCHERS
477		505
478	$w = AnyEvent->idle (cb => <callback>);	506	$w = AnyEvent->idle (cb => <callback>);
479		507
480	Sometimes there is a need to do something, but it is not so important	508	Repeatedly invoke the callback after the process becomes idle, until
481	to do it instantly, but only when there is nothing better to do. This	509	either the watcher is destroyed or new events have been detected.
482	"nothing better to do" is usually defined to be "no other events need
483	attention by the event loop".
484		510
485	Idle watchers ideally get invoked when the event loop has nothing	511	Idle watchers are useful when there is a need to do something, but it
486	better to do, just before it would block the process to wait for new	512	is not so important (or wise) to do it instantly. The callback will be
487	events. Instead of blocking, the idle watcher is invoked.	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.
488		519
489	Most event loops unfortunately do not really support idle watchers (only	520	Unfortunately, most event loops do not really support idle watchers (only
490	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	521	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
491	will simply call the callback "from time to time".	522	will simply call the callback "from time to time".
492		523
493	Example: read lines from STDIN, but only process them when the	524	Example: read lines from STDIN, but only process them when the
494	program is otherwise idle:	525	program is otherwise idle:
…		…
588	after => 1,	619	after => 1,
589	cb => sub { $result_ready->send },	620	cb => sub { $result_ready->send },
590	);	621	);
591		622
592	# this "blocks" (while handling events) till the callback	623	# this "blocks" (while handling events) till the callback
593	# calls -<send	624	# calls ->send
594	$result_ready->recv;	625	$result_ready->recv;
595		626
596	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
597	variables are also callable directly.	628	variables are also callable directly.
598		629
…		…
662	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
663	to use a condition variable for the whole process.	694	to use a condition variable for the whole process.
664		695
665	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
666	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
667	>>, 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
668	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
669	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.
670		702
671	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
672	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
673	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).
674		706
…		…
701	begung can potentially be zero:	733	begung can potentially be zero:
702		734
703	my $cv = AnyEvent->condvar;	735	my $cv = AnyEvent->condvar;
704		736
705	my %result;	737	my %result;
706	$cv->begin (sub { $cv->send (\%result) });	738	$cv->begin (sub { shift->send (\%result) });
707		739
708	for my $host (@list_of_hosts) {	740	for my $host (@list_of_hosts) {
709	$cv->begin;	741	$cv->begin;
710	ping_host_then_call_callback $host, sub {	742	ping_host_then_call_callback $host, sub {
711	$result{$host} = ...;	743	$result{$host} = ...;
…		…
786	=item $cb = $cv->cb ($cb->($cv))	818	=item $cb = $cv->cb ($cb->($cv))
787		819
788	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
789	replaces it before doing so.	821	replaces it before doing so.
790		822
791	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)
792	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
793	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>
794	is guaranteed not to block.	826	inside the callback or at any later time is guaranteed not to block.
795		827
796	=back	828	=back
797		829
798	=head1 SUPPORTED EVENT LOOPS/BACKENDS	830	=head1 SUPPORTED EVENT LOOPS/BACKENDS
799		831
…		…
802	=over 4	834	=over 4
803		835
804	=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.
805		837
806	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
807	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
808	that, will fall back to its own pure-perl implementation, which is	840	pure-perl implementation, which is available everywhere as it comes with
809	available everywhere as it comes with AnyEvent itself.	841	AnyEvent itself.
810		842
811	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	843	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
812	AnyEvent::Impl::Event based on Event, very stable, few glitches.
813	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	844	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
814		845
815	=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.
816		847
817	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
818	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
819	them. This means that AnyEvent will automatically pick the right backend	850	them. This means that AnyEvent will automatically pick the right backend
820	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
821	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.
822		853
		854	AnyEvent::Impl::Event based on Event, very stable, few glitches.
823	AnyEvent::Impl::Glib based on Glib, slow but very stable.	855	AnyEvent::Impl::Glib based on Glib, slow but very stable.
824	AnyEvent::Impl::Tk based on Tk, very broken.	856	AnyEvent::Impl::Tk based on Tk, very broken.
825	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	857	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
826	AnyEvent::Impl::POE based on POE, very slow, some limitations.	858	AnyEvent::Impl::POE based on POE, very slow, some limitations.
827	AnyEvent::Impl::Irssi used when running within irssi.	859	AnyEvent::Impl::Irssi used when running within irssi.
…		…
937	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:
938	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
939	array will be ignored.	971	array will be ignored.
940		972
941	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	973	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
942	it,as it takes care of these details.	974	it, as it takes care of these details.
943		975
944	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
945	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
946	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
947	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	}
948		993
949	=back	994	=back
950		995
951	=head1 WHAT TO DO IN A MODULE	996	=head1 WHAT TO DO IN A MODULE
952		997
…		…
1101		1146
1102	package AnyEvent;	1147	package AnyEvent;
1103		1148
1104	# basically a tuned-down version of common::sense	1149	# basically a tuned-down version of common::sense
1105	sub common_sense {	1150	sub common_sense {
1106	# no warnings	1151	# from common:.sense 1.0
1107	${^WARNING_BITS} ^= ${^WARNING_BITS};	1152	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1108	# use strict vars subs	1153	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1109	$^H \|= 0x00000600;	1154	$^H \|= 0x00000600;
1110	}	1155	}
1111		1156
1112	BEGIN { AnyEvent::common_sense }	1157	BEGIN { AnyEvent::common_sense }
1113		1158
1114	use Carp ();	1159	use Carp ();
1115		1160
1116	our $VERSION = 4.881;	1161	our $VERSION = '5.24';
1117	our $MODEL;	1162	our $MODEL;
1118		1163
1119	our $AUTOLOAD;	1164	our $AUTOLOAD;
1120	our @ISA;	1165	our @ISA;
1121		1166
1122	our @REGISTRY;	1167	our @REGISTRY;
1123		1168
1124	our $WIN32;
1125
1126	our $VERBOSE;	1169	our $VERBOSE;
1127		1170
1128	BEGIN {	1171	BEGIN {
1129	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1172	require "AnyEvent/constants.pl";
		1173
1130	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1174	eval "sub TAINT (){" . (${^TAINT} *1) . "}";
1131		1175
1132	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1176	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1133	if ${^TAINT};	1177	if ${^TAINT};
1134		1178
1135	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1179	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1147	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1191	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1148	}	1192	}
1149		1193
1150	my @models = (	1194	my @models = (
1151	[EV:: => AnyEvent::Impl::EV:: , 1],	1195	[EV:: => AnyEvent::Impl::EV:: , 1],
1152	[Event:: => AnyEvent::Impl::Event::, 1],
1153	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1196	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1154	# everything below here will not (normally) be autoprobed	1197	# everything below here will not (normally) be autoprobed
1155	# as the pureperl backend should work everywhere	1198	# as the pureperl backend should work everywhere
1156	# and is usually faster	1199	# and is usually faster
		1200	[Event:: => AnyEvent::Impl::Event::, 1],
1157	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1201	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1158	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1202	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1159	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1203	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1160	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1204	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1161	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1205	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
…		…
1164	[Prima:: => AnyEvent::Impl::POE::],	1208	[Prima:: => AnyEvent::Impl::POE::],
1165	# 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
1166	# byzantine signal and broken child handling, among others.	1210	# byzantine signal and broken child handling, among others.
1167	# 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
1168	# obvious default class.	1212	# obvious default class.
1169	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1213	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1170	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1214	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1171	# [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
1172	);	1217	);
1173		1218
1174	our %method = map +($_ => 1),	1219	our %method = map +($_ => 1),
1175	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);
1176		1221
…		…
1195	sub AnyEvent::Util::postdetect::DESTROY {	1240	sub AnyEvent::Util::postdetect::DESTROY {
1196	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1241	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1197	}	1242	}
1198		1243
1199	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
1200	unless ($MODEL) {	1262	unless ($MODEL) {
1201	local $SIG{__DIE__};	1263	for (@REGISTRY, @models) {
1202		1264	my ($package, $model) = @$_;
1203	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1265	if (${"$package\::VERSION"} > 0) {
1204	my $model = "AnyEvent::Impl::$1";
1205	if (eval "require $model") {	1266	if (eval "require $model") {
1206	$MODEL = $model;	1267	$MODEL = $model;
1207	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;
1208	} else {	1269	last;
1209	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1270	}
1210	}	1271	}
1211	}	1272	}
1212		1273
1213	# check for already loaded models
1214	unless ($MODEL) {	1274	unless ($MODEL) {
		1275	# try to autoload a model
1215	for (@REGISTRY, @models) {	1276	for (@REGISTRY, @models) {
1216	my ($package, $model) = @$_;	1277	my ($package, $model, $autoload) = @$_;
		1278	if (
		1279	$autoload
		1280	and eval "require $package"
1217	if (${"$package\::VERSION"} > 0) {	1281	and ${"$package\::VERSION"} > 0
1218	if (eval "require $model") {	1282	and eval "require $model"
		1283	) {
1219	$MODEL = $model;	1284	$MODEL = $model;
1220	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1285	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1221	last;	1286	last;
1222	}
1223	}	1287	}
1224	}	1288	}
1225		1289
1226	unless ($MODEL) {
1227	# try to autoload a model
1228	for (@REGISTRY, @models) {
1229	my ($package, $model, $autoload) = @$_;
1230	if (
1231	$autoload
1232	and eval "require $package"
1233	and ${"$package\::VERSION"} > 0
1234	and eval "require $model"
1235	) {
1236	$MODEL = $model;
1237	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1238	last;
1239	}
1240	}
1241
1242	$MODEL	1290	$MODEL
1243	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";
1244	}
1245	}	1292	}
1246
1247	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1248
1249	unshift @ISA, $MODEL;
1250
1251	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1252
1253	(shift @post_detect)->() while @post_detect;
1254	}	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;
1255		1303
1256	$MODEL	1304	$MODEL
1257	}	1305	}
1258		1306
1259	sub AUTOLOAD {	1307	sub AUTOLOAD {
1260	(my $func = $AUTOLOAD) =~ s/.*://;	1308	(my $func = $AUTOLOAD) =~ s/.*://;
1261		1309
1262	$method{$func}	1310	$method{$func}
1263	or Carp::croak "$func: not a valid method for AnyEvent objects";	1311	or Carp::croak "$func: not a valid AnyEvent class method";
1264		1312
1265	detect unless $MODEL;	1313	detect;
1266		1314
1267	my $class = shift;	1315	my $class = shift;
1268	$class->$func (@_);	1316	$class->$func (@_);
1269	}	1317	}
1270		1318
…		…
1283	# 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
1284		1332
1285	($fh2, $rw)	1333	($fh2, $rw)
1286	}	1334	}
1287		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
1288	package AnyEvent::Base;	1386	package AnyEvent::Base;
1289		1387
1290	# default implementations for many methods	1388	# default implementations for many methods
1291		1389
1292	sub _time {	1390	sub _time() {
		1391	eval q{ # poor man's autoloading
1293	# probe for availability of Time::HiRes	1392	# probe for availability of Time::HiRes
1294	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1393	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1295	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;
1296	*_time = \&Time::HiRes::time;	1395	*_time = \&Time::HiRes::time;
1297	# if (eval "use POSIX (); (POSIX::times())...	1396	# if (eval "use POSIX (); (POSIX::times())...
1298	} else {	1397	} else {
1299	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;
1300	*_time = sub { time }; # epic fail	1399	*_time = sub (){ time }; # epic fail
		1400	}
1301	}	1401	};
		1402	die if $@;
1302		1403
1303	&_time	1404	&_time
1304	}	1405	}
1305		1406
1306	sub time { _time }	1407	sub time { _time }
…		…
1317		1418
1318	our $HAVE_ASYNC_INTERRUPT;	1419	our $HAVE_ASYNC_INTERRUPT;
1319		1420
1320	sub _have_async_interrupt() {	1421	sub _have_async_interrupt() {
1321	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}	1422	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1322	&& eval "use Async::Interrupt 1.0 (); 1")	1423	&& eval "use Async::Interrupt 1.02 (); 1")
1323	unless defined $HAVE_ASYNC_INTERRUPT;	1424	unless defined $HAVE_ASYNC_INTERRUPT;
1324		1425
1325	$HAVE_ASYNC_INTERRUPT	1426	$HAVE_ASYNC_INTERRUPT
1326	}	1427	}
1327		1428
1328	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1429	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1329	our (%SIG_ASY, %SIG_ASY_W);	1430	our (%SIG_ASY, %SIG_ASY_W);
1330	our ($SIG_COUNT, $SIG_TW);	1431	our ($SIG_COUNT, $SIG_TW);
1331		1432
1332	sub _signal_exec {
1333	$HAVE_ASYNC_INTERRUPT
1334	? $SIGPIPE_R->drain
1335	: sysread $SIGPIPE_R, my $dummy, 9;
1336
1337	while (%SIG_EV) {
1338	for (keys %SIG_EV) {
1339	delete $SIG_EV{$_};
1340	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1341	}
1342	}
1343	}
1344
1345	# install a dummy wakeup watcher to reduce signal catching latency	1433	# install a dummy wakeup watcher to reduce signal catching latency
		1434	# used by Impls
1346	sub _sig_add() {	1435	sub _sig_add() {
1347	unless ($SIG_COUNT++) {	1436	unless ($SIG_COUNT++) {
1348	# try to align timer on a full-second boundary, if possible	1437	# try to align timer on a full-second boundary, if possible
1349	my $NOW = AnyEvent->now;	1438	my $NOW = AE::now;
1350		1439
1351	$SIG_TW = AnyEvent->timer (	1440	$SIG_TW = AE::timer
1352	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1441	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1353	interval => $MAX_SIGNAL_LATENCY,	1442	$MAX_SIGNAL_LATENCY,
1354	cb => sub { }, # just for the PERL_ASYNC_CHECK	1443	sub { } # just for the PERL_ASYNC_CHECK
1355	);	1444	;
1356	}	1445	}
1357	}	1446	}
1358		1447
1359	sub _sig_del {	1448	sub _sig_del {
1360	undef $SIG_TW	1449	undef $SIG_TW
…		…
1397	# probe for availability of Async::Interrupt	1486	# probe for availability of Async::Interrupt
1398	if (_have_async_interrupt) {	1487	if (_have_async_interrupt) {
1399	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;
1400		1489
1401	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1490	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1402	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);	1491	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1403		1492
1404	} else {	1493	} else {
1405	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;
1406
1407	require Fcntl;
1408		1495
1409	if (AnyEvent::WIN32) {	1496	if (AnyEvent::WIN32) {
1410	require AnyEvent::Util;	1497	require AnyEvent::Util;
1411		1498
1412	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1499	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1413	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1500	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1414	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
1415	} else {	1502	} else {
1416	pipe $SIGPIPE_R, $SIGPIPE_W;	1503	pipe $SIGPIPE_R, $SIGPIPE_W;
1417	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;
1418	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
1419		1506
1420	# 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...
1421	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1508	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1422	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1509	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1423	}	1510	}
1424		1511
1425	$SIGPIPE_R	1512	$SIGPIPE_R
1426	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";
1427		1514
1428	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);	1515	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1429	}	1516	}
1430		1517
1431	*signal = sub {	1518	*signal = sub {
1432	my (undef, %arg) = @_;	1519	my (undef, %arg) = @_;
1433		1520
…		…
1481	# print weird messages, or just unconditionally exit	1568	# print weird messages, or just unconditionally exit
1482	# instead of getting the default action.	1569	# instead of getting the default action.
1483	undef $SIG{$signal}	1570	undef $SIG{$signal}
1484	unless keys %{ $SIG_CB{$signal} };	1571	unless keys %{ $SIG_CB{$signal} };
1485	};	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	};
1486	};	1586	};
1487	die if $@;	1587	die if $@;
		1588
1488	&signal	1589	&signal
1489	}	1590	}
1490		1591
1491	# default implementation for ->child	1592	# default implementation for ->child
1492		1593
1493	our %PID_CB;	1594	our %PID_CB;
1494	our $CHLD_W;	1595	our $CHLD_W;
1495	our $CHLD_DELAY_W;	1596	our $CHLD_DELAY_W;
1496	our $WNOHANG;	1597	our $WNOHANG;
1497		1598
		1599	# used by many Impl's
1498	sub _emit_childstatus($$) {	1600	sub _emit_childstatus($$) {
1499	my (undef, $rpid, $rstatus) = @_;	1601	my (undef, $rpid, $rstatus) = @_;
1500		1602
1501	$_->($rpid, $rstatus)	1603	$_->($rpid, $rstatus)
1502	for values %{ $PID_CB{$rpid} \|\| {} },	1604	for values %{ $PID_CB{$rpid} \|\| {} },
1503	values %{ $PID_CB{0} \|\| {} };	1605	values %{ $PID_CB{0} \|\| {} };
1504	}	1606	}
1505		1607
1506	sub _sigchld {
1507	my $pid;
1508
1509	AnyEvent->_emit_childstatus ($pid, $?)
1510	while ($pid = waitpid -1, $WNOHANG) > 0;
1511	}
1512
1513	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 {
1514	my (undef, %arg) = @_;	1618	my (undef, %arg) = @_;
1515		1619
1516	defined (my $pid = $arg{pid} + 0)	1620	defined (my $pid = $arg{pid} + 0)
1517	or Carp::croak "required option 'pid' is missing";	1621	or Carp::croak "required option 'pid' is missing";
1518		1622
1519	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1623	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1520		1624
1521	# WNOHANG is almost cetrainly 1 everywhere	1625	# WNOHANG is almost cetrainly 1 everywhere
1522	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1626	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1523	? 1	1627	? 1
1524	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1628	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1525		1629
1526	unless ($CHLD_W) {	1630	unless ($CHLD_W) {
1527	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1631	$CHLD_W = AE::signal CHLD => \&_sigchld;
1528	# 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
1529	&_sigchld;	1633	&_sigchld;
1530	}	1634	}
1531		1635
1532	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1636	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1533	}	1637	};
1534		1638
1535	sub AnyEvent::Base::child::DESTROY {	1639	*AnyEvent::Base::child::DESTROY = sub {
1536	my ($pid, $cb) = @{$_[0]};	1640	my ($pid, $cb) = @{$_[0]};
1537		1641
1538	delete $PID_CB{$pid}{$cb};	1642	delete $PID_CB{$pid}{$cb};
1539	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1643	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1540		1644
1541	undef $CHLD_W unless keys %PID_CB;	1645	undef $CHLD_W unless keys %PID_CB;
		1646	};
		1647	};
		1648	die if $@;
		1649
		1650	&child
1542	}	1651	}
1543		1652
1544	# idle emulation is done by simply using a timer, regardless	1653	# idle emulation is done by simply using a timer, regardless
1545	# of whether the process is idle or not, and not letting	1654	# of whether the process is idle or not, and not letting
1546	# the callback use more than 50% of the time.	1655	# the callback use more than 50% of the time.
1547	sub idle {	1656	sub idle {
		1657	eval q{ # poor man's autoloading {}
		1658	*idle = sub {
1548	my (undef, %arg) = @_;	1659	my (undef, %arg) = @_;
1549		1660
1550	my ($cb, $w, $rcb) = $arg{cb};	1661	my ($cb, $w, $rcb) = $arg{cb};
1551		1662
1552	$rcb = sub {	1663	$rcb = sub {
1553	if ($cb) {	1664	if ($cb) {
1554	$w = _time;	1665	$w = _time;
1555	&$cb;	1666	&$cb;
1556	$w = _time - $w;	1667	$w = _time - $w;
1557		1668
1558	# 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,
1559	# within some limits	1670	# within some limits
1560	$w = 0.0001 if $w < 0.0001;	1671	$w = 0.0001 if $w < 0.0001;
1561	$w = 5 if $w > 5;	1672	$w = 5 if $w > 5;
1562		1673
1563	$w = AnyEvent->timer (after => $w, cb => $rcb);	1674	$w = AE::timer $w, 0, $rcb;
1564	} else {	1675	} else {
1565	# clean up...	1676	# clean up...
1566	undef $w;	1677	undef $w;
1567	undef $rcb;	1678	undef $rcb;
		1679	}
		1680	};
		1681
		1682	$w = AE::timer 0.05, 0, $rcb;
		1683
		1684	bless \\$cb, "AnyEvent::Base::idle"
1568	}	1685	};
		1686
		1687	*AnyEvent::Base::idle::DESTROY = sub {
		1688	undef $${$_[0]};
		1689	};
1569	};	1690	};
		1691	die if $@;
1570		1692
1571	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1693	&idle
1572
1573	bless \\$cb, "AnyEvent::Base::idle"
1574	}
1575
1576	sub AnyEvent::Base::idle::DESTROY {
1577	undef $${$_[0]};
1578	}	1694	}
1579		1695
1580	package AnyEvent::CondVar;	1696	package AnyEvent::CondVar;
1581		1697
1582	our @ISA = AnyEvent::CondVar::Base::;	1698	our @ISA = AnyEvent::CondVar::Base::;
…		…
1630	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1746	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1631	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1747	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1632	}	1748	}
1633		1749
1634	sub cb {	1750	sub cb {
1635	$_[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
1636	$_[0]{_ae_cb}	1758	$cv->{_ae_cb}
1637	}	1759	}
1638		1760
1639	sub begin {	1761	sub begin {
1640	++$_[0]{_ae_counter};	1762	++$_[0]{_ae_counter};
1641	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1763	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1647	}	1769	}
1648		1770
1649	# undocumented/compatibility with pre-3.4	1771	# undocumented/compatibility with pre-3.4
1650	*broadcast = \&send;	1772	*broadcast = \&send;
1651	*wait = \&_wait;	1773	*wait = \&_wait;
1652
1653	#############################################################################
1654	# "new" API, currently only emulation of it
1655	#############################################################################
1656
1657	package AE;
1658
1659	sub io($$$) {
1660	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1661	}
1662
1663	sub timer($$$) {
1664	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
1665	}
1666
1667	sub signal($$) {
1668	AnyEvent->signal (signal => $_[0], cb => $_[1]);
1669	}
1670
1671	sub child($$) {
1672	AnyEvent->child (pid => $_[0], cb => $_[1]);
1673	}
1674
1675	sub idle($) {
1676	AnyEvent->idle (cb => $_[0]);
1677	}
1678
1679	sub cv() {
1680	AnyEvent->condvar
1681	}
1682
1683	sub now() {
1684	AnyEvent->now
1685	}
1686
1687	sub now_update() {
1688	AnyEvent->now_update
1689	}
1690
1691	sub time() {
1692	AnyEvent->time
1693	}
1694		1774
1695	=head1 ERROR AND EXCEPTION HANDLING	1775	=head1 ERROR AND EXCEPTION HANDLING
1696		1776
1697	In general, AnyEvent does not do any error handling - it relies on the	1777	In general, AnyEvent does not do any error handling - it relies on the
1698	caller to do that if required. The L<AnyEvent::Strict> module (see also	1778	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1892	warn "read: $input\n"; # output what has been read	1972	warn "read: $input\n"; # output what has been read
1893	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1973	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1894	},	1974	},
1895	);	1975	);
1896		1976
1897	my $time_watcher; # can only be used once
1898
1899	sub new_timer {
1900	$timer = AnyEvent->timer (after => 1, cb => sub {	1977	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1901	warn "timeout\n"; # print 'timeout' about every second	1978	warn "timeout\n"; # print 'timeout' at most every second
1902	&new_timer; # and restart the time
1903	});	1979	});
1904	}
1905
1906	new_timer; # create first timer
1907		1980
1908	$cv->recv; # wait until user enters /^q/i	1981	$cv->recv; # wait until user enters /^q/i
1909		1982
1910	=head1 REAL-WORLD EXAMPLE	1983	=head1 REAL-WORLD EXAMPLE
1911		1984
…		…
2042	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
2043	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,
2044	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.
2045		2118
2046	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
2047	distribution.	2120	distribution. It uses the L<AE> interface, which makes a real difference
		2121	for the EV and Perl backends only.
2048		2122
2049	=head3 Explanation of the columns	2123	=head3 Explanation of the columns
2050		2124
2051	I<watcher> is the number of event watchers created/destroyed. Since	2125	I<watcher> is the number of event watchers created/destroyed. Since
2052	different event models feature vastly different performances, each event	2126	different event models feature vastly different performances, each event
…		…
2073	watcher.	2147	watcher.
2074		2148
2075	=head3 Results	2149	=head3 Results
2076		2150
2077	name watchers bytes create invoke destroy comment	2151	name watchers bytes create invoke destroy comment
2078	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
2079	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
2080	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
2081	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
2082	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
2083	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
2084	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
2085	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
2086	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
2087	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
2088	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
2089	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
2090		2164
2091	=head3 Discussion	2165	=head3 Discussion
2092		2166
2093	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
2094	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)
…		…
2106	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2180	benchmark machine, handling an event takes roughly 1600 CPU cycles with
2107	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2181	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2108	cycles with POE.	2182	cycles with POE.
2109		2183
2110	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
2111	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
2112	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).
2113	natively.
2114		2189
2115	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
2116	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
2117	interpreter and the backend itself). Nevertheless this shows that it	2192	interpreter and the backend itself). Nevertheless this shows that it
2118	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
…		…
2192	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
2193	(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
2194	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.
2195		2270
2196	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
2197	distribution.	2272	distribution. It uses the L<AE> interface, which makes a real difference
		2273	for the EV and Perl backends only.
2198		2274
2199	=head3 Explanation of the columns	2275	=head3 Explanation of the columns
2200		2276
2201	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
2202	each server has a read and write socket end).	2278	each server has a read and write socket end).
…		…
2210	a new one that moves the timeout into the future.	2286	a new one that moves the timeout into the future.
2211		2287
2212	=head3 Results	2288	=head3 Results
2213		2289
2214	name sockets create request	2290	name sockets create request
2215	EV 20000 69.01 11.16	2291	EV 20000 62.66 7.99
2216	Perl 20000 73.32 35.87	2292	Perl 20000 68.32 32.64
2217	IOAsync 20000 157.00 98.14 epoll	2293	IOAsync 20000 174.06 101.15 epoll
2218	IOAsync 20000 159.31 616.06 poll	2294	IOAsync 20000 174.67 610.84 poll
2219	Event 20000 212.62 257.32	2295	Event 20000 202.69 242.91
2220	Glib 20000 651.16 1896.30	2296	Glib 20000 557.01 1689.52
2221	POE 20000 349.67 12317.24 uses POE::Loop::Event	2297	POE 20000 341.54 12086.32 uses POE::Loop::Event
2222		2298
2223	=head3 Discussion	2299	=head3 Discussion
2224		2300
2225	This benchmark I<does> measure scalability and overall performance of the	2301	This benchmark I<does> measure scalability and overall performance of the
2226	particular event loop.	2302	particular event loop.
…		…
2352	As you can see, the AnyEvent + EV combination even beats the	2428	As you can see, the AnyEvent + EV combination even beats the
2353	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2429	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2354	backend easily beats IO::Lambda and POE.	2430	backend easily beats IO::Lambda and POE.
2355		2431
2356	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
2357	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
2358	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
2359	in a non-blocking way.	2435	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2360		2436
2361	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
2362	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
2363	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.
2364		2440
2365		2441
2366	=head1 SIGNALS	2442	=head1 SIGNALS
2367		2443
2368	AnyEvent currently installs handlers for these signals:	2444	AnyEvent currently installs handlers for these signals:
…		…
2410	it's built-in modules) are required to use it.	2486	it's built-in modules) are required to use it.
2411		2487
2412	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
2413	modules if they are installed.	2489	modules if they are installed.
2414		2490
2415	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
2416	affect AnyEvent's operetion.	2492	affect AnyEvent's operation.
2417		2493
2418	=over 4	2494	=over 4
2419		2495
2420	=item L<Async::Interrupt>	2496	=item L<Async::Interrupt>
2421		2497
…		…
2426	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
2427	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2503	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2428		2504
2429	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
2430	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
2431	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
2432	battery life on laptops).	2508	battery life on laptops).
2433		2509
2434	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
2435	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).
2436		2512
…		…
2457	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
2458	purely used for performance.	2534	purely used for performance.
2459		2535
2460	=item L<JSON> and L<JSON::XS>	2536	=item L<JSON> and L<JSON::XS>
2461		2537
2462	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
2463	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
2464	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.
2465		2541
2466	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
2467	installed.	2543	installed.
2468		2544
…		…
2483		2559
2484		2560
2485	=head1 FORK	2561	=head1 FORK
2486		2562
2487	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
2488	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
2489	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).
2490		2575
2491	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
2492	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
2493	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.
2494		2588
2495		2589
2496	=head1 SECURITY CONSIDERATIONS	2590	=head1 SECURITY CONSIDERATIONS
2497		2591
2498	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.266 by root, Thu Jul 30 03:41:56 2009 UTC vs. Revision 1.313 by root, Sun Feb 21 09:28:18 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.266 by root, Thu Jul 30 03:41:56 2009 UTC vs.
Revision 1.313 by root, Sun Feb 21 09:28:18 2010 UTC